IBM Support

Readme for IBM Business Automation Workflow on containers 22.0.1 interim fixes

Fix Readme


Abstract

This readme is for IBM Business Automation Workflow on containers 22.0.1 interim fixes released periodically to resolve security vulnerabilities, as well as other defects. It includes information about the CASE package download, installation, and other information about interim fixes for the 22.0.1 release.

Content

Readme file for IBM Business Automation Workflow on containers
Product release 22.0.1
Publication date 29 July 2022

Contents

Prerequisites and superseding fixes

  • Each interim fix typically supersedes all other previous interim fixes shipped for 22.0.1, and compliments a simultaneously delivered interim fix for IBM Cloud Pak for Business Automation 22.0.1. Consult the following table for specific relationships.
  • Business Automation Workflow on containers delivers container images that include operating system level and other open source libraries. Vulnerabilities (CVEs) for these libraries are published regularly. These interim fixes include fixes for these libraries. Consult the superseded and related Cloud Pak for Business Automation 22.0.1 Readmes for specific information about vulnerabilities and other defects that have been addressed.
Business Automation Workflow on containers interim fixes
Interim fix name Superseded interim fix names CASE package Complimentary Cloud Pak for Business Automation interim fix name Released
22.0.1 IF006 See note (*) below ibm-cs-bawautomation-2.3.6.tgz 22.0.1 IF006 December 2022
22.0.1 IF005 See note (*) below ibm-cs-bawautomation-2.3.5.tgz 22.0.1 IF005 November 2022
22.0.1 IF004 See note (*) below ibm-cs-bawautomation-2.3.4.tgz 22.0.1 IF004 October 2022
22.0.1 IF003 See note (*) below ibm-cs-bawautomation-2.3.3.tgz 22.0.1 IF003 September 2022
22.0.1 IF002 *Note: All previous interim fixes listed in this table ibm-cs-bawautomation-2.3.2.tgz 22.0.1 IF002 August 2022
22.0.1 IF001 None ibm-cs-bawautomation-2.3.1.tgz 22.0.1 IF001 July 2022
The previous table is chronologically listed in reverse order, with more recent fixes listed at the top.

Components impacted

Before installation

a. Ensure you back up all databases associated with the environment.
b. Ensure your operators are in a healthy state before upgrading.
If one or more operators are failing, the system might be prevented from completing an upgrade. Check a few of the important custom resource (CR) statuses for failures and to ensure the statuses appear ready for the various installed components.
Check the status of the following CRs when they exist:
oc get icp4acluster -o yaml

Installing the interim fix

Important:  Using individual image tag settings in your Business Automation Workflow CR file could prevent the operator from updating the images to the appropriate version. When you upgrade, ensure you remove these settings for a production installation.
Use the CASE package that is associated with the interim fix being applied. It is typically recommended that the latest interim fix be applied. To identify the appropriate CASE package, as well as links to obtain each package, see the table under Prerequisites and superseding fixes.
Business Automation Workflow 22.0.1 interim fixes are released to the v22.1 operator channel. After the operator is upgraded, rolling updates for all the pods the operator manages are triggered to ensure they are updated to the appropriate version that matches the operator.
If your environment has access to the IBM entitled registry and has an automatic v22.1 channel subscription, enterprise installations are upgraded automatically. This upgrade usually occurs when the interim fix is released or when images are mirrored for air-gap setup.

Depending on the current setup and state of your existing environment, various manual actions might be required. The following scenarios cover what actions might be needed for a particular setup.
  • Scenario 1: Your installation is version 21.0.2.x or earlier.
    Actions: If you are using a version earlier than 21.0.3, 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 22.0.1 CASE package while you follow the instructions. For air-gapped environments, you can use the case save command in step 1 of scenario 3.
    Note: If you are using versions that are earlier than 21.0.2, you must incrementally upgrade and follow the instructions for each version between your source version and 22.0.1.
  •  Scenario 2:  Your installation is online and 22.0.1.x.
    Actions: After these steps are completed, the operators are automatically upgraded.
    You can apply the following catalog sources from a command line by creating a YAML file (for example, cp4ba_catalog_sources.yaml) with the following catalog sources and performing "oc apply -f cp4ba_catalog_sources.yaml", or you can apply the catalog sources by using the OCP console.
    apiVersion: operators.coreos.com/v1alpha1
    kind: CatalogSource
    metadata:
      name: ibm-operator-catalog
      namespace: openshift-marketplace
    spec:
      displayName: "IBM Operator Catalog"
      image: icr.io/cpopen/ibm-operator-catalog
      publisher: IBM
      sourceType: grpc
      updateStrategy:
        registryPoll:
          interval: 45m
  • Scenario 3:  Your installation is air gapped and 22.0.1.x.
    1. Set up the environment variables for CASE, taking 22.0.1-IF001 as example:
      • export CASE_NAME=ibm-cs-bawautomation 
      • export OFFLINEDIR=/tmp/cp4ba2201-if001
      • export CASE_VERSION=2.3.1
      • export CASE_INVENTORY_SETUP=cp4aOperatorSetup 
      • export CASE_ARCHIVE=${CASE_NAME}/${CASE_VERSION}/${CASE_NAME}-${CASE_VERSION}.tgz 
      • export CASE_LOCAL_PATH=${OFFLINEDIR}/${CASE_ARCHIVE}
      Note: The values are specific to the interim fix, for instance, the value for CASE_VERSION, however, you can choose a different empty directory for the OFFLINEDIR if you need to put the files somewhere else.
    2. Download the Cloud Pak archives and image inventory, and put them in the offline store
      cloudctl case save \
        --case https://github.com/IBM/cloud-pak/raw/master/repo/case/${CASE_ARCHIVE} \
        --outputdir ${OFFLINEDIR}
      and then unpack the case file: 
      cd ${OFFLINEDIR}
      tar -xvzf ${CASE_ARCHIVE}
      cd cert-kubernetes
    3. Mirror images to trigger the operator upgrades. 
    4. Mirror the entitled registry images to the local registry by completing the same steps you followed during installation. For more information, see Mirroring images to the private registry.
      Important: Ensure you use the CASE image outputdir (/tmp/cp4ba-231) from step 1.
    5. If you have subscriptions set to manual, you must approve all the pending operator updates. 
      Important: Do not set subscriptions to manual because it can make the the upgrade more error prone if some of the many operator updates are not approved. By default all subscriptions are set to automatic.
