IBM Support

Readme for Cloud Pak for Business Automation 21.0.2 IF005

Fix Readme


Abstract

The following document is the documentation for IBM Cloud Pak for Business Automation 21.0.2 IF005.
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.2
Update Name: 21.0.2 IF005
Fix ID: 21.0.2-WS-CP4BA-IF005
Publication Date: 12 Nov 2021
Last modified date: 15 Nov 2021

Contents

Prerequisites and supersedes

  • Supersedes all prior interim fixes for CP4BA 21.0.2.

Components impacted

Before installation

Ensure you take regular backups of any databases associated with the environment.

Installing the interim fix

Cloud Pak for Business Automation 21.0.2 interim fixes are released to the v21.2 operator channel. If your environment has access to IBM entitled registry and has an automatic v21.2 channel subscription then enterprise installations are upgraded automatically. This upgrade generally occurs when the interim fix is released. Once the operator is upgraded, it triggers rolling updates for all the pods it manages to ensure they are updated to the appropriate version to match the operator.
Important: If you used any individual image tag settings in your CP4BA CR, it could prevent the operator from updating the images to the appropriate version. Ensure you remove any of these settings for an enterprise installation when you upgrade.
The CASE package associated with this interim fix is ibm-cp-automation-3.1.5.tgz.

Depending on the current setup and state of your existing environment, there are various manual actions that might be required. The following scenarios cover what actions might be needed for a particular setup.
  • Scenario 1: You are using a demo installation.
    Actions: Demo environments do not support upgrades. Although you can use the interim fix content, install a new demo environment and use the CASE package from this interim fix.
  • Scenario 2: Your installation is version 21.0.1.x or earlier.
    Actions: If you are using a version before 21.0.2, then you must upgrade first. To upgrade your environment, follow the "Upgrading automation containers" instructions.
    When you perform the upgrade, you can substitute the CASE package from this interim fix for the 21.0.2 CASE package while you follow the instructions.
  • Scenario 3: You are using an air gapped environment.
    Actions: To upgrade a 21.0.2 air gapped environment, you must first mirror all the new images to your internal registry. Follow the steps in "Setting up a mirror image registry" although be sure to use the CASE package from this interim fix.
    Once the images are mirrored, the automatic channel subscription completes the upgrade.
  • Scenario 4: Your v21.2 channel subscription is set to manual.
    Actions: If your channel subscription is set to manual, then you must approve any operator upgrades.
      a. Select the CP4BA operator from the OCP web console under Operators>Installed Operators.
      b. Go to the subscription tab for the operator.
      c. Trigger the operator update.
    Once the operator is updated, it triggers the upgrade of the other CP4BA images.

Performing the necessary tasks after installation

  1. Required when using Business Automation Insights
    You must update the IBM Automation Foundation operators to the v1.2 channel to ensure Business Automation Insights can be updated and continue to work. For more information on how to upgrade channels, see the Upgrade the IBM Automation Foundation Core and IBM Automation Foundation subscriptions to the v1.1 channel section.
  2. Required when using Workflow Process Service
    Entitlement is not set up for Workflow Process Service container images in the IBM Entitled Registry. To update this service, download the Workflow Process Service package (.tgz file) from Fix Central.
    1. Back up your database backup, docker-compose.yml and folder for docker volumes “production_workflow_runtime_data” and “production_workflow_runtime_logs”.
    2. Choose an environment that can access the internet and download the update image file 21.0.2-WS-CP4BA-WPS-IF005.tgz.
    3. Extract the archive.
    4. Load the images by changing directory (cd) to the extracted images folder and run docker load command: 
      docker load -i workflow-ps-authoring_21.0.2-IF005.tar.gz
docker load -i workflow-ps-server_21.0.2-IF005.tar.gz
    5. (Optional) Push the images to your docker registry. Log in to your docker registry, and push the docker images into your docker registry using the following commands: 
      docker login <server>
docker tag workflow-ps-server:21.0.2-IF005 <server>/workflow-ps-server:21.0.2-IF005
docker tag workflow-ps-authoring:21.0.2-IF005 <server>/workflow-ps-authoring:21.0.2-IF005
docker push <server>/workflow-ps-server:21.0.2-IF005
docker push <server>/workflow-ps-authoring:21.0.2-IF005
      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.
    6. Run docker-compose down command to stop the Workflow Process Server container.
    7. Update the image url's tags in docker-compose.yml: 
      workflow-ps-server:21.0.2-IF005
workflow-ps-authoring:21.0.2-IF005
    8. 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 .
  3. 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.

Uninstalling

There is no procedure to uninstall the interim fix.

List of Fixes

