IBM Support

Readme for Cloud Pak for Business Automation 21.0.3 IF012

Fix Readme


Abstract

The following document is for IBM Cloud Pak for Business Automation 21.0.3 IF012. It includes the CASE package download, installation information, and the list of APARs that are resolved in this interim fix.

Content

Readme file for: IBM Cloud Pak® for Business Automation
Product Release: 21.0.3
Update Name: 21.0.3 IF012
Fix ID: 21.0.3-WS-CP4BA-IF012
Publication Date: 1 September 2022

Before installation

  1. Ensure you take regular backups of any databases associated with the environment.
  2. Ensure your operators are in a healthy state, before upgrading.
    If one or more operators are failing, then it can prevent the system from completing an upgrade.
    It is recommended to check a few of the important CR statuses to ensure there are not failures and the statuses appear ready for the various installed components. Check the status of the following CRs when they exist:
    oc get icp4acluster -o yaml
    oc get AutomationUIConfig -o yaml 
    oc get Cartridge -o yaml 
    oc get AutomationBase -o yaml 
    oc get CartridgeRequirements -o yaml
  3. Required when you are using Business Automation Insights
    If Business Automation Insights is deployed, prune the Business Automation Insights deployment, and jobs,  before you apply the updated custom resource YAML file.
    $ oc delete Deployment,Job -l \
    > 'app.kubernetes.io/name=ibm-business-automation-insights'
    Tip: For Flink event processing to resume from its previous state, make sure that savepoints are created before the upgrade and specified in the updated CR. For more information see Restarting from a checkpoint or savepoint

Installing the interim fix

Important: If you used any individual image tag settings in your CP4BA CR, it could prevent the operator from updating the images to the appropriate version. Ensure you remove any of these settings for a production installation when you upgrade.
Breaking change(s):
  1.  In this interim fix, the URLs for Content Management Interoperability Services (CMIS) have changed (i.e., "cmis" context root was introduced):
    • The previous CPD route for CMIS has changed
      • from:  https://cpd-<cp4ba-namespace>.xxxx.xxxx.xxxx/openfncmis_wlp 
      • to:  https://cpd-<cp4ba-namespace>.xxxx.xxxx.xxxx/cmis/openfncmis_wlp
    • The previous Openshift route for CMIS has changed
      • from:  https://cmis-<cp4ba-namespace>.xxxx.xxxx.xxxx/openfncmis_wlp 
      • to:  https://cmis-<cp4ba-namespace>.xxxx.xxxx.xxxx/cmis/openfncmis_wlp
The CASE package associated with this interim fix is ibm-cp-automation-3.2.12.tgz.  Download the CASE package to wherever you are planning to perform the installation or upgrade of this interim fix (for example, the infrastructure node of your OCP cluster) and extract the CASE package into a directory.
Cloud Pak for Business Automation 21.0.3 interim fixes are released to the v21.3 operator channel. Once the operator is upgraded, it triggers rolling updates for all the pods it manages to ensure they are updated to the appropriate version to match the operator.
If your environment has access to IBM entitled registry and has an automatic v21.3 channel subscription then production installations are upgraded automatically. This upgrade generally occurs when the interim fix is released or when images are mirrored for air gap setup.
Starting with 21.0.3-IF007 interim fix, we "pin" the version of Cloud Pak for Business Automation along with all its dependencies including IBM Automation Foundation and IBM Cloud Pak Foundational Services.  In other words, the automatic updates will be turned off and you will need to perform the steps listed to upgrade your environments in the future. 
This interim fix contains the following version of Cloud Pak for Business Automation, Automation Foundation, and Cloud Pak Foundational Services:
  • Cloud Pak for Business Automation – 21.0.3-IF012
  • Automation Foundation – 1.3.9
  • Cloud Pak Foundational Services – 3.19.3
