Applying your entitlements without node pinning

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 instead.

If you're not sure whether you want to pin pods to nodes, see Planning for multiple solutions.

Installation phase
  • You are not here. Setting up a client workstation
  • You are not here. Setting up a cluster
  • You are not here. Collecting required information
  • You are not here. Preparing to run installs in a restricted network
  • You are not here. Preparing to run installs from a private container registry
  • You are not here. Preparing the cluster for IBM Software Hub
  • You are not here. Preparing to install an instance of IBM Software Hub
  • You are not here. Installing an instance of IBM Software Hub
  • You are here icon. Setting up the control plane
  • You are not here. Installing solutions and services
Who needs to complete this task?

Instance administrator An instance administrator can complete this task.

When do you need to complete this task?

Repeat as needed If you plan to install multiple instances of IBM Software Hub, you must repeat this task for each instance that you plan to install.

Before you begin

To complete this task, you must know which license or licenses you purchased and which solutions you plan to install in this instance of IBM Software Hub.

Best practice: You can run the commands in this task exactly as written if you use your installation environment variables script.

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.

Procedure

To apply your entitlements to an instance of IBM Software Hub:

  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 you plan to install in this instance of IBM Software Hub:

    For example, if you plan to install watsonx.ai™ and watsonx.governance™ Model Management, run the commands for both of the licenses.

    IBM Cloud Pak® for Data Enterprise Edition

    If you purchased the IBM Cloud Pak for Data Enterprise Edition license, apply the license to your environment.

    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

    If you purchased the IBM Cloud Pak for Data Standard Edition license, apply the license to your environment.

    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=cpd-standard
    Cognos Analytics

    If you purchased an IBM Cognos® Analytics license, apply the license to your environment.

    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=cognos-analytics
    Data Product Hub

    If you purchased the IBM Data Product Hub Cartridge license, apply the license to your environment.

    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

    If you purchased a DataStage license, apply the license to your environment.

    1. Set the LICENSE_NAME environment variable based on the DataStage license that you purchased:
      IBM DataStage Enterprise Cartridge 
      export LICENSE_NAME=datastage
      IBM DataStage Enterprise Plus Cartridge 
      export LICENSE_NAME=datastage-plus
    2. Apply the license to your environment:
      Production license 
      cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=${LICENSE_NAME}
      Non-production license 
      cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=${LICENSE_NAME} \
--production=false
    IBM Knowledge Catalog Premium

    If you purchased the IBM Knowledge Catalog Premium Cartridge license, apply the license to your environment.

    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=ikc-premium
    Non-production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=ikc-premium \
--production=false
    IBM Knowledge Catalog Standard

    If you purchased the IBM Knowledge Catalog Standard Cartridge license, apply the license to your environment.

    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=ikc-standard
    IBM Manta Data Lineage

    If you purchased an IBM Manta Data Lineage license, apply the license to your environment.

    1. Set the LICENSE_NAME environment variable based on the IBM Manta Data Lineage license that you purchased:
      IBM Manta Data Lineage Cartridge 
      export LICENSE_NAME=data-lineage
      IBM Manta Data Lineage Software Reserved 
      export LICENSE_NAME=data-lineage-reserved
    2. Apply the license to your environment.
      Production license 
      cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=${LICENSE_NAME}
      Non-production license 
      cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=${LICENSE_NAME} \
--production=false
    OpenPages

    If you purchased the IBM OpenPages® Cartridge license, apply the license to your environment.

    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=openpages
    Planning Analytics

    If you purchased the IBM Planning Analytics Cartridge license, apply the license to your environment.

    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=planning-analytics
    Product Master

    If you purchased the IBM Product Master Cartridge license, apply the license to your environment.

    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=product-master
    Watson Discovery

    If you purchased the IBM Watson® Discovery Cartridge license, apply the license to your environment.

    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watson-discovery
    Watson Speech services

    If you purchased the IBM Watson Speech Services Cartridge license, apply the license to your environment.

    1. Set the LICENSE_NAME environment variable based on the service that you plan to install:
      IBM Watson Speech to Text Cartridge 
      export LICENSE_NAME=speech-to-text
      IBM Watson Text to Speech Cartridge 
      export LICENSE_NAME=text-to-speech
    2. Apply the license to your environment.
      Production license 
      cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=${LICENSE_NAME}
    watsonx.ai

    If you purchased the IBM watsonx.ai license, apply the license to your environment.

    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

    If you purchased the IBM watsonx Assistant™ Cartridge license, apply the license to your environment.

    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watson-assistant
    watsonx™ BI

    If you purchased a watsonx BI license, apply the license to your environment.

    1. Set the LICENSE_NAME environment variable based on the license that you purchased:
      IBM watsonx BI Premium
      Measure by authorized users
      export LICENSE_NAME=watsonx-bi-premium
      Measure by virtual processor cores
      export LICENSE_NAME=watsonx-bi-premium-vpc
      IBM watsonx BI Premium Add-On for Cognos Analytics
      Measure by authorized users
      export LICENSE_NAME=watsonx-bi-premium-ca
      Measure by virtual processor cores
      export LICENSE_NAME=watsonx-bi-premium-ca-vpc
    2. Apply the license to your environment.
      Production license 
      cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=${LICENSE_NAME}
      Non-production license 
      cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=${LICENSE_NAME} \
