Skip to content

[enterprise-4.15] OBSDOCS-917: Update installation docs #74384

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 8, 2024
Merged

[enterprise-4.15] OBSDOCS-917: Update installation docs #74384

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions _attributes/common-attributes.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
25 changes: 11 additions & 14 deletions modules/distr-tracing-install-jaeger-operator.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,48 +5,45 @@ 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

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

. 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.
4 changes: 1 addition & 3 deletions modules/distr-tracing-tempo-install-cli.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,12 +216,10 @@ $ oc get pods
+
[source,terminal]
----
$ export TEMPO_URL=$(oc get route -n <control_plane_namespace> tempo -o jsonpath='{.spec.host}')
$ oc get route
----

.. Open `\https://<route_from_previous_step>` in a web browser.

.. Log in using your cluster administrator credentials for the web console.
+
[NOTE]
====
Expand Down
10 changes: 6 additions & 4 deletions modules/distr-tracing-tempo-install-web-console.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,18 +27,22 @@ 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*
* *Installed Namespace* -> *openshift-tempo-operator*
* *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*.
Expand Down Expand Up @@ -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]
====
Expand Down