Skip to content

Commit 211ad93

Browse files
max-cxopenshift-cherrypick-robot
max-cx
authored and
openshift-cherrypick-robot
committed
OBSDOCS-1799: Clarify lack of support for 'overrides' in Tempo CR
1 parent ce75072 commit 211ad93

File tree

2 files changed

+54
-51
lines changed

2 files changed

+54
-51
lines changed

‎snippets/distr-tracing-tempo-tempomonolithic-custom-resource.adoc

Lines changed: 28 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -11,46 +11,47 @@ kind: TempoMonolithic # <1>
1111
metadata:
1212
name: <metadata_name>
1313
namespace: <project_of_tempomonolithic_instance> # <2>
14-
spec:
15-
storage: # <3>
14+
spec: # <3>
15+
storage: # <4>
1616
traces:
17-
backend: <supported_storage_type> # <4>
18-
size: <value>Gi # <5>
19-
s3: # <6>
20-
secret: <secret_name> # <7>
21-
tls: # <8>
17+
backend: <supported_storage_type> # <5>
18+
size: <value>Gi # <6>
19+
s3: # <7>
20+
secret: <secret_name> # <8>
21+
tls: # <9>
2222
enabled: true
23-
caName: <ca_certificate_configmap_name> # <9>
23+
caName: <ca_certificate_configmap_name> # <10>
2424
jaegerui:
25-
enabled: true # <10>
25+
enabled: true # <11>
2626
route:
27-
enabled: true # <11>
28-
resources: # <12>
27+
enabled: true # <12>
28+
resources: # <13>
2929
total:
3030
limits:
3131
memory: <value>Gi
3232
cpu: <value>m
3333
multitenancy:
3434
enabled: true
3535
mode: openshift
36-
authentication: # <13>
37-
- tenantName: dev # <14>
38-
tenantId: "1610b0c3-c509-4592-a256-a1871353dbfa" # <15>
36+
authentication: # <14>
37+
- tenantName: dev # <15>
38+
tenantId: "1610b0c3-c509-4592-a256-a1871353dbfa" # <16>
3939
- tenantName: prod
4040
tenantId: "1610b0c3-c509-4592-a256-a1871353dbfb"
4141
----
4242
<1> This CR creates a TempoMonolithic deployment with trace ingestion in the OTLP protocol.
4343
<2> The namespace that you have chosen for the TempoMonolithic deployment.
44-
<3> Specifies the storage for storing traces.
45-
<4> Type of storage for storing traces: in-memory storage, a persistent volume, or object storage. The value for a persistent volume is `pv`. The accepted values for object storage are `s3`, `gcs`, or `azure`, depending on the used object store type. The default value is `memory` for the `tmpfs` in-memory storage, which is only appropriate for development, testing, demonstrations, and proof-of-concept environments because the data does not persist when the pod is shut down.
46-
<5> Memory size: For in-memory storage, this means the size of the `tmpfs` volume, where the default is `2Gi`. For a persistent volume, this means the size of the persistent volume claim, where the default is `10Gi`. For object storage, this means the size of the persistent volume claim for the Tempo Write-Ahead Logging (WAL), where the default is `10Gi`.
47-
<6> Optional: For object storage, the type of object storage. The accepted values are `s3`, `gcs`, and `azure`, depending on the used object store type.
48-
<7> Optional: For object storage, the value of the `name` in the `metadata` of the storage secret. The storage secret must be in the same namespace as the TempoMonolithic instance and contain the fields specified in "Table 1. Required secret parameters" in the section "Object storage setup".
49-
<8> Optional.
50-
<9> Optional: Name of a `ConfigMap` object that contains a CA certificate.
51-
<10> Exposes the Jaeger UI, which visualizes the data, via a route.
52-
<11> Enables creation of a route for the Jaeger UI.
53-
<12> Optional.
54-
<13> Lists the tenants.
55-
<14> The tenant name from the `X-Scope-OrgId` header when ingesting the data.
56-
<15> The unique identifier of the tenant. Must be unique throughout the lifecycle of the TempoMonolithic deployment. This ID will be added as a prefix to the objects in the object storage. You can reuse the value of the UUID or `tempoName` field.
44+
<3> Red{nbsp}Hat supports only the custom resource options that are available in the {DTProductName} documentation.
45+
<4> Specifies the storage for storing traces.
46+
<5> Type of storage for storing traces: in-memory storage, a persistent volume, or object storage. The value for a persistent volume is `pv`. The accepted values for object storage are `s3`, `gcs`, or `azure`, depending on the used object store type. The default value is `memory` for the `tmpfs` in-memory storage, which is only appropriate for development, testing, demonstrations, and proof-of-concept environments because the data does not persist when the pod is shut down.
47+
<6> Memory size: For in-memory storage, this means the size of the `tmpfs` volume, where the default is `2Gi`. For a persistent volume, this means the size of the persistent volume claim, where the default is `10Gi`. For object storage, this means the size of the persistent volume claim for the Tempo Write-Ahead Logging (WAL), where the default is `10Gi`.
48+
<7> Optional: For object storage, the type of object storage. The accepted values are `s3`, `gcs`, and `azure`, depending on the used object store type.
49+
<8> Optional: For object storage, the value of the `name` in the `metadata` of the storage secret. The storage secret must be in the same namespace as the TempoMonolithic instance and contain the fields specified in "Table 1. Required secret parameters" in the section "Object storage setup".
50+
<9> Optional.
51+
<10> Optional: Name of a `ConfigMap` object that contains a CA certificate.
52+
<11> Exposes the Jaeger UI, which visualizes the data, via a route at `+http://<gateway_ingress>/api/traces/v1/<tenant_name>/search+`.
53+
<12> Enables creation of a route for the Jaeger UI.
54+
<13> Optional.
55+
<14> Lists the tenants.
56+
<15> The tenant name, which is used as the value for the `X-Scope-OrgId` HTTP header.
57+
<16> The unique identifier of the tenant. Must be unique throughout the lifecycle of the TempoMonolithic deployment. This ID will be added as a prefix to the objects in the object storage. You can reuse the value of the UUID or `tempoName` field.

