diff --git a/_topic_map.yml b/_topic_map.yml index 0a45b4bba3..10c3bcaa49 100644 --- a/_topic_map.yml +++ b/_topic_map.yml @@ -452,10 +452,10 @@ Topics: File: olm-understanding-operatorhub - Name: Adding Operators to a cluster File: olm-adding-operators-to-cluster - Distros: openshift-enterprise,openshift-origin + Distros: openshift-enterprise,openshift-origin,openshift-dedicated - Name: Deleting Operators from a cluster File: olm-deleting-operators-from-cluster - Distros: openshift-enterprise,openshift-origin + Distros: openshift-enterprise,openshift-origin,openshift-dedicated - Name: Creating applications from installed Operators File: olm-creating-apps-from-installed-operators - Name: Service brokers diff --git a/administering_a_cluster/dedicated-admin-role.adoc b/administering_a_cluster/dedicated-admin-role.adoc index d446fccd01..dbeae8d351 100644 --- a/administering_a_cluster/dedicated-admin-role.adoc +++ b/administering_a_cluster/dedicated-admin-role.adoc @@ -29,3 +29,23 @@ include::modules/dedicated-admin-granting-permissions.adoc[leveloffset=+1] include::modules/dedicated-managing-service-accounts.adoc[leveloffset=+1] include::modules/dedicated-managing-quotas-and-limit-ranges.adoc[leveloffset=+1] + +[id="osd-installing-operators-from-operatorhub_{context}"] +== Installing Operators from the OperatorHub + +{product-title} administrators can install Operators from a curated list +provided by the OperatorHub. This makes the Operator available to all developers +on your cluster to create Custom Resources and applications using that Operator. + +[NOTE] +==== +Privileged and custom Operators cannot be installed. +==== + +Administrators can only install Operators to the default `openshift-operators` +namespace, except for the Cluster Logging Operator, which requires the +`openshift-logging` namespace. + +.Additional resources + +* xref:../applications/operators/olm-adding-operators-to-cluster.adoc#olm-adding-operators-to-a-cluster[Adding Operators to a cluster] diff --git a/applications/operators/olm-adding-operators-to-cluster.adoc b/applications/operators/olm-adding-operators-to-cluster.adoc index 2688a34023..d950ff5847 100644 --- a/applications/operators/olm-adding-operators-to-cluster.adoc +++ b/applications/operators/olm-adding-operators-to-cluster.adoc @@ -8,34 +8,8 @@ toc::[] This guide walks cluster administrators through installing Operators to an {product-title} cluster. -[id="olm-installing-operators-from-operatorhub_{context}"] -== Installing Operators from the OperatorHub - -As a cluster administrator, you can install an Operator from the OperatorHub -using the {product-title} web console or the CLI. You can then subscribe the -Operator to one or more namespaces to make it available for developers on your -cluster. - -During installation, you must determine the following initial settings for the -Operator: - -Installation Mode:: Choose *All namespaces on the cluster (default)* to have the -Operator installed on all namespaces or choose individual namespaces, if -available, to only install the Operator on selected namespaces. This example -chooses *All namespaces...* to make the Operator available to all users and -projects. - -Update Channel:: If an Operator is available through multiple channels, you can -choose which channel you want to subscribe to. For example, to deploy from the -*stable* channel, if available, select it from the list. - -Approval Strategy:: You can choose Automatic or Manual updates. If you choose -Automatic updates for an installed Operator, when a new version of that Operator -is available, the 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, the 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. - +include::modules/olm-installing-operators-from-operatorhub.adoc[leveloffset=+1] include::modules/olm-installing-from-operatorhub-using-web-console.adoc[leveloffset=+2] +ifdef::openshift-enterprise,openshift-origin[] include::modules/olm-installing-from-operatorhub-using-cli.adoc[leveloffset=+2] +endif::[] diff --git a/modules/dedicated-logging-in-and-verifying-permissions.adoc b/modules/dedicated-logging-in-and-verifying-permissions.adoc index 20c0505283..2640ae9995 100644 --- a/modules/dedicated-logging-in-and-verifying-permissions.adoc +++ b/modules/dedicated-logging-in-and-verifying-permissions.adoc @@ -30,7 +30,7 @@ projects that are created by users in the cluster. To verify if your account has administrator privileges, run the following command against a user-created project to view its default role bindings. If you are a cluster administrator, you will see your account listed under subjects for -the *dedicated-admin-project* role binding for the project: +the `dedicated-admin-project` role binding for the project: ---- $ oc describe rolebinding.rbac -n diff --git a/modules/olm-deleting-operators-from-a-cluster-using-cli.adoc b/modules/olm-deleting-operators-from-a-cluster-using-cli.adoc index 3823304e51..8238f07fc8 100644 --- a/modules/olm-deleting-operators-from-a-cluster-using-cli.adoc +++ b/modules/olm-deleting-operators-from-a-cluster-using-cli.adoc @@ -12,8 +12,13 @@ CatalogSourceConfig to remove the Operator's package name. .Prerequisites -- Access to an {product-title} cluster using an account with `cluster-admin` -permissions. +- Access to an {product-title} cluster using an account with +ifdef::openshift-enterprise,openshift-origin[] +`cluster-admin` permissions. +endif::[] +ifdef::openshift-dedicated[] +`dedicated-admin-cluster` permissions. +endif::[] - Install the `oc` command on your local system. .Procedure diff --git a/modules/olm-deleting-operators-from-a-cluster-using-web-console.adoc b/modules/olm-deleting-operators-from-a-cluster-using-web-console.adoc index d7ebb79cad..60e9972568 100644 --- a/modules/olm-deleting-operators-from-a-cluster-using-web-console.adoc +++ b/modules/olm-deleting-operators-from-a-cluster-using-web-console.adoc @@ -25,7 +25,7 @@ console, follow these steps: + -- . Select the namespace where the Operator is installed from the *Project* list. -For cluster-wide Operators, the default is *openshift-operators*. +For cluster-wide Operators, the default is `openshift-operators`. . From the *Operator Subscriptions* tab, find the Operator you want to delete (in this example, `jaeger`) and click the Options menu {kebab} at the end of its diff --git a/modules/olm-installing-from-operatorhub-using-web-console.adoc b/modules/olm-installing-from-operatorhub-using-web-console.adoc index e615c2bfb0..d449e49a26 100644 --- a/modules/olm-installing-from-operatorhub-using-web-console.adoc +++ b/modules/olm-installing-from-operatorhub-using-web-console.adoc @@ -10,8 +10,13 @@ an Operator from the OperatorHub using the {product-title} web console. .Prerequisites -- Access to an {product-title} cluster using an account with `cluster-admin` -permissions. +- Access to an {product-title} cluster using an account with +ifdef::openshift-enterprise,openshift-origin[] +`cluster-admin` permissions. +endif::[] +ifdef::openshift-dedicated[] +`dedicated-admin-cluster` permissions. +endif::[] .Procedure @@ -32,11 +37,15 @@ continuing. Information about the Operator is displayed. . On the *Create Operator Subscription* page: .. Select one of the following: *** *All namespaces on the cluster (default)* installs the Operator in the default -*openshift-operators* namespace to watch and be made available to all namespaces +`openshift-operators` namespace to watch and be made available to all namespaces in the cluster. This option is not always available. *** *A specific namespace on the cluster* allows you to choose a specific, single namespace in which to install the Operator. The Operator will only watch and be made available for use in this single namespace. +ifdef::openshift-dedicated[] +If you are installing the Cluster Logging Operator, choose this option to select +the `openshift-logging` namespace. +endif::[] .. Select an *Update Channel* (if more than one is available). .. Select *Automatic* or *Manual* approval strategy, as described earlier. @@ -68,7 +77,7 @@ and its *Status* ultimately resolves to *InstallSucceeded* in the relevant names [NOTE] ==== For the *All namespaces...* Installation Mode, the status resolves to -*InstallSucceeded* in the *openshift-operators* namespace, but the status is +*InstallSucceeded* in the `openshift-operators` namespace, but the status is *Copied* if you check in other namespaces. ==== + @@ -78,7 +87,7 @@ If it does not: the *Operator Subscriptions* and *Install Plans* tabs for any failure or errors under *Status*. -.. Check the logs in any Pods in the *openshift-operators* project (or other +.. Check the logs in any Pods in the `openshift-operators` project (or other relevant namespace if *A specific namespace...* Installation Mode was selected) on the *Workloads → Pods* page that are reporting issues to troubleshoot further. diff --git a/modules/olm-installing-operators-from-operatorhub.adoc b/modules/olm-installing-operators-from-operatorhub.adoc new file mode 100644 index 0000000000..a3a09fcaa8 --- /dev/null +++ b/modules/olm-installing-operators-from-operatorhub.adoc @@ -0,0 +1,56 @@ +// Module included in the following assemblies: +// +// * applications/operators/olm-adding-operators-to-cluster.adoc + +[id="olm-installing-operators-from-operatorhub_{context}"] += Installing Operators from the OperatorHub + +As a cluster administrator, you can install an Operator from the OperatorHub +using the {product-title} +ifdef::openshift-enterprise,openshift-origin[] +web console or the CLI. You can then subscribe the Operator to one or more +namespaces to make it available for developers on your cluster. +endif::[] +ifdef::openshift-dedicated[] +web console. You can then subscribe the Operator to the default +`openshift-operators` namespace to make it available for developers on your +cluster. + +In {product-title} clusters, a curated list of Operators is made available for +installation from the OperatorHub. Administrators can only install Operators to +the default `openshift-operators` namespace, except for the Logging Operator, +which requires the `openshift-logging` namespace. + +[NOTE] +==== +Privileged and custom Operators cannot be installed. +==== +endif::[] + +During installation, you must determine the following initial settings for the +Operator: + +ifdef::openshift-enterprise,openshift-origin[] +Installation Mode:: Choose *All namespaces on the cluster (default)* to have the +Operator installed on all namespaces or choose individual namespaces, if +available, to only install the Operator on selected namespaces. This example +chooses *All namespaces...* to make the Operator available to all users and +projects. +endif::[] +ifdef::openshift-dedicated[] +Installation Mode:: In {product-title} clusters, you can choose *All namespaces on the cluster (default)* +to have the Operator installed on all namespaces. This makes the Operator +available to all users and projects. +endif::[] + +Update Channel:: If an Operator is available through multiple channels, you can +choose which channel you want to subscribe to. For example, to deploy from the +*stable* channel, if available, select it from the list. + +Approval Strategy:: You can choose Automatic or Manual updates. If you choose +Automatic updates for an installed Operator, when a new version of that Operator +is available, the 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, the 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. diff --git a/modules/rbac-viewing-cluster-roles.adoc b/modules/rbac-viewing-cluster-roles.adoc index 538a598a90..805ee5f40e 100644 --- a/modules/rbac-viewing-cluster-roles.adoc +++ b/modules/rbac-viewing-cluster-roles.adoc @@ -13,7 +13,7 @@ You can use the `oc` CLI to view cluster roles and bindings by using the * Install the `oc` CLI. * Obtain permission to view the cluster roles and bindings. ifdef::openshift-dedicated[] -Users with the *dedicated-admin-cluster* role can view cluster roles and bindings. +Users with the `dedicated-admin-cluster` role can view cluster roles and bindings. endif::[] ifdef::openshift-enterprise,openshift-origin[]