Installing the operator with command lines with IBM Cloud Pak® for Business Automation

You can install the IBM Process Mining operator in Red Hat® OpenShift® Container Platform with command lines. The necessary operators for IBM Process Mining installation are already present in IBM Cloud Pak® for Business Automation.

To make sure all of the required dependencies are installed, you can verify that the following operators are present:

  • ibm-zen-operator-catalog
  • ibm-cert-manager-catalog
You can also install the following optional dependencies:
IBM Db2 Operator (ibm-db2uoperator-catalog).
You can add DB2 operator only if you already have IBM Task Mining running on top of DB2.
IBM Redis Operator (ibm-cloud-databases-redis-operator-catalog)
If you want to run the IBM Process Mining application with replicas, you must install Redis operator. For more information, see Installing IBM Redis.
IBM Licensing (ibm-licensing-catalog)
An optional component used for license tracking only contractual metrics in OpenShift Container Platform environments. Metrics are tracked by the IBM Metering service and made available through the license service APIs. For more information, see Installing IBM Licensing or Usage Metering Service.

Compatibility matrix

The following table shows the compatibility matrix of IBM Process Mining with IBM Cloud Pak® for Business Automation:
IBM Process Mining IBM Cloud Pak® for Business Automation
2.2.0 24.0.0 and 26.0.0
2.1.1 25.0.1-IF001
2.0.3 25.0.0-IF001
2.0.2 25.0.0
2.0.1 24.1.1
2.0.0 24.0.1

Setting environment variables

You need to set environment variables to the correct values. Make sure that you have the values for the following:
PM_PROJECT
The namespace used for CP4BA.
CPFS_PROJECT
Your foundational service namespace. It is usually the same as CP4BA.
See the following example of set values:
export PM_PROJECT=production
export CPFS_PROJECT=production

Installing the optional dependencies

Do the following steps to install the optional dependencies:

  1. Get the login command:
    1. Log in to the Red Hat OpenShift Web Console.
    2. Under the profile of the admin user (e.g.kubeadmin), click Copy login command > Display Token.
    3. Copy the command and paste it into your terminal.
  2. Use the command to open a terminal window and login to your Red Hat® OpenShift® Container Platform cluster:
    oc login --token=<LOGIN TOKEN> --server=https://<SERVER URL> 
    
  3. Create a namespace for IBM Process Mining and its dependencies:

    
    oc project ${PM_PROJECT}
    
  4. Use the following commands to install the optional operators and deploy the catalog source to the cluster:
    cat <<EOF | oc apply -f -
    apiVersion: operators.coreos.com/v1alpha1
    kind: CatalogSource
    metadata:
      name: ibm-db2uoperator-catalog
      namespace: ${PM_PROJECT}
    spec:
      sourceType: grpc
      image: icr.io/cpopen/ibm-db2uoperator-catalog@sha256:ac608e4f744be84997e0306e459f086a99223749bc29725045e3f673b1c0446b
      imagePullPolicy: Always
      displayName: IBM Db2U Catalog
      publisher: IBM
      updateStrategy:
        registryPoll:
          interval: 45m
    EOF
    apiVersion: operators.coreos.com/v1alpha1
    kind: CatalogSource
    metadata:
      name: ibm-redis-cp-catalog
      namespace: openshift-marketplace
    spec:
      displayName: ibm-redis-cp-1.4.0
      publisher: IBM
      image: icr.io/cpopen/ibm-redis-cp-operator-catalog@sha256:d194a69150504735f5142099bcb97bd4767cf252dfe0d9fa4bb9fe4f6fb18618
      sourceType: grpc
  5. To install IBM Licensing or Usage Metering Service, an admin must determine which service your CP4BA installation uses.
    If the processmining operator finds IBMUsageMetering in the CRD configuration in it's operand, it will deploy an instance of it. If IBMUsageMetering instance is deployed by the process mining operator, you can update the pminstance with the following CRD configuration:
    spec:
      usagemetering:
        anonymize: false
        # automatically send usage data to IBM Software Central
        enable: true
        entitlementkeysecret: '<USER ENTITLEMENT KEY SECRET NAME>'
        # IBM Software Central push frequency
        frequency: 5 0 * * *

Installing the IBM Process Mining catalog

Use the following command to create the catalog source for IBM Process Mining:

cat <<EOF | oc apply -f -
apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
  name: ibm-automation-processminings
  namespace: ${PM_PROJECT}
spec:
  displayName: ibm-process-mining-4.2.0
  publisher: IBM
  sourceType: grpc
  image: icr.io/cpopen/processmining-operator-catalog@sha256:cc2d6286fce49a84f9d9c24170d9a267158a91bfd104c8173de2f9efc8d94076
  updateStrategy:
    registryPoll:
      interval: 45m
EOF

Creating the subscription

With the subscription, you can track changes to catalogs and make sure that the operators are up to date. Make sure that all the installed catalog source are in READY state before proceeding.

Use the following commands to create the subscription:

cat <<EOF | oc apply -f -
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: processmining-subscription
  namespace: ${PM_PROJECT}
spec:
  channel: v4.0
  installPlanApproval: Automatic
  name: ibm-automation-processmining
  source: ibm-automation-processminings
  sourceNamespace: ${PM_PROJECT}
EOF
Note: Operator Group creation for Process Mining is not required for CP4BA based installation.