Note:  If you have other Cloud Paks installed on the same OCP cluster, be sure to check the compatibility of the Automation Foundation  and Cloud Pak Foundational Services versions, listed above, with other Cloud Paks.
Depending on the current setup and state of your existing environment, there are various upgrade actions that need to be taken. The following scenarios cover what actions might be needed for a particular setup.
  • Scenario 1: You are using a starter installation.
    Actions: Starter environments do not support upgrades. Although you can use the interim fix content, install a new starter environment and use the CASE package from this interim fix.
  • Scenario 2: Your installation is version 21.0.2.x or earlier.
    Actions: If you are using a version before 21.0.3, then you must upgrade first. To upgrade your environment, follow the Upgrading automation containers instructions.
    • If attempting to upgrade, using script ONLY (upgradeOperator.sh), from 21.0.2.x to 21.0.3.7 (and subsequent interim fixes), it is a must to upgrade to the 21.0.3 release before moving on to 21.0.3-IF007 (or any future interim fix). This is as a result of the change using pinned operator catalog. If you use the Operator Hub UI and upgrade the channel, this is NOT an issue.
    • When you perform the upgrade, you can substitute the CASE package from this interim fix for the 21.0.3 CASE package while you follow the instructions. For air gap, you can use the case save command in step 1 of scenario 4.
      Note: If you are using versions before 21.0.2, then you must incrementally upgrade and follow the instructions for each version between your source version and 21.0.3
  • Scenario 3:  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:  Apply the updated catalog sources below (Note: you are not require to execute the "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 21.0.3 IF012 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:b3ae7013b8b402e7776f683ab319229a8e73ee87a892bb2f187aca9b79a2b60d
        updateStrategy:
          registryPoll:
            interval: 45m
      ---
      # IBM Automation Foundation Base 1.3.9
      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:bb480738a3cf687917b2735b43e5729a276b02f6960d973064093069bfd6114e
        updateStrategy:
          registryPoll:
            interval: 45m
      ---
      # IBM Automation Foundation Core 1.3.9
      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:a1e8d449e5249530c6ae71f9fb5857ac852cf090343636b314873bbf93ba7d3f
        updateStrategy:
          registryPoll:
            interval: 45m
      ---
      # IBM Cloud Foundational Services 3.19.3
      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:c8d461f5d9f933cbae94e84dd28643f0874a58a04d56de23181610c65c473314
        updateStrategy:
          registryPoll:
            interval: 45m
        priority: 100
      ---
      # IBM DB2 Operator Catalog 4.0.9
      apiVersion: operators.coreos.com/v1alpha1
      kind: CatalogSource
      metadata:
        annotations:
          bedrock_catalogsource_priority: '1'
        name: ibm-db2uoperator-catalog
        namespace: openshift-marketplace
      spec:
        sourceType: grpc
        image: icr.io/cpopen/ibm-db2uoperator-catalog@sha256:99f725098b801474ff77e880ca235023452116e4b005e49de613496a1917f719
        displayName: IBM Db2U Catalog
        publisher: IBM
        updateStrategy:
          registryPoll:
            interval: 45m
      ---
      # IBM Business Teams Service version 3.20.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:6fb709566a67d1a4b29d2764c91caee742768607f69f1a286d8cbe9a9effb09c
        updateStrategy:
          registryPoll:
            interval: 45m
      ---
      # Cloud Native PostgresSQL 4.5.0
      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:4b09002a8a9f0f6832c3f21cf0e6a129274279e4f72907b5faec58b4d3100411
        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 4:  If you are not using "pinned" catalog and your installation is version 21.0.3-IFxxxx (where xxxx is the latest iFix of 21.0.3) with Cloud Pak Foundational Services version 3.19.x or prior ONLY.  Your 21.0.3 installation has the latest iFix because you are using the IBM Operator Catalog and the CP4BA Operator will automatically upgrades to the latest iFix when it is available.
    Actions: Apply the updated catalog sources above in scenario #3.  Then execute the "update_subscription.sh" script to change the subscriptions.
    1. 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.
    2. 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 5: Your installation is air gap and 21.0.3.x
    Actions:
    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.
    1. Set up the environment variables for CASE. 
      • export CASE_NAME=ibm-cp-automation 
      • export OFFLINEDIR=/tmp/cp4ba2103-if012
      • export CASE_VERSION=3.2.12
      • 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:2b9782c3e3daa7f8d3fce6c0477916d4dfe0cb8494c364a40ffb00462f6260a1 --outputdir ${OFFLINEDIR}
      Once the command completes, all the Case archive and inventory are saved under /tmp/cp4ba2103-if012.
    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/cp4ba2103-if012) 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.

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, 21.0.3-IF012.
    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, 21.0.3-IF012.
    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.

Uninstalling

There is no procedure to uninstall the interim fix.

List of Fixes

APARs fixed by this interim fix are listed in the following tables.
The columns are defined as follows: 
Column title Column description
APAR The defect number
Title A short description of the defect
Sec. A mark indicates a defect related to security
Cont. A mark indicates a defect specific to the Cloud Pak integration of the component
B.I. A mark indicates the fix has a business impact. Details are found in the title column or the APAR document
General
APAR Title Sec. Cont. B.I.
N/A
Cloud Pak for Business Automation delivers container images that include operating system level and other open source libraries. Vulnerabilities (CVEs) for these libraries are published regularly.
 
This interim fix includes fixes for these libraries to address:
CVE-2015-5211, CVE-2016-5007, CVE-2018-1257, CVE-2018-1270, CVE-2018-1271, CVE-2018-1275, CVE-2019-11254, CVE-2019-20149, CVE-2020-28915, CVE-2021-20223, CVE-2021-43616, CVE-2021-46823, CVE-2022-1012, CVE-2022-1271, CVE-2022-1621, CVE-2022-1629, CVE-2022-1729, CVE-2022-21540, CVE-2022-21541, CVE-2022-21549, CVE-2022-22950, CVE-2022-22968, CVE-2022-22970, CVE-2022-22971, CVE-2022-25313, CVE-2022-25314, CVE-2022-27666, CVE-2022-31159, CVE-2022-32250, CVE-2022-33980, CVE-2022-34169, GHSA-r8wq-qrxc-hmcm, PRISMA-2022-0239, RHSA-2022:5314, 
 
