Enable usage reporting

Overview on usage reporting

Customers have the option to enable usage reporting to track software consumption across a hybrid cloud environment. Usage data shows on the following pages:

  • Current usage — shows usage across all products on the account that report usage.
  • Product usage — shows usage details on individual products on the account that report usage.
  • Software — shows usage details on individual products on the account that report usage, as well as subscription plan details.

To enabled usage reporting, leverage the following technologies:

  • IBM License Service — reports usage on operator-based products deployed to OpenShift. Users can configure their OpenShift environment to deliver usage to Workspace.
  • IBM License Metric Tool — reports usage on products that are deployed to environments other than OpenShift, including virtual machines, selected public clouds, logical partitions, and physical computers. Users can export data from the tool to Workspace.

Enable usage reporting through IBM License Service

Usage data collected by IBM License Service can be integrated with your Workspace. The data transfer applies only to information about the products that are deployed on a cluster and enabled for License Service integration. Data shows on Current usage and Product usage pages. To integrate IBM License Service, prepare your OpenShift environment using the following procedure.

Prerequisites

About this task

To enable usage reporting, edit the IBMLicensing custom resource using OpenShift console or OpenShift Command-line Interface.

Procedure

  1. Open IBMLicensing custom resource:

    • From OpenShift console
      1. Log in to your OpenShift console.
      2. Go to Operators > Installed Operators.
      3. From the Project drop-down list, select ibm-common-services
      4. Select IBM Licensing Operator.
      5. Select the IBM License Service tab. The instance of License Service custom resource is listed.
      6. From the overflow action menu, select Edit IBMLicensing.
    • From the command line
      1. Run the following command:
      oc edit IBMLicensing instance -n ibm-common-services
  2. Add the following line to the IBMLicensing section:

    rhmpEnabled: true

    For example:

    apiVersion: operator.ibm.com/v1alpha1
    kind: IBMLicensing
    metadata:
    name: instance
    spec:
    version: 1.4.0
    datasource: datacollector
    httpsEnable: true
    instanceNamespace: ibm-common-services
    rhmpEnabled: true
  3. After you edit the YAML, save your changes.

Result

Usage reporting is now enabled.


Enable usage reporting through IBM License Metric Tool

Usage data collected by IBM License Metric Tool can be exported to your Workspace. Data shows on Current usage and Product usage pages. To export data, get a pull secret. Then, configure export settings on License Metric Tool.