Fix Readme
Abstract
The following document is the documentation for IBM Cloud Pak for Automation 20.0.3 IF009.
Including download and installation information and the list of APARs that are resolved in this interim fix.
Content
Readme file for: | IBM Cloud Pak® Automation |
---|---|
Product Release: | 20.0.3 |
Update Name: | 20.0.3 IF009 |
Fix ID: | 20.0.3-WS-CP4A-IF009 |
Publication Date: | 12 Nov 2021 |
Last modified date: | 12 Nov 2021 |
Contents
Prerequisites
Components impacted
Prior to installation
Installing
Performing the necessary tasks after installation
Uninstalling
List of fixes
Known Limitations
Document change history
Components impacted
Prior to installation
Installing
Performing the necessary tasks after installation
Uninstalling
List of fixes
Known Limitations
Document change history
Prerequisites
- Download the installation script resources https://github.com/icp4a/cert-kubernetes/archive/20.0.3.2.tar.gz and extract the files to your local machine.
- Change directory to the "cert-kubernetes" folder.
Components impacted
Prior to installation
If you installed any of the Cloud Pak components on a Kubernetes cluster, you can update them with 20.0.3 IF009 by using the updated operator and the relevant container interim fixes. Updated images are
- cp.icr.io/cp/cp4a/bas/bastudio:20.0.3-IF009
- cp.icr.io/cp/cp4a/bas/workflow-authoring:20.0.3-IF009
- cp.icr.io/cp/cp4a/baw/workflow-server:20.0.3-IF009
- cp.icr.io/cp/cp4a/baw/workflow-server-case-initialization:20.0.3-IF009
To deploy this interim fix as an update to a 20.0.3 deployment, follow the instructions in the Installing section. If you want to use the interim fix as a part of a new deployment or you want to upgrade a release prior to 20.0.3, refer to IBM Documentation. For more information, see IBM Cloud Pak for Automation 20.0.x.
Installing
Step 1: Get access to the interim fix container images
You can access the container images in the IBM image registry with your IBMid.
You can access the container images in the IBM image registry with your IBMid.
Create a pull secret for the IBM Cloud Entitled Registry
- Log in to MyIBM Container Software Library with the IBMid and password that is associated with the entitled software.
- In the Container software library tile, click "View library" and then click "Copy key" to copy the entitlement key to the clipboard.
- Log in to your Kubernetes cluster and set the context to the project/namespace for your existing deployment.
- Create a pull secret by running a kubectl create secret command.
$ kubectl create secret docker-registry admin.registrykey --docker-server=cp.icr.io --docker-username=cp --docker-password="<API_KEY_GENERATED>" --docker-email=<USER_EMAIL>
Note: The "cp.icr.io" value for the docker-server parameter is the only registry domain name that contains the images. Use "cp" for the docker-username. The docker-email must be a valid email address (associated to your IBM ID). Make sure you are copying the Entitlement Key in the docker-password field within double quotation marks. - Take a note of the secret and the server values so that you can set them to the "pullSecrets" and "repository" parameters when you update the operator for your containers.
Step 2: Update the installed operator
- Log in to your Kubernetes cluster and set the context to the project for your existing deployment.
$ oc login https://<CLUSTERIP>:<port> -u <ADMINISTRATOR> -
If the persistent volume (PV) for the operator is defined by a hostPath, provide group write permission according to the PV hostPath.path definition (/root/operator).
$ chmod -R g=u /root/operator
$ chmod g+rw /root/operator
Note: If you are using dynamic provisioning, this step is not needed as the PV is created automatically as per the Storage Class definition. -
Remove the .OPERATOR_TYPE file in case it exists from a previous deployment.
$ rm -f /<hostPath>/.OPERATOR_TYPE
Where hostPath is the value in your PV (root/operator). -
Go to the downloaded cert-kubernetes folder for the IF002 interim fix.
-
Upgrade the operator in your project by running the following command.$ ./scripts/upgradeOperator.sh -i <registry_url>/icp4a-operator:20.0.3-IF008 -p '<my_secret_name>' -a acceptWhere registry_url is the value for your internal registry or cp.icr.io/cp/cp4a for the IBM Cloud Entitled Registry. The my_secret_name is the secret that is created to access the registry, and accept means that you accept the license.Note: If you plan to use a non-admin user to install the operator, you must add the user to the "ibm-cp4a-operator" role.$ oc adm policy add-role-to-user ibm-cp4a-operator <user_name>
-
Monitor the pod until it shows a STATUS of Running:
$ oc get pods -w
Note: When started, you can monitor the operator logs with the following command:
$ oc logs -f deployment/ibm-cp4a-operator -c operator
Step 3: Update the custom resource YAML file for your deployment
Get the custom resource YAML file that you previously deployed (for example, scripts/generated-cr/ibm_cp4a_cr_final.yaml) and update the appVersion to "20.0.3.2". The operator pulls the corresponding 20.0.3.2 container images based on the value of appVersion.
Note: If you are using a new CR from the "cert-kubernetes" GitHub repository that you download from the prerequisites step above, then the appVersion is already set to "20.0.3.2".
As 20.0.3-IF009 updates only some images, appVersion remains 20.0.3.2. To ensure you use the 20.0.3-IF009 images, make sure to refer to these updated images in your CR. Remember to remove these references to specific images when you upgrade to future versions.
If you are deploying Workflow Authoring pattern, make sure to update the image tag
workflow_authoring_configuration:
images:
repository: "cp.icr.io/cp/cp4a/bas/workflow-authoring"
tag: "20.0.3-IF009"
If you are using multiple instances of Business Automation Workflow, make sure to update all following the pattern below.
baw_configuration:
- name: bawins1
case:
init_job_image:
repository: "cp.icr.io/cp/cp4a/baw/workflow-server"
tag: "20.0.3-IF009"
Tip: If you use image tags in your CR in your current deployment, then the correct values of the tags can be found in the fully customizable (FC) CR pattern templates provided with the interim fix under ../cert-kubernetes/descriptors/patterns (for example, ibm_cp4a_cr_enterprise_FC_content.yaml has the corresponding image tags for the iFix along with all the parameters that can be customized for the deployment). Verify that the secret named in the CR YAML file as the imagePullSecrets is valid. Note the secret might be expired, in which case you must re-create the secret.
Step 4: Apply the updated custom resource YAML file
- Check that all the components that you want to upgrade are configured with interim fix image tag values.
$ cat scripts/generated-cr/ibm_cp4a_cr_final.yaml -
Update the configured components by applying the custom resource.$ kubectl apply -f scripts/generated-cr/ibm_cp4a_cr_final.yaml
Step 5: Verify the updated automation containers
The operator reconciliation loop might take several minutes. When all of the pods are Running, you can access the status of your containers by running the following commands:
$ oc status
$ oc get pods -w
$ oc logs <operatorPodName> -f -c operator
$ oc get pods -w
$ oc logs <operatorPodName> -f -c operator
Performing the necessary tasks after installation
For more information, see IBM Cloud Pak for Automation 20.0.x.
Uninstalling
For more information, see IBM Cloud Pak for Automation 20.0.x.
List of Fixes
APARs are listed in tables and table columns are defined as follows:
Colunm 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 |
Business Automation Studio
APAR | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
JR63262 | ENABLE BPMN 2.0 ARCHIVE (.zip) IMPORT INTO IBM BUSINESS AUTOMATION STUDIO | |||
JR63451 | WEB IBM PROCESS DESIGNER STOPS RESPONDING WHEN YOU TRY TO USE CONTENT ASSIST ON AN OBJECT WITH NUMEROUS PROPERTIES | |||
JR64267 | ENHANCE CASE CLIENT TO OPEN A PROCESS WORK ITEM WITH A PARAMETERIZED LINK ACCEPTED BY CASE CLIENT |
Known Limitations
For more information, see the support page Cloud Pak for Automation Known Limitations
Document change history
[{"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":"20.0.3"}]
Was this topic helpful?
Document Information
Modified date:
01 December 2021
UID
ibm16507099