Chapter 3. Distributed tracing installation

Procedure

1. Log in to the OpenShift Container Platform web console as a user with the cluster-admin role. If you use Red Hat OpenShift Dedicated, you must have an account with the dedicated-admin role.
2. Navigate to Operators OperatorHub.
3. Type Elasticsearch into the filter box to locate the OpenShift Elasticsearch Operator.
4. Click the OpenShift Elasticsearch Operator provided by Red Hat to display information about the Operator.
5. Click Install.
6. On the Install Operator page, select the stable Update Channel. This automatically updates your Operator as new versions are released.

7. Accept the default All namespaces on the cluster (default). This installs the Operator in the default openshift-operators-redhat project and makes the Operator available to all projects in the cluster.

   Note

   The Elasticsearch installation requires the openshift-operators-redhat namespace for the OpenShift Elasticsearch Operator. The other Red Hat OpenShift distributed tracing Operators are installed in the openshift-operators namespace.

   • Accept the default Automatic approval strategy. By accepting the default, when a new version of this Operator is available, Operator Lifecycle Manager (OLM) automatically upgrades the running instance of your Operator without human intervention. If you select Manual updates, when a newer version of an Operator is available, OLM creates an update request. As a cluster administrator, you must then manually approve that update request to have the Operator updated to the new version.

     Note

     The Manual approval strategy requires a user with appropriate credentials to approve the Operator install and subscription process.

8. Click Install.
9. On the Installed Operators page, select the openshift-operators-redhat project. Wait until you see that the OpenShift Elasticsearch Operator shows a status of "InstallSucceeded" before continuing.

Procedure

1. Log in to the OpenShift Container Platform web console as a user with the cluster-admin role. If you use Red Hat OpenShift Dedicated, you must have an account with the dedicated-admin role.
2. Navigate to Operators OperatorHub.
3. Type distributing tracing platform into the filter to locate the Red Hat OpenShift distributed tracing platform Operator.
4. Click the Red Hat OpenShift distributed tracing platform Operator provided by Red Hat to display information about the Operator.
5. Click Install.
6. On the Install Operator page, select the stable Update Channel. This automatically updates your Operator as new versions are released.

7. Accept the default All namespaces on the cluster (default). This installs the Operator in the default openshift-operators project and makes the Operator available to all projects in the cluster.

   • Accept the default Automatic approval strategy. By accepting the default, when a new version of this Operator is available, Operator Lifecycle Manager (OLM) automatically upgrades the running instance of your Operator without human intervention. If you select Manual updates, when a newer version of an Operator is available, OLM creates an update request. As a cluster administrator, you must then manually approve that update request to have the Operator updated to the new version.

     Note

     The Manual approval strategy requires a user with appropriate credentials to approve the Operator install and subscription process.

8. Click Install.
9. Navigate to Operators Installed Operators.
10. On the Installed Operators page, select the openshift-operators project. Wait until you see that the Red Hat OpenShift distributed tracing platform Operator shows a status of "Succeeded" before continuing.

Procedure

1. Log in to the OpenShift Container Platform web console as a user with the cluster-admin role. If you use Red Hat OpenShift Dedicated, you must have an account with the dedicated-admin role.
2. Navigate to Operators OperatorHub.
3. Type distributing tracing data collection into the filter to locate the Red Hat OpenShift distributed tracing data collection Operator.
4. Click the Red Hat OpenShift distributed tracing data collection Operator provided by Red Hat to display information about the Operator.
5. Click Install.
6. On the Install Operator page, accept the default stable Update channel. This automatically updates your Operator as new versions are released.
7. Accept the default All namespaces on the cluster (default). This installs the Operator in the default openshift-operators project and makes the Operator available to all projects in the cluster.

8. Accept the default Automatic approval strategy. By accepting the default, when a new version of this Operator is available, Operator Lifecycle Manager (OLM) automatically upgrades the running instance of your Operator without human intervention. If you select Manual updates, when a newer version of an Operator is available, OLM creates an update request. As a cluster administrator, you must then manually approve that update request to have the Operator updated to the new version.

   Note

   The Manual approval strategy requires a user with appropriate credentials to approve the Operator install and subscription process.

