• Scenario 1: You are deploying a Starter deployment
  Actions: Starter deployments do not support upgrades. Although you can use this interim fix content to perform a Starter deployment.  To deploy a Starter deployment using the content of this interim fix, please see install a new Starter environment and use the CASE package from this interim fix.
• Scenario 2: You are deploying a Production deployment

  Actions: You can use this interim fix content to perform a Production deployment.  To deploy a Production deployment using the content of this interim fix, please see install a new Production environment and use the CASE package from this interim fix.
• Scenario 3: You already have a Production deployment installed with 22.0.1 GA or 22.0.1 + any interim fix prior to this one, and now you want to install another Production deployment using this interim fix on the same Openshift cluster.
  Actions: If you have existing production deployment with 22.0.1 GA or 22.0.1 + any interim fix prior to this one and you want to install another production deployment of this interim fix using pinned catalogs you need to be aware that when applying the catalog sources from this interim fix on the Openshift cluster, the existing production deployment of CP4BA will also be updated to this interim fix.
• Scenario 4: Your installation is version 21.0.3-IFxxx and you're not using pinned catalog
  Actions: If you are using 21.0.3-IFxxx and not pinned catalogs, then your deployment is automatically updated to the latest interim fix of 21.0.3 in the v21.3 channel. To change this behavior , please follow Upgrading operators that are not pinned instructions.
• Scenario 5: Your installation is version 21.0.3-IFxxx and you're using pinned catalog (note that pinned catalog was available with 21.0.3-IF007 or later)
  Actions: If your installation is 21.0.3-IFxxx and using pinned catalogs, then you must upgrade the operators for all of the Cloud Pak operators to 22.0.1-IF001. You can use the OpenShift console or the command line, please follow Upgrading operators that are pinned instructions.
