Installing the operators by using the Red Hat OpenShift console

Install the IBM Cloud Pak® for Integration operators by using the OpenShift web console. Installing the operators allows you to deploy instances later in the installation process.

A cluster administrator must install Cloud Pak for Integration. For more information, see Roles and permissions.

Operators extend a Kubernetes cluster by adding and managing more resource types in the Kubernetes API and enabling the installation and management of software by using standard Kubernetes tools. For more information, see Operator reference.

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: 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

  1. Log in to the OpenShift web console with your OpenShift cluster administrator credentials.

  2. Make sure that the Administrator perspective is selected.

  3. Click Operators > OperatorHub.

    Select the Administrator perspective, then click Operators > OperatorHub
  4. On the OperatorHub page that opens, use the search filter to locate the tile for the operator you plan to install, for example, IBM Cloud Pak for Integration, and click the tile:

    Click the tile for the operator that you want
  5. On the operator information page that opens, click Install.

    Click Install
  6. In the Install Operator page that opens:

    • Select the operator channel. The Instana agent doesn't have an operator channel, so if you are installing the Instana agent, skip this substep. For more information about available operators and operator channel versions, see Operator and instance versions for this release.

      Choose the operator channel
    • Select the option to install either in all namespaces in the cluster or in a specific namespace. The Instana agent can be installed only in all namespaces. For more information, see Guidelines for installing operators.

      Install in a single namespace or in all namespaces
    • If you select the option to install the operator in a specific namespace, create a new project for this purpose. Under Home > Projects, click Create Project, enter the name for your new project, and click Create.

    • For the approval strategy, do not select Manual, because it doesn't allows users to control which updates to apply, and it can block upgrade. The default strategy is Automatic. For more information, see Restricting automatic updates with an approval strategy.

      Selecting the approval strategy: automatic is the default
  7. Click Install. The operator installs.

  8. Confirm installation. To confirm the operator is installed:

    1. Make sure that you're logged in to the OpenShift web console.

    2. In the navigation panel, click Operators > Installed Operators.

    3. From the Project list, select the namespace in which the operator was installed. If you installed the operator by using the All namespaces on the cluster installation mode, the operator pod is located in the openshift-operators project.

    4. Locate your operator in the table and examine the status column. When the operator is ready, the status changes to Succeeded.

      Confirm that the operator is installed

You can now install other Cloud Pak for Integration operators.

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, because 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 (only if 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.

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 Instances
IBM Cloud Pak for Integration Platform UI, Integration assembly, Declarative API, and Declarative API Product
IBM Automation foundation assets Automation assets
IBM API Connect API management, API Manager, API Analytics, API Portal, and API Gateway
IBM App Connect Integration dashboard, Integration design, and Integration runtime
IBM Aspera HSTS High speed transfer server
IBM DataPower Gateway Enterprise gateway
IBM Event Streams Kafka cluster
IBM Event Endpoint Management Event Endpoint Manager, and Event Gateway
IBM MQ Queue manager
IBM Instana Agent IBM Instana
IBM Cloud Pak foundational services Cloud Pak foundational services
IBM Cert Manager Certificate management (OpenShift 4.12 on s390x or ppc64le hardware)
cert-manager Operator for Red Hat OpenShift Certificate management (OpenShift 4.12 on any hardware except s390x or ppc64le, or OpenShift 4.14 on any hardware)
IBM Licensing IBM License Service