9. Click Install.
10. Navigate to Operators Installed Operators.
11. On the Installed Operators page, select the openshift-operators project. Wait until you see that the Red Hat OpenShift distributed tracing data collection Operator shows a status of "Succeeded" before continuing.

Procedure

1. Log in to the OpenShift Container Platform web console as a user with the cluster-admin role.

2. Create a new project, for example tracing-system.

   Note

   If you are installing as part of Service Mesh, the distributed tracing resources must be installed in the same namespace as the ServiceMeshControlPlane resource, for example istio-system.

   1. Navigate to Home Projects.
   2. Click Create Project.
   3. Enter tracing-system in the Name field.
   4. Click Create.
3. Navigate to Operators Installed Operators.
4. If necessary, select tracing-system from the Project menu. You may have to wait a few moments for the Operators to be copied to the new project.
5. Click the Red Hat OpenShift distributed tracing platform Operator. On the Details tab, under Provided APIs, the Operator provides a single link.
6. Under Jaeger, click Create Instance.
7. On the Create Jaeger page, to install using the defaults, click Create to create the distributed tracing platform instance.
8. On the Jaegers page, click the name of the distributed tracing platform instance, for example, jaeger-all-in-one-inmemory.
9. On the Jaeger Details page, click the Resources tab. Wait until the pod has a status of "Running" before continuing.

Procedure

1. Log in to the OpenShift Container Platform web console as a user with the cluster-admin role.

2. Create a new project, for example tracing-system.

   Note

   If you are installing as part of Service Mesh, the distributed tracing resources must be installed in the same namespace as the ServiceMeshControlPlane resource, for example istio-system.

   1. Navigate to Home Projects.
   2. Click Create Project.
   3. Enter tracing-system in the Name field.
   4. Click Create.
3. Navigate to Operators Installed Operators.
4. If necessary, select tracing-system from the Project menu. You may have to wait a few moments for the Operators to be copied to the new project.
5. Click the Red Hat OpenShift distributed tracing platform Operator. On the Overview tab, under Provided APIs, the Operator provides a single link.
6. Under Jaeger, click Create Instance.

7. On the Create Jaeger page, replace the default all-in-one YAML text with your production YAML configuration, for example:

   Example jaeger-production.yaml file with Elasticsearch

   apiVersion: jaegertracing.io/v1
   kind: Jaeger
   metadata:
     name: jaeger-production
     namespace:
   spec:
     strategy: production
     ingress:
       security: oauth-proxy
     storage:
       type: elasticsearch
       elasticsearch:
         nodeCount: 3
         redundancyPolicy: SingleRedundancy
       esIndexCleaner:
         enabled: true
         numberOfDays: 7
         schedule: 55 23 * * *
       esRollover:
         schedule: '*/30 * * * *'

8. Click Create to create the distributed tracing platform instance.
9. On the Jaegers page, click the name of the distributed tracing platform instance, for example, jaeger-prod-elasticsearch.
10. On the Jaeger Details page, click the Resources tab. Wait until all the pods have a status of "Running" before continuing.

Procedure

1. Log in to the OpenShift Container Platform web console as a user with the cluster-admin role.

2. Create a new project, for example tracing-system.

   Note

   If you are installing as part of Service Mesh, the distributed tracing resources must be installed in the same namespace as the ServiceMeshControlPlane resource, for example istio-system.

   1. Navigate to Home Projects.
   2. Click Create Project.
   3. Enter tracing-system in the Name field.
   4. Click Create.
3. Navigate to Operators Installed Operators.
4. If necessary, select tracing-system from the Project menu. You may have to wait a few moments for the Operators to be copied to the new project.
5. Click the Red Hat OpenShift distributed tracing platform Operator. On the Overview tab, under Provided APIs, the Operator provides a single link.
6. Under Jaeger, click Create Instance.
7. On the Create Jaeger page, replace the default all-in-one YAML text with your streaming YAML configuration, for example:

