Deploying License Service

License Service collects and measures the license usage of IBM Cloud Pak® for Integration at the cluster level. You can retrieve this data upon request for monitoring and compliance. You can also retrieve an audit snapshot of the data that is audit evidence. License Service for Cloud Pak for Integration is not deployed automatically.

To learn more about License Service, see IBM License Service. For more information about Cloud Pak for Integration licensing, see Licensing.

You can deploy License Service:

Both methods are provided, including procedures for deploying using the OpenShift web console or using the OpenShift CLI for each method.

Once you have deployed License Service, you can validate it.

Deploying License Service with the Platform UI

You can deploy License Service by editing the YAML file for the PlatformNavigator custom resource.

Prerequisite: If you have not already deployed the Platform UI, follow the procedures in Deploying the Platform UI by using the OpenShift console or Deploying the Platform UI by using the CLI (up to, but not including, "Logging in to the Platform UI").

Deploying License Service using the OpenShift web console

  1. Log into the OpenShift web console with your OpenShift credentials.

  2. Change Project to the desired project (namespace) name. Click the drop-down arrow and select your project name from the list. This is the metadata.namespace (value of integration) in the YAML example in step 7.

  3. In the navigation panel, click Operators > Installed Operators.

  4. In the list on the Installed Operators panel, find and click IBM Cloud Pak for Integration.

  5. Click the Platform UI tab. If there is not already a created instance, follow the procedure for "Creating the Platform UI instance" in Deploying the Platform UI by using the CLI.

  6. Click the instance in the list and click YAML. The YAML view opens an editor.

  7. In the editor, enter spec.requestIbmServices.licensing with value true, as in the following example YAML file. Change the value of metadata.namespace to the desired namespace (project) as needed.

    kind: PlatformNavigator
metadata:
    name: integration-quickstart
    namespace: integration
spec:
    license:
        accept: false
    mqDashboard: true
    replicas: 3
    version: 2021.1.1
    requestIbmServices:
        licensing: true

  8. The License Service is now deployed in the ibm-common-services namespace.

Deploying the license service using the OpenShift CLI

You can deploy License Service by editing the pre-existing YAML file for the PlatformNavigator resource.

  1. Log in to the OpenShift CLI.

  2. Change the project to the desired project/namespace:

    oc project <namespace>

  3. Generate a list of instances in this namespace that includes the name of the PlatformNavigator resource:

    oc get pn

    If no instances are returned, follow the procedure for "Creating the Platform UI instance" in Deploying the Platform UI by using the CLI.

  4. Edit the resource by running this command, placing <name> with the name of your instance:

    oc edit pn <name>

  5. In the YAML, at the end of the spec section, add spec.requestIbmServices.licensing with value true as in the following YAML example.

    kind: PlatformNavigator
metadata:
    name: integration-quickstart
    namespace: integration
spec:
    license:
        accept: false
    mqDashboard: true
    replicas: 3
    version: 2021.1.1
    requestIbmServices:
        licensing: true

  6. Save and apply your changes in the editor.

  7. The License Service will now be deployed in the ibm-common-services namespace.

Deploying License Service without a PlatformNavigator resource

You can deploy License Service directly, without a PlatformNavigator resource.

Deploying using the OpenShift web console

  1. Log into the OpenShift web consolewith your OpenShift credentials.

  2. In the top banner, click the plus + icon to open the Import YAML dialog box.

  3. Paste this resource definition into the dialog box and change the namespace to the desired project/namespace. It can be any namespace with integration workloads, or the ibm-common-services namespace:

    apiVersion: operator.ibm.com/v1alpha1
kind: OperandRequest
metadata:
  name: licensing-request
  namespace: integration
spec:
  requests:
    - operands:
        - name: ibm-licensing-operator
      registry: common-service
      registryNamespace: ibm-common-services

  4. Click Create.

  5. The License Service will now be deployed in the ibm-common-services namespace.

Deploying using the OpenShift CLI

  1. Save this text to a file called licensing-request.yaml, replacing <namespace> with your desired namespace.

    apiVersion: operator.ibm.com/v1alpha1
kind: OperandRequest
metadata:
  name: licensing-request
  namespace: integration
spec:
  requests:
    - operands:
        - name: ibm-licensing-operator
      registry: common-service
      registryNamespace: ibm-common-services

  2. Run this command; use your project name as the value for <namespace>:

    oc apply -f licensing-request.yaml -n <namespace>

  3. The License Service will now be deployed in the ibm-common-services namespace.