Skip to main contentIBM Cloud Pak Playbook

Installation Guide Latest

Installation of the Cloud Pak for Integration 2020.2 currently requires OpenShift Cloud Platform (OCP) 4.4. Using the top level Operator for Cloud Pak for Integration to deploy all of the other operators a fix delivered as part of OCP 4.4.11. Prior to this version you must deploy the operators for Event Streams and API Connect prior to the top level operator. It is recommended that you use a version of OCP 4.4.11 or higher.


This document does not describe how to install or configure the underlying OpenShift Cloud Platform (OCP). Prior to installing ensure you have a working OCP cluster with the necessary capacity available.

Configuring Your Installation

The installation of the Cloud Pak for Integration v2020.2 has changed considerably. The installation and management of Cloud Pak workload now utilizes operators. Essentially, operators contain both a customer resource definition (CRD) and a controller. These help deploy and manage the operations of your Cloud Pak workload. Deploying an operator is not the same as deploying the capability or workload itself. It however enables the deployment of the capability it represents. Operators can (and often will) require / include the deployment of other operators. It is recommended that you learn all about operators since they will become central to most of what you do within OpenShift for the foreseeable future. Please see this page to learn more.

The general steps for installation are as follows:

  • Add operator catalog sources (for Cloud Paks and Common Services)
  • Subscribe to (Install) operators
  • Configure and deploy IBM Common Services
  • Configure and deploy IBM Cloud Pak for Integration capabilities

Even though deploying Cloud Pak for Integration capabilities also deploys the required IBM Common Services, if you wish to control certain aspects of the Common Services layer you can deploy them prior to installing Cloud Pak capabilities. In fact, it is a best-practice to perform this deployment independently.

As a Cluster-Admin log into the OpenShift Administrative UI and navigate to the OperatorHub. In the upper right of the UI, use the + sign to add the catalog sources.

Paste the following YAML to add the catalog for IBM Common Services and select create:

kind: CatalogSource
name: opencloud-operators
namespace: openshift-marketplace
displayName: IBMCS Operators
publisher: IBM
sourceType: grpc

Next add another catalog source that will allow you to load operators for the Cloud Paks:

kind: CatalogSource
name: ibm-operator-catalog
namespace: openshift-marketplace
displayName: ibm-operator-catalog
publisher: IBM Content
sourceType: grpc

Offline-Air-Gap Installation

To perform Offline or Air-Gap installation, at this time please see mirroring operators to a restricted environment in the Knowledge Center. This is an advanced technique to attempt at this time.

Online Installation

To begin deploying the Cloud Pak for Integration using the operator based installation, you first add the operator to your cluster and then create instances from the operator for the capabilities they represent. Configuration of the instances is managed by the operators and you will make these choices during instance creation. A typical first step would be to deploy the top level Cloud Pak for Integration operator, only use this method of subscription if you are using OCP 4.4.11 or newer.

Begin by deploying IBM Common Service by following these steps and then return here to continue deploying the Cloud Pak for Integration.

Adding the Platform Navigator

1. From the OCP Administrative UI as the Cluster Admin, return to the OperatorHub and filter on Nav to find and select the IBM Cloud Pak for Integration Platform Navigator tile.

The operators will provide information around configuration and use. Choose Install to configure and deploy the operator to your cluster.

2. The Create Operator Subscription dialog allows you to configure several behaviors of the operator.

The Installation Mode scopes the operator either to a specific or all namespaces within the cluster. If you scope the operator to a specific namespace, you will only be able to deploy instances of the included capabilities to that namespace. If chose to make the operator available to All namespaces on the cluster, you will be able to deploy its capabilities in any properly prepared project / namespace.

Update Channel allows you to set the target for version management. The channel sets the desired version of release.

Approval Strategy either gives permission for updates to proceed without approval or to require your approval prior to proceeding. Choosing manual will prompt the cluster administrator for permission to proceed to new versions.

In our case we will accept all of the defaults and Subscribe to the operator. In a few moments this operator will appear under the Installed Operators for all projects.

3. Prepare a project cp4i to deploy the Platform Navigator into.

  • Create a project oc new-project cp4i
  • Log in to MyIBM Container Software Library with the IBM ID and password that are associated with the entitled software. In the Entitlement Keys section, copy the entitlement key. This key will be used in future steps.
  • Create the secret in the new project to hold the entitlement key
oc create secret docker-registry ibm-entitlement-key --docker-username=cp --docker-password=**your-entitlement-key-goes-here** --namespace=cp4i

4. Navigate to the OCP Administrative UI - Installed Operators from within your prepared project cp4i open the IBM Cloud Pak for Integration Platform Navigator operator. From the Details tab choose Create Instance


The Create PlatformNavigator YAML allows for configuration of the instance. The only required change is to accept the license agreement by changing false to true. (Other changes can be made here such as namespace or the name of the deployment)


Chose Create. The Platform Navigator is deployed to your cp4i project. If you didn’t pre-deploy the IBM Common Services, the Platform Navigator operator would have done this deployment using defaults for you. In fact, it will check for all the required services and add any that may have been omitted and deploy them. The deployment may take a few minutes as the images that are required must be downloaded from the public registry.


5. Once deployed you can find the URL for your Platform Navigator from within the Installed Operators interface. Navigate to the Platform Navigator tab within the Platform Navigator Operator and open the deployed instance and find the link under Platform Navigator UI.


You can log into the Cloud Pak UI using the admin secret that was created by that operator. Find the secret by running:

oc get secrets -n ibm-common-services platform-auth-idp-credentials -ojsonpath='{.data.admin_password}' | base64 --decode && echo ""

The familiar Platform Navigator allows you to view your running instances of capabilities, runtimes and instances. You can use the new operators (and of course your CI-CD pipelines) for instance deployment.


Check back soon form additional capability deployment.


Uninstalling the Cloud Pak for Integration can be accomplished by following these steps in order:

  • Uninstall any deployed instances of each capability with the Cloud Pak. This task can be performed using the interface available within each of the operators
  • Verify / Remove any orphaned persistent storage volume claims
  • If desired, unsubscribe / uninstall the operators begining at the top level and working down
  • To uninstall the Common Services, follow the instructions for Uninstalling all services here and then run bash <(curl -s