IBM Support

Readme for Cloud Pak for Business Automation 23.0.1 IF001

Fix Readme


Abstract

The following document is for IBM Cloud Pak for Business Automation 23.0.1 IF001. 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: 23.0.1
Update Name: 23.0.1 IF001
Fix ID: 23.0.1-WS-CP4BA-IF001
Publication Date: 27 July 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:
  3. oc get icp4acluster -o yaml 
oc get content -o yaml
oc get Foundation -o yaml
  4. 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  23.0.1-IF001
  • Cloud Pak Foundational Services  4.0.1
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 (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 Cloud Pak Foundational Services versions, listed above, with other Cloud Paks' specifications.
Important interim fix details:
The CASE package content is used to help facilitate installation and upgrade operation. See the various instructions for more specific details.
Cloud Pak for Business Automation 23.0.1 interim fixes are released to the v23.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.
Depending on the current setup and state of your existing environment, there are various upgrade actions that need to be taken.  The following scenarios cover what actions might be needed for a particular setup.
  • Scenario 1: You are using a Starter 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.
    Note: If you have an existing Cloud Pak Foundation Services instance installed in the cluster 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.
  • Scenario 2: You are installing 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.
    Note: If you have an existing Cloud Pak Foundation Services instance installed in the cluster 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.
  • Scenario 3: Your installed version is 22.0.2 IF00x (at least IF002).
    Actions:  
  • Scenario 4:  Your installation is 23.0.1 GA and is online
    Actions: 
    Perform the following steps and then the upgrade of operators and deployments will start.
    1. If CP4BA is installed with deployment scripts, you could upgrade to this interim fix with the following steps: 
      • Running the script to upgrade a CP4BA deployment from 23.0.1 GA/23.0.1.X to 23.0.1.X.
      • Run the script in [upgradeOperator] mode to upgrade the CP4BA operator
        Example: 
        ./cp4a-deployment.sh -m upgradeOperator -n <project_name>
      • Alternatively the catalog sources can be applied to pin to the specified versions for Cloud Pak Foundational Services and Cloud Pak for Business Automation. If you download and unzip the case package mentioned above, the needed catalogSource yaml file is located here: 
        ibm-cp-automation\inventory\cp4aOperatorSdk\files\deploy\crs\cert-k8s-23.0.1\cert-kubernetes\descriptors\op-olm\catalog_source.yaml
      • Execute: 
        oc apply -f catalog_source.yaml
      • Alternatively you can create the catalog_source.yaml file with the following text. 
        # CP4BA 23.0.1 IF001 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:983629656b4f0c5cffe8b079b4e329091d3d8ac2155626b11772b6a1ce8ad2f3
  updateStrategy:
    registryPoll:
      interval: 45m
---
# IBM CS Flink Operator Catalog 1.3.13
apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
  name: ibm-cs-flink-operator-catalog
  namespace: openshift-marketplace
spec:
  displayName: IBM CS Flink Operator
  publisher: IBM
  sourceType: grpc
  image: icr.io/cpopen/ibm-cs-flink-operator-catalog@sha256:076685012d2b2b4f42af2d9a678aa8a09065b126c3f36bd45be006db5a5775eb
  updateStrategy:
    registryPoll:
      interval: 45m
  priority: 100
---
# IBM CS Elastic Operator Catalog 1.3.13
apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
  name: ibm-cs-elastic-operator-catalog
  namespace: openshift-marketplace
spec:
  displayName: IBM CS Elastic Search Operator
  publisher: IBM
  sourceType: grpc
  image: icr.io/cpopen/ibm-cs-elastic-operator-catalog@sha256:655128dbed1bdc2eb80921956638d97b9f8c28d87b59f7692254d56f55b08166
  updateStrategy:
    registryPoll:
      interval: 45m
  priority: 100
---
# IBM Certificate Manager 4.0.0
apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
  name: ibm-cert-manager-catalog
  namespace: openshift-marketplace
spec:
  displayName: ibm-cert-manager-4.0.0
  publisher: IBM
  sourceType: grpc
  image: icr.io/cpopen/ibm-cert-manager-operator-catalog@sha256:9ecbd78444208da0e2981b7a9060d2df960e09b59ac9990a959df069864085c2
  updateStrategy:
    registryPoll:
      interval: 45m
---
# IBM License Manager 4.0.0
apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
  name: ibm-licensing-catalog
  namespace: openshift-marketplace
spec:
  displayName: ibm-licensing-4.0.0
  publisher: IBM
  image: icr.io/cpopen/ibm-licensing-catalog@sha256:81d170807fad802496814ef35ab5877684031c178117eb3c8dc9bdeddbb269a0
  sourceType: grpc
  updateStrategy:
    registryPoll:
      interval: 45m
---
# IBM Cloud Foundational Services 4.0.1
apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
  name: opencloud-operators-v4-0
  namespace: openshift-marketplace
  annotations:
    bedrock_catalogsource_priority: '1'
spec:
  displayName: IBMCS Operators
  publisher: IBM
  sourceType: grpc
  image: icr.io/cpopen/ibm-common-service-catalog@sha256:f8fb1181851da5f1145f07ee2fccd0b1e33d460bc016296f25168c558d89d11f
  updateStrategy:
    registryPoll:
      interval: 45m
  priority: 100    
---
# IBM Business Teams Service version 3.27.0
apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
  name: bts-operator
  namespace: openshift-marketplace
  annotations:
    bedrock_catalogsource_priority: '1'
spec:
  displayName: BTS Operator
  publisher: IBM
  sourceType: grpc
  image: icr.io/cpopen/ibm-bts-operator-catalog@sha256:944cb82d1457a97635e6abd2ba9dc245c056159b30e9469240abd831382d07b7
  updateStrategy:
    registryPoll:
      interval: 45m
---
# Cloud Native PostgresSQL 4.14.0+20230619
apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
  name: cloud-native-postgresql-catalog
  namespace: openshift-marketplace
  annotations:
    bedrock_catalogsource_priority: '1'
spec:
  displayName: Cloud Native Postgresql Catalog
  publisher: IBM
  sourceType: grpc
  image: icr.io/cpopen/ibm-cpd-cloud-native-postgresql-operator-catalog@sha256:a06b9c054e58e089652f0e4400178c4a1b685255de9789b80fe5d5f526f9e732
  updateStrategy:
    registryPoll:
      interval: 45m
  priority: 100
---
# IBM FileNet Content Manager Standalone catalog.
apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
  name: ibm-fncm-operator-catalog
  namespace: openshift-marketplace
spec:
  displayName: ibm-fncm-operator
  publisher: IBM
  sourceType: grpc
  image: icr.io/cpopen/ibm-fncm-catalog@sha256:2fd6f301b908d2385c0600554f74b35baa287f1e821ea7ea4cb14b133296a055
  updateStrategy:
    registryPoll:
      interval: 45m
    2. If you have any subscriptions set to manual, then you need to approve any pending InstallPlans.
      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.  By default all subscriptions are set to automatic.
    3. If CP4BA is installed with deployment scripts, you could check the status of the upgrade of the CP4BA operator and CP4BA deployment to this interim fix with the following steps:
      1. Run the script in [upgradeOperatorStatus] mode to check that the upgrade of the CP4BA operator and its dependencies is successful.
        Example:  
        ./cp4a-deployment.sh -m upgradeOperatorStatus -n <project_name>
      2. Run the script in [upgradeDeploymentStatus] mode to check that the upgrade of the CP4BA deployment is successful.
        Example: 
        ./cp4a-deployment.sh -m upgradeDeploymentStatus -n <project_name>
  • Scenario 5:  Your installation is 23.0.1 GA and using airgap/offline.
    Actions: 
    Perform the following steps and then the upgrade of operators and deployments will start.
    1. Get the case package mirror file, cp4ba-case-to-be-mirrored-23.0.1-IF001.txt, for interim fix and you must rename the file to cp4ba-case-to-be-mirrored-23.0.1-IF001.yaml.  Then execute this command to download the case files: 
      oc ibm-pak get -c file://(absolute path to file)/cp4ba-case-to-be-mirrored-23.0.1-IF001.yaml
      The (absolute path to file) needs to be a path starting from "/". For example, "/opt"
      For more information, see Downloading the CASE files.
    2. Follow the instructions for either mirroring option in Mirroring images to the private registry.
      Important: You must set export CASE_NAME=ibm-cp-automation and export CASE_VERSION=5.0.1 and that is the version for this iFix.
    3. Update the catalog with the new version. 
      cat $HOME/.ibm-pak/data/mirror/$CASE_NAME/$CASE_VERSION/catalog-sources.yaml | sed 's/opencloud-operators/opencloud-operators-v4-0/g' | oc apply -f -
    4. If you have any subscriptions set to manual, then you need to approve any pending InstallPlans.
      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.  By default all subscriptions are set to automatic.
  • Scenario 6: Your installed version is 22.0.2 IF00x (at least IF002) and using airgap/offline.
    Actions:  

Performing the necessary tasks after installation

  1. 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.
  2. Required when you are using Workflow Process Service Docker Compose Edition
    1. Follow the step 2 of section "3. Running your environment23.0.1?topic=installing-workflow-process-service-docker" rel="noopener" target="_blank">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, 23.0.1-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, 23.0.1-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.
  3. 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.12.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-2023-24815, CVE-2023-2974, GHSA-gpv5-7x3g-ghjv, CVE-2022-36944, CVE-2022-48281, CVE-2023-20883, CVE-2022-34169, CVE-2023-38288, CVE-2023-38289, CVE-2022-35252, CVE-2022-43552, CVE-2022-36227, CVE-2022-36944, RHSA-2023:3106, RHSA-2023:2963, RHSA-2023:3018, CVE-2022-43552, CVE-2023-27535, CVE-2022-35252, CVE-2023-2727, CVE-2023-2728, CVE-2023-20883, CVE-2023-24815, CVE-2022-34169
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.

Back to top

Cloud Pak for Business Automation Operator
Known Issue Title Sec. Cont. B.I.
N/A N/A

Back to top

Automation Document Processing
Known Issue Title Sec. Cont. B.I.
DT223973 Support for PostgreSQL missing on IBM Cloud Pak for Business Automation's System Requirements page

Back to top

Automation Decision Services
Known Issue Title Sec. Cont. B.I.
N/A N/A

Back to top

Known Issue Title Sec. Cont. B.I.
N/A N/A

Back to top

Business Automation Insights
Known Issue Title Sec. Cont. B.I.
N/A N/A

Back to top

Business Automation Navigator
Business Automation Studio
Known Issue Title Sec. Cont. B.I.
DT222890 Permissions cannot be changed for a user or group in the Add collaborators dialog
DT223311 Workflow pod readiness probe show the wrong status for User Management Services
DT223597 Automation Services tab is empty for Automation Decision Services projects in IBM Business Automation Studio
DT223644 "Learn more" link on Business automation home page doesn't work
DT224296 Status column under Versions tab doesn't show published snapshot

Back to top

Business Automation Workflow including Automation Workstream Services
Known Issue Title Sec. Cont. B.I.
DT220253 TASK NARRATIVE SECTION IN EMAIL NOTIFICATION IS NOT POPULATED FOR ALL TASKS IN PROCESS PORTAL
DT220319 PERFORMANCE DEGRADATION WHEN RUNNING REST API (DELETE) /OPS/STD/BPM/PROCESSES OR RUNNING BPMPROCESSINSTANCESPURGE COMMAND
DT223311 Workflow pod readiness probe show the wrong status for User Management Services
DT223489 Workplace Team Dashboard does not display team statistics for Workflow servers using SQL Server database
DT224497 You see a NoSuchAlgorithmException error when you register project area with Case administration client

Back to top

Enterprise Records
Known Issue Title Sec. Cont. B.I.
N/A
N/A

Back to top

FileNet Content Manager
Operational Decision Management
Known Issue Title Sec. Cont. B.I.
DT208408 EXECUTION ORDER IS DIFFERENT WHEN USING CRE VS DE WITH NO MAIN RULEFLOW
DT209907 CONTENTION WHEN EXECUTING MULTIPLE NEW RULESETS IN PARALLEL
DT211231 DEADLOCK WHEN J2SE CONNECTION POOL PURGE IS ENABLED
DT213847 COLLECTIONDOMAIN ANNOTATION DOES NOT WORK WHEN USED IN JAVA COLLECTION TYPES
DT213905 TESTING IN DECISION CENTER MAY THROW AN UNEXPECTED ERROR "FAILED TO MIGRATE DVS PREDICATE"
DT213909 BOM VERBALISATION UNAVAILABLE WHEN AUTHORING SEMANTIC QUERIES IN BUSINESS CONSOLE
DT214728 DECISION CENTER DEPLOYMENT MAY THROW UNEXPECTED BUILD ERROR
DT215406 UNABLE TO ENFORCE SECURITY OF DECISION SERVICES WITH SHARED PROJECTS
DT215895 WHEN COMPLETING A CHANGE ACTIVITY, CHANGES ARE NOT ALWAYS APPLIED TO RELEASE
DT222055 WHEN USING A CLUSTER, A PACKAGE RENAMED IS NOT ALWAYS INCLUDED IN THE RULESET ARCHIVE
DT222320 RTSCONFIGMANAGER CANNOT EDIT PROJECT DEPENDENCIES
DT222721 CREATOR NAME MAY BE INCORRECT IN RULE VIEW
DT224034 PERFORMANCE ISSUE WITH DB2 WHEN BROWSING A SUB-BRANCH

Back to top

User Management Service
Known Issue Title Sec. Cont. B.I.
N/A N/A

Back to top

Workflow Process Service
Known Issue Title Sec. Cont. B.I.
DT220253 TASK NARRATIVE SECTION IN EMAIL NOTIFICATION IS NOT POPULATED FOR ALL TASKS IN PROCESS PORTAL
DT220319 PERFORMANCE DEGRADATION WHEN RUNNING REST API (DELETE) /OPS/STD/BPM/PROCESSES OR RUNNING BPMPROCESSINSTANCESPURGE COMMAND
DT223311 Workflow pod readiness probe show the wrong status for User Management Services

Back to top

Known Limitations

Document change history

  • 27 July 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":"23.0.1"}]

    Document Information

    Modified date:
    13 September 2023

    UID

    ibm17009703

    Page Feedback