OBSDOCS-932: Add clarifications about storage in the Tempo docs

openshift · Mar 26, 2024 · c287e6e · c287e6e
1 parent eae1e41
commit c287e6e
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 18 deletions.
diff --git a/modules/distr-tracing-tempo-install-cli.adoc b/modules/distr-tracing-tempo-install-cli.adoc
@@ -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 details, 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
 
@@ -107,6 +112,8 @@ $ oc apply -f - << EOF
 EOF
 ----
 +
+For more details, see the prerequisites and the section _Object storage setup_.
++
 --
 include::snippets/distr-tracing-tempo-secret-example.adoc[]
 --
@@ -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:
@@ -142,10 +149,11 @@ 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
+.Example of a TempoStack CR for AWS S3 and successfully created MinIO storage
 [source,yaml]
 ----
 apiVersion: tempo.grafana.com/v1alpha1
@@ -155,7 +163,7 @@ metadata:
   namespace: project_of_tempostack_instance
 spec:
   storageSize: 1Gi
-  storage:
+  storage: # <1>
     secret:
       name: minio-test
       type: s3
@@ -173,6 +181,8 @@ spec:
             termination: edge
           type: route
 ----
+<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.
++
 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.

diff --git a/modules/distr-tracing-tempo-install-web-console.adoc b/modules/distr-tracing-tempo-install-web-console.adoc
@@ -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 details, 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
 
@@ -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 details, see the prerequisites and the section _Object storage setup_.
 +
 --
 include::snippets/distr-tracing-tempo-secret-example.adoc[]
@@ -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:
@@ -79,10 +84,11 @@ 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
+.Example of a TempoStack CR for AWS S3 and successully created MinIO storage
 [source,yaml]
 ----
 apiVersion: tempo.grafana.com/v1alpha1
@@ -92,7 +98,7 @@ metadata:
   namespace: <project_of_tempostack_instance>
 spec:
   storageSize: 1Gi
-  storage:
+  storage: # <1>
     secret:
       name: minio-test
       type: s3
@@ -110,6 +116,8 @@ spec:
             termination: edge
           type: route
 ----
+<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.
++
 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*.

diff --git a/snippets/distr-tracing-tempo-secret-example.adoc b/snippets/distr-tracing-tempo-secret-example.adoc
@@ -5,7 +5,7 @@
 
 :_mod-docs-content-type: SNIPPET
 
-.Example secret for Amazon S3 and MinIO storage
+.Example secret for Amazon S3 and successfully created MinIO storage
 [source,yaml]
 ----
 apiVersion: v1