Installing

Installing the Tempo Operator
- Installing the Tempo Operator by using the web console
- Installing the Tempo Operator by using the CLI
Installing a TempoStack instance
- Installing a TempoStack instance by using the web console
- Installing a TempoStack instance by using the CLI
Installing a TempoMonolithic instance
- Installing a TempoMonolithic instance by using the web console
- Installing a TempoMonolithic instance by using the CLI
Object storage setup
Additional resources

Installing the distributed tracing platform (Tempo) requires the Tempo Operator and choosing which type of deployment is best for your use case:

For microservices mode, deploy a TempoStack instance in a dedicated OpenShift project.
For monolithic mode, deploy a TempoMonolithic instance in a dedicated OpenShift project.

Using object storage requires setting up a supported object store and creating a secret for the object store credentials before deploying a TempoStack or TempoMonolithic instance.

Installing the Tempo Operator

You can install the Tempo Operator by using the web console or the command line.

Installing the Tempo Operator by using the web console

You can install the Tempo Operator from the Administrator view of the web console.

Prerequisites

You are logged in to the OpenShift Container Platform web console as a cluster administrator with the cluster-admin role.
For Red Hat OpenShift Dedicated, you must be logged in using an account with the dedicated-admin role.

You have completed setting up the required object storage by a supported provider: Red Hat OpenShift Data Foundation, MinIO, Amazon S3, Azure Blob Storage, Google Cloud Storage. For more information, see "Object storage setup".

Object storage is required and not included with the distributed tracing platform (Tempo). You must choose and set up object storage by a supported provider before installing the distributed tracing platform (Tempo).

Procedure

Go to Operators → OperatorHub and search for Tempo Operator.

Select the Tempo Operator that is provided by Red Hat.

The following selections are the default presets for this Operator:

Update channel → stable
Installation mode → All namespaces on the cluster
Installed Namespace → openshift-tempo-operator
Update approval → Automatic

Select the Enable Operator recommended cluster monitoring on this Namespace checkbox.
Select Install → Install → View Operator.

Verification

In the Details tab of the page of the installed Operator, under ClusterServiceVersion details, verify that the installation Status is Succeeded.

Installing the Tempo Operator by using the CLI

You can install the Tempo Operator from the command line.

Prerequisites

An active OpenShift CLI (oc) session by a cluster administrator with the cluster-admin role.
Ensure that your OpenShift CLI (oc) version is up to date and matches your OpenShift Container Platform version.

Run oc login:

$ oc login --username=<your_username>

Procedure

Create a project for the Tempo Operator by running the following command:

$ oc apply -f - << EOF
apiVersion: project.openshift.io/v1
kind: Project
metadata:
  labels:
    kubernetes.io/metadata.name: openshift-tempo-operator
    openshift.io/cluster-monitoring: "true"
  name: openshift-tempo-operator
EOF

Create an Operator group by running the following command:

$ oc apply -f - << EOF
apiVersion: operators.coreos.com/v1
kind: OperatorGroup
metadata:
  name: openshift-tempo-operator
  namespace: openshift-tempo-operator
spec:
  upgradeStrategy: Default
EOF

Create a subscription by running the following command:

$ oc apply -f - << EOF
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: tempo-product
  namespace: openshift-tempo-operator
spec:
  channel: stable
  installPlanApproval: Automatic
  name: tempo-product
  source: redhat-operators
  sourceNamespace: openshift-marketplace
EOF

Verification

Check the Operator status by running the following command:
```
$ oc get csv -n openshift-tempo-operator
```

Installing a TempoStack instance

You can install a TempoStack instance by using the web console or the command line.

Installing a TempoStack instance by using the web console

You can install a TempoStack instance from the Administrator view of the web console.

Prerequisites

You are logged in to the OpenShift Container Platform web console as a cluster administrator with the cluster-admin role.
For Red Hat OpenShift Dedicated, you must be logged in using an account with the dedicated-admin role.

Procedure

Go to Home → Projects → Create Project to create a project of your choice for the TempoStack instance that you will create in a subsequent step.
Go to Workloads → Secrets → Create → From YAML to create a secret for your object storage bucket in the project that you created for the TempoStack instance. For more information, see "Object storage setup".
Example secret for Amazon S3 and MinIO storage
apiVersion: v1 kind: Secret metadata: name: minio-test stringData: endpoint: http://minio.minio.svc:9000 bucket: tempo access_key_id: tempo access_key_secret: <secret> type: Opaque

Create a TempoStack instance.

You can create multiple TempoStack instances in separate projects on the same cluster.

Go to Operators → Installed Operators.
Select TempoStack → Create TempoStack → YAML view.

In the YAML view, customize the TempoStack custom resource (CR):

