Fix Readme
Abstract
The following document is for IBM Cloud Pak for Business Automation 22.0.1 IF006. 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.1 |
Update Name: | 22.0.1 IF006 |
Fix ID: | 22.0.1-WS-CP4BA-IF006 |
Publication Date: | 28 December 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 22.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 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
- 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 previous CPD route for CMIS has changed
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.
- Cloud Pak for Business Automation – 22.0.1-IF006
- IBM Automation Foundation – 1.3.12
- Cloud Pak Foundational Services – 3.22.0
-
Scenario 1: You are deploying a Starter deploymentActions: 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 deploymentActions: You can use this interim fix content to perform a Production deployment. To deploy a Production deployment using the content of this interim fix, please see install a new Production environment and use the CASE package from this interim fix.
-
Scenario 3: You already have a Production deployment installed with 22.0.1 GA or 22.0.1 + any interim fix prior to this one, and now you want to install another Production deployment using this interim fix on the same Openshift cluster.
Actions: If you have existing production deployment with 22.0.1 GA or 22.0.1 + any interim fix prior to this one and you want to install another production deployment of this interim fix using pinned catalogs, then you must first upgrade existing Cloud Pak Foundational Services to version 3.22.0 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.1. Make sure that you upgrade the Cloud Pak Foundational Services to 3.22.0 before you apply the catalog sources from Scenario 6.
- Log in to the cluster as an administrator by using the oc login command.
- Download the upgrade_common_services.sh script to your local machine.
- Run the script with the
all namespaces
flag and channel version to the command:- ./upgrade_common_services.sh -a -c v3.22
- 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 namespacecp4ba-cs
to versionv3.22
, run the following command:- ./upgrade_common_services.sh -cloudpaksNS cp4ba -csNS cp4ba-cs -c v3.22
- Refer to the Cloud Pak Foundational Services upgrade section in the What's new in 22.0.1. Make sure that you upgrade the Cloud Pak Foundational Services to 3.22.0 before you apply the catalog sources from Scenario 6.
-
Scenario 4: Your installation is version 21.0.3-IFxxx and you're not using pinned catalog
Actions: If you are using 21.0.3-IFxxx and not pinned catalogs, then your deployment is automatically updated to the latest interim fix of 21.0.3 in the v21.3 channel. To change this behavior , please follow Upgrading operators that are not pinned instructions. -
Scenario 5: Your installation is version 21.0.3-IFxxx and you're using pinned catalog (note that pinned catalog was available with 21.0.3-IF007 or later)
Actions: If your installation is 21.0.3-IFxxx and using pinned catalogs, then you must upgrade the operators for all of the Cloud Pak operators to 22.0.1-IF006. You can use the OpenShift console or the command line, please follow Upgrading operators that are pinned instructions. - Scenario 6: Your installation is online and 22.0.1 GA or 22.0.1 + any interim fix.
Actions: If you are using version 22.0.1 GA or 22.0.1 + any interim fix, then you must first upgrade existing Cloud Pak Foundational Services to version 3.22.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.1. Make sure that you upgrade the Cloud Pak Foundational Services to 3.22.0 before you apply the catalog sources below.
- Log in to the cluster as an administrator by using the oc login command.
- Download the upgrade_common_services.sh script to your local machine.
- Run the script with the
all namespaces
flag and channel version to the command:- ./upgrade_common_services.sh -a -c v3.22
- 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 namespacecp4ba-cs
to versionv3.22
, run the following command:- ./upgrade_common_services.sh -cloudpaksNS cp4ba -csNS cp4ba-cs -c v3.22
- You 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 22.0.1 IF006 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:0b724f12b8a2854228af29c924da30aef38227cb57c30aff54d2aba0763f915f updateStrategy: registryPoll: interval: 45m --- # IBM Automation Foundation Base 1.3.12 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:61b40644c6442b21cce3d32eb07b3ae9bc4443b43d33575a8c73fb9cac6bfb57 updateStrategy: registryPoll: interval: 45m --- # IBM Automation Foundation Core 1.3.12 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:39ba42e91d7493d1ff7326d5364b99fe7305dbe713a71948de97b6a730314ede updateStrategy: registryPoll: interval: 45m --- # IBM Cloud Foundational Services 3.22.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:54a294b34afe71ceede6ebe6c8922b5a8accc7ca3bc23a828b885fc795d32c72 updateStrategy: registryPoll: interval: 45m priority: 100 --- # IBM Business Teams Service version 3.22.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:ea115ec291e4a0d1c17ed7dd7bee052c2a780fba60fe80f128d084074d71a070 updateStrategy: registryPoll: interval: 45m --- # Cloud Native PostgresSQL 4.8.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:3da7f227fee1034d585c2c76a643a6d749784ca005565de83b0016079c5151ac updateStrategy: registryPoll: interval: 45m priority: 100
-
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.
- Apply the catalog sources to pin to the specified versions for IBM Automation Foundation, IBM Foundational Services with Cloud Pak for Business Automation.
- Refer to the Cloud Pak Foundational Services upgrade section in the What's new in 22.0.1. Make sure that you upgrade the Cloud Pak Foundational Services to 3.22.0 before you apply the catalog sources below.
-
Scenario 7: Your installation is air gap and 22.0.1 GA or 22.0.1 + any interim fix
Actions: If you are using version 22.0.1 GA or 22.0.1 + any interim fix, then you must first upgrade existing Cloud Pak Foundational Services to version 3.22.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.1. Make sure that you upgrade the Cloud Pak Foundational Services to 3.22.0 before you apply the catalog sources from Scenario 6.
- Log in to the cluster as an administrator by using the oc login command.
- Download the upgrade_common_services.sh script to your local machine.
- Run the script with the
all namespaces
flag and channel version to the command:- ./upgrade_common_services.sh -a -c v3.22
- 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 namespacecp4ba-cs
to versionv3.22
, run the following command:- ./upgrade_common_services.sh -cloudpaksNS cp4ba -csNS cp4ba-cs -c v3.22
-
Follow the steps below on the bastion host where you previously deployed 22.0.1:
-
Set up the environment variables for CASE.
-
- export CASE_NAME=ibm-cp-automation
- export OFFLINEDIR=/opt/cp4ba2201-if006
- export CASE_VERSION=4.0.6
- 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:3f91e01f19883dfac600002cadaef2b9d59296fb7ec2bfa92220793eccc87b86 --outputdir ${OFFLINEDIR}
Once the command completes, all the Case archive and inventory are saved under /opt/cp4ba2201-if006. - 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/cp4ba2201-if005 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.
-
-
- Refer to the Cloud Pak Foundational Services upgrade section in the What's new in 22.0.1. Make sure that you upgrade the Cloud Pak Foundational Services to 3.22.0 before you apply the catalog sources from Scenario 6.
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, 22.0.1-IF006. - 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. - 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/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
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-39353, CVE-2022-42920, CVE-2022-1941, CVE-2020-35527, CVE-2022-40674, CVE-2022-2509, CVE-2020-35525, CVE-2022-42898, CVE-2022-42920, CVE-2022-37616, CVE-2022-39353, CVE-2022-37734, RHSA-2022:6878, RHSA-2022:7105, CVE-2022-1304, RHSA-2022:7089, RHSA-2022:7715, CVE-2016-3709, CVE-2020-35527, CVE-2020-35525, RHSA-2022:7106, CVE-2022-1941
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.
|
Known Issue | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
N/A | N/A |
Known Issue | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
DT172034 | Training hangs with object detection turned on in Starter deployment | X | X | |
DT196473 | Documentation - One Conversion pod needs the memory limit increased | X | X |
Known Issue | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
N/A | N/A |
Known Issue | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
N/A | N/A |
Known Issue | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
N/A | N/A |
Known Issue | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
Please see Business Automation Navigator Fix List APARs for Cloud Pak for Business Automation technote |
Known Issue | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
DT174377 | Business Automation import migration API results in "The reference view could not be resolved" error | |||
DT178158 | Security vulnerability CVE-2022-25887 affecting IBM Workflow center & Business Automation Studio |
Known Issue | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
N/A | N/A |
Known Issue | 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 |
Known Issue | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
DT172093 | WRONG TRANSLATION OF NUMBER LITERALS IN COLLECTION | |||
DT173771 | THE LIBRARY TAB MAY LIST ALL THE DECISION SERVICES UNDER SOME CIRCUMSTANCES | |||
DT173906 | LAST CHANGED ON DATES DO NOT ALWAYS SHOW THE TIME | |||
DT173997 | DOUBLE BYTES CHARACTERS IN ARTIFACT DESCRIPION IS MALFORMED DISPLAYED AFTER SAVE | |||
DT174051 | INDEXOUTOFBOUNDSEXCEPTION WHEN COMPARING RULE DIFFERENCES IN SNAPSHOT COMPARE | |||
DT178111 | SAVE RULE BUTTON IN BUSINESS CONSOLE UNEXPECTEDLY BECOMES INACTIVE |
Known Issue | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
N/A | N/A |
Known Issue | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
N/A | N/A |
Known Limitations
Document change history
Related Information
[Supersedes 22.0.1 IF005] Readme for Cloud Pak for Business Automation 22.0.1 I…
[Supersedes 22.0.1 IF004] Readme for Cloud Pak for Business Automation 22.0.1 I…
[Supersedes 22.0.1 IF003] Readme for Cloud Pak for Business Automation 22.0.1 I…
[Supersedes 22.0.1 IF002] Readme for Cloud Pak for Business Automation 22.0.1 I…
[Supersedes 22.0.1 IF001] Readme for Cloud Pak for Business Automation 22.0.1 I…
Was this topic helpful?
Document Information
Modified date:
15 February 2023
UID
ibm16846275