Overview

Skill Level: Any Skill Level

IBM Cloud Pak System comes with built-in support for automated deployment of IBM Cloud Pak for Integration. It makes it easier to deploy integration capabilities and for applications to consume integration capabilities quickly and deliver applications to market with speed.

Ingredients

IBM Cloud Pak System helps accelerate application development by automated deployment of IBM Cloud Pak for Integration using IBM Cloud Pak for Integration accelerator. It deploys OpenShift Container Platform 4.6 cluster, IBM Cloud Platform Common Services, and integration capabilities for applications to consume integration capabilities quickly and deliver applications to market with speed.

This tutorial walks you through the steps to deploy Cloud Pak for Integration V2020.3.1 on Red Hat OpenShift Container Platform V4.6 from IBM Cloud Pak System V2.3.3.3.

For the steps to deploy Cloud Pak for Integration V2020.3.1 with NFS on Red Hat OpenShift Container Platform V4.6, see this article.

Before you start with this tutorial, ensure that you have completed OpenShift Container Platform accelerator V4.6 prerequisites steps. For more information about the prerequisites, see OpenShift Container Platform accelerator V4.6.

This tutorial is based on the following assumptions:

  • The IBM Cloud Pak System is at V2.3.3.3 firmware
  • Availability of internet connectivity
  • Entitled to OpenShift Container Platform accelerator V4.6
  • Entitled to IBM Cloud Pak for Integration accelerator V2020.3.1

Before you deploy your first IBM Cloud Pak for Integration cluster on IBM Cloud Pak System, the following prerequisites need to be in place:

IBM Cloud Pak System V2.3.3.3
Intel based IBM Cloud Pak System models W2500, W3500, W3550, and W4600 are supported. There is currently no support for the Power based IBM Cloud Pak System model W3700.


IBM Cloud Pak System accelerator bundle for Red Hat Openshift V4.6.0
Cloud Pak for Integration accelerator depends on OpenShift Container Platform accelerator for deploying OpenShift Container Platform cluster in IBM Cloud Pak System. For detailed steps, see deploying Red Hat OpenShift Container Platform V4.6 in IBM Cloud Pak System V2.3.3.3.


Active subscription with Red Hat for the OpenShift Container Platform
Unlike the Red Hat subscription for RHEL and RHSS, the OpenShift Container Platform (OCP) subscription is not included with IBM Cloud Pak System. For detailed steps, see IBM Cloud Pak System Knowledge Center.


License for IBM Cloud Pak for Integration
IBM Cloud Pak for Integration license is not included with IBM Cloud Pak System. Procure it from https://www.ibm.com/account/us-en/.

IBM Cloud Pak System accelerator bundle for IBM Cloud Pak for Integration V2020.3.1
After you procure the license for IBM Cloud Pak for Integration 2020.3.1, download bundle from IBM Fix Central.

Enough compute, memory, and storage resources on IBM Cloud Pak System
Requirement for CPUs, RAM, and disk space for an instance of Cloud Pak for Integration varies with business requirement and capabilities that the instance is going to host. However, at a minimum, a single Cloud Pak for Integration cluster requires 116 virtual CPUs, 416 GB of RAM, and 3472 GB storage.

Note: IBM Cloud Pak System comes with Red Hat subscriptions for RHEL and RHSS. The IBM Knowledge Center covers these prerequisites.

