Online upgrading
As IBM Process Mining presents new versions such as a patch version, you can upgrade the operator and the IBM Process Mining installation to a newer version.
- Before you begin
- Removing IBM Automation Foundation core operator
- Upgrading IBM Foundational Services
- Installing Operator dependencies
- Upgrading the Operator version
- Changing the CRD
- Verifying the upgrade
- Recovering to last stable running state
- Upgrading to an interim fix
Before you begin
-
You can upgrade the IBM Process Mining application directly from the existing version to the next immediate version of IBM Process Mining. For example, you can upgrade directly from version 1.14.2 to 1.14.3. However, you cannot upgrade directly from version 1.14.1 to version 1.14.3.
-
You must back up the persistent data as described in Backing up and restoring data in OpenShift Container Platform.
-
To upgrade your IBM Process Mining installation to a newer version, you must get access to the new operator images. For how to get access to the images, see Accessing Process Mining images.
Upgrading IBM Foundational Services
Before you upgrade to IBM Process Mining version 1.14.3, you must install or upgrade to IBM Foundational Services version 4.2.0. You can use the procedure that is included in Upgrading foundational services to upgrade to the IBM Foundational Services version 4.2.0.
Installing Operator dependencies
Before you upgrade to IBM Process Mining version 1.14.3, you must upgrade the CatalogSource for the following dependencies:
- IBM Db2 Operator
- IBM Redis Operator
⚠ Important: You need to upgrade these dependencies only if they are not already installed on the system.
cat <<EOF | oc apply -f -
apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
name: ibm-db2uoperator-catalog
namespace: openshift-marketplace
spec:
displayName: IBM DB2 Operator Catalog
publisher: IBM
sourceType: grpc
image: icr.io/cpopen/ibm-db2uoperator-catalog@sha256:986c54823f2d536e2dd35fa60d8e875786ef7bc0d9e8f87b39e90a7730fc6d70
updateStrategy:
registryPoll:
interval: 45m
EOF
cat <<EOF | oc apply -f -
apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
name: ibm-cloud-databases-redis-operator-catalog
namespace: openshift-marketplace
spec:
displayName: ibm-cloud-databases-redis-operator-catalog
publisher: IBM
sourceType: grpc
image: icr.io/cpopen/ibm-cloud-databases-redis-catalog@sha256:a9aa2286ef12ec5525848e5e2813b7abff84742805d13f12d75bcee2fd4f8c75
updateStrategy:
registryPoll:
interval: 45m
EOF
Upgrading the Operator version
The IBM Process Mining Operator is installed with the Operator Lifecycle management (OLM) by following the steps in Installing Process Mining Operator. You can upgrade the OLM operator by following the standard OLM upgrade procedure as described in Upgrading installed Operators.
Note: For operator dependencies, see Version dependencies.
Changing the CRD
You must change the spec.version field to match the new version of the operand in the IBM Process Mining Custom Resource Definition (CRD), and add the mandatory attributes of the new version in the custom resource definition.
-
Log in to the target cluster by running the following commands:
oc login https://<CLUSTERIP>:<port> -u <ADMINISTRATOR>oc project <project_name>Optionally, you can use the following command to open a terminal window and log in to your cluster:
oc login --token=<LOGIN TOKEN> --server=https://<SERVER URL>Note: Do the following steps to get the login command:
- Log in to the Red Hat OpenShift Web Console.
- Under the profile of the admin user (for example,
kubeadmin), click Copy login command > Display Token, copy the command, and paste it in the terminal.
-
Edit the CRD by using the following command, and then add
1.14.3toversion.enum:oc edit crd processminings.processmining.ibm.com -
Change the IBM Process Mining custom resource by running the following command:
oc edit processmining <processmining_instance_name>Where <processmining_instance_name> is the IBM Process Mining instance name.
-
Check the
spec.versionfield, and modify it to match the new version. -
Check the
status.versions.versionsfield, and update the new version.
Verifying the upgrade
To verify that IBM Process Mining is correctly upgraded, refer to the steps in Validating installation.
Recovering to last stable running state
To recover to the last stable running state, you must roll back the version as described in the previous step.
Upgrading to an interim fix
When an interim fix is available, you can upgrade IBM Process Mining to a newer interim fix release. For more information, see interim fix readme files.
An interim fix is a code update to resolve security vulnerabilities and on some occasions includes defect fixes. The readme file documents the defects that are resolved along with instructions on how to install it.