The Red Hat OpenShift distributed tracing platform (Jaeger) is a deprecated feature. Deprecated functionality is still included in OpenShift Container Platform and continues to be supported; however, it will be removed in a future release of this product and is not recommended for new deployments. For the most recent list of major functionality that has been deprecated or removed within OpenShift Container Platform, refer to the Deprecated and removed features section of the OpenShift Container Platform release notes. |
You can install Red Hat OpenShift distributed tracing platform on OpenShift Container Platform in either of two ways:
You can install Red Hat OpenShift distributed tracing platform as part of Red Hat OpenShift Service Mesh. Distributed tracing is included by default in the Service Mesh installation. To install Red Hat OpenShift distributed tracing platform as part of a service mesh, follow the Red Hat Service Mesh Installation instructions. You must install Red Hat OpenShift distributed tracing platform in the same namespace as your service mesh, that is, the ServiceMeshControlPlane
and the Red Hat OpenShift distributed tracing platform resources must be in the same namespace.
If you do not want to install a service mesh, you can use the Red Hat OpenShift distributed tracing platform Operators to install distributed tracing platform by itself. To install Red Hat OpenShift distributed tracing platform without a service mesh, use the following instructions.
Before you can install Red Hat OpenShift distributed tracing platform, review the installation activities, and ensure that you meet the prerequisites:
Possess an active OpenShift Container Platform subscription on your Red Hat account. If you do not have a subscription, contact your sales representative for more information.
Review the OpenShift Container Platform 4.15 overview.
Install OpenShift Container Platform 4.15.
Install the version of the oc
CLI tool that matches your OpenShift Container Platform version and add it to your path.
An account with the cluster-admin
role.
The steps for installing Red Hat OpenShift distributed tracing platform are as follows:
Review the documentation and determine your deployment strategy.
If your deployment strategy requires persistent storage, install the OpenShift Elasticsearch Operator via the OperatorHub.
Install the Red Hat OpenShift distributed tracing platform (Jaeger) Operator via the OperatorHub.
Modify the custom resource YAML file to support your deployment strategy.
Deploy one or more instances of Red Hat OpenShift distributed tracing platform (Jaeger) to your OpenShift Container Platform environment.
The default Red Hat OpenShift distributed tracing platform (Jaeger) deployment uses in-memory storage because it is designed to be installed quickly for those evaluating Red Hat OpenShift distributed tracing platform, giving demonstrations, or using Red Hat OpenShift distributed tracing platform (Jaeger) in a test environment. If you plan to use Red Hat OpenShift distributed tracing platform (Jaeger) in production, you must install and configure a persistent storage option, in this case, Elasticsearch.
You have access to the OpenShift Container Platform web console.
You have access to the cluster 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.
Do not install Community versions of the Operators. Community Operators are not supported. |
If you have already installed the OpenShift Elasticsearch Operator as part of OpenShift Logging, you do not need to install the OpenShift Elasticsearch Operator again. The Red Hat OpenShift distributed tracing platform (Jaeger) Operator creates the Elasticsearch instance using the installed OpenShift Elasticsearch Operator. |
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.
Navigate to Operators → OperatorHub.
Type Elasticsearch into the filter box to locate the OpenShift Elasticsearch Operator.
Click the OpenShift Elasticsearch Operator provided by Red Hat to display information about the Operator.
Click Install.
On the Install Operator page, select the stable Update Channel. This automatically updates your Operator as new versions are released.
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.
The Elasticsearch installation requires the openshift-operators-redhat namespace for the OpenShift Elasticsearch Operator. The other Red Hat OpenShift distributed tracing platform Operators are installed in the |
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.
The Manual approval strategy requires a user with appropriate credentials to approve the Operator install and subscription process. |
Click Install.
On the Installed Operators page, select the openshift-operators-redhat
project. Wait for the InstallSucceeded status of the OpenShift Elasticsearch Operator before continuing.
You can install the Red Hat OpenShift distributed tracing platform Operator through the OperatorHub.
By default, the Operator is installed in the openshift-operators
project.
You have access to the OpenShift Container Platform web console.
You have access to the cluster 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.
If you require persistent storage, you must install the OpenShift Elasticsearch Operator before installing the Red Hat OpenShift distributed tracing platform Operator.
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.
Navigate to Operators → OperatorHub.
Search for the Red Hat OpenShift distributed tracing platform Operator by entering distributed tracing platform in the search field.
Select the Red Hat OpenShift distributed tracing platform Operator, which is provided by Red Hat, to display information about the Operator.
Click Install.
For the Update channel on the Install Operator page, select stable to automatically update the Operator when new versions are released.
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.
If you accept this default, the Operator Lifecycle Manager (OLM) automatically upgrades the running instance of this Operator when a new version of the Operator becomes available. If you select Manual updates, the OLM creates an update request when a new version of the Operator becomes available. To update the Operator to the new version, you must then manually approve the update request as a cluster administrator. The Manual approval strategy requires a cluster administrator to manually approve Operator installation and subscription. |
Click Install.
Navigate to Operators → Installed Operators.
On the Installed Operators page, select the openshift-operators
project. Wait for the Succeeded status of the Red Hat OpenShift distributed tracing platform Operator before continuing.