Step-by-step

  1. Load and verify required artefacts on IBM Cloud Pak System V2.3.3.3

    By default, IBM Cloud Pak System V2.3.3.3 loads most of the required content on the system. The following list provides everything that you need to have in IBM Cloud Pak System before you start:

     Content artefact   Type IBM Fix Central link 
     IBM OS Image Red Hat Linux V3.1.2.0 virtual machine   Virtual Image   IBM_OS_Image_RedHat_LS_V3.1.2.0_VM-cps
     Foundation Pattern Type V2.1.18.0    Accelerator   foundation-2.1.18.0-cps
     Red Hat OS Update Service V1.0.16.0    Accelerator   rhus-1.0.16.0-cps
     Docker Pattern Type V1.0.14.0    Accelerator   docker-1.0.14.0-cps
     IBM Cloud Pak System accelerator bundle for Red Hat Openshift V4.6.0.0  
      Accelerator bundle 
     cps-openshift-4-6-0-0-intel
     IBM Cloud Pak System accelerator bundle for IBM Cloud Pak for Integration V2020.3.1.0    Accelerator bundle  cps-cloudpak4int-2020-3-1-0-intel

     
    As a next step, you must import and/or verify BYOL binaries and accelerators.

  2. Import and verify bundle

    To deploy Cloud Pak for Integration 2020.3.1, it is required to have bundle for OpenShift Container Platform V4.6. By default, these binaries are not available in IBM Cloud Pak System. To confirm this, log in to IBM Cloud Pak System and go to System > Storehouse Browser. If you do not see an entry for /admin/files/RedHatOpenShift as shown in Figure 1, then it means that the binaries have not been installed yet.

    EmptySH-2

    Figure 1

    The process for loading the binaries has been documented here in the IBM Cloud Pak System Knowledge Center.

    ./cloudpakimport.sh -h 9.xx.xx.xx -u <IBM Cloud Pak System user> -p <IBM Cloud Pak System user password>
    ***************************************************
    Cloud Pak Accelerator Bundle Import utility
    ***************************************************
    Artifacts from accelerator Bundle will be imported to Cloud Pak System
    - Testing connectivity to Cloud Pak System
    Upload Cloud Pak binaries to Storehouse
    -----------------------------------------------
    - Uploading binaries for: Red Hat OpenShift 4.6.1 on IBM Cloud Pak System
    - Pre-upload Verification
    1) openshift-install-linux-4.3.1.tar.gz: found locally but not on server
    2) openshift-client-linux-4.6.1.tar.gz: found locally but not on server
    3) ocp4.4.6-x86_64.tgz: found locally but not on server
    4) openshift-install-linux-4.4.6.tar.gz: found locally but not on server
    5) openshift-install-linux-4.6.1.tar.gz: found locally but not on server
    6) openshift-client-linux-4.4.6.tar.gz: found locally but not on server
    7) ocp4.3.1-x86_64.tgz: found locally but not on server
    8) ocp4.6.1-x86_64.tgz: found locally but not on server
    9) ocp4.3.1-x86_64-extra.tar: found locally but not on server
    10) jq-linux64: found locally but not on server
    11) openshift-client-linux-4.3.1.tar.gz: found locally but not on server
    - Uploading openshift-install-linux-4.3.1.tar.gz
    - openshift-install-linux-4.3.1.tar.gz uploaded
    - Uploading openshift-client-linux-4.6.1.tar.gz
    - openshift-client-linux-4.6.1.tar.gz uploaded
    - Uploading ocp4.4.6-x86_64.tgz
    - ocp4.4.6-x86_64.tgz uploaded
    - Uploading openshift-install-linux-4.4.6.tar.gz
    - openshift-install-linux-4.4.6.tar.gz uploaded
    - Uploading openshift-install-linux-4.6.1.tar.gz
    - openshift-install-linux-4.6.1.tar.gz uploaded
    - Uploading openshift-client-linux-4.4.6.tar.gz
    - openshift-client-linux-4.4.6.tar.gz uploaded
    - Uploading ocp4.3.1-x86_64.tgz
    - ocp4.3.1-x86_64.tgz uploaded
    - Uploading ocp4.6.1-x86_64.tgz
    - ocp4.6.1-x86_64.tgz uploaded
    - Uploading ocp4.3.1-x86_64-extra.tar
    - ocp4.3.1-x86_64-extra.tar uploaded
    - Uploading jq-linux64
    - jq-linux64 uploaded
    - Uploading openshift-client-linux-4.3.1.tar.gz
    - openshift-client-linux-4.3.1.tar.gz uploaded
    - Post-upload verification
    1) openshift-install-linux-4.3.1.tar.gz: verified successfully
    2) openshift-client-linux-4.6.1.tar.gz: verified successfully
    3) ocp4.4.6-x86_64.tgz: verified successfully
    4) openshift-install-linux-4.4.6.tar.gz: verified successfully
    5) openshift-install-linux-4.6.1.tar.gz: verified successfully
    6) openshift-client-linux-4.4.6.tar.gz: verified successfully
    7) ocp4.3.1-x86_64.tgz: verified successfully
    8) ocp4.6.1-x86_64.tgz: verified successfully
    9) ocp4.3.1-x86_64-extra.tar: verified successfully
    10) jq-linux64: verified successfully
    11) openshift-client-linux-4.3.1.tar.gz: verified successfully
    - All binaries verified successfully.
    - Verifying file
    Name: IBM_OS_Image_for_Red_Hat_Enterprise_Linux_CoreOS_16G_4_3_0.ova
    - Verifying file
    Name: IBM_OS_Image_for_Red_Hat_Enterprise_Linux_CoreOS_-_16G.ova
    - Verifying file
    Name: IBM_OS_Image_for_Red_Hat_Enterprise_Linux_CoreOS_16G_4_6_1.ova
    - Downloading CLI from Cloud Pak System
    - Starting Cloud Pak System CLI
    /
    Import and Clone Virtual Images
    ----------------------------------------
    - Checking for Virtual Image
    Name: IBM OS Image for Red Hat Linux Systems
    Version: 3.1.2.0
    - Virtual Image is available
    - Working with image
    Name: IBM OS Image for Red Hat Enterprise Linux CoreOS - 16G
    Version: 4.3.0
    - Virtual Image will be imported from
    IBM_OS_Image_for_Red_Hat_Enterprise_Linux_CoreOS_16G_4_3_0.ova
    - Waiting for import to finish. This would take few minutes.
    - Cloning the image
    Name: IBM OS Image for Red Hat Enterprise Linux CoreOS - 120G
    - Waiting for clone to finish
    - Image import completed for IBM_OS_Image_for_Red_Hat_Enterprise_Linux_CoreOS_16G_4_3_0.ova
    - Working with image
    Name: IBM OS Image for Red Hat Enterprise Linux CoreOS - 16G
    Version: 4.4.3
    - Virtual Image will be imported from
    IBM_OS_Image_for_Red_Hat_Enterprise_Linux_CoreOS_-_16G.ova
    - Waiting for import to finish. This would take few minutes.
    - Cloning the image
    Name: IBM OS Image for Red Hat Enterprise Linux CoreOS - 120G
    - Waiting for clone to finish
    - Image import completed for IBM_OS_Image_for_Red_Hat_Enterprise_Linux_CoreOS_-_16G.ova
    - Working with image
    Name: IBM OS Image for Red Hat Enterprise Linux CoreOS - 16G
    Version: 4.6.1
    - Virtual Image will be imported from
    IBM_OS_Image_for_Red_Hat_Enterprise_Linux_CoreOS_16G_4_6_1.ova
    - Waiting for import to finish. This would take few minutes.
    - Cloning the image
    Name: IBM OS Image for Red Hat Enterprise Linux CoreOS - 120G
    - Waiting for clone to finish
    - Image import completed for IBM_OS_Image_for_Red_Hat_Enterprise_Linux_CoreOS_16G_4_6_1.ova
    Import Ptypes
    ------------------------
    - Import ptype for: Red Hat OpenShift 4.6.1 on IBM Cloud Pak System
    - Working with ptype
    Name: openshift
    Version: 4.6.0.0
    - Ptype will be imported from /home/byol_openshift/openshift-4.6.0.0.tgz
    --/

    Confirm that the following files are now visible from the IBM Cloud Pak System. Go to System > Storehouse browser and confirm that you see what is shown in Figure 2.

    OCPBundleLoaded-2

    Figure 2

    Cloud Pak accelerator bundle import utility is available for OpenShift Container Platform V4.6.0.0 accelerator on IBM Cloud Pak System. It loads images to storehouse, clones the Red Hat Enterprise Linux CoreOS OVA to two variants with different disk size of 16 GB and 120 GB, and makes them available in IBM Cloud Pak System Virtual Images catalog as shown in Figure 3. In addition, it also imports the accelerator into IBM Cloud Pak System.

     

    VirtualImagesImported-2Figure 3

  3. Import and verify accelerators

    The Cloud Pak accelerator bundle import utility (described in previous step) loads the pattern type to IBM Cloud Pak System too. After it is loaded, you should see the OpenShift 4.6.0.0 accelerator in the Catalog with status available as show in Figure 4.

    OCPPtypeImported-2

    Figure 4

    IBM Cloud Pak for Integration accelerator bundle can be imported as follows:

    ./cloudpakimport.sh -h 9.xx.xx.xx -u <IBM Cloud Pak System user> -p <IBM Cloud Pak System user password>
    ***************************************************
    Cloud Pak Accelerator Bundle Import utility
    ***************************************************
    Artifacts from accelerator Bundle will be imported to Cloud Pak System
    - Testing connectivity to Cloud Pak System
    Verify Openshift binaries in Storehouse
    -----------------------------------------------
    - Verifying file
    Name: ocp4.6.1-x86_64.tgz
    - File is available in Storehouse and checksum matches
    - Verifying file
    Name: jq-linux64
    - File is available in Storehouse and checksum matches
    - Verifying file
    Name: openshift-client-linux-4.6.1.tar.gz
    - File is available in Storehouse and checksum matches
    - Verifying file
    Name: openshift-install-linux-4.6.1.tar.gz
    - File is available in Storehouse and checksum matches
    - Downloading CLI from Cloud Pak System
    - Starting Cloud Pak System CLI
    Verify Virtual Images
    ----------------------------------------
    - Checking for Virtual Image
    Name: IBM OS Image for Red Hat Linux Systems
    Version: 3.1.2.0
    - Virtual Image is available
    - Checking for Virtual Image
    Name: IBM OS Image for Red Hat Enterprise Linux CoreOS - 120G
    Version: 4.6.1
    - Virtual Image is available
    Verify Ptypes
    ------------------------
    - Checking for Ptype
    Name: openshift
    Version: 4.6.0.0
    - Ptype is available
    Import Ptypes
    ------------------------
    - Import ptype for: IBM Cloud Pak for Integration 2020.3.1 on IBM Cloud Pak System
    - Working with ptype
    Name: cloudpakforcloudintegrationplatform
    Version: 2020.3.1.0
    - Ptype will be imported from /home/byol_cloudpak4int/patterntype.com.ibm.cloudpakforcloudintegrationplatform-2020.3.1.0.tgz
    Upload Cloud Pak binaries to Storehouse
    -----------------------------------------------
    - Uploading binaries for: IBM Cloud Pak for Integration 2020.3.1 on IBM Cloud Pak System
    - Pre-upload Verification
    - All binaries verified successfully.

    Note: Only online (via entitled registry) installation of IBM Cloud Pak for Integration 2020.3.1 is supported in IBM Cloud pak System 2.3.3.3; thus, no binaries for Cloud Pak are part of bundle.

    You can verify the accelerator from IBM Cloud Pak System Console by navigating to Catalog >Pattern Types as shown in Figure 5.

    CP4I-PatternType-1

    Figure 5

  4. Examin the IBM Cloud Pak for Integration with OCS V2020.3.1.0 accelerator

    Navigate to Provision accelerators from IBM Cloud Pak System console page as shown in Figure 6.

    ProvisionAccelerators-Tile-2

    Figure 6

    Search for Cloud Pak for Integration and click Ready to deploy as shown in Figure 7. It opens a page to select Default or Customized cluster option.

    CP4I-OCS-TileSelected

    Figure 7

    For this examination, select Customized to see all the details of the accelerator on screen shown in Figure 8.

    cp4i-ocs-custom

    Figure 8

    Click Continue. The Configure deployment tab page opens.

    This page has three section.

    The first section in this page includes IBM Cloud Pak System deployment options as shown in Figure 9. For example, environment profile, cloud group, and so on. Select the appropriate values such that all prerequisites are available in the chosen cloud group.

     ConfigureDeployment-2

    Figure 9

    The second section in this page contains OS users root and virtuser credentials for helper virtual machines as shown in Figure 10.

    OCP-OCS-Parameters-Creds

    Figure 10

    The last section in this page includes an optional parameter to generate SSH key, which is used in deployment as shown in Figure 11. If you genererate this key, you can use it to connect to helper and OpenShift Container Platform virtual machines via SSH.

    ConfigureDeployment-Optional-2

    Figure 11

    Click Accelerator options to go to Accelerator options tab page.

    The Accelerator options page contains parameters for accessing IBM Cloud Pak for Integration images as shown in Figure 12.

    Entitlement key

    It is the IBM entitlement registry key obtained for Cloud Pak for Integration.

    Entitlement registry

    It is the entitlement registry from where Cloud Pak for Integration images will be pulled.

    Entitlement registry user

    It is the user id that is used to obtain the key from entitlement registry.

    IBM Eventstreams operator channel

    It is the channel from which IBM Eventstreams operator should be deployed.

    IBM MQ operator channel

    It is the channel to deploy IBM MQ operator.

    Platform Navigator operator channel

    It is the channel for deploying platform navigator operator.

    IBM API Connect operator channel

    It is the channel from which API Connect operator should be deployed.

    CP4I-OCS-AcceleratorOptions

    Figure 12

    Click Configure nodes to open the Configure nodes tab page.
    This page shows type of VMs, such as helpers, control planes and worker nodes, which are included in the accelerator and hardware resource configuration for each virtual machine as shown in Figure 13 and Figure 14. You can change the resource configuration of all nodes in a cluster to be deployed. Use slider, as shown in Figure 13, to set the desired value for each resource type of virtual machines.

     CP4I-ConfigureNodes-2

    Figure 13

    Note: You cannot change the number of masters to be deployed as Red Hat recommends deploying three masters for OpenShift Container Platform 4 clusters.

     CP4I-ConfigureNodesAdvanced-1

    Figure 14

    Click OpenShift options to open the OpenShift options tab page. This page shows OpenShift Container Platform parameters for the deployment of IBM Cloud Pak for Integration accelerator as shown in Figure 15 and Figure 16. For detailed description of parameters, see this page.

    OpenShift version

    It is the Red Hat OpenShift Container Platform version to deploy.

    OpenShift cluster domain name

    It is the domain name for Red Hat OpenShift Container Platform cluster. If not specified, then a default cluster domain name is generated.

    OpenShift cluster name

    It is the Red Hat OpenShift Container Platform cluster name. If not specified, then a default cluster name is generated.

    OpenShift image registry name

    It is the fully qualified name for the Red Hat OpenShift Container Platform image registry. In case there is no Cloud Pak System Registry available in cloud group or you wish to use a different docker registry for accessing OpenShift Container Platform images, specify <registry hostname:port> here.

    OpenShift image registry username

    It is the username needed to access the Red Hat OpenShift Container Platform secure image registry.

    OpenShift image registry password

    It is the user password needed to access the Red Hat OpenShift Container Platform secure image registry.

    OpenShift pull-secret

    If access to external OpenShift registry is available and you wish to use it for OpenShift Container Platform images, paste the contents of the downloaded OpenShift install pull-secret.json file here.

     CP4I-OCP-Paramaters1-1

    Figure 15

    Click Review and deploy to open Ready to deploy tab page. This page shows a summary of topology and resource configuration as shown in Figure 16.

     cp4i-ocs-clickdeploy

    Figure 16

    Here is a quick overview of the different types of VMs included in cluster:

    Primary Helper and Secondary Helper
    There are two Helper nodes that run on RHEL 7.8. It supports the deployment of OpenShift cluster on virtual machines that run on Red Hat Core OS. The Helper node provide services for the OpenShift Cluster as documented in the OpenShift 4 documentation: Helper Git Repository and Helper Blog. IBM implements two Helper virtual machines and uses a floating IP address to provide high availability for these services.

    Bootstrap
    There is one Bootstrap node that is used to install the OpenShift Container Platform control plane on the master nodes. It is only used during the bootstrapping of OpenShift Container Platform. Eventually, this virtual machine is destroyed and the resources are released.

    Master
    There are three master nodes deployed on virtual machines that run Red Hat Core OS. OpenShift 4 requires three master nodes, ensuring high availability and quorum of essential Kubernetes services like etcd.

    Worker
    By default, four worker nodes are deployed on virtual machines that run Red Hat Core OS. This ensures high availability of containers running on those worker nodes. Depending on the needs for your IBM Cloud Pak for Integration cluster, you could opt for a higher number of worker nodes or worker nodes with more cpu and memory. Starting from IBM Cloud Pak System V2.3.3.3, it is possible to add additional worker nodes to your IBM Cloud Pak for Integration cluster after deployment (horizontal scaling).

    StorageWorker
    By default, three storage worker nodes are deployed on virtual machines that run Red Hat Core OS. These nodes run Red Hat OpenShift Container Storage cluster. Depending on the needs for your IBM Cloud Pak for Integration cluster, you could opt for a higher number of storage worker nodes. Starting from IBM Cloud Pak System V2.3.3.3, it is possible to add additional Storage worker nodes to your IBM Cloud Pak for Integration cluster after deployment (horizontal scaling), however, user must add nodes to the OCS cluster manually.

    As shown in the following table, by default, a single Cloud Pak for Integration cluster requires 116 virtual CPUs, 416 GB of RAM, and 3472 GB of storage default OCS as persistent storage. Depending on the number and sizing of the worker nodes, the amount of resources required could be higher.

    IBM Cloud Pak for Integration

      VM  Number  OS  virtual CPUs   RAM (GB)   storage (GB) 
      Primary Helper  1  Red Hat Enterprise Linux 7.8  4  16  412
      Secondary Helper  1  Red Hat Enterprise Linux 7.8  4  16  12
      Bootstrap  1  Red Hat CoreOS 4.6  4  16   120
      Master  3  Red Hat CoreOS 4.6  8  16  120
      Worker  4  Red Hat CoreOS 4.6  8  32  120
      StorageWorker  3  Red Hat CoreOS 4.6  16  64  630
      Total  13  –  116  416  3472
  5. Deploy IBM Cloud Pak for Integration with OCS V2020.3.1.0 accelerator

    With all the previous steps completed, you are now ready to deploy your first Cloud Pak for Integration V2020.3.1 cluster!

    Go to Cloud Pak System console https://<ICPS_system_IP>/cps/ and log in. You will see the Getting started page. Click Provision accelerators as shown in Figure 17.

    You should see Provision accelerators page. 

    Search for Cloud Pak for Integration with OCS and click Ready to deploy as shown in Figure 18.

     CP4I-OCS-TileSelected

    Figure 18

    User can deploy Cloud Pak for Integration with default or customized configuration.

    By default, IBM Cloud Pak for Integration version is set to 2020.3.1.
    Select the Default or Customized option based on your requirement.

    Default deployment

    Default deployment deploys Cloud Pak for Integration cluster by using the already configured values with minimum hardware. To deploy default cluster, select Default as shown in Figure 19.

     cp4i-ocs-default

    Figure 19

    Customized deployment

    Customized deployment enables you to configure a cluster as per business use case. It provides a way to change hardware specification for the Cloud Pak for Integration cluster. To deploy Customized cluster, select Customized on screen as shown in Figure 20 and continue.

     cp4i-ocs-custom

    Figure 20

    Refer to section ‘Examining the IBM Cloud Pak for Integration V2020.3.1 accelerator‘ about how to customize deployment. 

    For this deployment flow, select Default and click Continue to open Configure deployment page as shown in Figure 21.

    This has three sections.

    The first section on page shows environment profile, cloud group, and IP group for deployment. Select appropriate values based on where RHUS and Cloud Pak system registry shared services are running.

     ConfigureDeployment-2

    Figure 21

    In the Helper node credentials section, specify password for root and virtuser for helper virtual machines  and pull-secret for pulling OpenShift Container Storage images as shown in Figure 22.

     CP4I-OCP-Paramaters1-1

    Figure 22

    In the Optional section, specify a SSH key as shown in Figure 23. It is used to connect to helper VMs via SSH post deployment. If not specified, a default key is generated and used.

     ConfigureDeployment-Optional-2

    Figure 23

    Click Accelerator options to open the Accelerator options tab page.

    In the Accelerator options page, specify following parameters as shown in Figure 24:

    Entitlement key

    Entitlement registry

    Entitlement registry user

    IBM Eventstreams operator channel

    IBM MQ operator channel

    Platform Navigator operator channel

    IBM API Connect operator channel

     CP4I-OCS-AcceleratorOptions

    Figure 24

    Click Review and deploy.

    Review cluster topology and other values.

    Click deploy as shown in Figure 25 to deploy a cluster.

     cp4i-ocs-clickdeploy

    Figure 25

    Within seconds you should see a message indicating deployment has started as shown in Figure 26.

    Click Manage accelertor instances to go to the Manage accelerator instances page.

    CP4I-OCS-popup

     

    Figure 26

    As shown in Figure 27, deployment starts and the cluster status is in launching state.

     ManageAcceleratorPage-2

    Figure 27

    It takes approximately 120 minutes to deploy Cloud Pak for Integration cluster. After it is deployed, you should see an instance as shown in Figure 28.

     CP4I-OCS-Instance

    Figure 28

    Review history section of the instance for the required post deployment actions.

    Upon completion, review messages in the History section for instructions to retrieve the admin password for Cloud Pak for Integration capability. You must complete several post deployment actions before you access the consoles of the capabilities.

     

  6. Post deployment actions

    Before you can use the IBM Cloud Pak for Integration 4 Cluster, few more steps are required as documented in step 6 of Getting started with OpenShift Container Platform 4.x pattern.

    Review the History section for the next steps as shown in Figure 29.

     CP4I-OCS-History

    Figure 29

    A. Retrieve the password for kubeadmin

    The kubeadmin password gets generated during the installation of OpenShift 4. Retrieve kubeadmin password by providing root password for Helper VM as shown in Figure 30.

     CPS-getKubeadminPassword-2

    Figure 30

    B. Configure your DNS server

    Set up the following two DNS wildcard entries for the floating IP address and fully-qualified domain name of your OpenShift 4 Virtual System Instance. This is required to access the OpenShift web-console, applications, and APIs.

    *.<fqdn> IN A <ip>
    *.apps.<fqdn> IN A <ip>

    In the case of our OpenShift 4 cluster here, the floating IP address is ocp_cluster_ip with corresponding fully-qualified domain name cps-rack-79-vm-12.rtp.raleigh.ibm.com. So we would need the following DNS wildcard entries configured:

    *.apps.cps-rack-xx-vm-65.xxx.xxx.xxx.xxx IN A x.xx.xx.15
    *.cps-rack-xx-vm-65.xxx.xxx.xxx.xxx IN A x.xx.xx.15

    If you are unable to easily make changes to your DNS server, you can add the following entries to your local /etc/hosts file (or equivalent on Windows) for testing purposes. This will allow you to log in to the OpenShift console, but note that you would need additional entries for any applications you would deploy later.

    ocp_cluster_ip console-openshift-console.apps.cps-rack-xx-vm-65.xxx.xxx.xxx.xxx oauth-openshift.apps.cps-rack-xx-vm-65.xxx.xxx.xxx.xxx minimal-prod-ibm-es-ui-es.apps.cps-rack-xx-vm-65.xxx.xxx.xxx.xxx

    You can find more information about OpenShift external DNS requirements here. The DNS records listed as “This record must be resolvable by both clients external to the cluster …” are required. DNS is also provided on the Helper Nodes to cover the resolution inside the cluster.

    If you are able to configure DNS records up front, then the cluster console link will be immediately accessible. Configuring DNS ahead of time is the recommended approach for deploying OpenShift Container Platform clusters on Cloud Pak System. You would need to create the following records in your DNS server for each IP in the IP group you are using to deploy (so that any IP that is selected from the IP group to be the floating IP for the cluster will already have wildcard entries associated with it in DNS):

    *.sub.domain IN A <ip>
    *.mycluster.sub.domain IN A <ip>
  7. Access your cluster

    You can now access your IBM Cloud Pak for Integration cluster using the console links shown in Figure 31.

     CP4I-ConsoleLinks-1

    Figure 31

    Log in with the username kubeadmin and the password you retrieved earlier as shown in Figure 32 for OpenShift Container Platform console.

    CPS-LoginToOCP-2

    Figure 32

    After you log in, you will see the console as shown in Figure 33.

     CPS-OCPConsole-2

    Figure 33

    Log in to the different IBM Cloud Pak for Integration capabilities using the respective links under Consoles section as shown in Figure 31. You will need to retrieve the password for individual capabilities following instructions logged on to history as shown in Figure 29. Based on capabilities that you selected at start of deployment, you will see console links and password retrieval instructions.

    Figure 34 shows Platform navigator console after a successful cluster deployment.

     CP4I-PN-1

    Figure 34

    Figure 35 shows IBM MQ console after a successful cluster deployment.

     CP4I-MQ-1

    Figure 35

    Figure 36 shows IBM Event Streams console after a successful cluster deployment.

     Cp4I-ES-1

    Figure 36

    Figure 37 shows IBM API Connect console after a successful cluster deployment.

     CP4I-APIC-LoggedIn

    Figure 37

  8. Verify your cluster

    Inspect your cluster from IBM Cloud Pak Console > Manage accelerator instances

    A. Verify topology

    In the IBM Cloud Pak Console > Manage accelerator instances, click Nodes for the deployed instance as shown in Figure 38. You can verify cluster topology and virtual machines deployed as part of instance.

     CP4I-OCS-Nodes

    Figure 38

    B. Verify middleware roles

    In the IBM Cloud Pak Console > Manage accelerator instances, click Middleware for the deployed instance as shown in figure 39, you can verify cluster topology and VMs deployed as part of the instance.

     CP4I-mw-1

    Figure 39

    Note: Do not stop/restart cluster or any nodes until after 24 hours of deployment. Failing to do so may render your cluster into a broken state without recovery. Refer this page for more details.

  9. Register your Red Hat OpenShift cluster with Red Hat

    Finally, do not forget to register your OpenShift cluster with Red Hat. This manual step is required if your OpenShift cluster does not have internet access to reach Red Hat. You can follow step 4 here to register your cluster on the “Cluster registration” page.

  10. Next steps

    You can continue to add instances of integration capabilities that you are interested in from the Cloud Pak for Integration console within minutes.

    Now, you are also ready for day 2 operations on your cluster. Please see this article for day 2 cluster operations in IBM Cloud Pak System.

  11. Conclusion

    IBM Cloud Pak System V2.3.3.3 along with Cloud Pak accelerators (December 2020 release) enable you to quickly roll out one or more IBM Cloud Pak for Integration clusters. It enables quick deployment of integration capabilities and consumption by application developers. The automation simplifies the prerequisites setup, OCP cluster deployment, IBM Cloud platform Common Services, and deployment of Cloud Pak for Integration’s capabilities in IBM Cloud Pak System providing consistent repeatability and quick turnaround.

    I would like to thank Sanjeev Pradhan for his help in writing this article.

    Acronyms

    Abbreviation   Definition 
     ICPS  IBM Cloud Pak System
     CPS  IBM Cloud Pak System
     OCP  Red Hat OpenShift Container Platform
     accelerator  IBM Cloud Pak accelerators, also known as IBM Cloud Pak patterns
     CPSa  IBM Cloud Pak accelerators, also known as IBM Cloud Pak patterns
     RHEL  Red Hat Enterprise Linux
     RHUS  Red Hat OS Update Services
     RHSS  Red Hat Satellite Server
     CP4I  IBM Cloud Pak for Integration
     OCS  Red Hat OpenShift Container Storage
     CoreOS  Red Hat Core OS

Join The Discussion