Previous interim fixes have included fixes which are also addressed with this interim fix. Consult the Related links section for readmes of previous interim fixes, at the bottom of this document.
Cloud Pak for Business Automation Operator
APAR Title Sec. Cont. B.I.
N/A N/A
Automation Document Processing
Known Issue Title Sec. Cont. B.I.
DT144688 Digitally signed PDFs are stuck in processing X X
Automation Decision Services
APAR Title Sec. Cont. B.I.
N/A N/A
APAR Title Sec. Cont. B.I.
N/A N/A
Business Automation Insights
APAR Title Sec. Cont. B.I.
N/A N/A
Business Automation Navigator
APAR Title Sec. Cont. B.I.
N/A N/A
Business Automation Studio
APAR Title Sec. Cont. B.I.
JR65072 BLANK PAGE IS SHOWN WHEN RETURNING TO IBM BUSINESS AUTOMATION STUDIO FROM DECISION DESIGNER USING THE BREADCRUMB
Business Automation Workflow including Automation Workstream Services
APAR Title Sec. Cont. B.I.
DT139460 CVE-2022-35644 - PERSISTENT XSS VULNERABILITY IN PROCESS ADMIN CONSOLE X
DT142447 XA_RBDEADLOCK.ERRORCODE=-4203 DUE TO A DEADLOCK IN LSW_LOCK TABLE WHEN SAVING CASE PROPERTY CHANGES X
DT141469 COULDNOTSETPROPERTYEXCEPTION OCCURS WHEN MAPPING COMPLEX OBJECT TO ANY TYPE IN A CLIENT SIDE HUMAN SERVICE
JR64732 COACH GENERATION INCORRECTLY REPORTS AN ERROR FOR COACHES IN A HERITAGE HUMAN SERVICE
JR64992 BAR CHART DRILL DOWN DOES NOT CLEARING PREVIOUS CHART'S CONTENT
JR65006 UPDATE BUSINESS AUTOMATION WORKFLOW TO A NEWER VERSION OF THE SPRING FRAMEWORK X
JR65020 AN OBJECTNOTFOUNDEXCEPTION IS ENCOUNTERED WHILE RUNNING THE BPMUPDATESYSTEMAPP COMMAND DURING UPGRADE
JR65044 ECM FILE LIST VIEW NO LONGER DISPLAYS CORRECT COLUMNS FROM A CUSTOM QUERY AFTER YOU UPGRADE
JR65087 TOKEN OF THE ATTACHED INTERMEDIATE EVENT CANNOT BE DELETED
Enterprise Records
APAR Title Sec. Cont. B.I.
N/A
N/A
FileNet Content Manager
Operational Decision Management
APAR Title Sec. Cont. B.I.
RS03858 DECISION ENGINE PERFORMANCE OF RETE ALGORITHM MAY BE AFFECTED BY UPDATE
RS03915 DEFAULT ROW ORDERING FOR DECISION TABLES NOT WORKING
RS03921 OLD TEST REPORTS ARE NO LONGER DISPLAYED AFTER MIGRATING FROM 8.8
RS03932 NPE GENERATING TEST SUITE REPORT
RS03934 UNLOCK ICON DISPLAYED ON MOUSE HOVER WHEN MERGING LOCKED BRANCHES
RS03935 XHRTIMEOUT VALUE DEFINED IN BUSINESS CONSOLE SETTINGS NOT TAKEN INTO ACCOUNT
RS03936 CARRIAGE RETURN LOST IN DESCRIPTION FIELD OF DETAILS VIEW
RS03938 PASTE SPECIAL IN A DECISION TABLE USING RULE DESIGNER DOES NOT PASTE
RS03940 ERROR DURING DE RULESET GENERATION WHEN TESTING LONG VARIABLE 'IS ONE OF' INTEGER DOMAINS
RS03941 ERROR WHILE TRYING TO DELETE RESOURCES AND LIBRARIES FROM RES
RS03942 INVALID ASSERTION IN RETE
RS03944 DECISION TABLE COMPARISON MAY FAIL IN BUSINESS CONSOLE
RS03948 IN DECISION CENTER MAIN RULEFLOW PROPERTY MAY BE INCORRECT IN RULEAPP
User Management Service
APAR Title Sec. Cont. B.I.
N/A N/A
Workflow Process Service
APAR Title Sec. Cont. B.I.
JR65006 UPDATE BUSINESS AUTOMATION WORKFLOW TO A NEWER VERSION OF THE SPRING FRAMEWORK X

Known Limitations

Document change history

  • 1 September 2022: Initial publish.
  • 23 September 2022: Added missing fix Known Issue DT139460 to Business Automation Workflow fix list table.
  • Related Information

    [{"Type":"MASTER","Line of Business":{"code":"LOB45","label":"Automation"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSBYVB","label":"IBM Cloud Pak for Business Automation"},"ARM Category":[{"code":"a8m0z0000001gWWAAY","label":"Other-\u003ECloudPak4Automation Platform"}],"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions"}]

    Document Information

    Modified date:
    11 October 2022

    UID

    ibm16612563