Installing the operators by using the CLI

Install the IBM Cloud Pak® for Integration operators by using the CLI.

You must be an OpenShift cluster administrator to install the operators. For more information, see OpenShift roles and permissions.

Before you begin

Decide which installation mode to use to install the operators. For more information, see Installing 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. If you have your own instance of Keycloak installed on your OpenShift cluster, install the Cloud Pak foundational services operator in a different namespace. Cloud Pak for Integration uses only the Keycloak installation that is installed by Cloud Pak foundational services.

Important: The API Connect cluster, Event Manager, and Event Processing instances require you to install an appropriate certificate manager. Follow the instructions in Installing the cert-manager Operator for Red Hat OpenShift to fulfill this requirement.

Procedure

Install operators that provide the instances you want to use. For example, if you install the IBM API Connect operator now, you can deploy API Connect cluster instances later. For more information, see Operators available to install.

Specify the namespace where you want to install the operator, according to the decision about installation modes that you made in the "Before you begin" section of this task:
```
export NAMESPACE=<namespace_name>
```
For the placeholder <namespace_name>, if you are installing:
- in "All namespaces on the cluster" mode, enter openshift-operators.
- in "A specific namespace on the cluster" mode, enter a custom name.
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 ${NAMESPACE}
```
For example:
```
oc new-project integration
```
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}
```
(Only if your preferred installation mode is a specific namespace on the cluster) Create an OperatorGroup similar to the following example.
1. 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.
2. Save to a file called operator-group.yaml.
3. Run the following command:
```
oc apply -f operator-group.yaml
```

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

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: v8.0
  name: ibm-integration-platform-navigator
  source: ibm-integration-platform-navigator-catalog
  sourceNamespace: openshift-marketplace

Save to a file called subscription.yaml.
Run the following command:
```
oc apply -f subscription.yaml
```

Create a Subscription for the IBM Cloud Pak foundational services operator.

Create a YAML file similar to the following example:

apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: ibm-common-service-operator
  labels:
    backup.integration.ibm.com/component: subscription
spec:
  channel: v4.6
  name: ibm-common-service-operator
  source: opencloud-operators
  sourceNamespace: openshift-marketplace

Save to a file called subscription.yaml.
Run the following command:
```
oc apply -f subscription.yaml
```

Create a subscription for each operator that you want to install. For a full list of subscriptions, see Operators available to install.
1. Create a YAML file with the subscription.
2. Save to a file called subscription.yaml.
3. Run the following command:
```
oc apply -f subscription.yaml
```

To validate that the operators are 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.3.0     IBM Cloud Pak for Integration                        7.3.0     Succeeded
ibm-mq.v3.2.0                                 IBM MQ                                               3.2.0     Succeeded

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

Operators available to install

The list in this section provides each operator that you can install, the instance types that each operator supports, and a subscription object that you can copy to install the operator.

You can install any combination of operators. Installing the IBM Cloud Pak for Integration operator enables deployment of the Platform UI, which facilitates the deployment and management of the other instances.

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

For more information about available instances, see Deploying instances.

IBM Cloud Pak for Integration - Platform UI, Assembly, API, API Product, Messaging server, Messaging channel, Messaging queue, Messaging user

apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: ibm-integration-platform-navigator
  labels:
    backup.integration.ibm.com/component: subscription
spec:
  channel: v8.0
  name: ibm-integration-platform-navigator
  source: ibm-integration-platform-navigator-catalog
  sourceNamespace: openshift-marketplace

IBM Automation foundation assets - Automation assets

apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: ibm-integration-asset-repository
  labels:
    backup.integration.ibm.com/component: subscription
spec:
  channel: v1.8
  name: ibm-integration-asset-repository
  source: ibm-integration-asset-repository-catalog
  sourceNamespace: openshift-marketplace

IBM API Connect - API Connect cluster, API Manager, API Analytics, API Portal, API Gateway

apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: ibm-apiconnect
  labels:
    backup.apiconnect.ibm.com/component: subscription
spec:
  channel: v6.0
  name: ibm-apiconnect
  source: ibm-apiconnect-catalog
  sourceNamespace: openshift-marketplace

IBM App Connect - Integration dashboard, Integration design, Integration runtime

apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: ibm-appconnect
  labels:
    backup.appconnect.ibm.com/component: subscription
spec:
  channel: v12.11
  name: ibm-appconnect
  source: appconnect-operator-catalogsource
  sourceNamespace: openshift-marketplace

IBM MQ - Queue manager

apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: ibm-mq
  labels:
    backup.mq.ibm.com/component: subscription
spec:
  channel: v3.5
  name: ibm-mq
  source: ibmmq-operator-catalogsource
  sourceNamespace: openshift-marketplace

IBM Event Streams - Kafka cluster, Kafka topic, Kafka user, Kafka Connect runtime, Kafka connector

apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: ibm-eventstreams
  labels:
    backup.eventstreams.ibm.com/component: subscription
spec:
  channel: v3.7
  name: ibm-eventstreams
  source: ibm-eventstreams
  sourceNamespace: openshift-marketplace

IBM Event Endpoint Management - Event Manager, Event Gateway

apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: ibm-eventendpointmanagement
  labels:
    backup.events.ibm.com/component: subscription
spec:
  channel: v11.5
  name: ibm-eventendpointmanagement
  source: ibm-eventendpointmanagement-catalog
  sourceNamespace: openshift-marketplace

IBM Event Processing - Event Processing

apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: ibm-eventprocessing
spec:
  channel: v1.3
  name: ibm-eventprocessing
  source: ibm-eventprocessing-catalog
  sourceNamespace: openshift-marketplace

IBM Operator for Apache Flink - Flink

apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: ibm-eventautomation-flink
spec:
  channel: v1.3
  name: ibm-eventautomation-flink
  source: ibm-eventautomation-flink-catalog
  sourceNamespace: openshift-marketplace

IBM DataPower Gateway - Enterprise gateway
Important: Do not apply this subscription if you already applied the subscription for the IBM API Connect operator (or if you are going to apply that subscription next). The IBM API Connect operator automatically applies the IBM DataPower Gateway operator subscription for you.
```
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: datapower-operator
  labels:
    backup.datapower.ibm.com/component: subscription
spec:
  channel: v1.14
  name: datapower-operator
  source: ibm-datapower-operator-catalog
  sourceNamespace: openshift-marketplace
```

IBM Aspera HSTS - High speed transfer server

apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: ibm-aspera-hsts-operator
spec:
  channel: v1.5
  name: ibm-aspera-hsts-operator
  source: aspera-operators
  sourceNamespace: openshift-marketplace

IBM Cloud Pak foundational services - Cloud Pak foundational services for Cloud Native PostgreSQL and RedHat Build of Keycloak only

apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: ibm-common-service-operator
  labels:
    backup.integration.ibm.com/component: subscription
spec:
  channel: v4.6
  name: ibm-common-service-operator
  source: opencloud-operators
  sourceNamespace: openshift-marketplace

IBM Licensing operators - IBM License Service and IBM License Service reporter. For more information, see Deploying License Service.

What to do next

Follow one of these topics, depending on how you are installing and using Cloud Pak for Integration:

For online environments, see Finding and applying your entitlement key by using the CLI (online installation).
For air-gapped environments, see Deploying the Platform UI or Deploying instances.