1. Click Create to create the distributed tracing platform instance.
2. On the Jaegers page, click the name of the distributed tracing platform instance, for example, jaeger-streaming.
3. On the Jaeger Details page, click the Resources tab. Wait until all the pods have a status of "Running" before continuing.

Procedure from OpenShift console

1. Log in to the OpenShift Container Platform web console as a user with cluster-admin rights. If you use Red Hat OpenShift Dedicated, you must have an account with the dedicated-admin role.
2. Navigate to Networking Routes.

3. On the Routes page, select the control plane project, for example tracing-system, from the Namespace menu.

   The Location column displays the linked address for each route.

4. If necessary, use the filter to find the jaeger route. Click the route Location to launch the console.
5. Click Log In With OpenShift.

Procedure from the CLI

1. Log in to the OpenShift Container Platform CLI as a user with the cluster-admin role. If you use Red Hat OpenShift Dedicated, you must have an account with the dedicated-admin role.

   $ oc login --username=<NAMEOFUSER> https://<HOSTNAME>:6443

2. To query for details of the route using the command line, enter the following command. In this example, tracing-system is the control plane namespace.

   $ export JAEGER_URL=$(oc get route -n tracing-system jaeger -o jsonpath='{.spec.host}')

3. Launch a browser and navigate to https://<JAEGER_URL>, where <JAEGER_URL> is the route that you discovered in the previous step.
4. Log in using the same user name and password that you use to access the OpenShift Container Platform console.

5. If you have added services to the service mesh and have generated traces, you can use the filters and Find Traces button to search your trace data.

   If you are validating the console installation, there is no trace data to display.

Procedure

1. Log in to the OpenShift Container Platform web console.
2. Navigate to Operators Installed Operators.
3. Select the name of the project where the Operators are installed from the Project menu, for example, openshift-operators.
4. Click the Red Hat OpenShift distributed tracing platform Operator.
5. Click the Jaeger tab.
6. Click the Options menu next to the instance you want to delete and select Delete Jaeger.
7. In the confirmation message, click Delete.

1. Log in to the OpenShift Container Platform CLI.

   $ oc login --username=<NAMEOFUSER>

2. To display the distributed tracing platform instances run the command:

   $ oc get deployments -n <jaeger-project>

   For example,

   $ oc get deployments -n openshift-operators

   The names of Operators have the suffix -operator. The following example shows two Red Hat OpenShift distributed tracing platform Operators and four distributed tracing platform instances:

   $ oc get deployments -n openshift-operators

   You should see output similar to the following:

   NAME                     READY   UP-TO-DATE   AVAILABLE   AGE
   elasticsearch-operator   1/1     1            1           93m
   jaeger-operator          1/1     1            1           49m
   jaeger-test              1/1     1            1           7m23s
   jaeger-test2             1/1     1            1           6m48s
   tracing1                 1/1     1            1           7m8s
   tracing2                 1/1     1            1           35m

3. To remove an instance of distributed tracing platform, run the following command:

   $ oc delete jaeger <deployment-name> -n <jaeger-project>

   For example:

   $ oc delete jaeger tracing2 -n openshift-operators

4. To verify the deletion, run the oc get deployments command again:

   $ oc get deployments -n <jaeger-project>

   For example:

   $ oc get deployments -n openshift-operators

   You should see generated output that is similar to the following example:

   NAME                     READY   UP-TO-DATE   AVAILABLE   AGE
   elasticsearch-operator   1/1     1            1           94m
   jaeger-operator          1/1     1            1           50m
   jaeger-test              1/1     1            1           8m14s
   jaeger-test2             1/1     1            1           7m39s
   tracing1                 1/1     1            1           7m59s

Procedure

1. Follow the instructions for Deleting Operators from a cluster.

   • Remove the Red Hat OpenShift distributed tracing platform Operator.