diff --git a/_attributes/common-attributes.adoc b/_attributes/common-attributes.adoc index abc5c87b44b9..b097584180c1 100644 --- a/_attributes/common-attributes.adoc +++ b/_attributes/common-attributes.adoc @@ -120,6 +120,7 @@ endif::[] :DTShortName: distributed tracing platform :DTProductVersion: 3.1 :JaegerName: Red Hat OpenShift distributed tracing platform (Jaeger) +:JaegerOperator: Red Hat OpenShift distributed tracing platform :JaegerShortName: distributed tracing platform (Jaeger) :JaegerVersion: 1.53.0 :OTELName: Red Hat build of OpenTelemetry diff --git a/modules/distr-tracing-install-jaeger-operator.adoc b/modules/distr-tracing-install-jaeger-operator.adoc index 1db98d064ffe..e041bd01d9fc 100644 --- a/modules/distr-tracing-install-jaeger-operator.adoc +++ b/modules/distr-tracing-install-jaeger-operator.adoc @@ -5,21 +5,16 @@ This module included in the following assemblies: :_mod-docs-content-type: PROCEDURE [id="distr-tracing-jaeger-operator-install_{context}"] -= Installing the {JaegerName} Operator += Installing the {JaegerOperator} Operator -To install {JaegerName}, you use the link:https://operatorhub.io/[OperatorHub] to install the {JaegerName} Operator. +You can install the {JaegerOperator} Operator through the link:https://operatorhub.io/[*OperatorHub*]. By default, the Operator is installed in the `openshift-operators` project. .Prerequisites * You have access to the {product-title} web console. * You have access to the cluster as a user with the `cluster-admin` role. If you use {product-dedicated}, you must have an account with the `dedicated-admin` role. -* If you require persistent storage, you must also install the OpenShift Elasticsearch Operator before installing the {JaegerName} Operator. - -[WARNING] -==== -Do not install Community versions of the Operators. Community Operators are not supported. -==== +* If you require persistent storage, you must install the {es-op} before installing the {JaegerOperator} Operator. .Procedure @@ -27,26 +22,28 @@ Do not install Community versions of the Operators. Community Operators are not . Navigate to *Operators* -> *OperatorHub*. -. Type *distributed tracing platform* into the filter to locate the {JaegerName} Operator. +. Search for the {JaegerOperator} Operator by entering *distributed tracing platform* in the search field. -. Click the *{JaegerName} Operator* provided by Red Hat to display information about the Operator. +. Select the *{JaegerOperator}* Operator, which is *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. +. For the *Update channel* on the *Install Operator* page, select *stable* to automatically update the Operator when new versions are released. //If you select a maintenance channel, for example, *Stable*, you will receive bug fixes and security patches for the length of the support cycle for that version. . 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. +. Accept the default *Automatic* approval strategy. + [NOTE] ==== -The *Manual* approval strategy requires a user with appropriate credentials to approve the Operator install and subscription process. +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 until you see that the {JaegerName} Operator shows a status of "Succeeded" before continuing. +. On the *Installed Operators* page, select the `openshift-operators` project. Wait for the *Succeeded* status of the {JaegerOperator} Operator before continuing. diff --git a/modules/distr-tracing-tempo-install-cli.adoc b/modules/distr-tracing-tempo-install-cli.adoc index fe0a58bf7ef0..442a412e2f2a 100644 --- a/modules/distr-tracing-tempo-install-cli.adoc +++ b/modules/distr-tracing-tempo-install-cli.adoc @@ -216,12 +216,10 @@ $ oc get pods + [source,terminal] ---- -$ export TEMPO_URL=$(oc get route -n tempo -o jsonpath='{.spec.host}') +$ oc get route ---- .. Open `\https://` in a web browser. - -.. Log in using your cluster administrator credentials for the web console. + [NOTE] ==== diff --git a/modules/distr-tracing-tempo-install-web-console.adoc b/modules/distr-tracing-tempo-install-web-console.adoc index d8f93861dae6..6e30a290c116 100644 --- a/modules/distr-tracing-tempo-install-web-console.adoc +++ b/modules/distr-tracing-tempo-install-web-console.adoc @@ -27,11 +27,11 @@ Object storage is required and not included with the {TempoShortName}. You must .. Go to *Operators* -> *OperatorHub* and search for `{TempoOperator}`. -.. Select the *{TempoOperator}* that is *OpenShift Operator for Tempo* -> *Install* -> *Install* -> *View Operator*. +.. Select the *{TempoOperator}* that is *provided by Red Hat*. + [IMPORTANT] ==== -This installs the Operator with the default presets: +The following selections are the default presets for this Operator: * *Update channel* -> *stable* * *Installation mode* -> *All namespaces on the cluster* @@ -39,6 +39,10 @@ This installs the Operator with the default presets: * *Update approval* -> *Automatic* ==== +.. Select the *Enable Operator recommended cluster monitoring on this Namespace* checkbox. + +.. Select *Install* -> *Install* -> *View Operator*. + .. In the *Details* tab of the page of the installed Operator, under *ClusterServiceVersion details*, verify that the installation *Status* is *Succeeded*. . Create a project of your choice for the *TempoStack* instance that you will create in a subsequent step: go to *Home* -> *Projects* -> *Create Project*. @@ -135,8 +139,6 @@ spec: .. Go to *Networking* -> *Routes* and kbd:[Ctrl+F] to search for `tempo`. .. In the *Location* column, open the URL to access the Tempo console. - -.. Select *Log In With OpenShift* to use your cluster administrator credentials for the web console. + [NOTE] ====