Installing IBM Licensing or Usage Metering Service

Before Installing IBM Process Mining, you can optionally install IBM Licensing or Usage Metering Service. Metering is disabled by default.

IBM Licensing service is 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.

Usage Metering Service (UMS) is intended to allow products capture their business value metrics (contractual and adoption) for the purpose of creating compliance evidence and visualizing the metrics in reporting tools. This service mitigates customers’ concern of using singleton and cluster roles, which is required by License Service for Processor Capacity Metrics.

For more information about deployment and usage data, see Data privacy.

Important: You can use UMS or IBM Licensing.

Installing Usage Metering Service

Do the following steps to install UMS:

Deploy UMS catalog with the following command:

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

Create a subscription for UMS with the following command:

cat <<EOF | oc apply -f -                                                                                                                                     
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: ibm-usage-metering-operator
  namespace: ${PM_PROJECT}
spec:
  channel: v1.0
  installPlanApproval: Automatic
  name: ibm-usage-metering-operator
  source: usage-metering-service
  sourceNamespace: openshift-marketplace
  startingCSV: ibm-usage-metering-operator.v1.0.5
EOF

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 * * *

When push to IBM Software Central is enabled, you must provide your IBM entitlement key in a secret. Do the following steps to create a secret that contains your IBM Entitlement Key:
1. Obtain the IBM entitlement key from MyIBM Container Software Library. For more information, see Accessing Process Mining images.
2. Convert the IBM entitlement key to the Base64 format with the following command:
```
export TOKEN=<entitlement key>
printf %s "$TOKEN" | base64 | tr -d '\n'
```
3. Log in to the OpenShift console of the cluster where the product for which you want to send the data is deployed.
4. Open the process mining namespace and go to Workloads > Secrets.
5. In the Create menu, select From YAML.
6. Paste the following YAML with your entitlement key:
```
 kind: Secret
 apiVersion: v1
 metadata:
   name: <USER ENTITLEMENT KEY SECRET NAME>
 data:
   token: <IBM entitlement key converted to Base-64 format>
 type: Opaque
```
  Note: If an instance is already present in the namespace (i.e. when CP4BA is installed or it was created before), the operator will use that instance.

Opting out of Usage Metering Service

If you want to opt out of Usage Metering Service after you enabled it, you must disable sending the data to IBM Software Central in the pminstance CRD:

spec:
  usagemetering:
    anonymize: false
    # automatically send usage data to IBM Software Central
    enable: false
    entitlementkeysecret: '<USER ENTITLEMENT KEY SECRET NAME>'
    # IBM Software Central push frequency
    frequency: 5 0 * * *

Installing IBM Licensing

Do the following steps to install IBM Licensing:

Deploy IBM Licensing catalog with the following command:

cat <<EOF | oc apply -f -
apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
  name: ibm-licensing-catalog
  namespace: openshift-marketplace
spec:
  displayName: ibm-licensing-4.2.23
  publisher: IBM
  image: icr.io/cpopen/ibm-licensing-catalog@sha256:dc50f5d6e34b63d05e486bec83064a702fe60dd7ecaa0a827a154c4bf3a426d1
  sourceType: grpc
EOF

Note: Wait until all pods are in Running state before proceeding with subsequent steps. To check their state go to Workloads > Pods.

Create the namespace with the following command:

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

Create the operator group with the following command:

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

Create the subscription with the following command:

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