[Linux]

IBM MQ container license annotations

In Kubernetes and Red Hat® OpenShift® Container Platform environments, the IBM® License Service uses Pod annotations to track usage based on the limits defined on the container, rather than on the underlying machine. The IBM MQ Operator sets these Pod annotations for you, but when you deploy using other means, you must set them yourself.

For information about how the IBM MQ Operator annotates pods based on the values of a queue manager's YAML, see IBM MQ container license annotations that are applied by the IBM MQ Operator.

When deploying an IBM MQ container, there are two common approaches to licensing:
  • License the entire machine running the container.
  • License the container based on the associated limits (Kubernetes and Red Hat OpenShift Container Platform only)
Both options are available to customers, and further details can be found on the IBM Container Licenses page on Passport Advantage®.

If the IBM MQ container is to be licensed based on the container limits, then the IBM License Service needs to be installed to track usage. Further information regarding the supported environments and installation instructions can be found on the ibm-licensing-operator page on GitHub.

The IBM License Service is installed on the Kubernetes cluster where the IBM MQ container is deployed, and pod annotations are used to track usage. Therefore clients need to deploy the pod with specific annotations that the IBM License Service then uses. Based on your entitlement and capabilities deployed within the container, use one or more of the following annotations.

Note: Many of the annotations contain one or both of the following lines:
productChargedContainers: "All" | "NAME_OF_CONTAINER"
productMetric: "PROCESSOR_VALUE_UNIT" | "VIRTUAL_PROCESSOR_CORE"
You must edit these lines before using the annotation:
  • For productChargedContainers, you must choose "All", or substitute the actual name of the container.
  • For productMetric, you must choose one of the values offered.

Annotations to use with an IBM MQ product entitlement

If you have an IBM MQ product entitlement, select the annotation below that matches the entitlement you have purchased and want to use. The IBM MQ annotations to use with IBM MQ Multi Instance High Availability configurations are as follows. See also Selecting the correct annotations for High Availability configurations.

Annotations to use with CP4I product entitlement

If you have IBM Cloud Pak® for Integration (CP4I) entitlement select the annotation below that matches the entitlement you have purchased and want to use.

The CP4I annotations to use with IBM MQ Multi Instance High Availability configurations are as follows. See also Selecting the correct annotations for High Availability configurations.

Selecting the correct annotations for High Availability configurations

IBM MQ Multi Instance

When you deploy a multi-instance queue manager, you should use the same annotations on both the active and standby instances. One of the following annotations should be selected, depending on the entitlement purchased:
When used with IBM Cloud Pak for Integration entitlement, the entitlement ratios in the annotations ensure that correct entitlement consumption is recorded. When used with standalone IBM MQ or IBM MQ Advanced entitlements, the annotations reported in the License Service for each instance need to be mapped to the IBM MQ entitlement parts as follows:
  • IBM MQ Advanced Container Multi Instance
    • 1 x IBM MQ Advanced and 1 x IBM MQ Advanced High Availability Replica or
    • 2 x IBM MQ Advanced1
  • IBM MQ Advanced Container Multi Instance for Non-Production Environment
    • 1 x IBM MQ Advanced and 1 x IBM MQ Advanced High Availability Replica or
    • 2 x IBM MQ Advanced for Non-Production Environment)1
  • IBM MQ Container Multi Instance
    • 1 x IBM MQ and 1 x IBM MQ High Availability Replica or
    • 2 x IBM MQ1
  • IBM MQ Container Multi Instance for Non-Production Environment
    • 1 x IBM MQ and 1 x IBM MQ High Availability Replica or
    • 2 x IBM MQ for Non-Production Environment) 1

IBM MQ Native HA

If you are deploying a Native HA queue manager, only the active instance consumes entitlement, the two replica instances do not. All instances should have the same annotation. One of the following should be selected, depending on the entitlement purchased:

Annotations

The rest of this topic details the contents of each annotation.

IBM MQ

productID: "c661609261d5471fb4ff8970a36bccea"
productName: "IBM MQ"
productMetric: "PROCESSOR_VALUE_UNIT" | "VIRTUAL_PROCESSOR_CORE"
productChargedContainers: "All" | "NAME_OF_CONTAINER"
To use Native HA and Cross-Region Replication features on queue managers that use these license annotations, see the topic that matches your environment:

IBM MQ Advanced

productID: "208423bb063c43288328b1d788745b0c"
productName: "IBM MQ Advanced"
productMetric: "PROCESSOR_VALUE_UNIT" | "VIRTUAL_PROCESSOR_CORE"
productChargedContainers: "All" | "NAME_OF_CONTAINER"

IBM MQ for Non-Production Environment

productID: "151bec68564a4a47a14e6fa99266deff"
productName: "IBM MQ for Non-Production Environment"
productMetric: "PROCESSOR_VALUE_UNIT" | "VIRTUAL_PROCESSOR_CORE"
productChargedContainers: "All" | "NAME_OF_CONTAINER"
To use Native HA and Cross-Region Replication features on queue managers that use these license annotations, see the topic that matches your environment:

IBM MQ Advanced for Non-Production Environment

productID: "21dfe9a0f00f444f888756d835334909"
productName: "IBM MQ Advanced for Non-Production Environment"
productMetric: "PROCESSOR_VALUE_UNIT" | "VIRTUAL_PROCESSOR_CORE"
productChargedContainers: "All" | "NAME_OF_CONTAINER"

IBM MQ Advanced for Developers

productID: "2f886a3eefbe4ccb89b2adb97c78b9cb"
productName: "IBM MQ Advanced for Developers (Non-Warranted)"
productMetric: "FREE"
productChargedContainers: "All" | "NAME_OF_CONTAINER"

