New installation on Red Hat OpenShift using downloaded packages.

A guide to the installation of IBM Cloud Pak® for Integration on Red Hat OpenShift.


IBM Cloud Pak for Integration brings unified installation, single sign-on, centralized logging and simplified integration capability to Red Hat OpenShift.

An instance of the IBM Cloud Pak for Integration Platform Navigator is deployed. Further integration capabilities can then be added and managed via the Navigator.

To install IBM Cloud Pak for Integration, you can download all of the packages contained in the product to a local installation directory. If the cluster onto which the software is to be installed can make outbound connections to the internet, you can use the installer that retrieves the images from the online IBM Entitled Registry (see Entitled Registry install). These instruction explain how to use the downloaded packages.

It is recommended that the installation be carried out by a Cluster Administrator

Before you begin

The environment you plan to use to run IBM Cloud Pak for Integration must meet a number of hardware, software and system requirements. Be sure to review the requirements before you begin. See System requirements

Note: Red Hat OpenShift version 4.2 or later must be running in the target environment. See the instructions (Quick Start Guide part number CC643EN) available on the IBM Passport Advantage site where you downloaded this product.

Installation procedure

Boot node

For OCP 4.2 and later, it is not possible to log into the cluster nodes, so you must create a boot node outside the cluster. This is typically a local workstation or computer. The dedicated boot node must have access to the cluster. It is important to verify access with a command such as oc login.

Take the following steps to prepare a dedicated boot node. <b>Note<b> the boot node performs best with 8 cores available; transferring the software packages can be excessively time-consuming otherwise. Make sure the node has at least 50 GB of available space.

  1. You need a version of Docker that is supported by OpenShift installed on your boot node. All versions of Docker that are supported by OpenShift are supported for the boot node. Only Docker is currently supported.
  2. Install the Open Container CLI. See Open Container CLI.
  3. Log in to the boot node as a user with root permissions or as a user with sudo privileges.
  4. Download the ibm-cp-int-2020.1.x-offline.tgz file (part number CC644EN) from IBM Passport Advantage.
Installation environment
  1. Extract the contents of the archive with a command similar to the following.
    tar xvf ibm-cp-int-2020.1.x-offline.tgz
  2. Load the images into Docker. Extracting the images might take a few minutes.
    tar xf installer_files/cluster/images/common-services-boeblingen-2002-x86_64.tar.gz -O | docker load
  3. It is not necessary to create an installation directory or extract the cluster directory. This is done automatically when the Pak is extracted from the archive.
  4. Change to the installer_files/cluster/ directory. Place the cluster configuration files (admin.kubeconfig) in the installer_files/cluster/ directory. Rename the file kubeconfig. This file may reside in the setup directory used to create the cluster. If it is not available, you can log into the cluster as admin using oc login then issue the following command.
    oc config view --minify=true --flatten=true > kubeconfig
    Note this file contains an access token that can expire. You may need to re-acquire the file if the installation procedure fails.
Configure your cluster
  1. You need to configure your cluster by modifying the installer_files/cluster/config.yaml file. You can use the OpenShift container CLI to obtain information if desired. See CLI Tools. You can use your OpenShift master and infrastructure nodes here, or install these components to dedicated OpenShift compute nodes. You can specify more than one node for each type to build a high availability cluster. After using oc login, use the command oc get nodes to obtain these values. Note that you would likely want to use a worker node.
          - your-openshift-dedicated-node-to-deploy-icp-master-components
          - your-openshift-dedicated-node-to-deploy-icp-proxy-components>
          - your-openshift-dedicated-node-to-deploy-icp-management-components>
    The value of the master, proxy, and management parameters is an array and can have multiple nodes. Due to a limitation from OpenShift, if you want to deploy on any master or infrastructure node, you must label the node as an OpenShift compute node with the following command:
    oc label node <master node host name/infrastructure node host name>
    This only needs to be done if you want the OpenShift master node and Kubernetes master node to be the same.
  2. Set the default_admin_password. The password must meet the default password enforcement rule '^([a-zA-Z0-9\-]{32,})$' . Optionally, you can define one or more rules as regular expressions in an array list that the password must pass. For example, a rule can state that the password must be longer than a specified number of characters and/or that it must contain at least one special character. The rules are written as regular expressions that are supported by the Go programming language. To define a set of password rules, add the following parameter and values to the file:
    - '^.{10,}'
    - '.*[!@#\$%\^&\*].*'
    To disable the password_rule, add (.*).
    - '(.*)'
    Note: The default admin password set in this file is used for admin access.


Once preparation completes, run the installation command from the same directory containing the config.yaml file. You can use the command docker images | grep inception to see the value used to install.

sudo docker run -t --net=host -e LICENSE=accept -v $(pwd):/installer/cluster:z -v /var/run:/var/run:z -v /etc/docker:/etc/docker:z --security-opt label:disable ibmcom/icp-inception-amd64:3.2.4 addon
Note: This process transfers the product packages from the boot node to the cluster registry. This can take several hours to complete.

Access Platform Navigator

Once installation is complete, access the IBM Cloud Pak for Integration Platform Navigator at the URL of the form https://<release-name>-<namespace>.apps.<domain>. By default, the installer uses ibm-icp4i-prod for the helm release name and integration for the namespace. For example, https://ibm-icp4i-prod-integration.apps.<domain>. The default is the admin user and default password provided in the config.yaml file.

Platform Navigator

You can deploy integration capabilities using the Platform Navigator. See Capability deployments for more information.