apiVersion: tempo.grafana.com/v1alpha1
kind: TempoStack
metadata:
  name: sample
  namespace: <project_of_tempostack_instance>
spec:
  storageSize: 1Gi
  storage:
    secret: (1)
      name: <secret_name> (2)
      type: <secret_provider> (3)
  template:
    queryFrontend:
      jaegerQuery:
        enabled: true
        ingress:
          route:
            termination: edge
          type: route

1	The secret you created in step 2 for the object storage that had been set up as one of the prerequisites.
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

apiVersion: tempo.grafana.com/v1alpha1
kind: TempoStack
metadata:
  name: simplest
  namespace: <project_of_tempostack_instance>
spec:
  storageSize: 1Gi
  storage: (1)
    secret:
      name: minio-test
      type: s3
  resources:
    total:
      limits:
        memory: 2Gi
        cpu: 2000m
  template:
    queryFrontend:
      jaegerQuery: (2)
        enabled: true
        ingress:
          route:
            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 2.
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.

Verification

Use the Project: dropdown list to select the project of the TempoStack instance.
Go to Operators → Installed Operators to verify that the Status of the TempoStack instance is Condition: Ready.
Go to Workloads → Pods to verify that all the component pods of the TempoStack instance are running.
Access the Tempo console:
1. Go to Networking → Routes and Ctrl+F to search for tempo.
2. In the Location column, open the URL to access the Tempo console.
  
  The Tempo console initially shows no trace data following the Tempo console installation.

Installing a TempoStack instance by using the CLI

You can install a TempoStack instance from the command line.

Prerequisites

An active OpenShift CLI (oc) session by a cluster administrator with the cluster-admin role.
Ensure that your OpenShift CLI (oc) version is up to date and matches your OpenShift Container Platform version.

Run the oc login command:

$ oc login --username=<your_username>

Procedure

Run the following command to create a project of your choice for the TempoStack instance that you will create in a subsequent step:

$ oc apply -f - << EOF
apiVersion: project.openshift.io/v1
kind: Project
metadata:
  name: <project_of_tempostack_instance>
EOF

In the project that you created for the TempoStack instance, create a secret for your object storage bucket by running the following command:

$ oc apply -f - << EOF
<object_storage_secret>
EOF

For more information, see "Object storage setup".

Example secret for Amazon S3 and MinIO storage

apiVersion: v1
kind: Secret
metadata:
  name: minio-test
stringData:
  endpoint: http://minio.minio.svc:9000
  bucket: tempo
  access_key_id: tempo
  access_key_secret: <secret>
type: Opaque

Create a TempoStack instance in the project that you created for it:

You can create multiple TempoStack instances in separate projects on the same cluster.

Customize the TempoStack custom resource (CR):

apiVersion: tempo.grafana.com/v1alpha1
kind: TempoStack
metadata:
  name: sample
  namespace: <project_of_tempostack_instance>
spec:
  storageSize: 1Gi
  storage:
      secret: (1)
          name: <secret_name> (2)
          type: <secret_provider> (3)
  template:
    queryFrontend:
      jaegerQuery:
        enabled: true
        ingress:
          route:
            termination: edge
          type: route

1	The secret you created in step 2 for the object storage that had been set up as one of the prerequisites.
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

apiVersion: tempo.grafana.com/v1alpha1
kind: TempoStack
metadata:
  name: simplest
  namespace: <project_of_tempostack_instance>
spec:
  storageSize: 1Gi
  storage: (1)
    secret:
      name: minio-test
      type: s3
  resources:
    total:
      limits:
        memory: 2Gi
        cpu: 2000m
  template:
    queryFrontend:
      jaegerQuery: (2)
        enabled: true
        ingress:
          route:
            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 2.
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:
```
$ oc apply -f - << EOF
<tempostack_cr>
EOF
```

Verification

Verify that the status of all TempoStack components is Running and the conditions are type: Ready by running the following command:
```
$ oc get tempostacks.tempo.grafana.com simplest -o yaml
```
Verify that all the TempoStack component pods are running by running the following command:
```
$ oc get pods
```
Access the Tempo console:
1. Query the route details by running the following command:
  $ oc get route
2. Open https://<route_from_previous_step> in a web browser.
  
  The Tempo console initially shows no trace data following the Tempo console installation.

Installing a TempoMonolithic instance

The TempoMonolithic instance is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.

For more information about the support scope of Red Hat Technology Preview features, see Technology Preview Features Support Scope.

You can install a TempoMonolithic instance by using the web console or the command line.

The TempoMonolithic custom resource (CR) creates a Tempo deployment in monolithic mode. All components of the Tempo deployment, such as the compactor, distributor, ingester, querier, and query frontend, are contained in a single container.

A TempoMonolithic instance supports storing traces in in-memory storage, a persistent volume, or object storage.

