IBM Support

Readme for Cloud Pak for Business Automation 22.0.2 IF003

Fix Readme


Abstract

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

Content

Readme file for: IBM Cloud Pak® for Business Automation
Product Release: 22.0.2
Update Name: 22.0.2 IF003
Fix ID: 22.0.2-WS-CP4BA-IF003
Publication Date: 30 March 2023

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-4.1.3.tgz.  Download the CASE package to wherever you are planning to perform the online installation or upgrade of this interim fix (for example, the infrastructure node of your OCP cluster) and extract the CASE package into a directory. For offline/Airgap installation or upgrade follow below mentioned Scenario 8.
Cloud Pak for Business Automation 22.0.2 interim fixes are released to the v22.2 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 v22.2 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,  IBM Automation Foundation (IAF), and Cloud Pak Foundational Services (CPFS):
  • Cloud Pak for Business Automation – 22.0.2-IF003
  • IBM Automation Foundation – 1.3.13
  • Cloud Pak Foundational Services – 3.23.1
Note:  This interim fix only supports the Automation Foundation and Cloud Pak Foundational Services listed above. It is important that you deploy or upgrade Cloud Pak for Business Automation using the catalog sources in this readme document (the same catalog sources are also in the referenced CASE package).  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' specifications.
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 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: Your installed version is prior to 22.0.2.
    Actions: Follow the upgrade instructions while using the case package details from this iFix.
    Warning: If you are using Business Automation Applications, you must upgrade from 22.0.1-IF006 due to DT174377. Upgrading from an earlier release could result in corrupted business applications.  
    Important: When upgrading Cloud Pak Foundational Services, be sure to upgrade to the needed channel for the iFix as documented in the upgrade instructions.
    Note: If you are upgrading from a version prior to 22.0.1, then you will need to perform incremental upgrades from each prior version.
  • Scenario 4: You already have a Production deployment installed with 22.0.2 GA or 22.0.2 + 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.2 GA or 22.0.2 + any interim fix prior to this one and you want to install another production deployment of this interim fix using pinned catalogs, then you must first upgrade existing Cloud Pak Foundational Services to version 3.23 before you install another production deployment with this interim fix. You also needs 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.
    • Refer to the Cloud Pak Foundational Services upgrade section in the What's new in 22.0.2.  Make sure that you upgrade the Cloud Pak Foundational Services to 3.23 before you apply the catalog sources.
      1. Log in to the cluster as an administrator by using the oc login command.
      2. Download the upgrade_common_services.sh script to your local machine.
      3. Run the script with the all namespaces flag and channel version to the command:
        • ./upgrade_common_services.sh -a -c v3.23
        • If you installed foundational services in specific namespaces (an unusual use case), add the namespaces and channel version to the command. For example, if you want to upgrade foundational services in a Cloud Pak namespace cp4ba and foundational services namespace cp4ba-cs to version v3.23, run the following command:
          • ./upgrade_common_services.sh -cloudpaksNS cp4ba -csNS cp4ba-cs -c v3.23
      4. You 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 IBM Business Team Service, and Postgres catalog sources are dependent components of Cloud Pak for Business Automation.
          # CP4BA 22.0.2 IF003 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:0ed8e0a7606003951b01fe52f753fd7a50e2261148155eccc8587b494c9bb3cf
            updateStrategy:
              registryPoll:
                interval: 45m
          ---
          # IBM Automation Foundation Base 1.3.13
          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:1753b1cabf6cdc6d295d8da096ce3f769b6487fdbef5802de63dccbfa7d9a43b
            updateStrategy:
              registryPoll:
                interval: 45m
          ---
          # IBM Automation Foundation Core 1.3.13
          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:8bd0b52526de4a2adf6b299237f3d295a710e7d0ff538a319226c614ceae618b
            updateStrategy:
              registryPoll:
                interval: 45m
          ---
          # IBM Cloud Foundational Services 3.23.1
          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:95ed8b2bd8e2e77f863557d27e591ea15dd667159d9c52059492533c6ba0f270
            updateStrategy:
              registryPoll:
                interval: 45m
            priority: 100
          ---
          # IBM Business Teams Service version 3.23.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:1cbb05e621a8b0e6eacb720c823814ce4d9d178c9aad98252599e9972f911671
            updateStrategy:
              registryPoll:
                interval: 45m
          ---
          # Cloud Native PostgresSQL 4.11.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:642aba4b78bcadd8f1d5e1f9d05d8484e2934d914a5b6d67435f3e98082d7592
            updateStrategy:
              registryPoll:
                interval: 45m
            priority: 100
        2. If you have any subscriptions set to manual, then you need to approve any pending operator updates.
          Note: It is not recommended to set subscriptions to manual, this makes the upgrade more error prone . By default all subscriptions are set to automatic.
      5. Follow the steps to perform validation of your Production deployment
  • Scenario 5: 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 6: 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-IF006. You can use the OpenShift console or the command line, please follow Upgrading operators that are pinned instructions.
  • Scenario 7:  Your installation is 22.0.2 GA or 22.0.2 + any interim fix and you're using pinned catalog (Which is common use case as only pinned catalogs were provided in this version)
    Actions:  If you are using version 22.0.2 GA or 22.0.2 + any interim fix, then you must first upgrade existing Cloud Pak Foundational Services to version 3.23.0 before you install another production deployment with this interim fix.
    • Refer to the Cloud Pak Foundational Services upgrade section in the What's new in 22.0.2.  Make sure that you upgrade the Cloud Pak Foundational Services to 3.23.0 before you apply the catalog sources below.
      1. Log in to the cluster as an administrator by using the oc login command.
      2. Download the upgrade_common_services.sh script to your local machine.
      3. Run the script with the all namespaces flag and channel version to the command:
        • ./upgrade_common_services.sh -a -c v3.23
        • If you installed foundational services in specific namespaces (an unusual use case), add the namespaces and channel version to the command. For example, if you want to upgrade foundational services in a Cloud Pak namespace cp4ba and foundational services namespace cp4ba-cs to version v3.23, run the following command:
          • ./upgrade_common_services.sh -cloudpaksNS cp4ba -csNS cp4ba-cs -c v3.23
    • You 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 IBM Business Team Service, and Postgres catalog sources are dependent components of Cloud Pak for Business Automation.
        # CP4BA 22.0.2 IF003 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:0ed8e0a7606003951b01fe52f753fd7a50e2261148155eccc8587b494c9bb3cf
          updateStrategy:
            registryPoll:
              interval: 45m
        ---
        # IBM Automation Foundation Base 1.3.13
        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:1753b1cabf6cdc6d295d8da096ce3f769b6487fdbef5802de63dccbfa7d9a43b
          updateStrategy:
            registryPoll:
              interval: 45m
        ---
        # IBM Automation Foundation Core 1.3.13
        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:8bd0b52526de4a2adf6b299237f3d295a710e7d0ff538a319226c614ceae618b
          updateStrategy:
            registryPoll:
              interval: 45m
        ---
        # IBM Cloud Foundational Services 3.23.1
        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:95ed8b2bd8e2e77f863557d27e591ea15dd667159d9c52059492533c6ba0f270
          updateStrategy:
            registryPoll:
              interval: 45m
          priority: 100
        ---
        # IBM Business Teams Service version 3.23.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:1cbb05e621a8b0e6eacb720c823814ce4d9d178c9aad98252599e9972f911671
          updateStrategy:
            registryPoll:
              interval: 45m
        ---
        # Cloud Native PostgresSQL 4.11.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:642aba4b78bcadd8f1d5e1f9d05d8484e2934d914a5b6d67435f3e98082d7592
          updateStrategy:
            registryPoll:
              interval: 45m
          priority: 100
      2. If you have any subscriptions set to manual, then you need to approve any pending operator updates.
        Note: It is not recommended to set subscriptions to manual, this makes the upgrade more error prone . By default all subscriptions are set to automatic.
    • Follow the steps to perform validation of your Production deployment
  • Scenario 8:  Your installation is air gap and 22.0.2 GA or 22.0.2 + any interim fix
    Actions:  If you are using version 22.0.2 GA or 22.0.2 + any interim fix, then you must first upgrade existing Cloud Pak Foundational Services to version 3.23.0 before you install another production deployment with this interim fix.
    • Refer to the Cloud Pak Foundational Services upgrade section in the What's new in 22.0.2.  Make sure that you upgrade the Cloud Pak Foundational Services to 3.23.0 before you apply the catalog sources.
      1. Log in to the cluster as an administrator by using the oc login command.
      2. Download the upgrade_common_services_airgap.sh script to your local machine.
      3. Run the script with the all namespaces flag and channel version to the command:
        • ./upgrade_common_services_airgap.sh -a -c v3.23
        • If you installed foundational services in specific namespaces (an unusual use case), add the namespaces and channel version to the command. For example, if you want to upgrade foundational services in a Cloud Pak namespace cp4ba and foundational services namespace cp4ba-cs to version v3.23, run the following command:
          • ./upgrade_common_services_airgap.sh -cloudpaksNS cp4ba -csNS cp4ba-cs -c v3.23
    • Follow the steps below on the bastion host where you previously deployed 22.0.2:
      1. Set up the environment variables for CASE (Using IBM-Pak Plugin)
        1. Get the cp4ba-case-to-be-mirrored-22.0.2-IF003.txt file for 22.0.2 IF003 and you must rename the file to cp4ba-case-to-be-mirrored-22.0.2-IF003.yaml
          oc ibm-pak get -c file://(absolute path to file)/cp4ba-case-to-be-mirrored-22.0.2-IF003.yaml
          The (absolute path to file) needs to be a path starting from "/". For example, "/opt"
        2. Define the environment variable $TARGET_REGISTRY by running the following command
          export TARGET_REGISTRY=<target-registry>
          The <target-registry> refers to the registry (hostname and port) where the images are mirrored to and accessed by the OCP cluster. For example: 172.16.0.10:5000
        3. Create the following environment variables with the installer image name and the version.
          export CASE_NAME=ibm-cp-automation
          export CASE_VERSION=4.1.3
        4. Set the environment variable of the --inventory parameter
          export CASE_INVENTORY_SETUP=cp4aOperatorSetup
        5. Follow instructions from 1c onwards under procedure section mentioned in Mirroring images to the private registry.
        6. Update the catalog with the new version by running the install-catalog action.
          oc ibm-pak launch $CASE_NAME \
          --version $CASE_VERSION \
          --action install-catalog \
          --inventory $CASE_INVENTORY_SETUP \
          --namespace $NAMESPACE \
          --args  "--registry $TARGET_REGISTRY --recursive --inputDir ~/.ibm-pak/data/cases/$CASE_NAME/$CASE_VERSION"
        7. 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.
      2. Set up the environment variables for CASE (Using cloudctl which is deprecated)
        1. export CASE_NAME=ibm-cp-automation 
          export OFFLINEDIR=/opt/cp4ba2202-if003
          export CASE_VERSION=4.1.3
          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:df91932778e483de0eedf97f5a4bbe92f562a0db0cce64ce413c0594769df9e5 --outputdir ${OFFLINEDIR}
          Once the command completes, all the Case archive and inventory are saved under OFFLINEDIR.
        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 (/opt/cp4ba2202-if003) 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.
      3. Follow the steps to perform validation of your Production deployment

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.2-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.2-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.

