Installing the operator with the Red Hat OpenShift Operator Hub

You can install IBM Process Mining in a Red Hat OpenShift cluster with access to public registries by enabling the IBM Operator Catalog in the cluster, and then installing the IBM Process Mining Operator.

Enabling the IBM Operator Catalog

IBM provides a catalog of product offerings in the form of a catalog index image. To display the IBM offerings in the Red Hat OpenShift Operator catalog, you must enable the IBM Operator Catalog image on your Red Hat OpenShift cluster by deploying a CatalogSource resource.

You can install the CatalogSource object by using the Red Hat OpenShift CLI or web console. This task needs to be completed only once in a cluster.

Note: Ensure that you have cluster administrator authority with cluster-admin permissions.

Installing the IBM Operator Catalog by using the Red Hat OpenShift CLI

To install by using the Red Hat OpenShift CLI, complete the following steps:

  1. From your local computer, create a YAML file called catalog_source.yaml with the following content:

    apiVersion: operators.coreos.com/v1alpha1
    kind: CatalogSource
    metadata:
     name: ibm-operator-catalog
     namespace: openshift-marketplace
    spec:
     displayName: IBM Operator Catalog
     publisher: IBM
     sourceType: grpc
     image: icr.io/cpopen/ibm-operator-catalog
     updateStrategy:
      registryPoll:
       interval: 45m
    
  2. From the command line, log in to your Red Hat OpenShift cluster by using the oc login command.

  3. Run the following command:

    oc apply -f catalog_source.yaml -n openshift-marketplace
    
  4. Verify the installation by running this command:

    oc get CatalogSources ibm-operator-catalog -n openshift-marketplace
    

    If the installation was successful, you must see output that is similar to this:

    NAME                   DISPLAY                 TYPE   PUBLISHER      AGE
    ibm-operator-catalog   IBM Operator Catalog    grpc   IBM            50s
    

    If the installation failed, the following message is displayed:

    Error from server (NotFound): catalogsources.operators.coreos.com "ibm-operator-catalog" not found
    

    To help resolve this error, run the following command to check the pods and CatalogSource resources in the openshift-marketplace namespace:

    oc get catalogsource,pods -n openshift-marketplace
    

    The output must provide information about your CatalogSource resources and status of the pods. See the following example:

    NAME                                                                          DISPLAY                     TYPE   PUBLISHER   AGE
    catalogsource.operators.coreos.com/certified-operators                        Certified Operators         grpc   Red Hat     20d
    catalogsource.operators.coreos.com/community-operators                        Community Operators         grpc   Red Hat     20d
    catalogsource.operators.coreos.com/ibm-operator-catalog                       IBM Operator Catalog        grpc   IBM         48s
    catalogsource.operators.coreos.com/opencloud-operators                        IBMCS Operators             grpc   IBM         48s
    catalogsource.operators.coreos.com/redhat-marketplace                         Red Hat Marketplace         grpc   Red Hat     20d
    catalogsource.operators.coreos.com/redhat-operators                           Red Hat Operators           grpc   Red Hat     20d
    NAME                                                 READY   STATUS      RESTARTS   AGE
    pod/certified-operators-575f586fd8-m2ldh             1/1     Running     0          41m
    pod/community-operators-57fd7676ff-sqzgs             1/1     Running     0          15h
    pod/ibm-operator-catalog-85b2w                       1/1     Running     0          48s
    pod/marketplace-operator-5fcf68c65c-l8tcg            1/1     Running     0          5d8h
    pod/opencloud-operators-wbb9k                        1/1     Running     0          48s
    pod/redhat-operators-8678ddbc5-6szpp                 1/1     Running     0          4d1h
    
  5. You can now install the IBM Process Mining Operator as described in Installing the IBM Process Mining Operator from the Red Hat OpenShift web console.

Installing the IBM Operator catalog by using the Red Hat OpenShift web console

To install by using the Red Hat OpenShift web console, complete the following steps:

  1. Log in to the Red Hat OpenShift web console.
  2. Click the Import YAML icon. Then, copy and paste the following resource definition into the Import YAML editor.
    apiVersion: operators.coreos.com/v1alpha1
    kind: CatalogSource
    metadata:
     name: ibm-operator-catalog
     namespace: openshift-marketplace
    spec:
     displayName: IBM Operator Catalog
     publisher: IBM
     sourceType: grpc
     image: icr.io/cpopen/ibm-operator-catalog
     updateStrategy:
      registryPoll:
       interval: 45m
    
    Import Yaml
  3. Click Create. You can now install the IBM Process Mining Operator from the Red Hat OpenShift console.

Installing the IBM Process Mining Operator from the Red Hat OpenShift web console

Use these instructions to install the IBM Process Mining Operator by using the Red Hat OpenShift web console.

Note: Ensure that you have cluster administrator authority with cluster-admin permissions.

To install and subscribe to the IBM Process Mining Operator, complete the following steps:

  1. Log in to the OpenShift web console for your cluster.

  2. If you want to install the IBM Process Mining Operator into an existing namespace or cluster wide, go to step 3. Otherwise, create a namespace to use for the IBM Process Mining Operator as follows:

    1. From the navigation, click Home > Projects to open the Projects page.

    2. Click Create Project.

    3. Enter a namespace (or project) name, for example, processmining. Optionally add a display name and description.
      Note: The namespace name must be alphanumeric values, for example,processmining or processmining123. You cannot use a name that is only numbers.

    4. Click Create.

  3. From the navigation, click Operators > OperatorHub.

  4. From the OperatorHub page, search for process mining and then click the IBM Process Mining tile.

    Search for process mining from the OperatorHub page

  5. Click Install.

  6. From the Install Operator page, complete the following fields:

    • Update Channel: The supported update channels are displayed. This indicates that an Operator subscription is automatically created to keep the Operator up to date when new versions are delivered to the channel. It is recommended that you install the Operator by using a Manual approval strategy, which requires you to review the installation plan for a new Operator release.

    • Installation Mode: Choose whether to install the Operator into all namespaces in the cluster or into a specific namespace.

    • Installed Namespace: If you chose the option for a specific namespace, select a namespace from this list.

    • Approval Strategy: Click Automatic (the default) to indicate that the installation must proceed with no additional approval. This option will also cause the running instance of your Operator to be automatically upgraded whenever new versions are delivered to the channel. Click Manual if you want to review a generated installation plan for the Operator and then manually approve the installation. This option will also require you to review the installation plan for each new Operator version that is delivered to the channel, and then manually approve an upgrading.

      Tip: If required, you can change the approval strategy later from the Subscription tab for the installed IBM Process Mining Operator. You can access this tab by clicking Operators > Installed Operators in the navigation pane, and then clicking IBM Process Mining.

  7. Click Install to install the Operator. If you choose a Manual approval strategy, you are required to review and approve the installation plan of the subscription. No additional action is needed if you selected an Automatic approval strategy.

  8. Wait for the installation to complete and then click View Installed Operators in namespace. The IBM Process Mining Operator and its dependent Operators are displayed on the Installed Operators page with a deployment status of Succeeded / Up to date. Installed Operators