Installing Operators in your namespace

If a cluster administrator has delegated Operator installation permissions to your account, you can install and subscribe an Operator to your namespace in a self-service manner.

Prerequisites

  • A cluster administrator must add certain permissions to your OKD user account to allow self-service Operator installation to a namespace. See Allowing non-cluster administrators to install Operators for details.

  • Ensure that you have downloaded the pull secret from the Red Hat OpenShift Cluster Manager 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 OKD to use Red Hat Operators.

About Operator installation with OperatorHub

OperatorHub is a user interface for discovering Operators; it works in conjunction with Operator Lifecycle Manager (OLM), which installs and manages Operators on a cluster.

As a user with the proper permissions, you can install an Operator from OperatorHub by using the OKD web console or CLI.

During installation, you must determine the following initial settings for the Operator:

Installation Mode

Choose a specific namespace in which to install the Operator.

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 in the selected channel, 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.

Installing from OperatorHub using the web console

You can install and subscribe to an Operator from OperatorHub by using the OKD web console.

Prerequisites

  • Access to an OKD cluster using an account with Operator installation permissions.

Procedure

  1. Navigate in the web console to the Operators → OperatorHub page.

  2. Scroll or type a keyword into the Filter by keyword box to find the Operator you want. For example, type advanced to find the Advanced Cluster Management for Kubernetes Operator.

    You can also filter options by Infrastructure Features. For example, select Disconnected if you want to see Operators that work in disconnected environments, also known as restricted network environments.

  3. Select the Operator to display additional information.

    Choosing a Community Operator warns that Red Hat does not certify Community Operators; you must acknowledge the warning before continuing.

  4. Read the information about the Operator and click Install.

  5. On the Install Operator page:

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

    2. If the cluster is in AWS STS mode, enter the Amazon Resource Name (ARN) of the AWS IAM role of your service account in the role ARN field.

      Entering the ARN

      To create the role’s ARN, follow the procedure described in Preparing AWS account.

    3. If more than one update channel is available, select an Update channel.

    4. Select Automatic or Manual approval strategy, as described earlier.

      If the web console shows that the cluster is in “STS mode”, you must set Update approval to Manual.

      Subscriptions with automatic update approvals are not recommended because there might be permission changes to make prior to updating. Subscriptions with manual update approvals ensure that administrators have the opportunity to verify the permissions of the later version and take any necessary steps prior to update.

  6. Click Install to make the Operator available to the selected namespaces on this OKD cluster.

    1. If you selected a Manual approval strategy, the upgrade status of the subscription remains Upgrading until you review and approve the install plan.

      After approving on the Install Plan page, the subscription upgrade status moves to Up to date.

    2. If you selected an Automatic approval strategy, the upgrade status should resolve to Up to date without intervention.

  7. After the upgrade status of the subscription is Up to date, select Operators → Installed Operators to verify that the cluster service version (CSV) of the installed Operator eventually shows up. The Status should ultimately resolve to InstallSucceeded in the relevant namespace.

    For the All namespaces…​ installation mode, the status resolves to InstallSucceeded in the openshift-operators namespace, but the status is Copied if you check in other namespaces.

    If it does not:

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

Installing from OperatorHub using the CLI

Instead of using the OKD web console, you can install an Operator from OperatorHub by using the CLI. Use the oc command to create or update a Subscription object.

Prerequisites

  • Access to an OKD cluster using an account with Operator installation permissions.

  • You have installed the OpenShift CLI (oc).

