Monitoring and reporting use against license terms

You are required to keep a record of the size of deployments to report to IBM as requested. You can use the License Service to measure your IBM Cloud Pak® for Data use against your license terms.

The cpd-cli manage apply-entitlement command enables you to provide information about the license that you purchased. This enables the License Service to provide accurate usage information against your license terms.

What permissions do you need to complete this task?
To complete this task, you must have one of the following roles:
  • Cluster administrator
  • Instance administrator
When do you need to complete this task?
Complete this task after you install an instance of Cloud Pak for Data to ensure that you have an accurate record of your software use.

Before you begin

The workstation from which you will run the commands must be set up as a client workstation with the following command-line interfaces:

  • Cloud Pak for Data CLI: cpd-cli
  • OpenShift® CLI: oc

For details, see: Setting up a client workstation.

Procedure

  1. Log the cpd-cli in to the Red Hat OpenShift Container Platform cluster: 
    ${CPDM_OC_LOGIN}
    Remember: CPDM_OC_LOGIN is an alias for the cpd-cli manage login-to-ocp command.
  2. Run the appropriate commands to give the License Service information about your license.

    For example, if you installed watsonx.ai and watsonx.governance Model Management, run the commands for both of the licenses.

    Cloud Pak for Data Enterprise Edition
    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=cpd-enterprise
    Non-production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=cpd-enterprise \
--production=false
    Cloud Pak for Data Standard Edition
    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=cpd-standard
    IBM® watsonx.ai
    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-ai \
--apply_branding=true
    Non-production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-ai \
--production=false \
--apply_branding=true
    IBM watsonx.data
    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-data \
--apply_branding=true
    Non-production license
    Important: To run this command you must have olm-utils-v2:4.8.3 or later.
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-data \
--production=false \
--apply_branding=true
    IBM watsonx.governance Model Management
    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-gov-model-management \
--apply_branding=true
    Non-production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-gov-model-management \
--production=false \
--apply_branding=true
    IBM watsonx.governance Risk and Compliance Foundation
    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-gov-risk-compliance \
--apply_branding=true
    Non-production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-gov-risk-compliance \
--production=false \
--apply_branding=true

What to do next

You can use the License Service to generate an audit snapshot of your use. For more information, see Retrieving an audit snapshot in the License Service APIs:

It is recommended that you generate a monthly snapshot. For best practices, see Audit snapshot in the IBM Cloud Pak foundational services documentation: