Installing the operators by using the CLI

Install the IBM Cloud Pak® for Integration operators by using the CLI. Installing the operators is a prerequisite for deploying instances later in the installation process.

A cluster administrator needs to install the operators. For more information, see OpenShift Roles and permissions.

Before you begin

Review Operator reference before you install the operators.

Attention: The IBM Cloud Pak foundational services operator is no longer installed automatically. Install this operator manually if you need to create an instance that uses identity and access management. Install this operator in the same installation mode as the IBM Cloud Pak for Integration operator.
Important: The API management and Event Endpoint Manager instances require you to install an appropriate certificate manager:
  • If you are installing on OpenShift 4.12 on s390x (IBM Z®) or ppc64le (IBM® POWER®) hardware, install the IBM Cert Manager operator by adding the catalog source as explained in the "Adding specific catalog sources for each operator" section of Adding catalog sources to a cluster.
  • If you are installing on OpenShift 4.12 on other hardware, or on OpenShift 4.14 on any hardware, install the cert-manager Operator for Red Hat OpenShift by following the instructions in Installing the cert-manager Operator for Red Hat OpenShift.

Procedure

Installing operators

  1. Specify the namespace where you want to install the operator:

    export NAMESPACE=<namespace_name>

    For the placeholder <namespace_name>, if you are installing:

    • in all namespaces mode, enter openshift-operators.

    • in a specific namespace mode, enter a custom name.

  2. If the installation mode that you want is a specific namespace on the cluster, create a new project for installing the operator:

    oc new-project <project_name>

    For example:

    oc new-project integration
  3. Switch to the namespace where you want to install the operator (openshift-operators if you are installing in all namespaces, or a custom name if you are installing in a specific namespace):

    oc project ${NAMESPACE}
  4. (Only if your preferred installation mode is a specific namespace on the cluster) Create an OperatorGroup similar to the following example.

    . Create a YAML file similar to the following example:

    apiVersion: operators.coreos.com/v1
    kind: OperatorGroup
    metadata:
      name: ibm-integration-operatorgroup
      labels:
        backup.integration.ibm.com/component: operatorgroup        
    spec:
      targetNamespaces:
      - <namespace>

    Replace the following placeholders:

    • For <namespace>, use the namespace you want to install the workload in.

    b. Save to a file called operator-group.yaml.

    c. Run the following command: oc apply -f operator-group.yaml

  5. Create a Subscription for the IBM Cloud Pak for Integration operator.

    a. Create a YAML file similar to the following example:

    apiVersion: operators.coreos.com/v1alpha1
    kind: Subscription
    metadata:
      name: ibm-integration-platform-navigator
      labels:
        backup.integration.ibm.com/component: subscription        
    spec:
      channel: <current_channel>
      name: ibm-integration-platform-navigator
      source: <catalog_source_name>
      sourceNamespace: openshift-marketplace

    Replace the following placeholders:

    b. Save to a file called subscription.yaml.

    c. Run the following command:

    oc apply -f subscription.yaml
  6. Create a subscription for each operator that you want to install.

    a. Create a YAML file similar to the following example:

    apiVersion: operators.coreos.com/v1alpha1
      kind: Subscription
      metadata:
        name: <operator_name>
      spec:
        channel: <current_channel>
        name: <operator_name>
        source: <catalog_source_name>
        sourceNamespace: openshift-marketplace

    Replace the following placeholders, as indicated:

    b. Save to a file called subscription.yaml.

    c. Run the following command:

    oc apply -f subscription.yaml

Validating installation of an operator

To validate that an operator is installed, run the following command:

oc get csv

The command returns a list similar to the following example. Successfully installed operators have the value Succeeded in the PHASE column.

NAME                                          DISPLAY                                              VERSION   PHASE
ibm-integration-platform-navigator.v7.2.0     IBM Cloud Pak for Integration                        7.2.0     Succeeded
ibm-mq.v3.1.0                                 IBM MQ                                               3.1.0     Succeeded

When the operator is successfully installed (PHASE value of Succeeded), you can deploy instances that the operator manages.

Restricting automatic updates with an approval strategy

Controlling updates by using dedicated and declarative catalog sources is the only way to ensure that the cluster never upgrades. To use this method, follow the procedure in the "Adding specific catalog sources for each operator" section of Adding catalog sources to a cluster.

However, if you know you will always want automatic upgrades of operators, and you do not require declarative installs, you can use the IBM Operator catalog for installations.

Important: The built-in approval strategies for operators do not allow users to control what upgrades to apply. These strategies allow users to control only when to apply all available upgrades in a namespace. Therefore, if your use case requires that you control what upgrades to apply, use the procedure for "Adding specific catalog sources for each operator" as already described.

There are two approval strategies, Automatic and Manual.

  • Do not use the manual strategy, since users cannot control what upgrades to apply; this strategy forces all possible upgrades to be done at the same time. It can also block an upgrade. If your use case requires that you control what upgrades to apply, follow the procedure for "Adding specific catalog sources for each operator" as already described.

  • The automatic strategy is the default strategy. As new operator versions are made available on the subscription channel (each time the catalog source is updated), they are installed automatically, but only on fix packs. Minor version changes always require user input to change subscription channels.

Operators available to install

The following table lists each operator that you can install and the instance types that it supports. You can install any combination of operators, and any dependencies are pulled in automatically. Each value in the "Literal name" column can be used as a value of metadata.name and spec.name in step 2 of Installing operators.

Important: Not all operators are supported on every environment. For more information, see "Supported environments for operators" in Operating environment.

Installing the IBM Cloud Pak for Integration operator enables deployment of the Platform UI, which facilitates the deployment and management of the other instances.

Operator name Literal name Instances
IBM Cloud Pak for Integration ibm-integration-platform-navigator Platform UI, Integration assembly, Declarative API, and Declarative API Product
IBM Automation foundation assets ibm-integration-asset-repository Automation assets
IBM API Connect ibm-apiconnect API management, API Manager, API Analytics, API Portal, and API Gateway
IBM App Connect ibm-appconnect Integration dashboard, Integration design, and Integration runtime
IBM Aspera HSTS aspera-hsts-operator High speed transfer server
IBM DataPower Gateway datapower-operator Enterprise gateway
IBM Event Streams ibm-eventstreams Kafka cluster
IBM Event Endpoint Management ibm-eventendpointmanagement Event Endpoint Manager, and Event Gateway
IBM MQ ibm-mq Queue manager
IBM Instana Agent instana-agent-operator IBM Instana
IBM Cert Manager ibm-cert-manager-operator Certificate management (OpenShift 4.12 on s390x or ppc64le hardware)
cert-manager Operator for Red Hat OpenShift openshift-cert-manager-operator Certificate management (OpenShift 4.12 on any hardware except s390x or ppc64le, or OpenShift 4.14 on any hardware)
IBM Cloud Pak foundational services ibm-common-service-operator Cloud Pak foundational services
IBM Licensing ibm-licensing-operator-app IBM License Service