Applying your entitlements without node pinning (Upgrading from Version 5.0 to Version 5.1)

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 to Version 5.1) instead.

Upgrade phase

Updating your client workstation
Collecting required information
Preparing to run an upgrade in a restricted network
Preparing to run an upgrade from a private container registry
Upgrading prerequisite software
Upgrading shared cluster components
Preparing to upgrade an instance
Upgrading an instance

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.
You don't use node pinning to manage entitlement.

Repeat as needed If you have multiple instances of IBM Cloud Pak® for Data Version 5.0, repeat this task for each instance that you plan to upgrade to IBM® Software Hub Version 5.1.

Before you begin

To complete this task, you must know:

The license or licenses that you purchased
The solutions that are currently installed in this instance
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 IBM Software Hub.

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

Procedure

To apply your entitlements to an instance:

Log the cpd-cli in to the Red Hat® OpenShift® Container Platform cluster:
```
${CPDM_OC_LOGIN}
```

Run the apply-entitlement command for each solution that is installed or that you plan to install in this instance:

For example, if you installed IBM Cloud Pak for Data Enterprise Edition and Cognos Analytics, run the commands for both of the licenses.

IBM 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

IBM 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

IBM Manta Data Lineage

Production license

The command that you run depends on which license you purchased:

IBM Manta Data Lineage Cartridge

cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=data-lineage

Non-production license

The command that you run depends on which license you purchased:

IBM Manta Data Lineage Cartridge

cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=data-lineage \
--production=false

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

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™

Production license

cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-code-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

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

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

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

The command that you run depends on which license you purchased:

IBM watsonx Orchestrate® with watsonx Assistant™ Cartridge

cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-orchestrate

IBM watsonx Orchestrate with watsonx Assistant for Voice Interaction Cartridge

cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watson-orchestrate-with-assistant

Non-production license

cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-orchestrate \
--production=false

Run the remove-entitlement command for any solutions that you plan to remove from this instance:

IBM 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

IBM 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

IBM Manta Data Lineage

Production license

The command that you run depends on which license you want to remove:

IBM Manta Data Lineage Cartridge

cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=data-lineage \
--restart_pods=false

IBM Manta Data Lineage Software Reserved

cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=data-lineage-reserved \
--restart_pods=false

Non-production license

The command that you run depends on which license you want to remove:

IBM Manta Data Lineage Cartridge

cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=data-lineage \
--production=false \
--restart_pods=false

IBM Manta Data Lineage Software Reserved

cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=data-lineage-reserved \
--production=false \
--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

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

Production license

cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-code-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

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

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

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

The command that you run depends on which license you want to remove:

IBM watsonx Orchestrate with watsonx Assistant Cartridge

cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-orchestrate \
--restart_pods=false

IBM watsonx Orchestrate with watsonx Assistant for Voice Interaction Cartridge

cpd-cli manage remove-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watson-orchestrate-with-assistant \
--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, you're ready to complete Upgrading an instance to IBM Software Hub (Upgrading from Version 5.0 to Version 5.1).