Enable usage reporting

Docs Home

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.

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

Install the following items to a supported version of Red Hat® OpenShift® Container Platform:
- Red Hat Marketplace Operator
- IBM License Service Operator
  - License Service as a part of an IBM Cloud Pak (included in IBM Cloud Pak foundational services version 3.12 or later)
  - License Service version 1.9.0 or later without an IBM Cloud Pak

About this task

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

Note: For IBM License Service version 1.12.0 and higher, usage reporting is automatically enabled when License Service is deployed. For more information, refer to About IBM License Service version 1.12.0 and higher.

Procedure

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

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.9.0
  datasource: datacollector
  httpsEnable: true
  instanceNamespace: ibm-common-services
  rhmpEnabled: true

After you edit the YAML, save your changes.

Result

Usage reporting is now enabled.

Starting from License Service version 1.12.0, the integration with Red Hat Marketplace is automatically enabled when License Service is deployed. You do not need to edit the IBMLicensing custom resource and add the rhmpEnabled parameter.

Note that the integration is automatically enabled only when the rhmpEnabled parameter has not been already set. Otherwise, the set value has a higher priority. When you previously set the rhmpEnabled parameter to false this setting is not overwritten.

To verify whether the integration is enabled, check the IBMLicensing custom resource. See the status of the rhmpEnabled parameter, which is listed under status > features.

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.

Enable usage reporting

Overview on usage reporting