APARs fixed by this interim fix are listed in the following tables. Fixes from previous interim fixes are also included in this interim fix. Consult the Related links section for fix information of previous interim fixes.
The columns are defined as follows: 
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
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-2021-21295, CVE-2021-21409, CVE-2021-21290, CVE-2021-37713, CVE-2021-28918, CVE-2021-29418, CVE-2021-23406, CVE-2021-3749, CVE-2021-23449, CVE-2021-23437, PRISMA-2021-0134, PRISMA-2021-0090, CVE-2021-22931, CVE-2021-37635, CVE-2021-37636, CVE-2021-37637, CVE-2021-37638, CVE-2021-37639, CVE-2021-37640, CVE-2021-37641, CVE-2021-37642, CVE-2021-37643, CVE-2021-37644, CVE-2021-37645, CVE-2021-37646, CVE-2021-37647, CVE-2021-37648, CVE-2021-37649, CVE-2021-37650, CVE-2021-37651, CVE-2021-37652, CVE-2021-37653, CVE-2021-37654, CVE-2021-37655, CVE-2021-37656, CVE-2021-37657, CVE-2021-37658, CVE-2021-37659, CVE-2021-37660, CVE-2021-37661, CVE-2021-37662, CVE-2021-37663, CVE-2021-37664
 X X

Back to top

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

Back to top

Automation Document Processing
APAR Title Sec. Cont. B.I.
JR64288 SAVING OR DEPLOYING A PROJECT FAILS WITH A TIMEOUT ERROR X X
JR64333 DEPLOYMENT NOT REGISTERING ADP WITH UMS AND RR X X
JR64375 OCR PODS NOT COMPLETING TASKS AND HANGING X X

Back to top

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

Back to top

APAR Title Sec. Cont. B.I.
JR64271 RESOURCE REGISTRY DBA-RR PODS IN ERROR STATE AND CANNOT BE RECOVERED BY OPERATOR X

Back to top

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

Back to top

Business Automation Navigator
APAR Title Sec. Cont. B.I.
N/A
N/A

Back to top

Business Automation Studio
APAR Title Sec. Cont. B.I.
JR64271 RESOURCE REGISTRY DBA-RR PODS IN ERROR STATE AND CANNOT BE RECOVERED BY OPERATOR X

Back to top

Business Automation Workflow including Automation Workstream Services
APAR Title Sec. Cont. B.I.
JR63803 SECURITY APAR CVE-2021-29835 - IBM BUSINESS AUTOMATION WORKFLOW IS VULNERABLE TO REFLECTED CROSS-SITE SCRIPTING X X X
JR64165 YOU SEE CMISRUNTIMEEXCEPTION WHEN THE CASE REPOSITORY FOR DOCUMENT EXPLORER HAS DIFFERENT VALUES FOR ID AND NAME X
JR64271 RESOURCE REGISTRY DBA-RR PODS IN ERROR STATE AND CANNOT BE RECOVERED BY OPERATOR X
JR64321 PFS-DBAREG POD IS NOT IN RUNNING STATE X

Back to top

Enterprise Records
APAR Title Sec. Cont. B.I.
N/A
N/A

Back to top

FileNet Content Manager
APAR Title Sec. Cont. B.I.
N/A N/A

Back to top

Operational Decision Management
APAR Title Sec. Cont. B.I.
RS03856 LOCK ICON ON DECISION TABLE VALUES DISPLAY ISSUE IN BUSINESS CONSOLE
RS03831 "AN UNEXPECTED ERROR OCCURRED" POPUP WHILE DISPLAYING A PREVIEW OF A SIMULATION CONFIGURATION IN THE BUSINESS CONSOLE
RS03818 DECISION TABLE EXPORT TO EXCEL FAILS IF CELL CONTAINS AN OPERATOR AND NO VALUE
RS03797 WHEN USING REAL NUMBERS THE IMPORT OF AN EXCEL DECISION TABLE IS BREAKING THE NUMBER FORMAT
RS03756 RES CONSOLE DIAGNOSTIC MAY FAIL
RS03823 SOMETIMES DECISIONSERVICE APPLICATION MAY FAIL TO START
RS03830 RES CONSOLE PAGES ARE DISPLAYED IN 2 STEPS
RS03849 RULESET IS NOT UPDATED WHEN "USE BASE VERSION NUMBERS" POLICY IS SELECTED
RS03851 RES-DEPLOY-XOM ANT TASK REMOVES MANAGED URIS REFERENCE

Back to top

User Management Service
APAR Title Sec. Cont. B.I.
JR64271 RESOURCE REGISTRY DBA-RR PODS IN ERROR STATE AND CANNOT BE RECOVERED BY OPERATOR X

Back to top

Known Limitations

Document change history

  • 12 Nov 2021: Initial publish.
  • 15 Nov 2021: Refined Workflow Process Service update instructions

    • [{"Type":"MASTER","Line of Business":{"code":"LOB45","label":"Automation"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SS2JQC","label":"IBM Cloud Pak for Automation"},"ARM Category":[{"code":"a8m0z0000001gWWAAY","label":"CloudPak4Automation Platform"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions"}]

    Document Information

    Modified date:
    16 November 2021

    UID

    ibm16513701

    Page Feedback