• Scenario 6:  Your installation is online and 22.0.1 GA.
  Actions:  If you are using version 22.0.1 then you just need to apply below updated catalog sources and does not require to execute update_subscription.sh script to change the subscription. 
  1. Apply the catalog sources to pin to the specified versions for IBM Automation Foundation, IBM Foundational Services with Cloud Pak for Business Automation.
     You can apply the catalog sources below from a command line by creating a YAML file (for example, cp4ba_catalog_sources.yaml) with the catalog sources below and performing "oc apply -f cp4ba_catalog_sources.yaml", or you can apply the catalog sources using the OCP console
     Note, you can apply only one catalog source at a time using the OCP console. 
     Note:  The DB2, IBM Business Team Service, and Postgres catalog sources are dependent components of Cloud Pak for Business Automation.

     # CP4BA 22.0.1 IF001 catalog
     apiVersion: operators.coreos.com/v1alpha1
     kind: CatalogSource
     metadata:
       name: ibm-cp4a-operator-catalog
       namespace: openshift-marketplace
     spec:
       displayName: ibm-cp4a-operator
       publisher: IBM
       sourceType: grpc
       image: icr.io/cpopen/ibm-cp-automation-catalog@sha256:e595868ec426bfba2409878b86fa3398a0680b5c725cff212469068ce8824202
       updateStrategy:
         registryPoll:
           interval: 45m
     ---
     # IBM Automation Foundation Base 1.3.7
     apiVersion: operators.coreos.com/v1alpha1
     kind: CatalogSource
     metadata:
       name: ibm-cp-automation-foundation-catalog
       namespace: openshift-marketplace
     spec:
       displayName: IBM Automation Foundation Operators
       publisher: IBM
       sourceType: grpc
       image: icr.io/cpopen/ibm-cp-automation-foundation-catalog@sha256:267bbc17bad1966be259bb9a6951c520c6fb824bfa42bbec22570ba49883d4ae
       updateStrategy:
         registryPoll:
           interval: 45m
     ---
     # IBM Automation Foundation Core 1.3.7
     apiVersion: operators.coreos.com/v1alpha1
     kind: CatalogSource
     metadata:
       name: ibm-automation-foundation-core-catalog
       namespace: openshift-marketplace
     spec:
       displayName: IBM Automation Foundation Core Operators
       publisher: IBM
       sourceType: grpc
       image: icr.io/cpopen/ibm-automation-foundation-core-catalog@sha256:5502c003afe7a0590ce123c3bbbd76e46374af641b3a210e3c25cfe2381e4647
       updateStrategy:
         registryPoll:
           interval: 45m
     ---
     # IBM Cloud Foundational Services 3.19.0
     apiVersion: operators.coreos.com/v1alpha1
     kind: CatalogSource
     metadata:
       annotations:
         bedrock_catalogsource_priority: '1'
       name: opencloud-operators
       namespace: openshift-marketplace
     spec:
       displayName: IBMCS Operators
       publisher: IBM
       sourceType: grpc
       image: icr.io/cpopen/ibm-common-service-catalog@sha256:87904dee339ee4bbcbdc07949abc8df82bf6d85706f90795e6dae5e45f876b19
       updateStrategy:
         registryPoll:
           interval: 45m
       priority: 100
     ---
     # IBM Business Teams Service version 3.19.0
     apiVersion: operators.coreos.com/v1alpha1
     kind: CatalogSource
     metadata:
       annotations:
         bedrock_catalogsource_priority: '1'
       name: bts-operator
       namespace: openshift-marketplace
     spec:
       displayName: BTS Operator
       publisher: IBM
       sourceType: grpc
       image: icr.io/cpopen/ibm-bts-operator-catalog@sha256:68596113ad291b36b78d53207f73b53691f9f0154a21f38c717c08a0100deb9f
       updateStrategy:
         registryPoll:
           interval: 45m
     ---
     # Cloud Native PostgresSQL 4.0.8
     apiVersion: operators.coreos.com/v1alpha1
     kind: CatalogSource
     metadata:
       annotations:
         bedrock_catalogsource_priority: '1'
       name: cloud-native-postgresql-catalog
       namespace: openshift-marketplace
     spec:
       displayName: Cloud Native Postgresql Catalog
       publisher: IBM
       sourceType: grpc
       image: icr.io/cpopen/ibm-cpd-cloud-native-postgresql-operator-catalog@sha256:f3feb39b0dfb444a46d99a9cd160c616f8548d84d452cbc89e4985f0a2574486
       updateStrategy:
         registryPoll:
           interval: 45m
       priority: 100

  2. Update the existing subscriptions of Cloud Pak for Business Automation, Automation Foundation, and Cloud Pak Foundational Services to change from IBM Operator Catalog to the individual catalogs applied above.
     1. Find the update_subscription.sh script from the extracted CASE package under "../ibm-cp-automation/inventory/cp4aOperatorSdk/files/deploy/crs/cert-kubernetes/scripts" Note, at the root of the CASE package is a nested archive that needs to be extracted as well.
     2. Log in to your OCP cluster as a cluster administrator
     3. Execute the update_subscription.sh -n <your cp4ba namespace>
        Note, at this point, the environment will be updated to use the new "pinned" catalogs. Your environment will no longer auto-update the operators when new versions are released.
  3. If you have any subscriptions set to manual, then you need to approve any pending operator updates.
     If some of the many operator updates are not approved, it is not recommended to set subscriptions to manual, this makes the upgrade more error prone . By default all subscriptions are set to automatic.
• Scenario 7:  Your installation is air gap and 22.0.1
  Actions: Follow the steps below on the bastion host where you previously deployed 22.0.1:
  1. Set up the environment variables for CASE. 

     • export CASE_NAME=ibm-cp-automation 
     • export OFFLINEDIR=/tmp/cp4ba2201-if001
     • export CASE_VERSION=4.0.1
     • export CASE_INVENTORY_SETUP=cp4aOperatorSetup 
     • export CASE_ARCHIVE=${CASE_NAME}-${CASE_VERSION}.tgz 
     • export CASE_LOCAL_PATH=${OFFLINEDIR}/${CASE_ARCHIVE}
       
       Note: The values are specific to the interim fix, however, you can choose a different empty directory for the OFFLINEDIR if you need to put the files somewhere else.
  2. Save this specific set of case packages

     cloudctl case save --case docker://icr.io/cpopen/ibm-cp-automation-case-cache@sha256:87034c0d212e5a775cedff48cbaeaab0820546c5a14e96fa8335253dff6474ce --outputdir ${OFFLINEDIR}

     Once the command completes, all the Case archive and inventory are saved under /tmp/cp4ba2201-if001.
  3. Mirror the entitled registry images to the local registry by completing the same steps used during installation. For more information about mirroring, see Mirroring images to the private registry.
     Make sure to use the CASE image OFFLINEDIR (/tmp/cp4ba2201-if001) from step 1.
  4. Update the catalog with the new version by running the install-catalog action.

     cloudctl case launch \
     --case ${OFFLINEDIR}/${CASE_ARCHIVE} \
     --inventory ${CASE_INVENTORY_SETUP} \
     --action install-catalog \
     --namespace ${NAMESPACE} \
     --args "--registry ${LOCAL_REGISTRY} --inputDir ${OFFLINEDIR} --recursive" 

  5. If you have any subscriptions set to manual, then you need to approve any pending operator updates.
     If some of the many operator updates are not approved, it is not recommended to set subscriptions to manual as it can make the upgrade more error prone. By default all subscriptions would be set to automatic.
  After the operators are upgraded, it will trigger the upgrade of the related deployments and pods. See the items mentioned in "Performing the necessary tasks after installation" for more actions that can be needed after the upgrade is completed.