--production=false
    watsonx Code Assistant™

    If you purchased the IBM watsonx Code Assistant license, apply the license to your environment.

    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

    If you purchased the IBM watsonx Code Assistant for Ansible license, apply the license to your environment.

    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-code-assistant-ansible
    watsonx Code Assistant for Z

    If you purchased the IBM watsonx Code Assistant for Z license, apply the license to your environment.

    Production license 
    cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=watsonx-code-assistant-z
    watsonx.data™

    If you purchased a watsonx.data license, apply the license to your environment.

    1. Set the LICENSE_NAME environment variable based on the license that you purchased:
      IBM watsonx.data 
      export LICENSE_NAME=watsonx-data
      IBM watsonx.data Reserved 
      export LICENSE_NAME=watsonx-data-reserved
    2. Apply the license to your environment.
      Production license 
      cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=${LICENSE_NAME}
      Non-production license 
      cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=${LICENSE_NAME} \
--production=false
    watsonx.data Premium

    If you purchased a watsonx.data Premium license, apply the license to your environment.

    1. Set the LICENSE_NAME environment variable based on the license that you purchased:
      IBM watsonx.data Premium Edition 
      export LICENSE_NAME=watsonx-data-premium
      IBM watsonx.data Premium Edition Reserved 
      export LICENSE_NAME=watsonx-data-premium-reserved
    2. Apply the license to your environment.
      Production license 
      cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=${LICENSE_NAME}
      Non-production licensecpd-cli manage apply-entitlement \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --entitlement=${LICENSE_NAME} \ --production=false
    watsonx.data integration

    If you purchased a watsonx.data integration license, apply the license to your environment.

    1. Set the LICENSE_NAME environment variable based on the license that you purchased:
      IBM watsonx.data integration 
      export LICENSE_NAME=watsonx-dataintegration
      IBM watsonx.data integration Reserved 
      export LICENSE_NAME=watsonx-dataintegration-reserved
    2. Apply the license to your environment.
      Production license 
      cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=${LICENSE_NAME}
      Non-production license 
      cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=${LICENSE_NAME} \
--production=false
    watsonx.data intelligence

    If you purchased a watsonx.data intelligence license, apply the license to your environment.

    1. Set the LICENSE_NAME environment variable based on the license that you purchased:
      IBM watsonx.data intelligence
      Measure by resource units
      export LICENSE_NAME=watsonx-dataintelligence
      Measure by virtual processor cores (VPCs)
      export LICENSE_NAME=watsonx-dataintelligence-vpc
      IBM watsonx.data intelligence Reserved
      Measure by resource units
      export LICENSE_NAME=watsonx-dataintelligence-reserved
      Measure by virtual processor cores (VPCs)
      export LICENSE_NAME=watsonx-dataintelligence-reserved-vpc
      IBM watsonx.data intelligence Transition
      Measure by resource units
      export LICENSE_NAME=watsonx-dataintelligence-transition
      Measure by virtual processor cores (VPCs)
      export LICENSE_NAME=watsonx-dataintelligence-transition-vpc
      IBM watsonx.data intelligence Transition Reserved
      Measure by resource units
      export LICENSE_NAME=watsonx-dataintelligence-transition-reserved
      Measure by virtual processor cores (VPCs)
      export LICENSE_NAME=watsonx-dataintelligence-transition-reserved-vpc
    2. Apply the license to your environment.
      Production license 
      cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=${LICENSE_NAME}
      Non-production license 
      cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=${LICENSE_NAME} \
--production=false
    IBM watsonx.governance

    If you purchased an watsonx.governance license, apply the license to your environment.

    1. Set the LICENSE_NAME environment variable based on the license that you purchased:
      IBM watsonx.governance Model Management 
      export LICENSE_NAME=watsonx-gov-mm
      IBM watsonx.governance Risk and Compliance Foundation 
      export LICENSE_NAME=watsonx-gov-rc
    2. Apply the license to your environment.
      Production license 
      cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=${LICENSE_NAME}
      Non-production license 
      cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=${LICENSE_NAME} \
--production=false
    watsonx Orchestrate

    If you purchased a watsonx Orchestrate license, apply the license to your environment.

    1. Set the LICENSE_NAME environment variable based on the license that you purchased:
      IBM watsonx Orchestrate On-Prem 
      export LICENSE_NAME=watsonx-orchestrate
      IBM watsonx Orchestrate On-Prem for Voice Interaction 
      export LICENSE_NAME=watsonx-orchestrate-with-assistant
    2. Apply the license to your environment.
      Production license 
      cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=${LICENSE_NAME}
      Non-production license 
      cpd-cli manage apply-entitlement \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--entitlement=${LICENSE_NAME} \
--production=false

What to do next

Now that you've told the License Service which solutions you plan to install in this instance of IBM Software Hub, you're ready to complete Installing solutions and services.