You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/installation/proc-install-operator.adoc
+47-21Lines changed: 47 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,42 +15,68 @@ Containers are available for the following CPU architectures:
15
15
16
16
* You are logged in as an administrator on the {ocp-short} web console.
17
17
* You have configured the appropriate roles and permissions within your project to create or access an application. For more information, see the link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#building-applications-overview[{ocp-brand-name} documentation on Building applications].
18
+
* You have installed {ocp-brand-name} 4.17 or later.
18
19
20
+
.Procedure
21
+
22
+
. In the *Administrator* perspective of the {ocp-short} web console, click *Operators > OperatorHub*.
23
+
. In the *Filter by keyword* box, enter {product-short} and click the *{product} Operator* card.
24
+
. On the *{product} Operator* page, read the information about the Operator and click *Install* to open the *Install Operator* page.
25
+
. From the *Update channel* drop-down menu, select the update channel that you want to use, for example, *fast* or *fast-{product-version}*.
26
+
+
27
+
[IMPORTANT]
28
+
====
29
+
The `*fast* channel includes all of the updates available for a particular version. Any update might introduce unexpected changes in your {product} deployment. Check the release notes for details about any potentially breaking changes.
30
+
31
+
The *fast-{product-version}* channel only provides z-stream updates, for example, updating from version {product-version}.1 to {product-version}.2. If you want to update the {product} y-version in the future, for example, updating from {product-version} to {product-version-next}, you must switch to the *fast-{product-version-next}* channel manually.
32
+
====
33
+
. From the *Version* drop-down menu, select the version of the {product} Operator that you want to install. The default version is the latest version available in the selected channel.
34
+
. Select the Operator *Installation mode*.
35
+
//** If you select the *All namespaces on the cluster* option, the Operator is installed in all namespaces. This option is useful for Operators that manage cluster-wide resources.
36
+
//** If you select the *Specific namespace on the cluster* option, the Operator is installed in a specific namespace. This option is useful for Operators that manage resources in a specific namespace.
37
+
+
38
+
[NOTE]
39
+
====
40
+
The *All namespaces on the cluster (default)* option is selected by default. The *Specific namespace on the cluster* option is not currently supported.
41
+
====
42
+
. In the *Installed Namespace* field, do one of the following actions:
43
+
+
44
+
** Select *Operator recommended Namespace* to create and use the *rhdh-operator* namespace. This option is selected by default.
45
+
** Select *Select a Namespace* to use an alternative namespace.
46
+
*** From the *Select Project* drop-down menu, do one of the following actions:
47
+
**** Select an existing project.
48
+
**** Select *Create Project* to create a new project for the Operator.
49
+
***** On the *Create Project* dialog, enter text into the required fields and click *Create*.
50
+
+
19
51
[IMPORTANT]
20
52
====
21
53
For enhanced security, better control over the Operator lifecycle, and preventing potential privilege escalation, install the {product} Operator in a dedicated default `rhdh-operator` namespace. You can restrict other users' access to the Operator resources through role bindings or cluster role bindings.
22
54
23
55
You can also install the Operator in another namespace by creating the necessary resources, such as an Operator group. For more information, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/operators/index#olm-installing-global-namespaces_olm-adding-operators-to-a-cluster[Installing global Operators in custom namespaces].
24
56
25
57
However, if the {product} Operator shares a namespace with other Operators, then it shares the same update policy as well, preventing the customization of the update policy. For example, if one Operator is set to manual updates, the {product} Operator update policy is also set to manual. For more information, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/operators/index#olm-colocation-namespaces_olm-colocation[Colocation of Operators in a namespace].
26
-
27
58
====
28
-
29
-
.Procedure
30
-
31
-
. In the *Administrator* perspective of the {ocp-short} web console, click *Operators > OperatorHub*.
32
-
. In the *Filter by keyword* box, enter {product-short} and click the *{product}* Operator card.
33
-
. On the *{product} Operator* page, click *Install*.
34
-
35
-
. On the *Install Operator* page, use the *Update channel* drop-down menu to select the update channel that you want to use:
36
-
** The *fast* channel provides y-stream (x.y) and z-stream (x.y.z) updates, for example, updating from version 1.1 to 1.2, or from 1.1.0 to 1.1.1.
37
59
+
38
-
[IMPORTANT]
39
-
====
40
-
The `fast` channel includes all of the updates available for a particular version. Any update might introduce unexpected changes in your {product} deployment. Check the release notes for details about any potentially breaking changes.
60
+
. Select the *Update approval* method for the Operator.
61
+
** If you select the *Automatic* option, the Operator is updated without requiring manual confirmation.
62
+
** If you select the *Manual* option, a notification opens when a new update is released in the update channel. The update must be manually approved by an administrator before installation can begin.
63
+
. Click *Install*.
64
+
+
65
+
[NOTE]
41
66
====
67
+
If you selected a *Manual* approval strategy, the upgrade status of the subscription remains *Upgrading* until you review and approve the install plan. After you click *Approve* on the *Install Plan* page, the subscription upgrade status changes to *Up to date*.
42
68
43
-
** The *fast-1.1* channel only provides z-stream updates, for example, updating from version 1.1.1 to 1.1.2. If you want to update the {product} y-version in the future, for example, updating from 1.1 to 1.2, you must switch to the *fast* channel manually.
44
-
45
-
. On the *Install Operator* page, choose the *Update approval* strategy for the Operator:
46
-
** If you choose the *Automatic* option, the Operator is updated without requiring manual confirmation.
47
-
** If you choose the *Manual* option, a notification opens when a new update is released in the update channel. The update must be manually approved by an administrator before installation can begin.
48
-
49
-
. Click *Install*.
69
+
If you selected an *Automatic* approval strategy, the upgrade status should resolve to *Up to date* without intervention.
70
+
====
50
71
51
72
.Verification
52
73
53
-
* To view the installed {product} Operator, click *View Operator*.
74
+
* Immediately after the Operator is installed, the dialog box on the *OperatorHub* page displays the *Installed operator: ready for use* message.
75
+
* From the dialog box, do one of the following actions:
76
+
** Click *View Operator* to open the *Operator details* page for the {product} Operator.
77
+
** Click *View all installed operators* to open the *Installed Operators* page.
78
+
*** From the list of installed Operators, locate the {product} Operator name and details.
79
+
*** Click *{product} Operator* to open the *Operator details* page for the {product} Operator.
0 commit comments