Cloud Pak for Business Automation

 View Only

Technical Recipe: CP4BA Deployment Methodologies – IBM Cloud & TechZone Part-1

By Brahm Singh posted Mon February 13, 2023 03:33 AM

  
“CP4BA Deployment Methodologies – IBM Cloud & TechZone”
IBM Cloud Pak for Business Automation (CP4BA)
Part-1

AUTHOR

Brahm Singh, IBM Automation Architect.

Ecosystem Engineering – SI Lab (ISL Ahmedabad)

Email – brahm.singh@ibm.com

ABSTRACT

IBM Cloud Pak for Business Automation deployment methodology describes how to deploy the CP4BA components like Business Automation, Decision Services, etc., on IBM OpenShift platform as well as other cloud platforms like AWS, and Azure. CP4BA deployment provides a better and smooth platform where DevOps or even Dev team can deploy their capabilities with help of automation techniques.

In CP4BA deployment, we have a hybrid cloud deployment feature which makes it more powerful rather than other competitors. We leverage OpenShift Cloud platform (PaaS) to perform the deployment task for CP4BA.

INTENDED AUDIENCE

This blog is intended for Developers and Architects who deal ( or will deal) with any of the following situations: 

  • Developers planning to move to a career in IT Architecture
  • Architects involved with defining solution architecture
  •  Professionals involved in Pre-sales and Solution proposals

    

INTRODUCTION

IBM CP4BA helps to automate business operations with an integrated platform of automation capabilities. The platform relies on Kubernetes, which is open-source application container orchestration software that makes it easier to configure, deploy, and manage containerized applications. It is designed to help all types of projects small and large, improve employee productivity, and deliver better end-to-end customer journeys while you reduce the burden of governing your content and processes. It can increase your ability to scale and do more work faster and better.

Image Credits:  IBM Cloud Pak for Business Automation

       Cloud Pak for Business Automation (CP4BA) and its features and capabilities help to improve business growth and provide rapid automation

  •        Resolve client issues and provide a single platform where end-to-end solutions
  •         Provide solutions to reduce repetitive tasks and human error-free process
  •       CP4BA core capabilities like Document Processing, Workflow, Decision Management, and Content Services helps the client to reduce manual process  and also provide a better solution in terms of more accurate document processing, sequential activities, case management, and improvement and assist to make better decision making
  •        CP4BA accelerators help improve business growth and accelerate the speed like Operational AI to provide dashboard capability, Process Mining optimizes the current process based on events logs and assists in the improvement of scope and make better resource utilization.

DEPLOYMENT METHODOLOGIES

      We can deploy CP4BA components using the following methodologies for IBM Cloud and TechZone.

     

 

                                                                                                                                   (Deprecated)

       In all deployment methodologies, we have required a common pre-requisite checklist for CP4BA deployment

  •           At least one cloud Infrastructure like IBM Cloud, IBM TechZone, and other clouds.
  •        Basic understanding of container & containerization, docker, terraform CI/CD tools, YAML, etc.
  •        Cloud user account and Entitlement key of cloud account.
  •        Basic understanding of RedHat OpenShift platform.
  •        GitHub Account to access the CP4BA deployment-related content. 
  •        Tools required like text editor Visual Studio Code, Docker Desktop, IBM Cloud CLI, and GitHub Desktop (Optional).
  •        Request reserve an environment in IBM TechZone with the latest OpenShift version like 4.10 and above.
  •       OpenShift Cluster size depends on business needs for starter or production environment deployment of CP4BA required different sizes of a cluster, storage, worker nodes, etc.
  1.       Manual Deployment Process

       In the manual deployment method, we need to follow certain steps and configurations to perform the CP4BA deployment in IBM OpenShift platform.

       First of all, we need to make sure common pre-requisite checklist before starting the deployment of CP4BA. Then perform bellow steps

  •         Once we get the confirmation of OpenShift environment is ready then go to OpenShift Admin console as an Administrator role.
  •        Create a new project i.e. cp4ba.
  •        We Need to create pre-requisite secretes i.e., admin.registrykey and ibm-entitlement-key inside the cp4ba project.  
  •        Steps how to create secrets
  • Click the Projects option from the left menu option as shown below figure.

                                                   Image Credits:  IBM RedHat OpenShift Admin Console

  • Go to the inventory section from overview tab section of cp4ba project and click on Secretes Click to Create Select Image pull secret option and entered the required fields like

                                        Image Credits:  IBM RedHat OpenShift Image Pull Secret Creation Form

For admin.registrykey Secret

Secret Name - admin.registrykey,

Registry server address – cp.icr.io,

Username – cp

Password – IBM Entitlement Key

Email – Current User Email Id

For ibm-entitlement-key Secret

Secret Name - admin.registrykey,

Registry server address – cp.icr.io,

Username – cp

Password – IBM Entitlement Key

Email – Current User Email Id

  •            We need to create a service account using IBM CLI.
  • Click on the main menu top right side user name and select the option Copy login command as shown below figure, and generate a dynamic token to access the environment via the command line or terminal from the local system. 
Image Credits:  Login token generation
  •  When we click on to Copy login command, it will redirect to a new tab or browser window and here we have the  Display Token link need to click to generate an access token.
  • Once the token is generated, copy the oc login command below as shown in the below figure.

Image Credits:  Access API token

  •    Open a terminal (Mac System) or command line (Windows), paste the access token command, and run. Make sure OpenShift CLI command is already installed on your local system otherwise follow the below link