Performing the necessary tasks after installation

1. Update Kafka certificates when you are using Business Automation Insights
   If you are using Business Automation Insights and upgrading from an IBM Automation Foundation version before 1.3, the operator will fail to become ready after the upgrade, and kafka/zookeeper pods show SSL errors. To resolve the issue, follow the "To renew the leaf certificates for Kafka" instructions in Changes to CA certificate and key does not automatically rotate Kafka leaf certificates.
2. Review the installation
   It is recommended that you review the CR yaml status section and operator logs after the upgrade to ensure there are no failures preventing your pods from upgrading.

   oc get icp4acluster -o yaml > CP4BAconfig.yaml
   oc logs deployment/ibm-cp4a-operator -c operator > operator.log

   If you are interested in verifying the expected image digest for a particular image, then you can review the ibm-cp-automation\inventory\cp4aOperatorSdk\resources.yaml file in the CASE package. This file has a listing of the images managed by the CP4BA operator and their expected digest for this particular interim fix level.
3. Required when you are using Workflow Process Service OCP deployment
   If you used any individual image tag settings in your WfPSRuntime CR, it could prevent the operator from updating the images to the appropriate version. Ensure you remove any of these settings when you upgrade.
4. Required when you are using Workflow Process Service Docker Compose Edition
   1. Follow the step 2 of section "3. Running your environment" in Installing Workflow Process Service to log in to the entitled registry with your entitlement key.
   2. Back up your database backup, docker-compose.yml and folder for docker volumes “production_workflow_runtime_data” and “production_workflow_runtime_logs”.
   3. (Optional) Push the images to your docker registry. Log in to your docker registry, and push the docker images into your docker registry by using the following commands:

      docker login <server>
      docker tag cp.icr.io/cp/cp4a/workflow-ps/workflow-ps-server:<tag> \
       <server>/workflow-ps-server:<tag>
      docker tag cp.icr.io/cp/cp4a/workflow-ps/workflow-ps-authoring:<tag> \
       <server>/workflow-ps-authoring:<tag>
      docker push <server>/workflow-ps-server:<tag>
      docker push <server>/workflow-ps-authoring:<tag>

      Where <server> is the host of the docker image registry that you want to use to pull the images. For example, myregistry.local:5000 or localhost:8080 for a self-hosted registry. Also, replace <tag> with the corresponding tag matching this interim fix's tag in the form of <release>-IFxxx, for example, 22.0.1-IF001.
   4. Run docker-compose down command to stop the Workflow Process Server container.
   5. Update the image url's tags in docker-compose.yml.

      <server>/workflow-ps-server:<tag>
      <server>/workflow-ps-authoring:<tag>

      Where <tag> is the corresponding tag matching this interim fix's tag in the form of <release>-IFxxx, for example, 22.0.1-IF001.
   6. Run docker-compose up command to start the Workflow Process Server container

   For more detail on Workflow Process Service, refer to Installing Workflow Process Service .

   Troubleshooting: If you are using a Docker Desktop version 4.3.0 or greater, you might get an out of memory error when you start the server. For more details and possible resolution to this issue, and other troubleshooting guidance, refer to Troubleshooting Workflow Process Service.
5. Required when you are using Operational Decision Manager
   • You must update your Rule Designer:
     • Open Eclipse 
     • Open menu Help > Check for Updates
     • Select IBM Operational Decision Manager for Developers v8.11.x - Rule Designer
     • Proceed with installation.
6. Required when you are using Workforce Insights
   •   You must update the Workforce Insights configuration:
     • Set the Workforce Insights pod count, the default value is 2
     • Set Intelligent Task Prioritization pod count, the default value is 2
     • For more details, see Configuring Workforce Insights

Uninstalling

List of Fixes

Back to top

Back to top

Back to top

Back to top

Back to top

Back to top

Back to top

Back to top

Back to top

Back to top

Back to top

Back to top

Back to top

Back to top

Known Limitations