Procedure

  1. View the list of Operators available to the cluster from OperatorHub:

    1. $ oc get packagemanifests -n openshift-marketplace

    Example output

    1. NAME                               CATALOG               AGE
    2. 3scale-operator                    Red Hat Operators     91m
    3. advanced-cluster-management        Red Hat Operators     91m
    4. amq7-cert-manager                  Red Hat Operators     91m
    5. ...
    6. couchbase-enterprise-certified     Certified Operators   91m
    7. crunchy-postgres-operator          Certified Operators   91m
    8. mongodb-enterprise                 Certified Operators   91m
    9. ...
    10. etcd                               Community Operators   91m
    11. jaeger                             Community Operators   91m
    12. kubefed                            Community Operators   91m
    13. ...

    Note the catalog for your desired Operator.

  2. Inspect your desired Operator to verify its supported install modes and available channels:

    1. $ oc describe packagemanifests <operator_name> -n openshift-marketplace

  3. An Operator group, defined by an OperatorGroup object, selects target namespaces in which to generate required RBAC access for all Operators in the same namespace as the Operator group.

    The namespace to which you subscribe the Operator must have an Operator group that matches the install mode of the Operator, either the AllNamespaces or SingleNamespace mode. If the Operator you intend to install uses the AllNamespaces, then the openshift-operators namespace already has an appropriate Operator group in place.

    However, if the Operator uses the SingleNamespace mode and you do not already have an appropriate Operator group in place, you must create one.

    The web console version of this procedure handles the creation of the OperatorGroup and Subscription objects automatically behind the scenes for you when choosing SingleNamespace mode.

    1. Create an OperatorGroup object YAML file, for example operatorgroup.yaml:

      Example OperatorGroup object

      1. apiVersion: operators.coreos.com/v1
      2. kind: OperatorGroup
      3. metadata:
      4.   name: <operatorgroup_name>
      5.   namespace: <namespace>
      6. spec:
      7.   targetNamespaces:
      8.   - <namespace>

    2. Create the OperatorGroup object:

      1. $ oc apply -f operatorgroup.yaml

  4. Create a Subscription object YAML file to subscribe a namespace to an Operator, for example sub.yaml:

    Example Subscription object

    1. apiVersion: operators.coreos.com/v1alpha1
    2. kind: Subscription
    3. metadata:
    4.   name: <subscription_name>
    5.   namespace: openshift-operators (1)
    6. spec:
    7.   channel: <channel_name> (2)
    8.   name: <operator_name> (3)
    9.   source: redhat-operators (4)
    10.   sourceNamespace: openshift-marketplace (5)
    11.   config:
    12.     env: (6)
    13.     - name: ARGS
    14.       value: "-v=10"
    15.     envFrom: (7)
    16.     - secretRef:
    17.         name: license-secret
    18.     volumes: (8)
    19.     - name: <volume_name>
    20.       configMap:
    21.         name: <configmap_name>
    22.     volumeMounts: (9)
    23.     - mountPath: <directory_name>
    24.       name: <volume_name>
    25.     tolerations: (10)
    26.     - operator: "Exists"
    27.     resources: (11)
    28.       requests:
    29.         memory: "64Mi"
    30.         cpu: "250m"
    31.       limits:
    32.         memory: "128Mi"
    33.         cpu: "500m"
    34.     nodeSelector: (12)
    35.       foo: bar
    1For default AllNamespaces install mode usage, specify the openshift-operators namespace. Alternatively, you can specify a custom global namespace, if you have created one. Otherwise, specify the relevant single namespace for SingleNamespace install mode usage.
    2Name of the channel to subscribe to.
    3Name of the Operator to subscribe to.
    4Name of the catalog source that provides the Operator.
    5Namespace of the catalog source. Use openshift-marketplace for the default OperatorHub catalog sources.
    6The env parameter defines a list of Environment Variables that must exist in all containers in the pod created by OLM.
    7The envFrom parameter defines a list of sources to populate Environment Variables in the container.
    8The volumes parameter defines a list of Volumes that must exist on the pod created by OLM.
    9The volumeMounts parameter defines a list of volume mounts that must exist in all containers in the pod created by OLM. If a volumeMount references a volume that does not exist, OLM fails to deploy the Operator.
    10The tolerations parameter defines a list of Tolerations for the pod created by OLM.
    11The resources parameter defines resource constraints for all the containers in the pod created by OLM.
    12The nodeSelector parameter defines a NodeSelector for the pod created by OLM.

  5. If the cluster is in STS mode, include the following fields in the Subscription object:

    1. kind: Subscription
    2. # ...
    3. spec:
    4.   installPlanApproval: Manual (1)
    5.   config:
    6.     env:
    7.     - name: ROLEARN
    8.       value: "<role_arn>" (2)
    1Subscriptions with automatic update approvals are not recommended because there might be permission changes to make prior to updating. Subscriptions with manual update approvals ensure that administrators have the opportunity to verify the permissions of the later version and take any necessary steps prior to update.
    2Include the role ARN details.

  6. Create the Subscription object:

    1. $ oc apply -f sub.yaml

    At this point, OLM is now aware of the selected Operator. A cluster service version (CSV) for the Operator should appear in the target namespace, and APIs provided by the Operator should be available for creation.

Additional resources

Installing a specific version of an Operator

You can install a specific version of an Operator by setting the cluster service version (CSV) in a Subscription object.

Prerequisites

  • Access to an OKD cluster using an account with Operator installation permissions.

  • You have installed the OpenShift CLI (oc).