https://docs.openshift.com/container-platform/4.8/cli_reference/openshift_cli/getting-started-cli.html

  •    Create the ibm-cp4ba-anyuid service account (SA) in a service-account-for-starter.yaml file.

Image Credits:  Service Account for CP4BA

  •    Apply the service account to the target namespace using the terminal or command line. Where the ${NAMESPACE} is the namespace where you want to install the deployment.

Image Credits:  Service Account creation command for CP4BA

  •    Bind the security context constraints (SCC) to control the actions the SA can take and what it can access.

                      Image Credits:  Service Account role and policy apply command

  •            After successful secrets and service account creation then need to install the catalog for CP4BA in OperatorHub.
  •    Go to support page and select the current release like 22.0.2 as shown below figure.

           (Please skip this step if Operator Catalog is already there in Operator Hub)

Image Credits:  IBM Support Page for CP4BA

  •    Click to interim fix the latest version like IF001 and inside this need to copy all catalogs as shown below figure.

             (Please skip this step if Operator Catalog is already there in Operator Hub)

Image Credits:  IBM Catalog for CP4BA

  •    Go Back to IBM OpenShift admin console and click on  + icon from the menu option as shown below figure and paste the copied IBM catalog for CP4BA and click on to create button to install the CP4BA catalog.  (Please skip this step if Operator Catalog is already there in Operator Hub)

    Image Credits:  IBM import catalog for CP4BA

  •         After the successful catalog installation, we can see it in OperatorHub and select the Business Automation option from the All Items menu option then click on IBM Cloud Pak for Business Automation(CP4BA) multi-pattern operator catalog as shown below figure. 

Image Credits:  IBM OpenShift Admin Console OperatorHub

  •    After clicking CP4BA multi-pattern it will open a new popup window, here we can see an overview of Cp4BA and pre-requisite for CP4BA, storage required info, and documentation link of CP4BA. Click on to install button as shown in the below figure.

Image Credits:  IBM OpenShift Admin Console CP4BA multi-pattern operator-catalog

  •    When we click the install button it will open a new form, where we need to choose Installation mode A specific namespace on cluster i.e. cp4ba, and click to install button of the form to trigger the installation of CP4BA operator catalog into CP4BA project.

Image Credits:  IBM CP4BA multi-pattern operator-catalog form

  •    Once CP4BA operator installation triggers it will take 5-10 minutes depending on network speed. After the operator catalog installation, it will show the installed operator in the Installed Operators section as shown below figure.

     Image Credits:  IBM CP4BA installed operators

  •    Meanwhile, it will create another project i.e., ibm-common-services, which will take care of required necessary dependencies of CP4BA like IBM Cloud Pak Foundational Services (Common Service).

Image Credits:  IBM Common Service installed operators

  •          Once we ensured all CP4BA & IBM Common Services operators install successfully then we required a custom resource (CR) YAML file for CP4BA       component deployment. We can access the Custom Resource file from the below location and select the latest CR.

https://github.ibm.com/jgoodhue/cp4ba-roks-install/tree/master/CR-files

  •  Custom resource YAML file having below properties

o   CP4BA version information

o   Namespace i.e. cp4ba

o   Specification for CP4BA components like BAW, ODM, etc which feature we can enable

o   Container image repository URL, tag (version) for CP4BA components

o   Open LDAP, DB2 repository URL, tag (version)

o   Deployment types like starter or production

o   Storage classes configuration used in CP4BA

o   Deployment pattern

o   Image pull-secrets

o   IBM License acceptance status

o   CP4BA component deployment status once it will be installed successfully.

  •        After getting the custom resource (CR) YAML file, we need to apply this CR file to our cp4ba project as we did same for catalog installation using + sign from the menu option. Once it is installed, we can see in installed operators section that inside installed operator needs to click on the CP4BA deployment option and it will create a cluster instance i.e., icp4deploy. Then we need to click on icp4deploy and it will redirect to it Details tab where can see CP4BA deployment overview, in the second tab YAML we can verify the CR file which we applied earlier. 

Image Credits:  IBM CP4BA deployment cluster instance

  •           We have done all necessary steps and configuration for CP4BA manual deployment. We need to wait approx. 3-4 hours based on network speed to    execute all backend activities and monitor the deployment. Once all activities have been completed then we can follow the below steps to verify the   CP4BA deployment and access the components.

o   Go to Projects from the left menu option then select cp4ba project.

o   Go to inventory section click to ConfigMaps option

o   Inside ConfigMaps search icp4adeploy-cp4ba-access-info

o   In icp4adeploy-cp4ba-access-info   go to bastudio-access-info section and access the Cloudpak Dashboard URL, username, and password and it will re-direct to BA studio portal where we can access CP4BA installed components like Business Automation.

REFERENCES:

Other Useful Blogs

CP4BA Deployment Methodologies – IBM Cloud & TechZone Part-2 (Automation Script)

Automation Script

How to automate deployment?

https://community.ibm.com/community/user/automation/blogs/brahm-singh/2022/09/15/how-to-automate-deployment

4 comments
160 views

Permalink

Comments

Wed February 15, 2023 06:56 AM

@Ela Dixit Thank you Ela. We can use it and make easier our Cp4BA deployment process.

Wed February 15, 2023 06:51 AM

Nice content shall make use of it when engage with our SI's. Thanks Brahm

Wed February 15, 2023 05:28 AM

@Vivek Satwal Thanks for encouraging me.

Tue February 14, 2023 12:10 AM

Very useful content. Great job Brahm !!!