IBM Support

Readme for Cloud Pak for Business Automation 23.0.1 IF003

Fix Readme


Abstract

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

Content

Readme file for: IBM Cloud Pak® for Business Automation
Product Release: 23.0.1
Update Name: 23.0.1 IF003
Fix ID: 23.0.1-WS-CP4BA-IF003
Publication Date: 28 September 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-IF003
  • Cloud Pak Foundational Services 4.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:
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.
Step 1: Setup the CASE package
  1. Download the CASE package provided with this interim fix to a Linux based machine (RHEL or macOS).
  2. Use the tar command to extract the cert-kubernetes directory.
tar -xvzf ibm-cp-automation-5.0.3%2B20230928.034423.tgz
cd ibm-cp-automation/inventory/cp4aOperatorSdk/files/deploy/crs
tar -xvf cert-k8s-23.0.1.tar
cd cert-kubernetes
Step 2:  Perform the installation or update the existing deployment
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 installing a Starter deployment or have an existing 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 Production deployment version is 22.0.2 IF00x (at least IF002).
    Actions:  
    Follow the upgrade instructions, Upgrading CP4BA multi-pattern clusters from 22.0.2.
    Warning: You can only upgrade existing environments if they were using a single namespace scoped foundational services(CPFS) instance. Which mean the CPFS instance is installed in the same namespace as the cloud pak and isn't shared with any other Cloud Pak instances. Otherwise you would need to rebuild to upgrade.
    Note: Direct upgrade from version prior to 22.0.2 is not supported. If you are upgrading from a prior version then you would need to perform incremental upgrading using the instructions from each prior version.
  • Scenario 4:  Your installed Production deployment is 23.0.1 GA or any previous 23.0.1 iFix and is online
    Actions: 
    Perform the following steps and then the upgrade of operators and deployments will start.
    1. Upgrade the CP4BA operators using one of two methods. 
      • Option 1: Running the operator upgrade script from the case package. 
        ./scripts/cp4a-deployment.sh -m upgradeOperator -n <project_name>

         
      • Option 2: Manually deploy the catalog source and update the CPFS channels using the CPFS upgrade script.
        1. Apply the new catalog sources. 
          oc apply -f ./descriptors/op-olm/catalog_source.yaml
        2. Update the cert manager and license service channels to the appropriate level with this script: 
          ./scripts/cpfs/installer_scripts/cp3pt0-deployment/setup_singleton.sh --enable-licensing --cert-manager-source ibm-cert-manager-catalog --licensing-source ibm-licensing-catalog --license-accept -v 1 -c v4.1
        3. Update the channels to the appropriate levels for the rest of the CPFS subscriptions. 
          ./scripts/cpfs/installer_scripts/cp3pt0-deployment/setup_tenant.sh --operator-namespace <CP4BA Namespace> -s opencloud-operators-v4-1 -c v4.1 --license-accept -v 1
          Note: Be sure to replace the namespace with the appropriate CP4BA namespace.
           
    2. 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. 
      oc get installPlan
      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.
    3. You can use the following scripts to check the status of the upgrades.
      1. Run the script in [upgradeOperatorStatus] mode to check that the upgrade of the CP4BA operator and its dependencies is successful. 
        ./scripts/cp4a-deployment.sh -m upgradeOperatorStatus -n <project_name>
        Warning: The script will scale the CP4BA deployments down to zero. You must execute the upgradeDeploymentStatus command to scale them back up.
      2. Run the script in [upgradeDeploymentStatus] mode to check that the upgrade of the CP4BA deployment is successful. 
        ./scripts/cp4a-deployment.sh -m upgradeDeploymentStatus -n <project_name>
  • Scenario 5:  Your installed Production deployment is 23.0.1 GA or any previous 23.0.1 iFix and using airgap/offline.
    Actions: 
    Perform the following steps and then the upgrade of operators and deployments will start.
    1. Download the case package mirror file, cp4ba-case-to-be-mirrored-23.0.1-IF003.txt, for this interim fix and you must rename the file to cp4ba-case-to-be-mirrored-23.0.1-IF003.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-IF003.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. You will need to mirror the images associated with the new case package. Follow the instructions for either mirroring option in Mirroring images to the private registry using the new version values associated with this fix. 
      export CASE_NAME=ibm-cp-automation
export CASE_VERSION=5.0.3+20230928.034423
    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-1/g' | oc apply -f -
    4. Update the cert manager and license service channels to the appropriate level with this script: 
      ./scripts/cpfs/installer_scripts/cp3pt0-deployment/setup_singleton.sh --enable-licensing --cert-manager-source ibm-cert-manager-catalog --licensing-source ibm-licensing-catalog --license-accept -v 1 -c v4.1
    5. Update the channels to the appropriate levels for the rest of the CPFS subscriptions. 
      ./scripts/cpfs/installer_scripts/cp3pt0-deployment/setup_tenant.sh --operator-namespace <CP4BA Namespace> -s opencloud-operators-v4-1 -c v4.1 --license-accept -v 1
      Note: Be sure to replace the namespace with the appropriate CP4BA namespace.
    6. 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 oc get installPlan 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 can make the upgrade more error prone.

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 -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.
b. 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.
c. Required If you are installing or upgrading Business Automation Insights with this iFix.
    You must update CP4BA Custom Resource with digests for iaf-flink & iaf-eventprocessing-proxy images before applying custom resource to deploy this iFix.
  • Update custom resource file to add below with correct digests for Flink.
  • apiVersion: icp4a.ibm.com/v1