Uninstalling

There is no procedure to uninstall the interim fix.

List of Fixes

APARs/Known Issues fixed by this interim fix are listed in the following tables.
The columns are defined as follows: 
Column title Column description
APAR/Known Issue 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/Known Issue document
General
Known Issue 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-2022-3204, CVE-2022-1996, CVE-2023-23934, CVE-2023-25577, CVE-2022-40899, CVE-2022-36087, CVE-2022-45907, CVE-2022-25882, CVE-2022-42010, CVE-2022-42011, CVE-2022-42012, CVE-2022-40303, CVE-2022-40304, CVE-2022-43680, CVE-2022-21698, CVE-2022-36760, CVE-2022-37436, CVE-2022-23539, CVE-2022-23540, CVE-2022-23541, CVE-2022-40151, CVE-2022-41966, CVE-2022-29599, RHSA-2023:0625, CVE-2022-45061, RHSA-2023:0837, CVE-2022-4415, RHSA-2023:0842, CVE-2022-40151, CVE-2022-41966, CVE-2022-29599, CVE-2023-25577, CVE-2023-23934, CVE-2022-40899, CVE-2022-43945, CVE-2022-41222, CVE-2022-2873, CVE-2021-29063, CVE-2022-25882, CVE-2022-45907, CVE-2022-40898, CVE-2019-25033, CVE-2022-3204, CVE-2019-16866, CVE-2022-23539, CVE-2022-23540, CVE-2022-23541, RHSA-2023:0096, CVE-2022-42010, CVE-2022-42011, CVE-2022-42012, RHSA-2023:0103, RHSA-2023:0116, RHSA-2023:0173, CVE-2022-40304, CVE-2022-40303, CVE-2022-35737, RHSA-2023:0100, CVE-2022-3821, CVE-2023-25194
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
Known Issue Title Sec. Cont. B.I.
N/A N/A
Automation Document Processing
Known Issue Title Sec. Cont. B.I.
DT197996 ProjectCleanup script fails after first project X X
DT208911 Document Owner permissions should not allow user to add a document X X
DT211439 Automation Document Processing project export not compressing zip file X X
Automation Decision Services
Known Issue Title Sec. Cont. B.I.
N/A N/A
Known Issue Title Sec. Cont. B.I.
N/A N/A
Business Automation Insights
Known Issue Title Sec. Cont. B.I.
N/A N/A
Business Automation Navigator
Business Automation Studio
Known Issue Title Sec. Cont. B.I.
DT195750 UPGRADE FAILS WITH NOCLASSDEFFOUNDERROR RELATED TO SCIM DURING DB-INIT JOB WHEN IMPORTING SNAPSHOTS
DT196668 EXTRA DROPDOWN APPEARS IN IBM BUSINESS AUTOMATION STUDIO WHEN CASE IS DISABLED
DT195793 POSSIBLY SENSITIVE INFORMATION IN URL PARAMETERS
Business Automation Workflow including Automation Workstream Services
Known Issue Title Sec. Cont. B.I.
DT196140 SECURITY - CVE-2022-34917 in kafka-clients reported for bai-events-java-sdk X
DT179527 SECURITY - SEVERAL SECURITY VULNERABILITIES ARE PRESENT IN BOOTSTRAP-3.3.4.JS X
DT195919 SECURITY - CVE-2023-25194 - Update Apache Kafka for Case and Case History Emitters X
DT188313 THE LOGS OF DATABASE INIT JOB ARE NOT PERSISTED, AND THE TRACE SPECIFICATION CAN NOT BE SPECIFIED FOR THIS JOB.
DT195750 UPGRADE FAILS WITH NOCLASSDEFFOUNDERROR RELATED TO SCIM DURING DB-INIT JOB WHEN IMPORTING SNAPSHOTS
DT196158 YOU SEE AN ERROR WHEN YOU TRY TO SAVE ACTIVITY PROPERTIES FOR A CASE ACTIVITY PROCESS THAT IS USING CLIENT-SIDE HUMAN SERVICE.
DT196587 tw.system.retrieveTaskList throws an error if the Dashboards toolkit is not upgraded to the latest version (later than 22.0.2)
DT197423 USING WORKPLACE TO OPEN A DOCUMENT FROM A CLIENT-SIDE HUMAN SERVICE CASE VIEW DOESN'T OPEN THE DOCUMENT IN CONTENT NAVIGATOR VIEWER
DT197965 INCORRECT IMAGE IS USED FOR IBM BUSINESS AUTOMATION WORKFLOW RUNTIME WHEN THE APP_DESIGNER COMPONENT IS ENABLED
Enterprise Records
Known Issue Title Sec. Cont. B.I.
N/A
N/A
FileNet Content Manager
Operational Decision Management
Known Issue Title Sec. Cont. B.I.
DT172544 SETTING TO CHANGE B2X ARL EDITOR HEIGHT IN RULE DESIGNER NOT APPLIED
DT179492 ENABLE LOGGING OF THE CREATION AND DELETION OF BASELINES
DT179799 CROSS SITE SCRIPTING (XSS) VULNERABILITY IN USER PROFILE X
DT196023 CANNOT DELETE A RULE ARTIFACT IN THE BUSINESS CONSOLE
DT197613 SLOW DISPLAY OF A CHANGE ACTIVITY IN THE BUSINESS CONSOLE
User Management Service
Known Issue Title Sec. Cont. B.I.
N/A N/A
Workflow Process Service
Known Issue Title Sec. Cont. B.I.
DT196140 SECURITY - CVE-2022-34917 in kafka-clients reported for bai-events-java-sdk
DT195750 UPGRADE FAILS WITH NOCLASSDEFFOUNDERROR RELATED TO SCIM DURING DB-INIT JOB WHEN IMPORTING SNAPSHOTS

Known Limitations

Document change history

  • 30 March 2023: Initial publish.
  • [{"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"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"22.0.2"}]

    Document Information

    Modified date:
    07 November 2023

    UID

    ibm16958120