Procedure

  1. Look up the available versions and channels of the Operator you want to install by running the following command:

    Command syntax

    1. $ oc describe packagemanifests <operator_name> -n <catalog_namespace>

    For example, the following command prints the available channels and versions of the Red Hat Quay Operator from OperatorHub:

    Example command

    1. $ oc describe packagemanifests quay-operator -n openshift-marketplace

    Example output

    1. Name:         quay-operator
    2. Namespace:    operator-marketplace
    3. Labels:       catalog=redhat-operators
    4.               catalog-namespace=openshift-marketplace
    5.               hypershift.openshift.io/managed=true
    6.               operatorframework.io/arch.amd64=supported
    7.               operatorframework.io/os.linux=supported
    8.               provider=Red Hat
    9.               provider-url=
    10. Annotations:  <none>
    11. API Version:  packages.operators.coreos.com/v1
    12. Kind:         PackageManifest
    13. ...
    14.     Current CSV:  quay-operator.v3.7.11
    15. ...
    16.     Entries:
    17.       Name:       quay-operator.v3.7.11
    18.       Version:    3.7.11
    19.       Name:       quay-operator.v3.7.10
    20.       Version:    3.7.10
    21.       Name:       quay-operator.v3.7.9
    22.       Version:    3.7.9
    23.       Name:       quay-operator.v3.7.8
    24.       Version:    3.7.8
    25.       Name:       quay-operator.v3.7.7
    26.       Version:    3.7.7
    27.       Name:       quay-operator.v3.7.6
    28.       Version:    3.7.6
    29.       Name:       quay-operator.v3.7.5
    30.       Version:    3.7.5
    31.       Name:       quay-operator.v3.7.4
    32.       Version:    3.7.4
    33.       Name:       quay-operator.v3.7.3
    34.       Version:    3.7.3
    35.       Name:       quay-operator.v3.7.2
    36.       Version:    3.7.2
    37.       Name:       quay-operator.v3.7.1
    38.       Version:    3.7.1
    39.       Name:       quay-operator.v3.7.0
    40.       Version:    3.7.0
    41.     Name:         stable-3.7
    42. ...
    43.    Current CSV:  quay-operator.v3.8.5
    44. ...
    45.    Entries:
    46.       Name:         quay-operator.v3.8.5
    47.       Version:      3.8.5
    48.       Name:         quay-operator.v3.8.4
    49.       Version:      3.8.4
    50.       Name:         quay-operator.v3.8.3
    51.       Version:      3.8.3
    52.       Name:         quay-operator.v3.8.2
    53.       Version:      3.8.2
    54.       Name:         quay-operator.v3.8.1
    55.       Version:      3.8.1
    56.       Name:         quay-operator.v3.8.0
    57.       Version:      3.8.0
    58.     Name:           stable-3.8
    59.   Default Channel:  stable-3.8
    60.   Package Name:     quay-operator

    You can print an Operator’s version and channel information in the YAML format by running the following command:

    1. $ oc get packagemanifests <operator_name> -n <catalog_namespace> -o yaml

    • If more than one catalog is installed in a namespace, run the following command to look up the available versions and channels of an Operator from a specific catalog:

      1. $ oc get packagemanifest \
      2.    --selector=catalog=<catalogsource_name> \
      3.    --field-selector metadata.name=<operator_name> \
      4.    -n <catalog_namespace> -o yaml

      If you do not specify the Operator’s catalog, running the oc get packagemanifest and oc describe packagemanifest commands might return a package from an unexpected catalog if the following conditions are met:

      • Multiple catalogs are installed in the same namespace.

      • The catalogs contain the same Operators or Operators with the same name.

  2. An Operator group, defined by an OperatorGroup object, selects target namespaces in which to generate required role-based access control (RBAC) access for all Operators in the same namespace as the Operator group.

    The namespace to which you subscribe the Operator must have an Operator group that matches the install mode of the Operator, either the AllNamespaces or SingleNamespace mode. If the Operator you intend to install uses the AllNamespaces mode, then the openshift-operators namespace already has an appropriate Operator group in place.

    However, if the Operator uses the SingleNamespace mode and you do not already have an appropriate Operator group in place, you must create one:

    1. Create an OperatorGroup object YAML file, for example operatorgroup.yaml:

      Example OperatorGroup object

      1. apiVersion: operators.coreos.com/v1
      2. kind: OperatorGroup
      3. metadata:
      4.   name: <operatorgroup_name>
      5.   namespace: <namespace>
      6. spec:
      7.   targetNamespaces:
      8.   - <namespace>

    2. Create the OperatorGroup object:

      1. $ oc apply -f operatorgroup.yaml

  3. Create a Subscription object YAML file that subscribes a namespace to an Operator with a specific version by setting the startingCSV field. Set the installPlanApproval field to Manual to prevent the Operator from automatically upgrading if a later version exists in the catalog.

    For example, the following sub.yaml file can be used to install the Red Hat Quay Operator specifically to version 3.7.10:

    Subscription with a specific starting Operator version

    1. apiVersion: operators.coreos.com/v1alpha1
    2. kind: Subscription
    3. metadata:
    4.   name: quay-operator
    5.   namespace: quay
    6. spec:
    7.   channel: quay-operator.v3.7.10
    8.   installPlanApproval: Manual (1)
    9.   name: quay-operator
    10.   source: redhat-operators
    11.   sourceNamespace: openshift-marketplace
    12.   startingCSV: quay-operator.v3.7.10 (2)
    1Set the approval strategy to Manual in case your specified version is superseded by a later version in the catalog. This plan prevents an automatic upgrade to a later version and requires manual approval before the starting CSV can complete the installation.
    2Set a specific version of an Operator CSV.

  4. Create the Subscription object:

    1. $ oc apply -f sub.yaml

  5. Manually approve the pending install plan to complete the Operator installation.

Additional resources