mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
e8593cf7cd
Change `operatorhub` to `software-catalog` in filenames, includes, xrefs, and topic map files
115 lines
6.5 KiB
Plaintext
115 lines
6.5 KiB
Plaintext
:_mod-docs-content-type: ASSEMBLY
|
|
[id="olm-adding-operators-to-a-cluster"]
|
|
= Adding Operators to a cluster
|
|
include::_attributes/common-attributes.adoc[]
|
|
:context: olm-adding-operators-to-a-cluster
|
|
|
|
// Assembly and included modules watched for changes by Ecosystem Catalog team:
|
|
// https://projects.engineering.redhat.com/projects/RHEC/summary
|
|
|
|
toc::[]
|
|
|
|
Using Operator Lifecycle Manager (OLM),
|
|
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
cluster administrators can install OLM-based Operators to an {product-title} cluster.
|
|
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
administrators with the `dedicated-admin` role can install OLM-based Operators to a {product-title} cluster.
|
|
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
|
|
[NOTE]
|
|
====
|
|
For information on how OLM handles updates for installed Operators colocated in the same namespace, as well as an alternative method for installing Operators with custom global Operator groups, see xref:../../operators/understanding/olm/olm-colocation.adoc#olm-colocation[Multitenancy and Operator colocation].
|
|
====
|
|
|
|
ifdef::openshift-origin[]
|
|
[id="olm-adding-operators-to-a-cluster-prereqs"]
|
|
== Prerequisites
|
|
|
|
* Ensure that you have downloaded the {cluster-manager-url-pull} as shown in _Obtaining the installation program_ in the installation documentation for your platform.
|
|
+
|
|
If you have the pull secret, add the `redhat-operators` catalog to the `OperatorHub` custom resource (CR) as shown in _Configuring {product-title} to use Red Hat Operators_.
|
|
endif::[]
|
|
|
|
include::modules/olm-installing-operators-from-software-catalog.adoc[leveloffset=+1]
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
|
|
* xref:../../operators/understanding/olm-understanding-software-catalog.adoc#olm-understanding-software-catalog[Understanding the software catalog]
|
|
|
|
// Installing from OperatorHub by using the CLI
|
|
include::modules/olm-installing-from-software-catalog-using-web-console.adoc[leveloffset=+1]
|
|
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
|
|
* xref:../../operators/admin/olm-upgrading-operators.adoc#olm-approving-pending-upgrade_olm-upgrading-operators[Manually approving a pending Operator update]
|
|
|
|
ifdef::openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
|
|
// Installing from OperatorHub by using the CLI
|
|
include::modules/olm-installing-from-software-catalog-using-cli.adoc[leveloffset=+1]
|
|
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
|
|
* xref:../../operators/understanding/olm/olm-understanding-operatorgroups.adoc#olm-operatorgroups-about_olm-understanding-operatorgroups[About Operator groups]
|
|
* xref:../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-global-namespaces_olm-adding-operators-to-a-cluster[Installing global Operators in custom namespaces]
|
|
* xref:../../operators/admin/olm-upgrading-operators.adoc#olm-approving-pending-upgrade_olm-upgrading-operators[Manually approving a pending Operator update]
|
|
|
|
include::modules/olm-preparing-multitenant-operators.adoc[leveloffset=+1]
|
|
.Next steps
|
|
|
|
* Install the Operator in the tenant Operator namespace. This task is more easily performed by using the software catalog in the web console instead of the CLI; for a detailed procedure, "Installing from software catalog using the web console".
|
|
+
|
|
[NOTE]
|
|
====
|
|
After completing the Operator installation, the Operator resides in the tenant Operator namespace and watches the tenant namespace, but neither the Operator's pod nor its service account are visible or usable by the tenant.
|
|
====
|
|
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
|
|
* xref:../../operators/understanding/olm-multitenancy.adoc#olm-multitenancy[Operators in multitenant clusters]
|
|
|
|
include::modules/olm-installing-global-namespaces.adoc[leveloffset=+1]
|
|
|
|
.Next steps
|
|
|
|
* Install the desired Operator in your custom global namespace. Because the web console does not populate the *Installed Namespace* menu during Operator installation with custom global namespaces, the install task can only be performed with the OpenShift CLI (`oc`). For a detailed installation procedure, see "Installing from OperatorHub by using the CLI".
|
|
+
|
|
[NOTE]
|
|
====
|
|
When you initiate the Operator installation, if the Operator has dependencies, the dependencies are also automatically installed in the custom global namespace. As a result, it is then valid for the dependency Operators to have the same update policy and shared install plans.
|
|
====
|
|
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
|
|
* xref:../../operators/understanding/olm/olm-colocation.adoc#olm-colocation[Multitenancy and Operator colocation]
|
|
|
|
include::modules/olm-pod-placement.adoc[leveloffset=+1]
|
|
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
* Adding taints and tolerations xref:../../nodes/scheduling/nodes-scheduler-taints-tolerations.adoc#nodes-scheduler-taints-tolerations-adding_nodes-scheduler-taints-tolerations[manually to nodes] or xref:../../nodes/scheduling/nodes-scheduler-taints-tolerations.adoc#nodes-scheduler-taints-tolerations-adding-machineset_nodes-scheduler-taints-tolerations[with compute machine sets]
|
|
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
* xref:../../nodes/scheduling/nodes-scheduler-node-selectors.adoc#nodes-scheduler-node-selectors-project_nodes-scheduler-node-selectors[Creating project-wide node selectors]
|
|
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
* xref:../../nodes/scheduling/nodes-scheduler-taints-tolerations.adoc#nodes-scheduler-taints-tolerations-projects_nodes-scheduler-taints-tolerations[Creating a project with a node selector and toleration]
|
|
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
endif::[]
|
|
|
|
include::modules/olm-overriding-operator-pod-affinity.adoc[leveloffset=+1]
|
|
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
|
|
* xref:../../nodes/scheduling/nodes-scheduler-pod-affinity.adoc#nodes-scheduler-pod-affinity-about_nodes-scheduler-pod-affinity[Understanding pod affinity]
|
|
* xref:../../nodes/scheduling/nodes-scheduler-node-affinity.adoc#nodes-scheduler-node-affinity-about_nodes-scheduler-node-affinity[Understanding node affinity]
|
|
// This xref points to a topic not currently included in the OSD and ROSA docs.
|
|
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
* xref:../../nodes/nodes/nodes-nodes-working.adoc#nodes-nodes-working-updating_nodes-nodes-working[Understanding how to update labels on nodes]
|
|
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|