After the operators are upgraded, the upgrade of the related deployments and pods is triggered.

Performing the necessary tasks after installation

Review the installation
Review the CR yaml status section and operator logs after the upgrade to ensure no failures prevented your pods from upgrading.
oc get icp4acluster -o yaml > CP4BAconfig.yaml
oc logs deployment/ibm-cp4a-operator -c operator > operator.log
To verify the expected image digest for a particular image, 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 Cloud Pak for Business Automation operator and their expected digest for this particular interim fix level.

Uninstalling

There is no procedure to uninstall the interim fix.

List of fixes

The following APARs are specific to Business Automation Workflow on containers. Depending on the components and capabilities you installed and configured, additional fix information might apply to you. See the "List of Fixes" in the readmes linked under Complimentary Cloud Pak for Business Automation interim fixes in the Prerequisites and superseding fixes section in this document. These readmes detail vulnerability fixes shipped with interim fixes for included operating system level and other open source libraries. The fixes below are also listed in those readmes, but they are also listed here as a convenience.
Fixes that involve security are indicated with an X mark.
Business Automation Workflow
22.0.1 IF006
APAR Security APAR Behavior change Title
N/A N/A
22.0.1 IF005
APAR Security APAR Behavior change Title
DT149047 X SECURITY APAR - MULTIPLE VULNERABILITIES IN SNAKEYAML SHIPPED WITH BUSINESS AUTOMATION INSIGHTS EMITTERS
DT160626 X SECURITY APAR - CVE-2022-41735 - CROSS SITE SCRIPTING IN PROCESS ADMIN CONSOLE
DT170126 X SECURITY APAR CVE-2022-42003 AND CVE-2022-42004 IN LIBRARY USED BY EVENT EMITTER
DT143915 JAVASCRIPT API TW.SYSTEM.FINDPROCESSINSTANCEBYID(<INSTANCE ID>).RETRIEVETASKLIST ALWAYS RETRIEVES THE SYSTEM TASKS
DT168911 CVE-2022-34917, CVE-2022-42003, CVE-2022-42004 - Update Apache Kafka and jackson-databind library for Case Emitter
DT169189 CVE-2022-25857, CVE-2022-42003, CVE-2022-42004 - Update snakeyaml and jackson-databind for Case History emitter
22.0.1 IF004
APAR Security APAR Behavior change Title
DT160695 X SECURITY APAR - CVE-2022-34917 IN KAFKA-CLIENTS MAY AFFECT BAI EVENT EMITTERS
DT145527 PROCESS WORK ITEM DOES NOT APPEAR IN AN IN-BASKET AFTER THE NEW ACTIVITY HAS BEEN UPDATED PRIOR TO COMMIT OR DEPLOYMENT
DT160624 YOU ARE UNABLE TO PREVIEW A CASE DOCUMENT WITH DAEJA VIEWER IN CLIENT-SIDE HUMAN SERVICE
DT168882 DOC - REST INTERFACE TOPIC SHOULDN'T REFER TO IBM BUSINESS MONITOR
JR65102 YOU CAN'T UPLOAD A DOCUMENT OF TYPE IBM_BPM_DOCUMENT WHEN USER_NAME_ATTRIBUTE IN CP4BA IS CONFIGURED WITH EMAILADDRESS OR UID
22.0.1 IF003
APAR Security APAR Behavior change Title
DT145308 OUTOFMEMORY EXCEPTION WHEN STARTING PFS BPEL INDEXER ON A DATABASE THAT HAS PREVIOUS INDEXING FAILURES
DT145567 WEB PROCESS DESIGNER TEAM EDITOR FILTER NOT AVAILABLE AFTER USER REGISTRY FAILURES
22.0.1 IF002
APAR Security APAR Behavior change Title
DT142447 XA_RBDEADLOCK.ERRORCODE=-4203 DUE TO A DEADLOCK IN LSW_LOCK TABLE WHEN SAVING CASE PROPERTY CHANGES
22.0.1 IF001
APAR Security APAR Behavior change Title
JR64982 UNUSED COM.LOMBARDI.JSEDITOR.JAR IS INSTALLED WITH CLOUD PAK FOR AUTOMATION
JR65009 PROPERTIES PANEL SHOWS EMPTY IN WEB PROCESS DESIGNER
Document change history
  • 29 July 2022: Initial publish.
  • 2 September 2022: Updated with 22.0.1 IF002 details
  • 30 September 2022: Updated with 22.0.1 IF003 details
  • 28 October 2022: Updated with 22.0.1 IF004 details
  • 30 November 2022: Updated with 22.0.1 IF005 details
  • 28 December 2022: Updated with 22.0.1 IF005 details
  • [{"Line of Business":{"code":"LOB45","label":"Automation"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SS8JB4","label":"IBM Business Automation Workflow"},"ARM Category":[{"code":"a8m50000000CcWOAA0","label":"Security"}],"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions","Type":"MASTER"}]

    Document Information

    Modified date:
    29 December 2022

    UID

    ibm16608102