Tempo deployment in monolithic mode is preferred for a small deployment, demonstration, testing, and as a migration path of the Red Hat OpenShift distributed tracing platform (Jaeger) all-in-one deployment.

The monolithic deployment of Tempo does not scale horizontally. If you require horizontal scaling, use the TempoStack CR for a Tempo deployment in microservices mode.

Installing a TempoMonolithic instance by using the web console

For more information about the support scope of Red Hat Technology Preview features, see Technology Preview Features Support Scope.

You can install a TempoMonolithic instance from the Administrator view of the web console.

Prerequisites

You are logged in to the OpenShift Container Platform web console as a cluster administrator with the cluster-admin role.
For Red Hat OpenShift Dedicated, you must be logged in using an account with the dedicated-admin role.

Procedure

Go to Home → Projects → Create Project to create a project of your choice for the TempoMonolithic instance that you will create in a subsequent step.

Decide which type of supported storage to use for storing traces: in-memory storage, a persistent volume, or object storage.

Object storage is not included with the distributed tracing platform (Tempo) and requires setting up an object store by a supported provider: Red Hat OpenShift Data Foundation, MinIO, Amazon S3, Azure Blob Storage, or Google Cloud Storage.

Additionally, opting for object storage requires creating a secret for your object storage bucket in the project that you created for the TempoMonolithic instance. You can do this in Workloads → Secrets → Create → From YAML.

For more information, see "Object storage setup".

Example secret for Amazon S3 and MinIO storage

apiVersion: v1
kind: Secret
metadata:
  name: minio-test
stringData:
  endpoint: http://minio.minio.svc:9000
  bucket: tempo
  access_key_id: tempo
  access_key_secret: <secret>
type: Opaque

Create a TempoMonolithic instance:

You can create multiple TempoMonolithic instances in separate projects on the same cluster.

Go to Operators → Installed Operators.
Select TempoMonolithic → Create TempoMonolithic → YAML view.

In the YAML view, customize the TempoMonolithic custom resource (CR).

The following TempoMonolithic CR creates a TempoMonolithic deployment with trace ingestion over OTLP/gRPC and OTLP/HTTP, storing traces in a supported type of storage and exposing Jaeger UI via a route:

apiVersion: tempo.grafana.com/v1alpha1
kind: TempoMonolithic
metadata:
  name: <metadata_name>
  namespace: <project_of_tempomonolithic_instance>
spec:
  storage:
    traces:
      backend: <supported_storage_type> (1)
      size: <value>Gi (2)
      s3: (3)
        secret: <secret_name> (4)
  jaegerui:
    enabled: true (5)
    route:
      enabled: true (6)

1	Type of storage for storing traces: in-memory storage, a persistent volume, or object storage. The value for the `tmpfs` in-memory storage is `memory`. 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.
2	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 WAL, where the default is `10Gi`.
3	Optional: For object storage, the type of object storage. The accepted values are `s3`, `gcs`, and `azure`, depending on the used object store type.
4	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".
5	Enables the Jaeger UI.
6	Enables creation of a route for the Jaeger UI.

Select Create.

Verification

Use the Project: dropdown list to select the project of the TempoMonolithic instance.
Go to Operators → Installed Operators to verify that the Status of the TempoMonolithic instance is Condition: Ready.
Go to Workloads → Pods to verify that the pod of the TempoMonolithic instance is running.
Access the Jaeger UI:
1. Go to Networking → Routes and Ctrl+F to search for jaegerui.
  
  The Jaeger UI uses the tempo-<metadata_name_of_TempoMonolithic_CR>-jaegerui route.
2. In the Location column, open the URL to access the Jaeger UI.
When the pod of the TempoMonolithic instance is ready, you can send traces to the tempo-<metadata_name_of_TempoMonolithic_CR>:4317 (OTLP/gRPC) and tempo-<metadata_name_of_TempoMonolithic_CR>:4318 (OTLP/HTTP) endpoints inside the cluster.

The Tempo API is available at the tempo-<metadata_name_of_TempoMonolithic_CR>:3200 endpoint inside the cluster.

Installing a TempoMonolithic instance by using the CLI

For more information about the support scope of Red Hat Technology Preview features, see Technology Preview Features Support Scope.

You can install a TempoMonolithic instance from the command line.

Prerequisites

An active OpenShift CLI (oc) session by a cluster administrator with the cluster-admin role.
Ensure that your OpenShift CLI (oc) version is up to date and matches your OpenShift Container Platform version.

Run the oc login command:

$ oc login --username=<your_username>

Procedure

Run the following command to create a project of your choice for the TempoMonolithic instance that you will create in a subsequent step:

$ oc apply -f - << EOF
apiVersion: project.openshift.io/v1
kind: Project
metadata:
  name: <project_of_tempomonolithic_instance>
