Installation

The IBM Cloud Pak for Integration (CP4I) is delivered as operators that are installed and managed using the Operator Lifecycle Manager (OLM) within Red Hat OpenShift. To install CP4I, add the OLM Catalog Sources for IBM components, install the operators using OLM, and then create a Platform Navigator custom resource.

Note: You can also install the IBM Cloud Pak for Integration on a managed Red Hat OpenShift on IBM Cloud instance by using the IBM Cloud Catalog. For more information, see Getting started with IBM Cloud Pak for Integration in the IBM Cloud documentation.

What is an operator?

An operator extends a Kubernetes cluster by adding and managing additional resource types to the Kubernetes API. This allows for the installation and management of software using standard Kubernetes tools. For more information, see Understanding Operators.

Making CP4I operators available to a cluster

To make the CP4I operators available to a cluster, use OLM catalog sources to refer to the location of the CP4I operators.

The OLM catalog sources from IBM components can be added directly to clusters connected to the internet. Follow the steps in Adding online catalog sources to a cluster.

For clusters not connected to the internet, the software must be mirrored to a registry within the restricted network. Follow the steps in Mirroring operators to a restricted environment.

Installing the CP4I operators

You can install all of the CP4I operators at once by using the Cloud Pak for Integration operator, or install a subset of operators by selecting and installing only the operators you want to use on your cluster. When installing an operator, OLM will automatically install any required dependencies.

Install CP4I operators using the Red Hat OpenShift Operator Hub, located in the left hand menu of the OpenShift console under the Operators menu item, or the oc command-line tool.

For detailed instructions on how to install an operator, see Adding Operators to a cluster in the Red Hat OpenShift documentation.

The operators available to install are:

Cloud Pak for Integration

Top level CP4I operator that will install all other CP4I operators automatically. Use this to install the whole Cloud Pak in one operation.

IBM Cloud Pak for Integration Platform Navigator

Provides a dashboard and central services for other CP4I capabilities. Should be installed for most CP4I installations.

IBM Cloud Pak for Integration Asset Repository

Stores, manages, retrieves and searches for integration assets for use within the IBM Cloud Pak for Integration and its capabilities.

IBM Cloud Pak for Integration Operations Dashboard

Cross-component transaction tracing to allow troubleshooting and investigation of errors and latency issues across integration capabilities to ensure applications meet service level agreements.

IBM API Connect

Provides API management capabilities.

IBM App Connect

Provides application integration capabilities and a means to easily create and export flows that run in an App Connect instance.

IBM Aspera HSTS

Provides high speed transfer integration capabilities.

IBM Datapower Gateway

Provides gateway capabilities.

IBM Event Streams

Provides IBM Event Streams capabilities.

IBM MQ

Provides messaging capabilities.

Validating an installed operator

To validate a operator has installed, navigate to the Installed Operators menu item in the OpenShift console. Select the project the operator was installed in. If you installed the operator using cluster scope, the operator will be located in the openshift-operators project.

Locate your Operator in the table and look at the status column. When the Operator is ready, it will say Succeeded.

To check the progress of operator deployment, you can look at the operator pod within the selected namespace using the oc command-line tool or the Openshift console.

Installation modes

When installing operators, you can choose to install an operator in All namespaces on the cluster or a A specific namespace on the cluster.

Specific namespace on the cluster mode runs the operator in the selected namespace, and the operator will only process resources created in that namespace.

All namespaces on the cluster mode runs the operator in the openshift-operators namespace and can process resources within any namespace on the cluster. This is the default installation mode.

Important: When installing the CP4I operators, be sure to choose to install the operators in just one of the install modes and not combine the two. OLM (Operator Lifecycle Manager) does not currently support combining two install modes. If you do this, OLM will not pick up the latest operator version.

Deploying the Platform Navigator

In most cases, you will want to deploy the Platform Navigator to manage your CP4I integration capabilities and provide platform services used by other capabilities. See Platform Navigator deployment.