IBM MQ Container Multi Instance

productID: "2dea73b866b648b6b4abe2a85eb76964"
productName: "IBM MQ Container Multi Instance"
productMetric: "PROCESSOR_VALUE_UNIT" | "VIRTUAL_PROCESSOR_CORE"
productChargedContainers: "All" | "NAME_OF_CONTAINER"

IBM MQ Advanced Container Multi Instance

productID: "bd35bff411bb47c2a3f3a4590f33a8ef"
productName: "IBM MQ Advanced Container Multi Instance"
productMetric: "PROCESSOR_VALUE_UNIT" | "VIRTUAL_PROCESSOR_CORE"
productChargedContainers: "All" | "NAME_OF_CONTAINER"

IBM MQ Container Multi Instance for Non-Production Environment

productID: "af11b093f16a4a26806013712b860b60"
productName: "IBM MQ Container Multi Instance for Non-Production Environment"
productMetric: "PROCESSOR_VALUE_UNIT" | "VIRTUAL_PROCESSOR_CORE"
productChargedContainers: "All" | "NAME_OF_CONTAINER"

IBM MQ Advanced Container Multi Instance for Non-Production Environment

productID: "31f844f7a96b49749130cd0708fdbb17"
productName: "IBM MQ Advanced Container Multi Instance for Non-Production Environment"
productMetric: "PROCESSOR_VALUE_UNIT" | "VIRTUAL_PROCESSOR_CORE"
productChargedContainers: "All" | "NAME_OF_CONTAINER"

IBM MQ with CP4I entitlement

cloudpakId: "c8b82d189e7545f0892db9ef2731b90d"
cloudpakName: "IBM Cloud Pak for Integration"
productID: "c661609261d5471fb4ff8970a36bccea"
productName: "IBM MQ"
productMetric: "VIRTUAL_PROCESSOR_CORE"
productChargedContainers: "All" | "NAME_OF_CONTAINER"
productCloudpakRatio: "4:1"

IBM MQ Advanced with CP4I entitlement

cloudpakId: "c8b82d189e7545f0892db9ef2731b90d"
cloudpakName: "IBM Cloud Pak for Integration"
productID: "208423bb063c43288328b1d788745b0c"
productName: "IBM MQ Advanced"
productMetric: "VIRTUAL_PROCESSOR_CORE"
productChargedContainers: "All" | "NAME_OF_CONTAINER"
productCloudpakRatio: "2:1"

IBM MQ for Non-Production Environment with CP4I entitlement

cloudpakId: "c8b82d189e7545f0892db9ef2731b90d"
cloudpakName: "IBM Cloud Pak for Integration"
productID: "151bec68564a4a47a14e6fa99266deff"
productName: "IBM MQ for Non-Production Environment"
productMetric: "VIRTUAL_PROCESSOR_CORE"
productChargedContainers:  "All" | "NAME_OF_CONTAINER"
productCloudpakRatio: "8:1"

IBM MQ Advanced for Non-Production Environment with CP4I entitlement

cloudpakId: "c8b82d189e7545f0892db9ef2731b90d"
cloudpakName: "IBM Cloud Pak for Integration"
productID: "21dfe9a0f00f444f888756d835334909"
productName: "IBM MQ Advanced for Non-Production Environment"
productMetric: "VIRTUAL_PROCESSOR_CORE"
productChargedContainers: "All" | "NAME_OF_CONTAINER"
productCloudpakRatio: "4:1"

IBM MQ Container Multi Instance with CP4I entitlement

productName: "IBM MQ Container Multi Instance"
productID: "2dea73b866b648b6b4abe2a85eb76964"
productChargedContainers: "All" | "NAME_OF_CONTAINER"
productMetric: "VIRTUAL_PROCESSOR_CORE"
productCloudpakRatio: "10:3"
cloudpakName: "IBM Cloud Pak for Integration"
cloudpakId: "c8b82d189e7545f0892db9ef2731b90d"

IBM MQ Advanced Container Multi Instance with CP4I entitlement

cloudpakId: "c8b82d189e7545f0892db9ef2731b90d"
cloudpakName: "IBM Cloud Pak for Integration"
productID: "bd35bff411bb47c2a3f3a4590f33a8ef"
productName: "IBM MQ Advanced Container Multi Instance"
productMetric: "VIRTUAL_PROCESSOR_CORE"
productChargedContainers: "All" | "NAME_OF_CONTAINER"
productCloudpakRatio: "5:3"

IBM MQ Container Multi Instance for Non-Production Environment with CP4I entitlement

cloudpakId: "c8b82d189e7545f0892db9ef2731b90d"
cloudpakName: "IBM Cloud Pak for Integration"
productID: "af11b093f16a4a26806013712b860b60"
productName: "IBM MQ Container Multi Instance for Non-Production Environment"
productMetric: "VIRTUAL_PROCESSOR_CORE"
productChargedContainers: "All" | "NAME_OF_CONTAINER"
productCloudpakRatio: "20:3"

IBM MQ Advanced Container Multi Instance for Non-Production Environment with CP4I entitlement

cloudpakId: "c8b82d189e7545f0892db9ef2731b90d"
cloudpakName: "IBM Cloud Pak for Integration"
productID: "31f844f7a96b49749130cd0708fdbb17"
productName: "IBM MQ Advanced Container Multi Instance for Non-Production Environment"
productMetric: "VIRTUAL_PROCESSOR_CORE"
productChargedContainers: "All" | "NAME_OF_CONTAINER"
productCloudpakRatio: "10:3"
1 This entitlement option is sub optimal and should only be used if no entitlement of the relevant High Availability Replica part is available.