1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Files
openshift-docs/snippets/distr-tracing-tempo-tempostack-custom-resource.adoc
2025-10-28 14:54:43 -04:00

55 lines
2.5 KiB
Plaintext

// :_mod-docs-content-type: SNIPPET
// Text snippet included in the following modules:
//
// * modules/distr-tracing-tempo-install-tempostack-web-console.adoc
// * modules/distr-tracing-tempo-install-tempostack-cli.adoc
.Example `TempoStack` CR for AWS S3 and MinIO storage and two tenants
[source,yaml]
----
apiVersion: tempo.grafana.com/v1alpha1
kind: TempoStack # <1>
metadata:
name: simplest
namespace: <permitted_project_of_tempostack_instance> # <2>
spec: # <3>
storage: # <4>
secret: # <5>
name: <secret_name> # <6>
type: <secret_provider> # <7>
storageSize: <value>Gi # <8>
resources: # <9>
total:
limits:
memory: 2Gi
cpu: 2000m
tenants:
mode: openshift # <10>
authentication: # <11>
- tenantName: dev # <12>
tenantId: "1610b0c3-c509-4592-a256-a1871353dbfa" # <13>
- tenantName: prod
tenantId: "1610b0c3-c509-4592-a256-a1871353dbfb"
template:
gateway:
enabled: true # <14>
queryFrontend:
jaegerQuery:
enabled: true # <15>
----
<1> This CR creates a `TempoStack` deployment, which is configured to receive Jaeger Thrift over the HTTP and OpenTelemetry Protocol (OTLP).
<2> The project that you have chosen for the `TempoStack` deployment. Project names beginning with the `openshift-` prefix are not permitted.
<3> Red{nbsp}Hat supports only the custom resource options that are available in the {DTProductName} documentation.
<4> Specifies the storage for storing traces.
<5> The secret you created in step 2 for the object storage that had been set up as one of the prerequisites.
<6> The value of the `name` field in the `metadata` section of the secret. For example: `minio`.
<7> The accepted values are `azure` for Azure Blob Storage; `gcs` for {gcp-full} Storage; and `s3` for Amazon S3, MinIO, or {odf-full}. For example: `s3`.
<8> The size of the persistent volume claim for the Tempo Write-Ahead Logging (WAL). The default is `10Gi`. For example: `1Gi`.
<9> Optional.
<10> The value must be `openshift`.
<11> The list of tenants.
<12> The tenant name, which is used as the value for the `X-Scope-OrgId` HTTP header.
<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.
<14> Enables a gateway that performs authentication and authorization.
<15> Exposes the Jaeger UI, which visualizes the data, via a route at `+http://<gateway_ingress>/api/traces/v1/<tenant_name>/search+`.