Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[enterprise-4.13] OBSDOCS-932: Add clarifications about storage in the Tempo docs #74372

Merged
merged 1 commit into from
Apr 8, 2024
Merged

[enterprise-4.13] OBSDOCS-932: Add clarifications about storage in the Tempo docs #74372

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 18 additions & 9 deletions modules/distr-tracing-tempo-install-cli.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,12 @@ $ oc login --username=<your_username>
----
====

* You are using a supported provider of object storage: link:https://www.redhat.com/en/technologies/cloud-computing/openshift-data-foundation[Red Hat OpenShift Data Foundation], link:https://min.io/[MinIO], link:https://aws.amazon.com/s3/[Amazon S3], link:https://azure.microsoft.com/en-us/products/storage/blobs/[Azure Blob Storage], link:https://cloud.google.com/storage/[Google Cloud Storage].
* You have completed setting up the required object storage by a supported provider: link:https://www.redhat.com/en/technologies/cloud-computing/openshift-data-foundation[Red Hat OpenShift Data Foundation], link:https://min.io/[MinIO], link:https://aws.amazon.com/s3/[Amazon S3], link:https://azure.microsoft.com/en-us/products/storage/blobs/[Azure Blob Storage], link:https://cloud.google.com/storage/[Google Cloud Storage]. For more information, see "Object storage setup".
+
[WARNING]
====
Object storage is required and not included with the {TempoShortName}. You must choose and set up object storage by a supported provider before installing the {TempoShortName}.
====

.Procedure

Expand Down Expand Up @@ -107,6 +112,8 @@ $ oc apply -f - << EOF
EOF
----
+
For more information, see "Object storage setup".
+
--
include::snippets/distr-tracing-tempo-secret-example.adoc[]
--
Expand All @@ -130,9 +137,9 @@ metadata:
spec:
storageSize: 1Gi
storage:
secret:
name: <secret-name> # <1>
type: <secret-provider> # <2>
secret: # <1>
name: <secret-name> # <2>
type: <secret-provider> # <3>
template:
queryFrontend:
jaegerQuery:
Expand All @@ -142,8 +149,9 @@ spec:
termination: edge
type: route
----
<1> The value of the `name` in the `metadata` of the secret.
<2> The accepted values are `azure` for Azure Blob Storage; `gcs` for Google Cloud Storage; and `s3` for Amazon S3, MinIO, or Red Hat OpenShift Data Foundation.
<1> The secret you created in step 3.
<2> The value of the `name` in the `metadata` of the secret.
<3> The accepted values are `azure` for Azure Blob Storage; `gcs` for Google Cloud Storage; and `s3` for Amazon S3, MinIO, or Red Hat OpenShift Data Foundation.
+
.Example of a TempoStack CR for AWS S3 and MinIO storage
[source,yaml]
Expand All @@ -155,7 +163,7 @@ metadata:
namespace: project_of_tempostack_instance
spec:
storageSize: 1Gi
storage:
storage: # <1>
secret:
name: minio-test
type: s3
Expand All @@ -166,14 +174,15 @@ spec:
cpu: 2000m
template:
queryFrontend:
jaegerQuery:
jaegerQuery: # <2>
enabled: true
ingress:
route:
termination: edge
type: route
----
The stack deployed in this example is configured to receive Jaeger Thrift over HTTP and OpenTelemetry Protocol (OTLP), which permits visualizing the data with the Jaeger UI.
<1> In this example, the object storage was set up as one of the prerequisites, and the object storage secret was created in step 3.
<2> The stack deployed in this example is configured to receive Jaeger Thrift over HTTP and OpenTelemetry Protocol (OTLP), which permits visualizing the data with the Jaeger UI.

.. Apply the customized CR by running the following command.
+
Expand Down
27 changes: 17 additions & 10 deletions modules/distr-tracing-tempo-install-web-console.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,12 @@ You can install the {TempoShortName} from the *Administrator* view of the web co

