Applying your entitlements without node pinning (Upgrading from Version 5.0.x to a later 5.0 refresh)

Tell the License Service which licenses apply to your installation.

If you also want to pin pods to nodes, complete Applying your entitlements and pinning pods to nodes (Upgrading from Version 5.0.x to a later 5.0 refresh) instead.

Upgrade phase
  • You are not here. Updating your cluster
  • You are not here. Updating your client workstation
  • You are not here. Collecting required information
  • You are not here. Preparing to run an upgrade in a restricted network
  • You are not here. Preparing to run an upgrade from a private container registry
  • You are not here. Installing prerequisite software
  • You are not here. Updating the shared cluster components
  • You are here icon. Preparing to upgrade an instance of Cloud Pak for Data
  • You are not here. Upgrading an instance of Cloud Pak for Data
Who needs to complete this task?

Instance administrator An instance administrator can complete this task.

When do you need to complete this task?
Complete this task only if both of the following statements are true:
  • You plan to change the solutions that are installed in this instance of Cloud Pak for Data.
  • You don't use node pinning to manage entitlement.

Repeat as needed If you have multiple instances of Cloud Pak for Data, repeat this task for each instance of Cloud Pak for Data where the preceding conditions apply.

Before you begin

To complete this task, you must know:

  • The license or licenses that you purchased
  • The solutions that are installed in this instance of Cloud Pak for Data
  • The solutions that you plan to add or remove
Best practice: You can run the commands in this task exactly as written using the installation environment variables. Ensure that you added the new environment variables from Updating your environment variables script.

In addition, ensure that you source the environment variables before you run the commands in this task.

About this task

Use the apply-entitlement command to give the License Service information about the entitled software in an instance of Cloud Pak for Data.

Use the remove-entitlement command to remove entitlements for software that you plane to remove.

Procedure

To apply your entitlements to an instance of Cloud Pak for Data:

  1. Log the cpd-cli in to the Red Hat® OpenShift® Container Platform cluster: 
    ${CPDM_OC_LOGIN}
  2. Run the apply-entitlement command for each solution that is installed or that you plan to install in this instance of Cloud Pak for Data:

    For example, if you installed Cloud Pak for Data Enterprise Edition and Cognos Analytics, 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
    Cognos Analytics
    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=cognos-analytics
    Data Product Hub
    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=data-product-hub
    Non-production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=data-product-hub \
--production=false
    DataStage
    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=datastage
    IBM Knowledge Catalog Premium
    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=ikc-premium
    IBM Knowledge Catalog Standard
    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=ikc-standard
    OpenPages
    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=openpages
    Planning Analytics
    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=planning-analytics
    Product Master
    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=product-master
    Watson Discovery
    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watson-discovery
    Watson Speech to Text
    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=speech-to-text
    Watson Text to Speech
    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=text-to-speech
    IBM watsonx.ai
    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-ai
    Non-production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-ai \
--production=false
    watsonx Assistant
    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watson-assistant
    watsonx Code Assistant for Red Hat Ansible® Lightspeed
    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-code-assistant-ansible
    watsonx Code Assistant for Z
    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-code-assistant-z
    IBM watsonx.data
    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-data
    Non-production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-data \
--production=false
    IBM watsonx.governance Model Management
    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-gov-mm
    Non-production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-gov-mm \
--production=false
    IBM watsonx.governance Risk and Compliance Foundation
    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-gov-rc
    Non-production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-gov-rc \
--production=false
    watsonx Orchestrate
    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-orchestrate
    Non-production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-orchestrate \
--production=false
  3. Run the remove-entitlement command for any solution that you plan to remove from this instance of Cloud Pak for Data:
    Cloud Pak for Data Enterprise Edition
    Production license 
    cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=cpd-enterprise \
--restart_pods=false
    Non-production license 
    cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=cpd-enterprise \
--production=false \
--restart_pods=false
    Cloud Pak for Data Standard Edition
    Production license 
    cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=cpd-standard \
--restart_pods=false
    Cognos Analytics
    Production license 
    cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=cognos-analytics \
--restart_pods=false
    Data Product Hub
    Production license 
    cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=data-product-hub \
--restart_pods=false
    Non-production license 
    cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=data-product-hub \
--production=false \
--restart_pods=false
    DataStage
    Production license 
    cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=datastage \
--restart_pods=false
    IBM Knowledge Catalog Premium
    Production license 
    cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=ikc-premium \
--restart_pods=false
    IBM Knowledge Catalog Standard
    Production license 
    cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=ikc-standard \
--restart_pods=false
    OpenPages
    Production license 
    cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=openpages \
--restart_pods=false
    Planning Analytics
    Production license 
    cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=planning-analytics \
--restart_pods=false
    Product Master
    Production license 
    cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=product-master \
--restart_pods=false
    Watson Discovery
    Production license 
    cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watson-discovery \
--restart_pods=false
    Watson Speech to Text
    Production license 
    cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=speech-to-text \
--restart_pods=false
    Watson Text to Speech
    Production license 
    cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=text-to-speech \
--restart_pods=false
    IBM watsonx.ai
    Production license 
    cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-ai \
--restart_pods=false
    Non-production license 
    cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-ai \
--production=false \
--restart_pods=false
    watsonx Assistant
    Production license 
    cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watson-assistant \
--restart_pods=false
    watsonx Code Assistant for Red Hat Ansible Lightspeed
    Production license 
    cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-code-assistant-ansible \
--restart_pods=false
    watsonx Code Assistant for Z
    Production license 
    cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-code-assistant-z \
--restart_pods=false
    IBM watsonx.data
    Production license 
    cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-data \
--restart_pods=false
    Non-production license 
    cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-data \
--production=false \
--restart_pods=false
    IBM watsonx.governance Model Management
    Production license 
    cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-gov-mm \
--restart_pods=false
    Non-production license 
    cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-gov-mm \
--production=false \
--restart_pods=false
    IBM watsonx.governance Risk and Compliance Foundation
    Production license 
    cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-gov-rc \
--restart_pods=false
    Non-production license 
    cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-gov-rc \
--production=false \
--restart_pods=false
    watsonx Orchestrate
    Production license 
    cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-orchestrate \
--restart_pods=false
    Non-production license 
    cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-orchestrate \
--production=false \
--restart_pods=false

What to do next

Now that you've told the License Service which solutions you plan to install in this instance of Cloud Pak for Data, you're ready to complete Upgrading an instance of IBM Cloud Pak for Data (Upgrading from Version 5.0.x to a later 5.0 refresh).