Fix Readme
Abstract
The following document is for IBM Cloud Pak for Business Automation 24.0.1 IF002. 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: | 24.0.1 |
| Update Name: | 24.0.1 IF002 |
| Fix ID: | 24.0.1-WS-CP4BA-IF002 |
| Publication Date: | 30 April 2025 |
Contents
Prerequisites and supersedes
Components impacted
Before installation
Installing the interim fix
Performing the necessary tasks after installation
Uninstalling
List of fixes
Known Limitations
Document change history
Components impacted
Before installation
Installing the interim fix
Performing the necessary tasks after installation
Uninstalling
List of fixes
Known Limitations
Document change history
Prerequisites and supersedes
- Supersedes all prior interim fixes for Cloud Pak for Business Automation 24.0.1.
Components impacted
- General
- Cloud Pak for Business Automation Operator
- Automation Document Processing
- Automation Decision Services
- Business Automation Application
- Business Automation Insights
- Business Automation Navigator
- Business Automation Studio
- Business Automation Workflow including Automation Workstream Services
- Enterprise Records
- FileNet Content Manager
- Operational Decision Management
- User Management Service
- Workflow Process Service
Before installation
- Ensure you take regular backups of any databases associated with the environment.
- 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 content -o yaml oc get Foundation -o yaml - Remove any image settings in CRs
If you used any individual image tag settings in your CRs, it could prevent the operator from updating the images to the appropriate version. Ensure you remove any of these settings when you upgrade. This doesn't apply to starter installation as it requires a new install.
Installing the interim fix
This interim fix contains the following version of Cloud Pak for Business Automation and Cloud Pak Foundational Services (CPFS):
- Cloud Pak for Business Automation 24.0.1-IF002
- Cloud Pak Foundational Services 4.11
Note: This interim fix only supports the 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. If you have other Cloud Paks installed on the same OCP cluster, be sure to check the compatibility of the Cloud Pak Foundational Services versions listed above with other Cloud Paks' specifications.
Note: If you have already deployed / upgraded to 24.0.1-IF002 before the refresh was announced for https://www.ibm.com/support/pages/node/7233623 , Refer to Scenario 10 of Step 2: Perform an online/offline fresh installation or an upgrade on an existing online/offline deployment.
Cloud Pak for Business Automation (CP4BA) 24.0.1 interim fixes are released to the v24.1 operator channel. Once the operators are upgraded, it triggers rolling updates for all the pods it manages to ensure they are updated to the appropriate version to match the operator.
Step 1: Download the installation and upgrade scripts
- Download the 24.0.1 IF002 branch by using the following
git clonecommand.git clone -b 24.0.1-IF002 https://github.com/icp4a/cert-kubernetes.git
Step 2: Perform an online/offline fresh installation or an upgrade on an existing online/offline deployment.
Depending on the current setup and state of your existing environment, there are various actions that need to be taken. The following scenarios cover what actions might be needed for a particular setup.
For an upgrade scenario, these are the Cloud Pak foundational services migration modes supported -
Note: The recommended migration mode for an instance with cluster scoped Cloud Pak foundational services is to namespace scoped Cloud Pak foundational services.
| Migration Mode | Support |
|---|---|
| Cluster-scoped to Namespace-scoped | Supported (This is the recommended approach if your current deployment is using cluster-scoped CPFs) |
| Namespace-scoped to Namespace-scoped | Supported (If your CPFs deployment is already namespace-scoped, then continue to remain at namespace-scoped) |
| Cluster-scoped to Cluster-scoped | Not Supported (Please follow the recommended upgrade from Cluster-scoped to Namespace-scoped for CPFs) |
| Cluster-scoped ("All namespaces") to Cluster-scoped ("All namespaces") | Supported ( There is no migration path from Cluster-scoped ("All namespaces") to Namespace-scoped ) |
Note: The recommended migration mode for an instance with cluster scoped Cloud Pak foundational services is to namespace scoped Cloud Pak foundational services.
-
Scenario 1: You are installing a Starter deployment online or have an existing online Starter deploymentWarning: If you have an existing Cloud Pak Foundation Services instance installed at the cluster scoped level or in the namespace where CP4BA is being installed, then it is not supported. The Starter deployment of CP4BA is only supported when deploying into a new namespace without CPFs.
Actions: Starter deployments do not support upgrades; however, 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 installation scripts from the branch that you cloned above. -
Scenario 2: You are installing online Production deployment
Warning: If you have an existing Cloud Pak Foundation Services instance installed at the cluster scoped level or in the namespace where CP4BA is being installed, then it is not supported. The Production deployment of CP4BA is only supported when deploying into a new namespace without CPFs.Actions: To deploy an online Production deployment without using a local registry, please follow steps in install a new online Production environment and use the installation scripts from the branch that you cloned above. -
Scenario 3: You are installing offline/airgap Production deploymentWarning: If you have an existing Cloud Pak Foundation Services instance installed at the cluster scoped level or in the namespace where CP4BA is being installed, then it is not supported. The Production deployment of CP4BA is only supported when deploying into a new namespace without CPFs.Note: As prerequisites for this scenario, you must follow steps here to set up the bastion host to mirror images to the registry and further to set up the private registry. The mirroring of images can be completed using "oc mirror" for the mirroring images process. If you are looking to install only a set of capabilities then you can make use of filters listed in Table 1 so that you can only download the specific set of images that you require. Please note that if the set of capabilities include Business Automation Workflow, Process Federation Server, Workflow Process Service or Business Automation Insights then make sure to include the filter "ibm_es_1_1_2470".Actions:
- To deploy an airgap/offline Production deployment, find mirror file cp4ba-case-to-be-mirrored-24.0.1-IF003.txt for this interim fix from the branch that you cloned above under the scripts/airgap directory. Execute this command from your bastion host to download the CASE files.
The absolute path to file needs to be a path starting from "/". For example, "/opt".oc ibm-pak get -c file://(absolute path to file)/cp4ba-case-to-be-mirrored-24.0.1-IF003.txt - You will need to mirror the images associated with the new cp4ba-case-to-be-mirrored-24.0.1-IF003.txt mirror file.
Follow the instructions for either mirroring option in Mirroring images to the private registry using the new CASE version associated with this interim fix.export CASE_NAME=ibm-cp-automation export CASE_VERSION=24.1.3 export CASE_INVENTORY_SETUP=cp4aOperatorSetup export TARGET_REGISTRY=<target-registry> export NAMESPACE=<cp4ba_namespace_name> - Login to the cluster and go to namespace for the operator from the bastion host.
oc login https://<CLUSTERIP>:<port> -u <ADMINISTRATOR> oc project ${NAMESPACE} - From your bastion host, install the catalog sources and operators using the steps listed in Install Catalog Source and Operators using cluster admin script.
- Follow the remaining steps from Question 6 listed here to complete the installations of offline/airgap Production deployment.
- To deploy an airgap/offline Production deployment, find mirror file cp4ba-case-to-be-mirrored-24.0.1-IF003.txt for this interim fix from the branch that you cloned above under the scripts/airgap directory. Execute this command from your bastion host to download the CASE files.
- Scenario 4: Your installed Production deployment version is 21.0.3 IF031 or newer (If you do not have 21.0.3 IF031 or newer, you need to upgrade to 21.0.3 IF031 or newer before proceeding with this upgrade).
Note: Direct upgrade from 21.0.3 IF031 or newer to 24.0.1 IF002 is not supported. For this scenario, complete an upgrade to 24.0.0 GA first or a newer 24.0.0 interim fix, and then perform an upgrade to this current interim fix.
Actions:- Complete a direct upgrade to 24.0.0 GA or a newer 24.0.0 interim fix.
- For online upgrade, follow the upgrade instructions documented in Upgrading CP4BA multi-pattern clusters from 21.0.3.
- For offline upgrade, you must first complete the prerequisites by following steps here to set up the bastion host to mirror images to the registry and further to set up the private registry. The mirroring of images can be completed using "oc mirror" for the mirroring images process. Once the mirroring of images is completed, follow the upgrade instructions documented in Upgrading CP4BA multi-pattern clusters from 21.0.3.
- Complete an upgrade from 24.0.0 GA or a newer 24.0.0 interim fix to the current 24.0.1 interim fix.
- For online upgrade, follow the instructions listed in Scenario 7.
- For offline upgrade, follow the instructions listed in Scenario 8.
- Complete a direct upgrade to 24.0.0 GA or a newer 24.0.0 interim fix.
- Scenario 5: Your installed Production deployment version is 22.0.2 IF006(If you do not have 22.0.2 IF006, you need to upgrade to 22.0.2 IF006 before proceeding with this upgrade).
Note: Direct upgrade from 22.0.2 IF006 to 24.0.1 IF002 is not supported. For this scenario, complete an upgrade to 24.0.0 GA first or a newer 24.0.0 interim fix, and then perform an upgrade to this current interim fix.
Actions:- Complete a direct upgrade to 24.0.0 GA or a newer 24.0.0 interim fix.
- For online upgrade, follow the upgrade instructions documented in Upgrading CP4BA multi-pattern clusters from 22.0.2 in online environment.
- For offline upgrade, you must first complete the prerequisites by following steps here to set up the bastion host to mirror images to the registry and further to set up the private registry. The mirroring of images can be completed using "oc mirror" for the mirroring images process. Once the mirroring of images is completed, follow the upgrade instructions documented in Upgrading CP4BA multi-pattern clusters from 22.0.2 in online environment.
- Complete an upgrade from 24.0.0 GA or a newer 24.0.0 interim fix to the current 24.0.1 interim fix.
- For online upgrade, follow the instructions listed in Scenario 7.
- For offline upgrade, follow the instructions listed in Scenario 8.
- Complete a direct upgrade to 24.0.0 GA or a newer 24.0.0 interim fix.
- Scenario 6: Your installed Production deployment version is 23.0.2 IF006 (If you do not have 23.0.2 IF006 you need to upgrade to 23.0.2 IF006 before proceeding with this upgrade).
Note: Direct upgrade from 23.0.2 IF006 to 24.0.1 IF002 is not supported. For this scenario, complete an upgrade to 24.0.0 GA first or a newer 24.0.0 interim fix, and then perform an upgrade to this current interim fix.
Actions:- Complete a direct upgrade to 24.0.0 GA or a newer 24.0.0 interim fix.
- For online upgrade, follow the upgrade instructions documented in Upgrading CP4BA multi-pattern clusters from 23.0.2 in online environment.
- For offline upgrade, you must first complete the prerequisites by following steps here to set up the bastion host to mirror images to the registry and further to set up the private registry. The mirroring of images can be completed using "oc mirror" for the mirroring images process. Once the mirroring of images is completed, follow the upgrade instructions documented in in Upgrading CP4BA multi-pattern clusters from 23.0.2 in online environment.
- Complete an upgrade from 24.0.0 GA or a newer 24.0.0 interim fix to the current 24.0.1 interim fix.
- For online upgrade, follow the instructions listed in Scenario 7.
- For offline upgrade, follow the instructions listed in Scenario 8.
- Complete a direct upgrade to 24.0.0 GA or a newer 24.0.0 interim fix.
-
Scenario 7: Your installed Production deployment version is 24.0.0 GA or newer.Warning:
All instructions to download the installation and upgrade scripts in the Knowledge Center links referenced below can be ignored. Instead use the installation and upgrade scripts downloaded in Step 1
Actions:
For online upgrade, follow the upgrade instructions documented in Upgrading CP4BA multi-pattern clusters from 24.0.0 in online environment.
For offline upgrade, you must first complete the prerequisites by following steps here to set up the bastion host to mirror images to the registry and further to set up the private registry. The mirroring of images can be completed using "oc mirror" for the mirroring images process manually or using"oc mirror" for the mirroring images process by script . Once the mirroring of images is completed, follow the upgrade instructions documented in Upgrading CP4BA multi-pattern clusters from 24.0.0 in online environment. -
Scenario 8: Your installed Production deployment is 24.0.1 GA or newer.Note:
For a dedicated deployment or namespace scoped deployment, the value for < CP4BA Namespace > should be the namespace where all IBM Cloud Pak foundational services/CP4BA Operators and Services are deployed. If the CP4BA Operators and Services are deployed in different namespaces( separation of duties), the value for < CP4BA Namespace > should be the namespace where all IBM Cloud Pak foundational services/CP4BA Operators are deployed in.
Warning:
For a CP4BA Deployment with BAI ( Business Automation Insights ) selected as an optional component, it is recommended to create BAI savepoints before starting the upgrade process to this interim fix. For Flink event processing to resume from its previous state, savepoints are required to be created before the upgrade and specified in the updated CR. BAI savepoints can be created by following the below steps.-
Retrieve the name of the InsightsEngine custom resource file.Create BAI savepoints and store them in a temporary file called bai.json.
InsightsEngine_CR=$(kubectl get InsightsEngine --no-headers --ignore-not-found -n <CP4BA-Namespace> -o name)Retrieve and export the below details.export MANAGEMENT_URL=$(kubectl get ${InsightsEngine_CR} --no-headers --ignore-not-found -n <CP4BA Namespace> -o jsonpath='{.status.components.management.endpoints[?(@.scope=="External")].uri}') export MANAGEMENT_AUTH_SECRET=$(kubectl get ${InsightsEngine_CR} --no-headers --ignore-not-found -n <CP4BA Namespace> -o jsonpath='{.status.components.management.endpoints[?(@.scope=="External")].authentication.secret.secretName}') export MANAGEMENT_USERNAME=$(kubectl get secret ${MANAGEMENT_AUTH_SECRET} --no-headers --ignore-not-found -n <CP4BA Namespace> -o jsonpath='{.data.username}' | base64 -d) export MANAGEMENT_PASSWORD=$(kubectl get secret ${MANAGEMENT_AUTH_SECRET} --no-headers --ignore-not-found -n <CP4BA Namespace> -o jsonpath='{.data.password}' | base64 -d)curl -X POST -k -u ${MANAGEMENT_USERNAME}:${MANAGEMENT_PASSWORD} "${MANAGEMENT_URL}/api/v1/processing/jobs/savepoints" -o ./bai.jsonScale down the CP4BA and Insights Engine Operator.oc scale --replicas=0 deployment ibm-cp4a-operator oc scale --replicas=0 deployment ibm-insights-engine-operator - Retrieve the recovery path locations for each BAI component for which BAI savepoints are created from ./bai.json and update the bai_configuration section of the custom resource file. For Example: If there is a BAI savepoint being created for navigator component, then the updated custom resource file should have the below configuration.
bai_configuration: navigator: recovery_path: /mnt/pv/savepoints/dba/bai-navigator/savepoint-fb88f4-42027046b73b ... # Add recovery_path for all other components - Once the upgrade has been completed, make sure to remove all instances of the recovery_path parameters from the updated custom resource file.
Actions:
From the branch that you cloned above navigate to the scripts directory and perform the following steps to upgrade the CP4BA operators and deployment.- Upgrade the CP4BA operators.
- Warning:
The script with the upgradeOperator option will scale the CP4BA Operators down to zero. You must execute the script with the upgradeDeploymentStatus mode to scale them back in. - Actions:
Run the cp4a-deployment.sh script with the upgradeOperator option to upgrade the IBM Cloud Pak foundational services/CP4BA operators:./scripts/cp4a-deployment.sh -m upgradeOperator -n <CP4BA Namespace>
- Warning:
- Wait for the operators to complete their upgrades.
By default all subscriptions are set to automatic, but if you have any subscriptions set to manual then you need to approve any pending InstallPlans.
Use the below command to see the current status of the install plans.
The upgrade will be blocked, if any of the needed InstallPlans are not approved. It is not recommended to set subscriptions to manual as this makes the upgrade more error prone.oc get installPlan - You can use the following scripts to check the status of the upgrades.
- Warning:
The script will scale the CP4BA deployments down to zero. You must execute the cp4a-deployment.sh script with upgradeDeploymentStatus option to scale them back up. - Actions:
[OPTIONAL] Run the cp4a-deployment.sh script with upgradeOperatorStatus option to check that the upgrade of the CP4BA operator and its dependencies is successful:./scripts/cp4a-deployment.sh -m upgradeOperatorStatus -n <CP4BA Namespace>
- Warning:
- Start up the upgraded CP4BA Operators.
Run the cp4a-deployment.sh script with upgradeDeploymentStatus option to check that the upgrade of the CP4BA deployment is successful:./scripts/cp4a-deployment.sh -m upgradeDeploymentStatus -n <CP4BA Namespace>Note: If you are using the P8BPMREST CPE end point, you must wait for the CPE components status to display "Done" and then execute the below command to make it accessible.kubectl patch zenextension <CUSTOM_RESOURCE_FILENAME>-cpe-zen-extension -n <CP4BA NAMESPACE> --type=merge -p '{"metadata": {"annotations": {"checksum_cpe_ips": "0"}}}'
-
-
Scenario 9: Your installed Production deployment is 24.0.1 GA or newer and using airgap/offline.Note:
As prerequisites for this scenario, you must follow steps here to set up the bastion host to mirror images to the registry and further to set up the private registry.
For a dedicated deployment or namespace scoped deployment, the value for < CP4BA Namespace > should be the namespace where all IBM Cloud Pak foundational services/CP4BA Operators and Services are deployed. If the CP4BA Operators and Services are deployed in different namespaces( separation of duties), the value for < CP4BA Namespace > should be the namespace where all IBM Cloud Pak foundational services/CP4BA Operators are deployed in.
Warning:
For a CP4BA Deployment with BAI ( Business Automation Insights ) selected as an optional component, it is recommended to create BAI savepoints before starting the upgrade process to this interim fix. For Flink event processing to resume from its previous state, savepoints are required to be created before the upgrade and specified in the updated CR. BAI savepoints can be created by following the below steps.-
Retrieve the name of the InsightsEngine custom resource file.Create BAI savepoints and store them in a temporary file called bai.json.
InsightsEngine_CR=$(kubectl get InsightsEngine --no-headers --ignore-not-found -n <CP4BA-Namespace> -o name)Retrieve and export the below details.export MANAGEMENT_URL=$(kubectl get ${InsightsEngine_CR} --no-headers --ignore-not-found -n <CP4BA Namespace> -o jsonpath='{.status.components.management.endpoints[?(@.scope=="External")].uri}') export MANAGEMENT_AUTH_SECRET=$(kubectl get ${InsightsEngine_CR} --no-headers --ignore-not-found -n <CP4BA Namespace> -o jsonpath='{.status.components.management.endpoints[?(@.scope=="External")].authentication.secret.secretName}') export MANAGEMENT_USERNAME=$(kubectl get secret ${MANAGEMENT_AUTH_SECRET} --no-headers --ignore-not-found -n <CP4BA Namespace> -o jsonpath='{.data.username}' | base64 -d) export MANAGEMENT_PASSWORD=$(kubectl get secret ${MANAGEMENT_AUTH_SECRET} --no-headers --ignore-not-found -n <CP4BA Namespace> -o jsonpath='{.data.password}' | base64 -d)curl -X POST -k -u ${MANAGEMENT_USERNAME}:${MANAGEMENT_PASSWORD} "${MANAGEMENT_URL}/api/v1/processing/jobs/savepoints" -o ./bai.jsonScale down the CP4BA and Insights Engine Operator.oc scale --replicas=0 deployment ibm-cp4a-operator oc scale --replicas=0 deployment ibm-insights-engine-operator - Retrieve the recovery path locations for each BAI component for which BAI savepoints are created from ./bai.json and update the bai_configuration section of the custom resource file. For Example: If there is a BAI savepoint being created for navigator component, then the updated custom resource file should have the below configuration.
bai_configuration: navigator: recovery_path: /mnt/pv/savepoints/dba/bai-navigator/savepoint-fb88f4-42027046b73b ... # Add recovery_path for all other components - Once the upgrade has been completed, make sure to remove all instances of the recovery_path parameters from the updated custom resource file.
Actions:
Perform the following steps and then the upgrade of operators and deployments will start.- To upgrade an airgap/offline Production deployment, find mirror file cp4ba-case-to-be-mirrored-24.0.1-IF003.txt for this interim fix from the branch that you cloned above under the scripts/airgap directory. Execute this command from your bastion host to download the CASE files:
The (absolute path to file) needs to be a path starting from "/". For example, "/opt".oc ibm-pak get -c file://(absolute path to file)/cp4ba-case-to-be-mirrored-24.0.1-IF003.txt -
You will need to mirror the images associated with the new cp4ba-case-to-be-mirrored-24.0.1-IF003.txt mirror file.
Follow the instructions for either mirroring option in Mirroring images to the private registry using the new CASE version associated with this interim fix. If you are looking to install only a set of capabilities then you can make use of filters listed in Table 1 so that you can only download the specific set of images that you require. Please note that if the set of capabilities include Business Automation Workflow, Process Federation Server, Workflow Process Service or Business Automation Insights then make sure to include the filter "ibm_es_1_1_2470".export CASE_NAME=ibm-cp-automation export CASE_VERSION=24.1.3 export CASE_INVENTORY_SETUP=cp4aOperatorSetup export TARGET_REGISTRY=<target-registry> export NAMESPACE=<cp4ba_namespace_name> -
From the branch that you cloned above navigate to the scripts directory and perform the following steps to upgrade the CP4BA operators.
- Warning:
The script with the upgradeOperator option will scale the CP4BA Operators down to zero. You must execute the script with the upgradeDeploymentStatus mode to scale them back in. - Actions:
Run the cp4a-deployment.sh script with the upgradeOperator option to upgrade the IBM Cloud Pak foundational services/CP4BA operators:
./scripts/cp4a-deployment.sh -m upgradeOperator -n <CP4BA Namespace>
- Warning:
-
Wait for the operators to complete their upgrades.
By default all subscriptions are set to automatic, but if you have any subscriptions set to manual then you need to approve any pending InstallPlans.
Use the below command to see the current status of the install plans.
The upgrade will be blocked, if any of the needed InstallPlans are not approved. It is not recommended to set subscriptions to manual as this makes the upgrade more error prone.oc get installPlan -
You can use the following scripts to check the status of the upgrades.
- Warning:
The script will scale the CP4BA deployments down to zero. You must execute the cp4a-deployment.sh script with upgradeDeploymentStatus option to scale them back up. - Actions:
[OPTIONAL] Run the cp4a-deployment.sh script with upgradeOperatorStatus option to check that the upgrade of the CP4BA operator and its dependencies is successful:./scripts/cp4a-deployment.sh -m upgradeOperatorStatus -n <CP4BA Namespace>
- Warning:
- Start up the upgraded CP4BA Operators.
Run the cp4a-deployment.sh script with upgradeDeploymentStatus option to check that the upgrade of the CP4BA deployment is successful:
Note: If you are using the P8BPMREST CPE end point, you must wait for the CPE components status to display "Done" and then execute the below command to make it accessible../scripts/cp4a-deployment.sh -m upgradeDeploymentStatus -n <CP4BA Namespace>kubectl patch zenextension <CUSTOM_RESOURCE_FILENAME>-cpe-zen-extension -n <CP4BA NAMESPACE> --type=merge -p '{"metadata": {"annotations": {"checksum_cpe_ips": "0"}}}'
-
-
Scenario 10: You had installed or upgraded to 24.0.1-IF002 before a fix for https://www.ibm.com/support/pages/node/7233623 was availableNote:
In this case the existing deployment should be upgraded to the newer version which contains the fix
- If you have deployed in Airgap/Offline
Note:
As prerequisites for this scenario, you must follow steps here to set up the bastion host to mirror images to the registry and further to set up the private registry. When mirroring this refreshed version make sure you are using previously used registry folder where you have mirrored images from this mirror file cp4ba-case-to-be-mirrored-24.0.1-IF002.txt. This will only mirror the updated images instead all images again.
Actions:- To upgrade an airgap/offline Production deployment, find mirror file cp4ba-case-to-be-mirrored-24.0.1-IF003.txt for this interim fix from the branch that you cloned above under the scripts/airgap directory. Execute this command from your bastion host to download the CASE files:
The (absolute path to file) needs to be a path starting from "/". For example, "/opt".oc ibm-pak get -c file://(absolute path to file)/cp4ba-case-to-be-mirrored-24.0.1-IF003.txt -
You will need to mirror the images associated with the new cp4ba-case-to-be-mirrored-24.0.1-IF003.txt mirror file.
export CASE_NAME=ibm-cp-automation export CASE_VERSION=24.1.3 export CASE_INVENTORY_SETUP=cp4aOperatorSetup export TARGET_REGISTRY=<target-registry> export NAMESPACE=<cp4ba_namespace_name>Follow the instructions for either mirroring option in Mirroring images to the private registry using the new CASE version associated with this interim fix. If you are looking to install only a set of capabilities then you can make use of filters listed in Table 1 so that you can only download the specific set of images that you require. Please note that if the set of capabilities include Business Automation Workflow, Process Federation Server, Workflow Process Service or Business Automation Insights then make sure to include the filter "ibm_es_1_1_2470".
- To upgrade an airgap/offline Production deployment, find mirror file cp4ba-case-to-be-mirrored-24.0.1-IF003.txt for this interim fix from the branch that you cloned above under the scripts/airgap directory. Execute this command from your bastion host to download the CASE files:
- For online and offfline/airgap deployment
Actions:- Navigate to the descriptors/op-olm directory
- Open the catalog_source.yaml file. Replace the namespace from openshift-marketplace to the required namespace value
- Apply the catalog source to the cluster
oc apply -f catalog_source.yaml -n ${NAMESPACE} - Wait for the operators to be upgraded. The ibm-cp4a-operators, icp4a-foundation-operator, and ibm workflow-operator would be upgraded to 24.1.3
- Once all operators are upgraded, the new versions can be verified by checking the CSV versions of the operators:
$ oc get csv NAME DISPLAY VERSION REPLACES PHASE ibm-ads-operator.v24.1.2 IBM CP4BA Automation Decision Service 24.1.2 ibm-ads-operator.v24.1.1 Succeeded ibm-cert-manager-operator.v4.2.12 IBM Cert Manager 4.2.12 ibm-cert-manager-operator.v4.2.11 Succeeded ibm-common-service-operator.v4.11.0 IBM Cloud Pak foundational services 4.11.0 ibm-common-service-operator.v4.10.0 Succeeded ibm-content-operator.v24.1.2 IBM CP4BA FileNet Content Manager 24.1.2 ibm-content-operator.v24.1.1 Succeeded ibm-cp4a-operator.v24.1.3 IBM Cloud Pak for Business Automation (CP4BA) multi-pattern 24.1.3 ibm-cp4a-operator.v24.1.1 Succeeded ibm-cp4a-wfps-operator.v24.1.2 IBM CP4BA Workflow Process Service 24.1.2 ibm-cp4a-wfps-operator.v24.1.1 Succeeded ibm-dpe-operator.v24.1.2 IBM Document Processing Engine 24.1.2 ibm-dpe-operator.v24.1.1 Succeeded ibm-insights-engine-operator.v24.1.2 IBM CP4BA Insights Engine 24.1.2 ibm-insights-engine-operator.v24.1.1 Succeeded ibm-odm-operator.v24.1.2 IBM Operational Decision Manager 24.1.2 ibm-odm-operator.v24.1.1 Succeeded ibm-pfs-operator.v24.1.2 IBM CP4BA Process Federation Server 24.1.2 ibm-pfs-operator.v24.1.1 Succeeded ibm-workflow-operator.v24.1.3 IBM Business Automation Workflow Runtime and Workstream Services 24.1.3 ibm-workflow-operator.v24.1.1 Succeeded icp4a-foundation-operator.v24.1.3 IBM CP4BA Foundation 24.1.3 icp4a-foundation-operator.v24.1.1 Succeeded operand-deployment-lifecycle-manager.v4.4.0 Operand Deployment Lifecycle Manager 4.4.0 operand-deployment-lifecycle-manager.v4.3.7 Succeeded
- If you have deployed in Airgap/Offline
Performing the necessary tasks after installation
a. 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 icp4adeploy -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.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
- Cloud Pak for Business Automation Operator
- Automation Document Processing
- Automation Decision Services
- Business Automation Application
- Business Automation Insights
- Business Automation Navigator
- Business Automation Studio
- Business Automation Workflow including Automation Workstream Services
- Enterprise Records
- FileNet Content Manager
- Operational Decision Management
- User Management Service
- Workflow Process Service
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-2019-12900,CVE-2021-27290,CVE-2021-3807,CVE-2023-27043,CVE-2023-28319,CVE-2023-39333,CVE-2023-4218,CVE-2024-11168,CVE-2024-11187,CVE-2024-12705,CVE-2024-21096,CVE-2024-3596,CVE-2024-43855,CVE-2024-47554,CVE-2024-50302,CVE-2024-50349,CVE-2024-52006,CVE-2024-53197,CVE-2024-6923,CVE-2024-8184,CVE-2024-9287,CVE-2025-0665,CVE-2025-1094,CVE-2025-1247,CVE-2025-21490,CVE-2025-21785,CVE-2025-22150,CVE-2025-23083,CVE-2025-23085,CVE-2025-23184,CVE-2025-24855,CVE-2025-26519,CVE-2025-27152,CVE-2025-29923,CVE-2025-3277,DSA-5863-1,GHSA-r68h-jhhj-9jvm,PRISMA-2021-0153,RHSA-2025:1330,RHSA-2025:1350,RHSA-2025:1443,RHSA-2025:1741,RHSA-2025:2679,RHSA-2025:3107,RHSA-2025:3407,RHSA-2025:3421,RHSA-2025:3531,RHSA-2025:3631,RHSA-2025:3634
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. |
|---|---|---|---|---|
| DT425276 | Customizing the CPD route to use no certificate, the cp4ba operator overwrites the change | |||
| DT435072 | Unable to access the ACCE console with HTTP ERROR 403. | |||
| DT423620 | [ARO] cp4ba deployment is failing due to the get certificate from IM operator from external route throwing error | |||
| DT426664 | Business Automation Workflow pod repeatedly restarting after applying Interim fix 4 for 24.0.0 | |||
| DT433773 | jvmOptions in Workflow Process Service operator for indicating multiple options requires a special syntax different than other operators |
Automation Document Processing
| Known Issue | Title | Sec. | Cont. | B.I. |
|---|---|---|---|---|
| DT425982 | Automation Document Processing returns an invalid json when the document is unreadable | X | X | |
| DT426718 | Documentation: Need steps to add object stores to Automation Document Processing | X | ||
| DT436628 | Failed documents need to be removed from extraction training | X | X |
Automation Decision Services
| Known Issue | Title | Sec. | Cont. | B.I. |
|---|---|---|---|---|
| DT399723 | Numbers with more than 16 digits are rounded off | |||
| DT419752 | Attributes of type java.lang.String[][] in the BOM lead to Concept already exists in target vocabulary: ilog.rules.brl.String | |||
| DT425467 | Maven build of a model can be very slow |
Business Automation Application
| Known Issue | Title | Sec. | Cont. | B.I. |
|---|---|---|---|---|
| DT423276 | Unable to search Task in the Process Portal Work Dashboard |
Business Automation Insights
| Known Issue | Title | Sec. | Cont. | B.I. |
|---|---|---|---|---|
| N/A | N/A |
Business Automation Navigator
| Known Issue | Title | Sec. | Cont. | B.I. |
|---|---|---|---|---|
| Please see Business Automation Navigator Fix List APARs for Cloud Pak for Business Automation technote |
Business Automation Studio
| Known Issue | Title | Sec. | Cont. | B.I. |
|---|---|---|---|---|
| DT423859 | Security vulnerability in CVE-2023-4218 affects eclipse.jars | X | ||
| DT424716 | Security vulnerability CVE-2025-1495 lack of authorization validation affects Workflow Center and Business Automation Studio | X | ||
| DT425691 | Security vulnerability CVE-2025-1838 affects IBM Workflow Center and IBM Business Automation Studio | X | ||
| DT418087 | Illegal XML Character: 0xd83d in Process app causes export to fail in IBM Workflow Center | |||
| DT423276 | Unable to search Task in the Process Portal Work Dashboard | |||
| DT433874 | Blank editor property sheets after renaming an activity | |||
| DT434513 | Searching processes in Process Portal results in ''org.apache.lucene.search.BooleanQuery$TooManyClauses: maxClauseCount is set to 1024'' error |
Business Automation Workflow including Automation Workstream Services
| Known Issue | Title | Sec. | Cont. | B.I. |
|---|---|---|---|---|
| DT417496 | CVE-2024-31141 in kafka-clients reported for bai-events-java-sdk | X | ||
| DT424716 | Security vulnerability CVE-2025-1495 lack of authorization validation affects Workflow Center and Business Automation Studio | X | ||
| DT425691 | Security vulnerability CVE-2025-1838 affects IBM Workflow Center and IBM Business Automation Studio | X | ||
| DT433330 | Security vulnerabilities CVE-2024-57965, CVE-2025-27152 and CVE-2025-27789 affect Process Admin Console | X | ||
| DT395245 | Unable to upload file using BPM document list control after installing the DT213423 & DT380377 fixes | |||
| DT419248 | You see error in case activities cshs view, FNRPA0556E The deployed task type info object for the {GUID} task type was not found after solution deployment. | |||
| DT423276 | Unable to search Task in the Process Portal Work Dashboard | |||
| DT423451 | The BPM document list component can upload the same file multiple times | |||
| DT425091 | The Process Admin Console displays the html encoded text of the Exposed Process Variable's external description | |||
| DT425681 | Even though monitoring for Workflow is enabled there are no prometheus events | |||
| DT425711 | Workflow pods are slow or fail to startup due to the IBM_BPM_Portal application - Cloud Pak for Business Automation | |||
| DT426664 | Business Automation Workflow pod repeatedly restarting after applying Interim fix 4 for 24.0.0 | |||
| DT431851 | baw-db-init pod is going into 'CrashLoopBackOff' while moving inflight process instances from traditional Business Automation Workflow 24.0.1.0 to Cloud Pak for Business Automation 24.0.1 | |||
| DT433874 | Blank editor property sheets after renaming an activity | |||
| DT434439 | The Case REST API ''/writableappspaces/{appspace}/roles/{role}/member'' has a 1k limit for the number of returned users. | |||
| DT434695 | Saved search acceleration tools table column size limitation of 128 chars impacts IBM Business Automation Workflow Case dynamic filters |
Enterprise Records
| Known Issue | Title | Sec. | Cont. | B.I. |
|---|---|---|---|---|
| N/A | N/A |
FileNet Content Manager
| APAR | Title | Sec. | Cont. | B.I. |
|---|---|---|---|---|
| See FileNet Content Manager Release Fix List APARs for IBM Cloud Pak for Business Automation technote |
Operational Decision Management
| Known Issue | Title | Sec. | Cont. | B.I. |
|---|---|---|---|---|
| DT431954 | ERROR IN CLEANUP SERVICE REST API WHEN DELETE TEST REPORT | |||
| DT422536 | EXECUTION OF RULEAPPS EXCEEDING A CERTAIN AMOUNT OF (DYNAMIC) DOMAINS IS NOT POSSIBLE | |||
| DT424788 | ERROR WHEN LOADING THE CUSTOM PROPERTIES IN EDITOR VIEW IF CONTAINS DATE TIME PROPERTIES | |||
| DT418896 | NO DECISION SERVICE DISPLAYED IN THE BUSINESS CONSOLE FOR SOME USERS | |||
| DT390112 | INCONSISTENT BEHAVIOUR WHILE HANDLING DECSIONID | |||
| DT425334 | LIST OF DYNAMIC DOMAIN VALUES DISAPPEARS AFTER SYNCHONIZATION | |||
| DT417140 | UNABLE TO DELETE A PROJECT IN THE BACKGROUND | |||
| DT417126 | FORCEFULLY DELETE BASELINE IF THERE IS AN DEPENDENCY TO AN UNKNOWN PROJECT | |||
| DT418490 | CLASSFORMATERROR ERROR BUILDING A RULESET WITH AUTOMATIC EXCEPTION HANDLING | |||
| DT424303 | CUSTOM GROUP UPDATE /CREATION IS DISABLED ON ODM ON CLOUD | |||
| DT423809 | DEPLOYMENT TIME INCREASE WHEN USING OVERRIDDEN RULES | |||
| DT423884 | UNABLE TO DELETE A TEST REPORT IN BUSINESS CONSOLE | |||
| DT421807 | TEST SUITE FAILURE DUE TO DELETION OF TEST REPORT DURING ONGOING TEST | |||
| DT426754 | RULE DESIGNER SAVE BUTTON MULFUNCTION IN DECISION TABLE | |||
| DT426494 | HANDLE NULLPOINTEREXCEPTION WHEN DYNAMIC DOMAIN PROVIDER CLASS IS INVALID | |||
| DT426440 | RULE EXPRESSION CONVERTED TO STRING IN DECISION TABLE ACTION COLUMN | |||
| DT425653 | NPE IN RULE DESIGNER WHEN EDITING RULEFLOW TASK PROPERTIES ON SAME TAB | |||
| DT426467 | STRUCT TYPE PROPERTIES NOT BEING RETURNED DECISION CENTER REST API | |||
| DT421854 | WHEN RULE PROPERTY NAMES ARE LONG, BC DETAILS PANE DOESN'T ADJUST WIDTH ACCORDINGLY | |||
| DT418606 | B2X IMPORT THROWS UNEXPECTED WARNING MESSAGE |
User Management Service
| Known Issue | Title | Sec. | Cont. | B.I. |
|---|---|---|---|---|
| DT425507 | Business Automation Workflow and Cloud Pak for Automation Operators fail while waiting for SCIM POD |
Workflow Process Service
| Known Issue | Title | Sec. | Cont. | B.I. |
|---|---|---|---|---|
| DT417496 | CVE-2024-31141 in kafka-clients reported for bai-events-java-sdk | X | ||
| DT433330 | Security vulnerabilities CVE-2024-57965, CVE-2025-27152 and CVE-2025-27789 affect Process Admin Console | X | ||
| DT431851 | baw-db-init pod is going into 'CrashLoopBackOff' while moving inflight process instances from traditional Business Automation Workflow 24.0.1.0 to Cloud Pak for Business Automation 24.0.1 | |||
| DT433773 | jvmOptions in Workflow Process Service operator for indicating multiple options requires a special syntax different than other operators | |||
| DT434695 | Saved search acceleration tools table column size limitation of 128 chars impacts IBM Business Automation Workflow Case dynamic filters |
Known Limitations
Document change history
Related Information
[{"Type":"MASTER","Line of Business":{"code":"LOB76","label":"Data Platform"},"Business Unit":{"code":"BU048","label":"IBM Software"},"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":"24.0.1"}]
Was this topic helpful?
Document Information
Modified date:
16 July 2025
UID
ibm17184634