Express installation

If you are installing on an internet-connected cluster using the OpenShift web console, you can follow these steps to get up-and-running quickly with IBM Cloud Pak® for Integration. Express installation covers all phases of installation up to, but not including, deploying instances of capabilities and runtimes.

If you do not intend to continue with express installation, start with one of the following:


You can use express installation if your deployment meets the following requirements:


  • Your Red Hat OpenShift cluster has access to the internet to pull images
  • You are installing with the OpenShift web console.
  • You have cluster admin privileges to perform the installation.
  • You are installing Cloud Pak for Integration on a cluster running on OpenShift Container Platform version 4.6 and later. If you don't already have a license to run OpenShift, you may be able to use an OpenShift trial entitlement. For more information, see Get started with OpenShift.
  • The minimum install size for Cloud Pak for Integration requires the following resources to be available on your cluster:
    • 32 CPU units
    • 128 GB of memory
    The available resources can be spread across one or more worker nodes. ​ If you have a trial scenario in mind, and need to size the cluster for workloads with specific capabilities, see Table 1. ​
    Note: These requirements are intentionally scaled down and simplified so that you can get started quickly. For details on sizing, see Compute resources for development environments. For details on environment requirements, see Operating environment.
    Note: The trial license does not entitle you to IBM support.

If you wish to use a different type of deployment (one that does not meet the requirements for this procedure), see Installation options.


The capabilities and runtimes in Cloud Pak for Integration have varying storage requirements. At a minimum, you require a storage class that supports the RWO access mode. For other capabilities in Cloud Pak for Integration (Asset Repository, Operations Dashboard, App Connect dashboard, Aspera HSTS, and MQ), you also need a storage class that supports the RWX access mode.

The recommended storage providers are:

  • OpenShift Data Foundation (formerly OpenShift Container Storage), version 4.2 or above

  • Portworx Storage, version 2.5.5 or above

  • IBM Cloud Block Storage and IBM Cloud File Storage

Note: These requirements are intentionally scaled down and simplified so that you can get started quickly. For details on storage, see Storage.

Adding the IBM CatalogSource object

  1. Log into the OpenShift web consolewith your OpenShift cluster admin credentials.
  2. In the top banner, click the plus (+) icon to open the Import YAML dialog box.
    Note: You do not need to select a value for Project. The YAML in the next step already includes correct value for metadata:namespace, which ensures that the catalog source is installed in the correct project (namespace).
  3. Paste this resource definition into the dialog box:
    kind: CatalogSource
      name: ibm-operator-catalog
      namespace: openshift-marketplace
      displayName: IBM Operator Catalog
      image: ''
      publisher: IBM
      sourceType: grpc
          interval: 45m
  4. Click Create.

Installing the Cloud Pak for Integration Operator

  1. Log into the OpenShift web console with your OpenShift cluster admin credentials.
  2. Make sure you have selected the Administrator view.

    Select the Administrator viewin the OpenShift console

  3. Click Operators > OperatorHub > Integration & Delivery.
  4. Search for and click the tile for the IBM Cloud Pak for Integration operator.
  5. Click Install.
  6. In the Install Operator pane:
    • Select the latest update channel.
    • Select the option to install Cloud Pak for Integration in one namespace or for all namespaces on your cluster. If in doubt, choose the All namespaces on the cluster installation mode, and accept the default Installed Namespace.
    • Select the Automatic approval strategy.
    • Click Install.

Obtaining your entitlement key

  1. Go to the Container software library.
  2. Click Copy key.
  3. Copy the entitlement key to a safe place so you can use it in Adding a pull secret to a namespace.
  4. (Optional) Verify the validity of the key by logging in to the IBM Entitled Registry using a container tool.
    docker login --username cp --password entitlement_key

Adding a pull secret to a namespace

To install Cloud Pak for Integration in its own namespace, create a docker registry secret named ibm-entitlement-key, using the following command. In the third line, replace entitlement_key with the value of your entitlement key from the previous section. In the last line, replace target_namespace with the name of your target namespace:

oc create secret docker-registry ibm-entitlement-key \
    --docker-username=cp \
    --docker-password=entitlement_key \ \

Deploying the Cloud Pak for Integration instance

Creating the Platform Navigator instance

  1. Log into the OpenShift web console with your OpenShift cluster admin credentials.
  2. In the navigation panel, click Operators > Installed Operators.
  3. In the list on the Installed Operators panel, find and click IBM Cloud Pak for Integration Platform Navigator.
  4. Click the Platform Navigator tab.
  5. Click Create PlatformNavigator. The Create Platform Navigator panel opens. The Form view is selected by default).
  6. Change Project to your project name: Click the drop-down arrow and select your project name from the list. The project name in the example screen below is cp4i.
    Note: Project is the same as the Kubernetes term namespace. You may encounter both terms in the UI or in the documentation. They are interchangeable.
  7. In the Name field, enter a name for the new instance.
  8. Accept the terms of the license agreement. Click to expand the License section:
    • Set License Accept to true.
    • For License LI, click the arrow to open the drop-down list, and select a license. For details about specific licenses, see the "Table of license versions" section in Licensing.
  9. Specify the Storage class. Click the arrow to expand the Storage pane, then click the arrow for Select Storage Class and select a file storage class.
    Note: If you don't see any options in the Storage Class list, you need to create one or more storage options. See the Requirements section for more information.
  10. Set any other configuration values as appropriate.
  11. Click Create.

    Your instance of Platform Navigator is added to the list of instances in the current project (namespace).

Logging into your Cloud Pak for Integration instance

When the Platform Navigator status changes to Ready, log into IBM Cloud Pak Platform UI for the first time to create Cloud Pak for Integration users and permissions.

  1. In the navigation panel of the OpenShift web console, click Operators > Installed Operators.
  2. Click to expand the Project list and select the project where Platform Navigator is deployed.
  3. In the Installed Operators pane, click IBM Cloud Pak for Integration Platform Navigator.
  4. Click Platform Navigator.
  5. In the PlatformNavigators list, click the name of the deployed instance.
  6. In the Endpoints section, click the link under Platform Navigator UI.

    Selecting the Platform Navigator UI endpoint

  7. At the login screen, click OpenShift authentication and log in with your OpenShift cluster admin credentials.

    Log into IBM Cloud Pak Administration Hub

    The IBM Automation UI opens. You can now create users and permissions.