Configuring Queue Managers with IBM MQ license annotations by using the IBM MQ Operator

To use an IBM® MQ license (base entitlement), certain license annotations must be applied to queue managers. How these licenses are applied depends on the version of your IBM MQ Operator and the version of your IBM MQ Operator queue managers.

Before you begin

Note: These instructions apply only if you are using the IBM MQ Operator. If you are self-deploying (in other words, without using the IBM MQ Operator) queue managers on Kubernetes, see IBM MQ container license annotations instead.

About this task

You might not need to complete this task, depending on the license that you want to use:

If you want to use an IBM MQ or IBM MQ for Non-Production Environment license, you do not need to complete this task. Instead, select your license when you deploy a queue manager, as described in Deploying a simple queue manager using the IBM MQ Operator on Red Hat OpenShift or Deploying a simple queue manager using the IBM MQ Operator on Amazon EKS. The IBM MQ Operator applies the necessary annotations for you.
If you want to use an IBM Cloud Pak® for Integration license with your base IBM MQ license, complete the steps in this task to specify both licenses when you deploy a queue manager. The IBM MQ Operator then applies the relevant annotations for you.
If you want to add a Native HA and Cross-Region Replication Add-On license to an IBM MQ licensed queue manager, you do not need to complete this task. Instead, follow the steps in Configuring Native HA and Cross-Region Replication on IBM MQ licensed Queue Managers by using the IBM MQ Operator.

Important: Updating the queue manager YAML triggers a pod restart.

Procedure

If you want to use an IBM Cloud Pak for Integration license with your base IBM MQ license, specify both licenses when you deploy a queue manager:

Specify an IBM Cloud Pak for Integration license in the spec.license.license field.
Specify an IBM MQ license in the spec.license.additionalLicenses field.

For information about the available licenses, see Licensing and API references for the IBM MQ Operator.

The following example shows how to configure a queue manager with an IBM Cloud Pak for Integration license and an IBM MQ additional license, for production use:

...
spec:
  license:
    accept: false
    license: L-VEMB-RABZSN
    additionalLicenses:
      - L-MKDD-7KHY2Q
    use: Production
...

When you deploy the queue manager, the IBM MQ Operator applies one of the following annotations for you, depending on the licenses that you specified:

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

In the previous example, the operator applies the IBM MQ with CP4I entitlement annotation.