kind: ICP4ACluster
metadata:
  name: icp4adeploy
spec:
  shared_configuration: 
    ---
  ##############################################################################
  ########      IBM Business Automation Insights (BAI) configuration    ########
  ##############################################################################
  bai_configuration:
    flink:
      manager_image: cp.icr.io/cp/iaf-flink@sha256:0a5e18b137524877b4378113f362a67c1768453ff65273fd667dc57d55afa005
      eventprocessing_proxy_image: cp.icr.io/cp/iaf-eventprocessing-proxy@sha256:954ef0ee64b447736dd69083ec94afeae4229382798f1317cc44a0a208e5b82e
  • Apply the modified custom resource

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-2017-5932, CVE-2018-16984, CVE-2018-18074, CVE-2018-19787, CVE-2019-11236, CVE-2019-11324, CVE-2019-11358, CVE-2019-12308, CVE-2019-12387, CVE-2019-12781, CVE-2019-12855, CVE-2019-14232, CVE-2019-14233, CVE-2019-14234, CVE-2019-14235, CVE-2019-19118, CVE-2019-19844, CVE-2019-20916, CVE-2019-3498, CVE-2019-6446, CVE-2019-6975, CVE-2020-10108, CVE-2020-10109, CVE-2020-25659, CVE-2020-26137, CVE-2020-27783, CVE-2020-29651, CVE-2020-7471, CVE-2020-9402, CVE-2021-28363, CVE-2021-28957, CVE-2021-31684, CVE-2021-31684, CVE-2021-32559, CVE-2021-33203, CVE-2021-33430, CVE-2021-34141, CVE-2021-3572, CVE-2021-40690, CVE-2021-41125, CVE-2021-41495, CVE-2021-41496, CVE-2021-42343, CVE-2021-42771, CVE-2021-43818, CVE-2021-44420, CVE-2022-1471, CVE-2022-1471, CVE-2022-2309, CVE-2022-23491, CVE-2022-40898, CVE-2022-42969, CVE-2023-2253, CVE-2023-25399, CVE-2023-29159, CVE-2023-29159, CVE-2023-32360, CVE-2023-34462, CVE-2023-34462
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.
DT236960 Json file too large to be retrieved with large documents X X
DT237278 Table row detected incorrectly on documents with text on multiple lines X X
DT237284 Extraction Training models cause Socket Error when entering Extraction Model X X
DT237424 Spbackend logging cannot recover after celery is killed X X
DT237656 Doc: Add SystemT limitation to Known Limitations page X
DT237967 Runtime api request for json returns 502 bad gateway error for large documents X X
DT241232 RecursionError: maximum recursion depth exceeded in comparison when ID card detection enabled X X
DT241237 List index out of range error in spbackend log X X
DT241238 Large documents cause memory leak in the postprocessing pod X X

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.
DT228436 Typeahead Text component throwing Ajax item list fetching error when pulling data from a service

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.
DT224465 Remove duplicate dependency Rest api introduced in DT214235 fails when snapshot name is too long
DT228436 Typeahead Text component throwing Ajax item list fetching error when pulling data from a service
DT236804 Internal groups get deactivated at server start
DT238179 Opening Workplace on a Workflow server fails with an authorization error

Back to top

Business Automation Workflow including Automation Workstream Services
Known Issue Title Sec. Cont. B.I.
DT224476 JAVA.LANG.NOSUCHFIELDERROR: ORG/APACHE/XERCES/IMPL/XS/XSELEMENTDECL.FSUBGROUP ERROR OCCURS WHEN IMPORTING SOME WSDL FILES
DT224607 You notice the time picker of the Date time picker view does not show the selection list when clicked
DT225302 TABLE VIEW FROM THE COACHES TOOLKIT IS NOT DISPLAYING NESTED TABLES CORRECTLY
DT228436 Typeahead Text component throwing Ajax item list fetching error when pulling data from a service
DT236804 Internal groups get deactivated at server start
DT237106 Workplace task list does not refresh automatically
DT238616 Setting the purge-minimum-interval property has no effect

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.
DT228706 MERGE CHANGES NOT REFLECTED IN RELEASE WHEN CHANGE ACTIVITIES ADD DELETED RULE ARTIFACTS
DT236899 THERE IS NO ERROR REPORTED WHEN 2 MEMBERS IN A BOM CLASS VERBALIZED WITH SAME PHRASE
DT238184 BUILDING PROJECTS WITH THE BUILD COMMAND LINE FAILS WHENEVER A RULE PACKAGE HAS AN AMPERSAND CHARACTER IN ITS NAME
DT238293 CLASSCASTEXCEPTION WHEN DEPLOYING A DECISION ENGINE RULESET
DT238726 DEPLOYING A RULEAPP WITH ANT MAY THROW AN EXCEPTION
DT238795 UNABLE TO CREATE A BRANCH IS DECISION CENTER
DT238558 DECISION CENTER DATABASE SETUP SEQUENCE IS FAILING AT INSTALL
DT238563 ABOUT PAGE DISPLAYS WRONG VERSION

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.
DT236804 Internal groups get deactivated at server start
DT237755 DOC: ImagePullBackoff errors are seen when using Cloud Pak for Business Automation air gap installation and Workflow Process Service image filters.

Back to top

Known Limitations

Document change history

  • 28 September 2023: Initial publish.

    • [{"Type":"MASTER","Line of Business":{"code":"LOB10","label":"Data and AI"},"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:
    29 February 2024

    UID

    ibm17032026

    Page Feedback