‎snippets/distr-tracing-tempo-tempostack-custom-resource.adoc

Lines changed: 26 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -12,41 +12,43 @@ kind: TempoStack # <1>
1212
metadata:
1313
name: simplest
1414
namespace: <project_of_tempostack_instance> # <2>
15-
spec:
16-
storage: # <3>
17-
secret: # <4>
18-
name: <secret_name> # <5>
19-
type: <secret_provider> # <6>
20-
storageSize: <value>Gi # <7>
21-
resources:
15+
spec: <3>
16+
storage: # <4>
17+
secret: # <5>
18+
name: <secret_name> # <6>
19+
type: <secret_provider> # <7>
20+
storageSize: <value>Gi # <8>
21+
resources: # <9>
2222
total:
2323
limits:
2424
memory: 2Gi
2525
cpu: 2000m
2626
tenants:
27-
mode: openshift # <8>
28-
authentication: # <9>
29-
- tenantName: dev # <10>
30-
tenantId: "1610b0c3-c509-4592-a256-a1871353dbfa" # <11>
27+
mode: openshift # <10>
28+
authentication: # <11>
29+
- tenantName: dev # <12>
30+
tenantId: "1610b0c3-c509-4592-a256-a1871353dbfa" # <13>
3131
- tenantName: prod
3232
tenantId: "1610b0c3-c509-4592-a256-a1871353dbfb"
3333
template:
3434
gateway:
35-
enabled: true # <12>
35+
enabled: true # <14>
3636
queryFrontend:
3737
jaegerQuery:
38-
enabled: true # <13>
38+
enabled: true # <15>
3939
----
4040
<1> This CR creates a TempoStack deployment, which is configured to receive Jaeger Thrift over the HTTP and OpenTelemetry Protocol (OTLP).
4141
<2> The namespace that you have chosen for the TempoStack deployment.
42-
<3> Specifies the storage for storing traces.
43-
<4> The secret you created in step 2 for the object storage that had been set up as one of the prerequisites.
44-
<5> The value of the `name` field in the `metadata` section of the secret. For example: `minio`.
45-
<6> The accepted values are `azure` for Azure Blob Storage; `gcs` for Google Cloud Storage; and `s3` for Amazon S3, MinIO, or {odf-full}. For example: `s3`.
46-
<7> The size of the persistent volume claim for the Tempo Write-Ahead Logging (WAL). The default is `10Gi`. For example: `1Gi`.
47-
<8> The value must be `openshift`.
48-
<9> The list of tenants.
49-
<10> The tenant name, which is to be provided in the `X-Scope-OrgId` header when ingesting the data.
50-
<11> The unique identifier of the tenant. Must be unique throughout the lifecycle of the TempoStack deployment. The {TempoShortName} uses this ID to prefix objects in the object storage. You can reuse the value of the UUID or `tempoName` field.
51-
<12> Enables a gateway that performs authentication and authorization. The Jaeger UI is exposed at `+http://<gateway_ingress>/api/traces/v1/<tenant_name>/search+`.
52-
<13> Exposes the Jaeger UI, which visualizes the data, via a route.
42+
<3> Red{nbsp}Hat supports only the custom resource options that are available in the {DTProductName} documentation.
43+
<4> Specifies the storage for storing traces.
44+
<5> The secret you created in step 2 for the object storage that had been set up as one of the prerequisites.
45+
<6> The value of the `name` field in the `metadata` section of the secret. For example: `minio`.
46+
<7> The accepted values are `azure` for Azure Blob Storage; `gcs` for Google Cloud Storage; and `s3` for Amazon S3, MinIO, or {odf-full}. For example: `s3`.
47+
<8> The size of the persistent volume claim for the Tempo Write-Ahead Logging (WAL). The default is `10Gi`. For example: `1Gi`.
48+
<9> Optional.
49+
<10> The value must be `openshift`.
50+
<11> The list of tenants.
51+
<12> The tenant name, which is used as the value for the `X-Scope-OrgId` HTTP header.
52+
<13> The unique identifier of the tenant. Must be unique throughout the lifecycle of the TempoStack deployment. The {TempoShortName} uses this ID to prefix objects in the object storage. You can reuse the value of the UUID or `tempoName` field.
53+
<14> Enables a gateway that performs authentication and authorization.
54+
<15> Exposes the Jaeger UI, which visualizes the data, via a route at `+http://<gateway_ingress>/api/traces/v1/<tenant_name>/search+`.

0 commit comments

Comments
 (0)