EOF

Decide which type of supported storage to use for storing traces: in-memory storage, a persistent volume, or object storage.

Additionally, opting for object storage requires creating a secret for your object storage bucket in the project that you created for the TempoMonolithic instance. You can do this by running the following command:

$ oc apply -f - << EOF
<object_storage_secret>
EOF

For more information, see "Object storage setup".

Example secret for Amazon S3 and MinIO storage

apiVersion: v1
kind: Secret
metadata:
  name: minio-test
stringData:
  endpoint: http://minio.minio.svc:9000
  bucket: tempo
  access_key_id: tempo
  access_key_secret: <secret>
type: Opaque

Create a TempoMonolithic instance in the project that you created for it.

You can create multiple TempoMonolithic instances in separate projects on the same cluster.

Customize the TempoMonolithic custom resource (CR).

apiVersion: tempo.grafana.com/v1alpha1
kind: TempoMonolithic
metadata:
  name: <metadata_name>
  namespace: <project_of_tempomonolithic_instance>
spec:
  storage:
    traces:
      backend: <supported_storage_type> (1)
      size: <value>Gi (2)
      s3: (3)
        secret: <secret_name> (4)
  jaegerui:
    enabled: true (5)
    route:
      enabled: true (6)

1	Type of storage for storing traces: in-memory storage, a persistent volume, or object storage. The value for the `tmpfs` in-memory storage is `memory`. 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.
2	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 WAL, where the default is `10Gi`.
3	Optional: For object storage, the type of object storage. The accepted values are `s3`, `gcs`, and `azure`, depending on the used object store type.
4	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".
5	Enables the Jaeger UI.
6	Enables creation of a route for the Jaeger UI.

Apply the customized CR by running the following command:
```
$ oc apply -f - << EOF
<tempomonolithic_cr>
EOF
```

Verification

Verify that the status of all TempoMonolithic components is Running and the conditions are type: Ready by running the following command:
```
$ oc get tempomonolithic.tempo.grafana.com <metadata_name_of_tempomonolithic_cr> -o yaml
```
Run the following command to verify that the pod of the TempoMonolithic instance is running:
```
$ oc get pods
```
Access the Jaeger UI:
1. Query the route details for the tempo-<metadata_name_of_tempomonolithic_cr>-jaegerui route by running the following command:
  $ oc get route
2. Open https://<route_from_previous_step> in a web browser.
When the pod of the TempoMonolithic instance is ready, you can send traces to the tempo-<metadata_name_of_tempomonolithic_cr>:4317 (OTLP/gRPC) and tempo-<metadata_name_of_tempomonolithic_cr>:4318 (OTLP/HTTP) endpoints inside the cluster.

The Tempo API is available at the tempo-<metadata_name_of_tempomonolithic_cr>:3200 endpoint inside the cluster.

Object storage setup

You can use the following configuration parameters when setting up a supported object storage.

Table 1. Required secret parameters
Storage provider	Secret parameters
Red Hat OpenShift Data Foundation	`name: tempostack-dev-odf # example` `bucket: <bucket_name> # requires an ObjectBucketClaim` `endpoint: https://s3.openshift-storage.svc` `access_key_id: <data_foundation_access_key_id>` `access_key_secret: <data_foundation_access_key_secret>`
MinIO	See MinIO Operator. `name: tempostack-dev-minio # example` `bucket: <minio_bucket_name> # MinIO documentation` `endpoint: <minio_bucket_endpoint>` `access_key_id: <minio_access_key_id>` `access_key_secret: <minio_access_key_secret>`
Amazon S3	`name: tempostack-dev-s3 # example` `bucket: <s3_bucket_name> # Amazon S3 documentation` `endpoint: <s3_bucket_endpoint>` `access_key_id: <s3_access_key_id>` `access_key_secret: <s3_access_key_secret>`
Microsoft Azure Blob Storage	`name: tempostack-dev-azure # example` `container: <azure_blob_storage_container_name> # Microsoft Azure documentation` `account_name: <azure_blob_storage_account_name>` `account_key: <azure_blob_storage_account_key>`
Google Cloud Storage on Google Cloud Platform (GCP)	`name: tempostack-dev-gcs # example` `bucketname: <google_cloud_storage_bucket_name> # requires a bucket created in a GCP project` `key.json: <path/to/key.json> # requires a service account in the bucket’s GCP project for GCP authentication`

Installing the Tempo Operator

Installing the Tempo Operator by using the web console

Installing the Tempo Operator by using the CLI

Installing a TempoStack instance

Installing a TempoStack instance by using the web console

Installing a TempoStack instance by using the CLI

Installing a TempoMonolithic instance

Installing a TempoMonolithic instance by using the web console

Installing a TempoMonolithic instance by using the CLI

Object storage setup

Additional resources