Fix Readme
Abstract
The following document is the documentation for IBM Cloud Pak for Automation 20.0.3 IF001.
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 IF001 |
Fix ID: | 20.0.3-WS-CP4A-IF001 |
Publication Date: | 15 Jan 2021 |
Last modified date: | 28 Jan 2021 |
Contents
Download location
Prerequisites
Components impacted
Prior to installation
Installing
Performing the necessary tasks after installation
Uninstalling
List of fixes
Document change history
Prerequisites
Components impacted
Prior to installation
Installing
Performing the necessary tasks after installation
Uninstalling
List of fixes
Document change history
Download location
Download 20.0.3-WS-CP4A-IF001 from Fix Central here.
Prerequisites
- Download the interim fix GitHub repository to your local machine https://github.com/icp4a/cert-kubernetes/archive/20.0.3.tar.gz.
- Change directory to the "cert-kubernetes" folder.
Components impacted
- Cloud Pak for Automation Operator
- Business Automation Application
- Business Automation Studio
- FileNet Content Manager
Prior to installation
If you installed any of the Cloud Pak components on a Kubernetes cluster, you can update them with the 20.0.3 IF001 by using the updated operator and the relevant container interim fixes. Details like the image: tag of the interim fix image can be found in the pattern templates on GitHub.
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 Knowledge Center. 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 (Option 1), or you can download the images from Fix Central (Option 2).
You can access the container images in the IBM image registry with your IBMid (Option 1), or you can download the images from Fix Central (Option 2).
Option 1: 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.
Option 2: Download the packages from Fix Central
- Download the images per the instructions in the Download location section, and make a note of the file names.
- Log in to your Kubernetes cluster and set the context to the project/namespace for your existing deployment.
- Check that you can run a Podman command
$ podman ps
-
Log in to the Docker registry with a token.$ podman login $(oc registry info) -u <ADMINISTRATOR> -p $(oc whoami -t) –tls-verify=false
-
Run a kubectl command to make sure that you have access to Kubernetes.
$ kubectl cluster-info -
Change the permissions of the scripts/loadimages.sh script so that you can run it.
$ cd scripts
$ chmod +x loadimages.sh -
Run the loadimages.sh script to load the images into your image registry. The following example shows the input values in the command line../loadimages.sh -p <ARCHIVE> -r $(oc registry info)/<project-name>Where:-p The archive files location or archive file name
-r Target image registry and namespace -
Check that the images are pushed correctly to the registry.
$ oc get is -
If you want to use an external registry, create a registry secret:$ oc create secret docker-registry admin.registrykey --docker-server=<registry_url> --docker-username=<your_account> --docker-password=<your_password> --docker-email=<your_email>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.git for the IF001 interim fix.
-
Upgrade the operator in your project by running the following command.$ ./scripts/upgradeOperator.sh -i <registry_url>/icp4a-operator:20.0.3-IF001 -p '<my_secret_name>' -a accept
Where 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: use 20.0.3-IF001 operator image.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 (e.g., ../scripts/generated-cr/ibm_cp4a_cr_final.yaml) and edit it to update each component:
- For 20.0.3-IF001, there are six container images that have been updated including the icp4a-operator image:
solution-server:20.0.3-IF001
bastudio:20.0.3-IF001
solution-server:20.0.3-IF001
navigator-sso:ga-309-icn-la001
navigator:ga-309-icn-la001
icp4a-operator:20.0.3-IF001
dba-keytool-initcontainer:20.0.3-IF001
dba-keytool-jobcontainer:20.0.3-IF001
dba-umsregistration-initjob:20.0.3-IF001
dba-dbcompatibility-initcontainer:20.0.3-IF001 - In the sections for each of the components that are included in your deployment, add or modify the component.image.repository and component.image.tag configuration parameter to reflect the values for the new images. For example:
images:
solution-server:
repository: cp.icr.io/cp/cp4a/bas/solution-server
tag: 20.0.1-IF001
solution-server:
repository: cp.icr.io/cp/cp4a/bas/solution-server
tag: 20.0.1-IF001
Tip: The values of the tags for a given interim fix can be found in the readme file that is provided with that interim fix. Verify that the secret named in the CR YAML file as the imagePullSecrets is valid. Note that the secret might be expired, in which case you must re-create the secret.
Repeat this step for each component that you want to update.
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, columns are defined as follow:
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 is found in the title column or the APAR document |
- General
- Cloud Pak for Automation Operator
- Business Automation Application
- Automation Decision Services
- Automation Document Processing
- Business Automation Insights
- Business Automation Navigator
- Business Automation Studio
- Business Automation Workflow
- Enterprise Records
- FileNet Content Manager
- Operational Decision Management
- User Management Service
General
APAR | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
N/A |
Cloud Pak for Automation Operator
APAR | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
JR63226 | THE IBM FILENET CONTENT MANAGER PODS DO NOT CONTAIN ANY LICENSING INFORMATION. | X | X |
Business Automation Application
APAR | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
JR63164 |
YOU CAN'T CREATE A DESKTOP |
|||
JR63170 |
APPLICATION ENGINE RESTARTS UNEXPECTEDLY |
|||
JR63079 |
YOU RECEIVE AN ERROR USING GET AUTOMATIONSERVICEIMPORTER AND CAN'T CREATE AN AUTOMATION SERVICE |
Automation Decision Services
APAR | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
N/A | X |
Automation Document Processing
APAR | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
N/A | X |
Business Automation Insights
APAR | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
Business Automation Navigator
APAR | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
|
Business Automation Studio
APAR | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
JR63170 |
APPLICATION ENGINE RESTARTS UNEXPECTEDLY |
|||
JR63079 |
YOU RECEIVE AN ERROR USING GET AUTOMATIONSERVICEIMPORTER AND CAN'T CREATE AN AUTOMATION SERVICE |
|||
JR63161 |
YOU CAN'T DELETE AN APP WITHOUT REPOSITORY ADMINISTRATION PERMISSION IN IBM BUSINESS AUTOMATION STUDIO |
Business Automation Workflow including Automation Workstream Services
APAR | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
N/A |
Enterprise Records
APAR | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
N/A
|
FileNet Content Manager
APAR | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
See Cloud Pak for Automation Operator | X |
Operational Decision Management
APAR | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
N/A |
User Management Service
APAR | Title | Sec. | Cont. | B.I. |
---|---|---|---|---|
N/A |
Document change history
[{"Line of Business":{"code":"LOB45","label":"Automation"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"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:
28 January 2021
UID
ibm16395480