Skip to content

Commit f61555a

Browse files
stevsmitstevsmit
authored
Merge pull request #73716 from max-cx/OBSDOCS-932
OBSDOCS-932: Add clarifications about storage in the Tempo docs
2 parents 03f3159 + afa819a commit f61555a

File tree

2 files changed

+35
-19
lines changed

2 files changed

+35
-19
lines changed

‎modules/distr-tracing-tempo-install-cli.adoc

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,12 @@ $ oc login --username=<your_username>
2424
----
2525
====
2626
27-
* 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].
27+
* 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".
28+
+
29+
[WARNING]
30+
====
31+
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}.
32+
====
2833
2934
.Procedure
3035

@@ -107,6 +112,8 @@ $ oc apply -f - << EOF
107112
EOF
108113
----
109114
+
115+
For more information, see "Object storage setup".
116+
+
110117
--
111118
include::snippets/distr-tracing-tempo-secret-example.adoc[]
112119
--
@@ -130,9 +137,9 @@ metadata:
130137
spec:
131138
storageSize: 1Gi
132139
storage:
133-
secret:
134-
name: <secret-name> # <1>
135-
type: <secret-provider> # <2>
140+
secret: # <1>
141+
name: <secret-name> # <2>
142+
type: <secret-provider> # <3>
136143
template:
137144
queryFrontend:
138145
jaegerQuery:
@@ -142,8 +149,9 @@ spec:
142149
termination: edge
143150
type: route
144151
----
145-
<1> The value of the `name` in the `metadata` of the secret.
146-
<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.
152+
<1> The secret you created in step 3.
153+
<2> The value of the `name` in the `metadata` of the secret.
154+
<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.
147155
+
148156
.Example of a TempoStack CR for AWS S3 and MinIO storage
149157
[source,yaml]
@@ -155,7 +163,7 @@ metadata:
155163
namespace: project_of_tempostack_instance
156164
spec:
157165
storageSize: 1Gi
158-
storage:
166+
storage: # <1>
159167
secret:
160168
name: minio-test
161169
type: s3
@@ -166,14 +174,15 @@ spec:
166174
cpu: 2000m
167175
template:
168176
queryFrontend:
169-
jaegerQuery:
177+
jaegerQuery: # <2>
170178
enabled: true
171179
ingress:
172180
route:
173181
termination: edge
174182
type: route
175183
----
176-
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.
184+
<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.
185+
<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.
177186

178187
.. Apply the customized CR by running the following command.
179188
+

‎modules/distr-tracing-tempo-install-web-console.adoc

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,12 @@ You can install the {TempoShortName} from the *Administrator* view of the web co
1414
1515
* For {product-dedicated}, you must be logged in using an account with the `dedicated-admin` role.
1616
17-
* 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].
17+
* 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".
18+
+
19+
[WARNING]
20+
====
21+
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}.
22+
====
1823
1924
.Procedure
2025

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

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

41-
. 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*.
46+
. 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".
4247
+
4348
--
4449
include::snippets/distr-tracing-tempo-secret-example.adoc[]
@@ -67,9 +72,9 @@ metadata:
6772
spec:
6873
storageSize: 1Gi
6974
storage:
70-
secret:
71-
name: <secret-name> # <1>
72-
type: <secret-provider> # <2>
75+
secret: # <1>
76+
name: <secret-name> # <2>
77+
type: <secret-provider> # <3>
7378
template:
7479
queryFrontend:
7580
jaegerQuery:
@@ -79,8 +84,9 @@ spec:
7984
termination: edge
8085
type: route
8186
----
82-
<1> The value of the `name` in the `metadata` of the secret.
83-
<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.
87+
<1> The secret you created in step 3.
88+
<2> The value of the `name` in the `metadata` of the secret.
89+
<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.
8490
+
8591
.Example of a TempoStack CR for AWS S3 and MinIO storage
8692
[source,yaml]
@@ -92,7 +98,7 @@ metadata:
9298
namespace: <project_of_tempostack_instance>
9399
spec:
94100
storageSize: 1Gi
95-
storage:
101+
storage: # <1>
96102
secret:
97103
name: minio-test
98104
type: s3
@@ -103,14 +109,15 @@ spec:
103109
cpu: 2000m
104110
template:
105111
queryFrontend:
106-
jaegerQuery:
112+
jaegerQuery: # <2>
107113
enabled: true
108114
ingress:
109115
route:
110116
termination: edge
111117
type: route
112118
----
113-
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.
119+
<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.
120+
<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.
114121

115122
.. Select *Create*.
116123

0 commit comments

Comments
 (0)