Fix Readme
Abstract
The following document is for IBM Cloud Pak for Business Automation 21.0.3 IF010. 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 IF010 |
Fix ID: | 21.0.3-WS-CP4BA-IF010 |
Publication Date: | 29 June 2022 |
Contents
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 21.0.3.
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 AutomationUIConfig -o yaml oc get Cartridge -o yaml oc get AutomationBase -o yaml oc get CartridgeRequirements -o yaml
- 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
- Cloud Pak for Business Automation – 21.0.3-IF010
- Automation Foundation – 1.3.7
- Cloud Pak Foundational Services – 3.19.0
-
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: If you are using version 21.0.3-IFxxx then you just need to apply below updated catalog sources and does not require to execute update_subscription.sh script to change the subscription.- 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 IF010 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:229c158cf01ecc7c54819f8e6f83682cf58d4855d01d3a06b6aeee3a39ea54f5 updateStrategy: registryPoll: interval: 45m --- # IBM Automation Foundation Base 1.3.7 apiVersion: operators.coreos.com/v1alpha1 kind: CatalogSource metadata: name: ibm-cp-automation-foundation-catalog namespace: openshift-marketplace spec: displayName: IBM Automation Foundation Operators publisher: IBM sourceType: grpc image: icr.io/cpopen/ibm-cp-automation-foundation-catalog@sha256:267bbc17bad1966be259bb9a6951c520c6fb824bfa42bbec22570ba49883d4ae updateStrategy: registryPoll: interval: 45m --- # IBM Automation Foundation Core 1.3.7 apiVersion: operators.coreos.com/v1alpha1 kind: CatalogSource metadata: name: ibm-automation-foundation-core-catalog namespace: openshift-marketplace spec: displayName: IBM Automation Foundation Core Operators publisher: IBM sourceType: grpc image: icr.io/cpopen/ibm-automation-foundation-core-catalog@sha256:5502c003afe7a0590ce123c3bbbd76e46374af641b3a210e3c25cfe2381e4647 updateStrategy: registryPoll: interval: 45m --- # IBM Cloud Foundational Services 3.19.0 apiVersion: operators.coreos.com/v1alpha1 kind: CatalogSource metadata: annotations: bedrock_catalogsource_priority: '1' name: opencloud-operators namespace: openshift-marketplace spec: displayName: IBMCS Operators publisher: IBM sourceType: grpc image: icr.io/cpopen/ibm-common-service-catalog@sha256:87904dee339ee4bbcbdc07949abc8df82bf6d85706f90795e6dae5e45f876b19 updateStrategy: registryPoll: interval: 45m priority: 100 --- # IBM 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.19.0 apiVersion: operators.coreos.com/v1alpha1 kind: CatalogSource metadata: annotations: bedrock_catalogsource_priority: '1' name: bts-operator namespace: openshift-marketplace spec: displayName: BTS Operator publisher: IBM sourceType: grpc image: icr.io/cpopen/ibm-bts-operator-catalog@sha256:68596113ad291b36b78d53207f73b53691f9f0154a21f38c717c08a0100deb9f updateStrategy: registryPoll: interval: 45m --- # Cloud Native PostgresSQL 4.0.8 apiVersion: operators.coreos.com/v1alpha1 kind: CatalogSource metadata: annotations: bedrock_catalogsource_priority: '1' name: cloud-native-postgresql-catalog namespace: openshift-marketplace spec: displayName: Cloud Native Postgresql Catalog publisher: IBM sourceType: grpc image: icr.io/cpopen/ibm-cpd-cloud-native-postgresql-operator-catalog@sha256:f3feb39b0dfb444a46d99a9cd160c616f8548d84d452cbc89e4985f0a2574486 updateStrategy: registryPoll: interval: 45m priority: 100
- Apply the catalog sources to pin to the specified versions for IBM Automation Foundation, IBM Foundational Services with Cloud Pak for Business Automation.
-
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). 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.-
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.
- 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.
- Log in to your OCP cluster as a cluster administrator
- 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.
- 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: 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). Your 21.0.3 installation has the latest iFix or this iFix because you are using the IBM Operator Catalog. Now you want to upgrade the installation to 22.0.1 and want to switch to use "pinned" catalogs.
Actions: Apply the updated catalog sources above in scenario #3 for 21.0.3. Then execute the "update_subscription.sh" script to change the subscriptions to use "pinned" catalogs.-
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 in scenario #3 for 21.0.3 .
- 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.
- Log in to your OCP cluster as a cluster administrator
- 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. This update process might take some time to restart all the operators.
- 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. - Once the subscriptions are updated and operators restarted follow the steps from Upgrading operators that are pinned.
-
-
Scenario 6: 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.-
Set up the environment variables for CASE.
- export CASE_NAME=ibm-cp-automation
- export OFFLINEDIR=/tmp/cp4ba-if010
- export CASE_VERSION=3.2.10
- 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.
-
Save this specific set of case packages
cloudctl case save --case docker://icr.io/cpopen/ibm-cp-automation-case-cache@sha256:163df287aa1a5e3bf5c7ff8915393b161e3ba62c328348d27be65f5c3134a546 --outputdir ${OFFLINEDIR}
Once the command completes, all the Case archive and inventory are saved under /tmp/cp4ba-if010. - 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/cp4ba-if010) from step 1. - 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"
-
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
- 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. - 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 theibm-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. - 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. - Required when you are using Workflow Process Service Docker Compose Edition
- 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.
- Back up your database backup, docker-compose.yml and folder for docker volumes “production_workflow_runtime_data” and “production_workflow_runtime_logs”.
- (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>
- Run
docker-compose down
command to stop the Workflow Process Server container. - 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-IF010. - 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 on Podman or Troubleshooting Workflow Process Service on Docker. - 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
List of Fixes
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
- 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
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-2022-30973,CVE-2022-25878,CVE-2022-24434,CVE-2022-33987,CVE-2021-35604,CVE-2021-46659,CVE-2021-46661,CVE-2021-46662,CVE-2021-46663,CVE-2021-46664,CVE-2021-46665,CVE-2021-46667,CVE-2021-46668,CVE-2022-24048,CVE-2022-24050,CVE-2022-24051,CVE-2022-24052,CVE-2022-31621,CVE-2022-31622,CVE-2022-31623,CVE-2022-31624,CVE-2022-27775,CVE-2021-3995,CVE-2021-3996,CVE-2022-0563,CVE-2021-4160,ALPINE-13661,CVE-2022-28391,CVE-2022-1552,CVE-2022-24975,CVE-2022-1587,CVE-2022-23990,CVE-2021-3712,CVE-2022-25169,CVE-2022-30126,CVE-2022-29155,CVE-2022-1664,CVE-2019-20838,CVE-2019-13050,CVE-2019-18276
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.
|
APAR | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
JR65029 |
COLLECTD PCH MONITORING GENERATES TOO MUCH LOG ENTRIES |
|||
JR65049 | WITH PROXY SETTING IN OCP, YOU'LL SEE "503 SERVICE UNAVAILABLE" BETWEEN SERVICE COMMUNICATION | |||
JR65062 | FILENET CONTENT MANAGER OPERATOR FAILS TO START IBM CONTENT NAVIGATOR AFTER UPGRADE FROM 21.0.2 TO 2.0.3GM |
APAR | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
JR64993 | TRAINING A MODEL FAILS WITH A NO SUCH FILE ERROR | X | X | |
JR65056 | CHECKBOX PROPERTIES ARE LOST WHEN DEPLOYING AN ADP PROJECT | X | X | |
JR65057 | PROCESSING EXTRACTION LOG SHOWS SENSITIVE INFORMATION | X | X | |
JR65058 | ADP RUNTIME TEXT EDIT BOX NOT TRIMMING TRAILING SPACES | X | X | |
JR65064 | FILE UPLOAD FAILS AFTER CHANGING CHECKBOX DEFAULT IN DATA STANDARDIZATION | X | X | |
JR65065 | CONTENT DESIGNER VIEWER DOESN'T RESET PAGE WHEN SWITCHING TO ANOTHER DOCUMENT | X | X |
APAR | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
N/A | N/A |
APAR | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
N/A | N/A |
APAR | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
N/A | N/A |
APAR | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
N/A | N/A |
APAR | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
JR64868 | SECURITY VULNERABILITY EXISTS IN THE ASYNC NPM PACKAGE | X | ||
JR64943 | A 403 ERROR APPEARS IN THE BROWSER CONSOLE WHEN ACCESSING PROCESS DESIGNER | |||
JR65005 | DEBUG FAILS TO STEP INTO NESTED SERVICES FLOW IN IBM CLOUD PAK FOR BUSINESS AUTOMATION |
APAR | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
JR64602 | USING ROUND BRACKETS CHARACTERS '(' OR ')' IN A IBM CLOUD PAK FOR BUSINESS AUTOMATION SECRET PASSWORD WILL CAUSE FAILURES | |||
JR64886 | CAN NOT SELECT TAB IN EDITOR WHEN NESTED IN A COMPOSITE VIEW | |||
JR64944 | PROCESS FEDERATION SERVER MAY ASSIGN MORE INDEXER PARTITIONS THAN AVAILABLE AGENTS CAN CONSUME | |||
JR64968 | PROCESS FEDERATION SERVER SEARCH QUERIES FAIL IF A RETURNED DOCUMENT CONTAINS THE _IGNORED FIELD | |||
JR64969 | THE TEAM PERFORMANCE DASHBOARD CANNOT BE ACCESSED ON PROCESS PORTAL RUNNING ON MULTIPLE FEDERATED BAW SYSTEMS | |||
JR65018 | MULTIPLE VULNERABILITIES ARE REPORTED FOR JRULES-RES-EXECUTION.JAR AND JQUERY-UI-1.10.4.MIN.JS |
APAR | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
N/A
|
N/A
|
APAR | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
See FileNet Content Manager Release Fix List APARs for IBM Cloud Pak for Business Automation technote |
APAR | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
RS03915 | DEFAULT ROW ORDERING FOR DECISION TABLES NOT WORKING | |||
RS03928 | LONG RUNNING RETE EXECUTION WITH DECISION ENGINE MAY THROW OUTOFMEMORY EXCEPTION | |||
RS03931 | ERROR DURING DE RULESET GENERATION WHEN ASSIGNING A SUBCLASS OF INTEGER TO AN INT VARIABLE | |||
RS03916 | RULE DESIGNER MAY FAIL TO IMPORT MANY PROJECTS IN THE SAME WORKSPACE | |||
RS03868 | COMPARISON OF DECISION TABLE IN SYNCHRONIZATION VIEW SHOWS NON EXISTING DIFFERENCES |
APAR | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
N/A | N/A |
APAR | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
N/A | N/A |
Known Limitations
Document change history
Related Information
[Supersedes 21.0.3-IF009] Readme for Cloud Pak for Business Automation 21.0.3 I…
[Supersedes 21.0.3-IF008] Readme for Cloud Pak for Business Automation 21.0.3 I…
[Supersedes 21.0.3-IF007] Readme for Cloud Pak for Business Automation 21.0.3 I…
[Supersedes 21.0.3-IF006] Readme for Cloud Pak for Business Automation 21.0.3 I…
[Supersedes 21.0.3-IF005] Readme for Cloud Pak for Business Automation 21.0.3 I…
[Supersedes 21.0.3-IF004] Readme for Cloud Pak for Business Automation 21.0.3 I…
[Supersedes 21.0.3-IF003] Readme for Cloud Pak for Business Automation 21.0.3 I…
[Supersedes 21.0.3-IF002] Readme for Cloud Pak for Business Automation 21.0.3 I…
Was this topic helpful?
Document Information
Modified date:
01 April 2024
UID
ibm16597563