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 type of IBM Cloud Pak for Data 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
-
Run the
cpd-cli
manage
login-to-ocp command to log in to the cluster as a user with
sufficient permissions to complete this task. For example:
cpd-cli manage login-to-ocp \
--username=${OCP_USERNAME} \
--password=${OCP_PASSWORD} \
--server=${OCP_URL}
Tip: The login-to-ocp command takes the same
input as the oc login command. Run oc login --help for
details.
- Run the following command to give the License Service information about your license:
Enterprise Edition
license
cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=cpd-enterprise
Enterprise Edition
non-production license
cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=cpd-enterprise \
--production=false
Standard Edition license
cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=cpd-standard
watsonx.data
license
Important: To use this option, you must have olm-utils-v2:4.7.2 or later.
cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-data
watsonx.data
non-production license
Important: To use this option, you must have olm-utils-v2:4.7.2 or later.
cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-data-non-production
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: