Installing the operator with command lines

You can install the IBM Process Mining operator in Red Hat® OpenShift® Container Platform with command lines.

Installing Operator dependencies
Installing the prerequisites
- Installing IBM Cert Manager
- Installing IBM Licensing
Installing the IBM Process Mining catalog
Creating the Catalog Source for IBM Process Mining
Creating the Operator group
Creating the subscription
Verifying the Operator installation

If IBM Process Mining is installed on a cluster (and in a namespace) where a Cloud Pak is already installed, you can install the IBM Process Mining operator from Operator Hub. You need not install catalog sources and operator groups.

The IBM Process Mining operator installation also installs the following required operators if they are not available on the namespace:

IBM Cloud Pak foundational services
IBM Db2 Operator
IBM Operator Catalog

To make sure IBM Process Mining is successfully installed, you must install IBM foundational services in the ibm-common-services namespace.

As the initial step, you must install the required CatalogSources in your cluster. The CatalogSource is a repository of CSVs, Custom Resource Definitions (CRDs), and operator packages.

Installing Operator dependencies

Install dependencies ONLY when they are not yet installed on the system.

You must install CatalogSource for the following dependencies:

IBM Cloud Pak foundational services
IBM Db2 Operator
IBM Redis Operator
IBM Cert Manager
IBM Licensing

Use the following 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>

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 into your terminal.

Use the following commands to deploy the catalog sources to the cluster:

cat <<EOF | oc apply -f -
apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
  name: ibm-db2uoperator-catalog
  namespace: openshift-marketplace
spec:
  sourceType: grpc
  image: icr.io/cpopen/ibm-db2uoperator-catalog@sha256:278fa6bbaa834faa4a0ec522cd85a301a088e610d8f5a74d7981f172d30cd5d4
  imagePullPolicy: Always
  displayName: IBM Db2U Catalog
  publisher: IBM
  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


cat <<EOF | oc apply -f -
apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
  name: opencloud-operators
  namespace: openshift-marketplace
spec:
  displayName: IBMCS Operators
  publisher: IBM
  sourceType: grpc
  image: icr.io/cpopen/ibm-common-service-catalog:4.10.0
  updateStrategy:
    registryPoll:
      interval: 45m
EOF

cat <<EOF | oc apply -f -
apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
  name: ibm-zen-operator-catalog-6-1-0
  namespace: openshift-marketplace
spec:
  displayName: IBM Zen Operator Catalog
  publisher: IBM
  sourceType: grpc
  image: icr.io/cpopen/ibm-zen-operator-catalog:6.1.0-207
  updateStrategy:
    registryPoll: 
      interval: 30m0s
EOF


cat <<EOF | oc apply -f -
apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
  name: ibm-cert-manager-catalog
  namespace: openshift-marketplace
spec:
  displayName: ibm-cert-manager
  publisher: IBM
  sourceType: grpc
  image: icr.io/cpopen/ibm-cert-manager-operator-catalog:4.2.10
  updateStrategy:
    registryPoll: 
      interval: 45m
EOF


cat <<EOF | oc apply -f -
apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
  name: ibm-licensing-catalog
  namespace: openshift-marketplace
spec:
  displayName: ibm-licensing
  publisher: IBM
  sourceType: grpc
  image: icr.io/cpopen/ibm-licensing-catalog:4.2.10
  updateStrategy:
    registryPoll: 
      interval: 45m
EOF


cat <<EOF | oc apply -f -
apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
  name: cloud-native-postgresql-catalog
  namespace: openshift-marketplace
annotations:
    bedrock_catalogsource_priority: '1'
spec:
  displayName: Cloud Native Postgresql Catalog
  publisher: IBM
  sourceType: grpc
  image: icr.io/cpopen/ibm-cpd-cloud-native-postgresql-operator-catalog@sha256:d6b5e43f3b5c4e4198ed6ddfd4577eebea644df9d2fe2bac33600764b5cda631
  updateStrategy:
    registryPoll: 
      interval: 45m
  priority: 100
EOF

The value of ibm-common-service-catalog indicates the operator version of IBM Cloud Pak foundational services. For more information on the value, see Version dependencies.

Installing the prerequisites

Before Installing IBM Process Mining, you must install IBM Cert Manager and IBM Licensing.

Installing IBM Cert Manager

Use the following commands to install IBM Cert Manager:

cat <<EOF | oc apply -f -
apiVersion: v1
kind: Namespace
metadata:
  name: ibm-cert-manager
EOF


cat <<EOF | oc apply -f -
apiVersion: operators.coreos.com/v1alpha2
kind: OperatorGroup
metadata:
  name: operatorgroup
  namespace: ibm-cert-manager
spec:
EOF


cat <<EOF | oc apply -f -
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: ibm-cert-manager-operator
  namespace: ibm-cert-manager
spec:
  channel: v4.2
  installPlanApproval: Automatic
  name: ibm-cert-manager-operator
  source: ibm-cert-manager-catalog
  sourceNamespace: openshift-marketplace

EOF

Installing IBM Licensing

Use the following commands to install IBM Licensing:

cat <<EOF | oc apply -f -
apiVersion: v1
kind: Namespace
metadata:
  name: ibm-licensing
EOF

cat <<EOF | oc apply -f -
apiVersion: operators.coreos.com/v1alpha2
kind: OperatorGroup
metadata:
  name: ibm-licensing-operator-app
  namespace: ibm-licensing
spec:
  targetNamespaces:
  - ibm-licensing
EOF

cat <<EOF | oc apply -f -
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: ibm-licensing-operator-app
  namespace: ibm-licensing
spec:
  channel: v4.2
  installPlanApproval: Automatic
  name: ibm-licensing-operator-app
  source: ibm-licensing-catalog
  sourceNamespace: openshift-marketplace
EOF

Installing the IBM Process Mining catalog

Before installing the catalog and the IBM Process Mining custom resource, you must decide the namespace on which you want to perform the installation. You must install IBM Process Mining in an existing Cloud Pak or create a new namespace if a Cloud Pak is not already installed in the cluster.

The namespace name must be alphanumeric values, for example,processmining or processmining123. You cannot use a name that is only numbers.

Use the following command to create a new namespace:

export PM_PROJECT=mynamespace
oc new-project ${PM_PROJECT}

Creating the catalog source for IBM Process Mining

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

cat <<EOF | oc apply -f -
apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
  name: ibm-automation-processminings
  namespace: openshift-marketplace
spec:
  displayName: IBM ProcessMining Operators
  publisher: IBM
  sourceType: grpc
  image: icr.io/cpopen/processmining-operator-catalog@sha256:3f921a21aab1d011e61fbdda50edc504486f3eee353bec568208f478909dfd17
  updateStrategy:
    registryPoll:
      interval: 45m
EOF

The digest number is the image for the latest general version of IBM Process Mining. To install interim fix updates with their corresponding digest numbers, follow the readme documentation on the IBM Support page. For more information, see IBM Support for Process Mining.

Creating the Operator group

The Operator Group is a unit of multitenancy for operators that the Operator Lifecycle Manager (OLM) manages. It constrains the installation of operators in its namespace to a specified set of target namespaces.

Do not create the Operator Group if you are installing into a Cloud Pak. It is required only when Process Mining is installed stand-alone inside a namespace.

Use the following commands to create the operator group for IBM Process Mining:

cat <<EOF | oc apply -f -
apiVersion: operators.coreos.com/v1alpha2
kind: OperatorGroup
metadata:
  name: processmining-group
  namespace: ${PM_PROJECT}
spec:
  targetNamespaces:
  - ${PM_PROJECT}
EOF

Creating the subscription

The subscription tracks changes to catalogs and ensures that the operators are up to date. Use the following commands to create a subscription:

cat <<EOF | oc apply -f -
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: processmining-subscription
  namespace: ${PM_PROJECT}
spec:
  channel: v3.0
  installPlanApproval: Automatic
  name: ibm-automation-processmining
  source: ibm-automation-processminings
  sourceNamespace: openshift-marketplace
EOF

cat <<EOF | oc apply -f -
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: ibm-platformui-operator
  namespace: processmining
spec:
  channel: v6.1
  installPlanApproval: Automatic
  name: ibm-zen-operator
  source: ibm-zen-operator-catalog-6-1-0
  sourceNamespace: openshift-marketplace
EOF

Verifying the Operator installation

The operator is available in the Operator > Installed Operators section of your Red Hat® OpenShift® Container Platform (OCP) console.

Operator hub

Click the operator to see the information in detail.

Create instances when the status is Succeeded.