* For {product-dedicated}, you must be logged in using an account with the `dedicated-admin` role.

* You are using a supported provider of object storage: link:https://www.redhat.com/en/technologies/cloud-computing/openshift-data-foundation[Red Hat OpenShift Data Foundation], link:https://min.io/[MinIO], link:https://aws.amazon.com/s3/[Amazon S3], link:https://azure.microsoft.com/en-us/products/storage/blobs/[Azure Blob Storage], link:https://cloud.google.com/storage/[Google Cloud Storage].
* You have completed setting up the required object storage by a supported provider: link:https://www.redhat.com/en/technologies/cloud-computing/openshift-data-foundation[Red Hat OpenShift Data Foundation], link:https://min.io/[MinIO], link:https://aws.amazon.com/s3/[Amazon S3], link:https://azure.microsoft.com/en-us/products/storage/blobs/[Azure Blob Storage], link:https://cloud.google.com/storage/[Google Cloud Storage]. For more information, see "Object storage setup".
+
[WARNING]
====
Object storage is required and not included with the {TempoShortName}. You must choose and set up object storage by a supported provider before installing the {TempoShortName}.
====

.Procedure

Expand All @@ -38,7 +43,7 @@ This installs the Operator with the default presets:

. Create a project of your choice for the *TempoStack* instance that you will create in a subsequent step: go to *Home* -> *Projects* -> *Create Project*.

. In the project that you created for the *TempoStack* instance, create a secret for your object storage bucket: go to *Workloads* -> *Secrets* -> *Create* -> *From YAML*.
. In the project that you created for the *TempoStack* instance, create a secret for your object storage bucket: go to *Workloads* -> *Secrets* -> *Create* -> *From YAML*. For more information, see "Object storage setup".
+
--
include::snippets/distr-tracing-tempo-secret-example.adoc[]
Expand Down Expand Up @@ -67,9 +72,9 @@ metadata:
spec:
storageSize: 1Gi
storage:
secret:
name: <secret-name> # <1>
type: <secret-provider> # <2>
secret: # <1>
name: <secret-name> # <2>
type: <secret-provider> # <3>
template:
queryFrontend:
jaegerQuery:
Expand All @@ -79,8 +84,9 @@ spec:
termination: edge
type: route
----
<1> The value of the `name` in the `metadata` of the secret.
<2> The accepted values are `azure` for Azure Blob Storage; `gcs` for Google Cloud Storage; and `s3` for Amazon S3, MinIO, or Red Hat OpenShift Data Foundation.
<1> The secret you created in step 3.
<2> The value of the `name` in the `metadata` of the secret.
<3> The accepted values are `azure` for Azure Blob Storage; `gcs` for Google Cloud Storage; and `s3` for Amazon S3, MinIO, or Red Hat OpenShift Data Foundation.
+
.Example of a TempoStack CR for AWS S3 and MinIO storage
[source,yaml]
Expand All @@ -92,7 +98,7 @@ metadata:
namespace: <project_of_tempostack_instance>
spec:
storageSize: 1Gi
storage:
storage: # <1>
secret:
name: minio-test
type: s3
Expand All @@ -103,14 +109,15 @@ spec:
cpu: 2000m
template:
queryFrontend:
jaegerQuery:
jaegerQuery: # <2>
enabled: true
ingress:
route:
termination: edge
type: route
----
The stack deployed in this example is configured to receive Jaeger Thrift over HTTP and OpenTelemetry Protocol (OTLP), which permits visualizing the data with the Jaeger UI.
<1> In this example, the object storage was set up as one of the prerequisites, and the object storage secret was created in step 3.
<2> The stack deployed in this example is configured to receive Jaeger Thrift over HTTP and OpenTelemetry Protocol (OTLP), which permits visualizing the data with the Jaeger UI.

.. Select *Create*.

Expand Down