Skip to content

Commit 6e93671

Browse files
authored
Merge pull request #73479 from max-cx/OBSDOCS-917
OBSDOCS-917: Update installation docs
2 parents d6100a4 + 2b3c258 commit 6e93671

File tree

4 files changed

+19
-21
lines changed

4 files changed

+19
-21
lines changed

_attributes/common-attributes.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,7 @@ endif::[]
120120
:DTShortName: distributed tracing platform
121121
:DTProductVersion: 3.1
122122
:JaegerName: Red Hat OpenShift distributed tracing platform (Jaeger)
123+
:JaegerOperator: Red Hat OpenShift distributed tracing platform
123124
:JaegerShortName: distributed tracing platform (Jaeger)
124125
:JaegerVersion: 1.53.0
125126
:OTELName: Red Hat build of OpenTelemetry

modules/distr-tracing-install-jaeger-operator.adoc

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,48 +5,45 @@ This module included in the following assemblies:
55

66
:_mod-docs-content-type: PROCEDURE
77
[id="distr-tracing-jaeger-operator-install_{context}"]
8-
= Installing the {JaegerName} Operator
8+
= Installing the {JaegerOperator} Operator
99

10-
To install {JaegerName}, you use the link:https://operatorhub.io/[OperatorHub] to install the {JaegerName} Operator.
10+
You can install the {JaegerOperator} Operator through the link:https://operatorhub.io/[*OperatorHub*].
1111

1212
By default, the Operator is installed in the `openshift-operators` project.
1313

1414
.Prerequisites
1515
* You have access to the {product-title} web console.
1616
* 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.
17-
* If you require persistent storage, you must also install the OpenShift Elasticsearch Operator before installing the {JaegerName} Operator.
18-
19-
[WARNING]
20-
====
21-
Do not install Community versions of the Operators. Community Operators are not supported.
22-
====
17+
* If you require persistent storage, you must install the {es-op} before installing the {JaegerOperator} Operator.
2318
2419
.Procedure
2520

2621
. Log in to the {product-title} web console as a user with the `cluster-admin` role. If you use {product-dedicated}, you must have an account with the `dedicated-admin` role.
2722

2823
. Navigate to *Operators* -> *OperatorHub*.
2924

30-
. Type *distributed tracing platform* into the filter to locate the {JaegerName} Operator.
25+
. Search for the {JaegerOperator} Operator by entering *distributed tracing platform* in the search field.
3126

32-
. Click the *{JaegerName} Operator* provided by Red Hat to display information about the Operator.
27+
. Select the *{JaegerOperator}* Operator, which is *provided by Red Hat*, to display information about the Operator.
3328

3429
. Click *Install*.
3530

36-
. On the *Install Operator* page, select the *stable* Update Channel. This automatically updates your Operator as new versions are released.
31+
. For the *Update channel* on the *Install Operator* page, select *stable* to automatically update the Operator when new versions are released.
3732
//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.
3833

3934
. 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.
4035

41-
* 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.
36+
. Accept the default *Automatic* approval strategy.
4237
+
4338
[NOTE]
4439
====
45-
The *Manual* approval strategy requires a user with appropriate credentials to approve the Operator install and subscription process.
40+
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.
41+
42+
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.
4643
====
4744

4845
. Click *Install*.
4946

5047
. Navigate to *Operators* -> *Installed Operators*.
5148

52-
. 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.
49+
. On the *Installed Operators* page, select the `openshift-operators` project. Wait for the *Succeeded* status of the {JaegerOperator} Operator before continuing.

modules/distr-tracing-tempo-install-cli.adoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -216,12 +216,10 @@ $ oc get pods
216216
+
217217
[source,terminal]
218218
----
219-
$ export TEMPO_URL=$(oc get route -n <control_plane_namespace> tempo -o jsonpath='{.spec.host}')
219+
$ oc get route
220220
----
221221

222222
.. Open `\https://<route_from_previous_step>` in a web browser.
223-
224-
.. Log in using your cluster administrator credentials for the web console.
225223
+
226224
[NOTE]
227225
====

modules/distr-tracing-tempo-install-web-console.adoc

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,18 +27,22 @@ Object storage is required and not included with the {TempoShortName}. You must
2727

2828
.. Go to *Operators* -> *OperatorHub* and search for `{TempoOperator}`.
2929

30-
.. Select the *{TempoOperator}* that is *OpenShift Operator for Tempo* -> *Install* -> *Install* -> *View Operator*.
30+
.. Select the *{TempoOperator}* that is *provided by Red Hat*.
3131
+
3232
[IMPORTANT]
3333
====
34-
This installs the Operator with the default presets:
34+
The following selections are the default presets for this Operator:
3535
3636
* *Update channel* -> *stable*
3737
* *Installation mode* -> *All namespaces on the cluster*
3838
* *Installed Namespace* -> *openshift-tempo-operator*
3939
* *Update approval* -> *Automatic*
4040
====
4141

42+
.. Select the *Enable Operator recommended cluster monitoring on this Namespace* checkbox.
43+
44+
.. Select *Install* -> *Install* -> *View Operator*.
45+
4246
.. In the *Details* tab of the page of the installed Operator, under *ClusterServiceVersion details*, verify that the installation *Status* is *Succeeded*.
4347

4448
. 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:
135139
.. Go to *Networking* -> *Routes* and kbd:[Ctrl+F] to search for `tempo`.
136140

137141
.. In the *Location* column, open the URL to access the Tempo console.
138-
139-
.. Select *Log In With OpenShift* to use your cluster administrator credentials for the web console.
140142
+
141143
[NOTE]
142144
====

0 commit comments

Comments
 (0)