Licensing

Full licenses include 3 cores of restricted Red Hat OpenShift Container Platform for each virtual processor core (VPC) of Cloud Pak for Integration. For more information about restricted Red Hat OpenShift Container Platform in Cloud Pak for Integration, see Red Hat OpenShift entitlements.

To review the license agreements for any of the following full IBM Cloud Pak for Integration licenses, click the link for that license:

• IBM Cloud Pak for Integration 2023.4.1 (L-VTPK-22YZPK)

• IBM Cloud Pak for Integration 2023.2.1 (L-YBXJ-ADJNSM)

• IBM Cloud Pak for Integration 2022.4.1 (L-RJON-CJR2RX)

• IBM Cloud Pak for Integration 2022.2.1 (L-RJON-CD3JKX)

Reserved licenses do not include OpenShift entitlement. They are intended for organizations that either have an existing Red Hat OpenShift entitlement, or commit to using Cloud Pak for Integration on public cloud environments with managed OpenShift. Prior IBM approval is required.

The reserved Cloud Pak for Integration licenses can be found here:

• IBM Cloud Pak for Integration Reserved 2023.4.1 (L-QYQF-8UFZBN)

• IBM Cloud Pak for Integration Reserved 2023.2.1 (L-PYRA-849GYQ)

• IBM Cloud Pak for Integration Reserved 2022.4.1 (L-RJON-CJR2TC)

• IBM Cloud Pak for Integration Reserved 2022.2.1 (L-RJON-CD3JJU)

The full Cloud Pak for Integration licenses are available on the OpenShift cluster at the following address:

https://<home>/static/media/<version>/<license_title>.txt

Values for the placeholders in the URL are:

• <home> - the UI host of the Platform UI, for example, https://integration-quickstart-pn-integration.apps.acme.cloud.com. To get the value of <home>, do one of the following:

  • In the OpenShift web console, select the Project (namespace) where the Platform UI instance is deployed, then locate and click its UI route.

  • Run the following command in OpenShift Container Platform CLI, replacing <namespace> with the namespace where the Platform UI instance is deployed:

  oc get routes -n <namespace>

• <license_title> - can have one of the following values:

• Other documents:

Deployed instances in Cloud Pak for Integration are charged at different rates that are based on their ratios. The following are two examples of ratio use that is provided in the "Production license ratio" table:

• 3 VPCs of Cloud Pak for Integration are required for 1 VPC of App Connect Enterprise deployment.

• 1 VPC of Cloud Pak for Integration is required for 2 VPCs of MQ Advanced deployment.

Entitlements of Cloud Pak for Integration that are used in these ratios can be reused in other ratios at any time, as long as you don't exceed the total entitlement. There is no limit to the number of times that entitlements can be used in different combinations.

Cloud Pak for Integration includes both chargeable and non-chargeable components. Only chargeable components consume Cloud Pak for Integration entitlements when deployed. Other components do not consume Cloud Pak for Integration entitlements when deployed, but use OpenShift entitlement if deployed on OpenShift. This relationship is described in the following table. For more information, see Noncharged entitlements for Cloud Pak for Integration.

Deployment ratios apply to the bundled programs within Cloud Pak for Integration only. Additional Cloud Pak for Integration instances, such as Platform UI and Automation assets, can be deployed without requiring Cloud Pak for Integration VPCs to be counted against their deployment. Additionally, when MQ is deployed as a supporting program to App Connect Enterprise (as described by the App Connect Enterprise License) this deployment is not charged, and can be configured to be free. For more information, see Example: Customizing license service annotations.

Customers with entitlements outside IBM Cloud Pak for Integration may have used licensing that uses PVUs and reporting deployments with IBM License Metric Tool (ILMT) for subcapacity measurements.

ILMT keeps track of which software programs are deployed on particular physical hardware setups. It provides reporting for customers, so they can present reports to IBM when it they are requested in order to demonstrate compliance around entitlement capacity. See IBM License Metric Tool information for more details about how to use this tool.

Deployments under IBM Cloud Pak for Integration entitlement can continue to be deployed on the same hardware, and in the same VMs as previously measured and reported with PVUs. Recent updates to ILMT now allow it to track deployments of software programs entitled under VPCs. ILMT should now be used to keep track of software deployed in VMs and entitled under VPCs.

For containers under IBM Cloud Pak for Integration VPC entitlements, the license service available to Cloud Pak deployments can be configured to report the deployments of each bundled offering in each container. It can also report the container size and how that relates—using the VPC-to-license ratio—to IBM Cloud Pak for Integration entitlements.

This deployment reporting is aggregated for each OpenShift cluster to provide a high-water mark of deployment to track against customer IBM Cloud Pak for Integration entitlements.

For more information about the IBM Cloud Platform License Service as used by deployments of Cloud Pak for Integration, see Viewing and tracking license usage. The License Service operator, when deployed, reports if any containers are not configured with the correct annotations to report to the License Service; certified containers provided by IBM include the correct annotations for the License Service. For more information on IBM License tracking and counting for instances, review the IBM Licensing Methodology pages.

For the purposes of this discussion, “entitlement” to the Red Hat OpenShift Container Platform means the software subscription and support for the RedHat OpenShift Container Platform. “Restricted license entitlement” means that any software subscription and support for the Red Hat OpenShift Container Platform that is acquired pursuant to your Cloud Pak for Integration license is only provided for use of the Red Hat OpenShift Container Platform (henceforth referred to as OpenShift), specifically for Cloud Pak for Integration and not for non-Cloud Pak for Integration workloads.

When bundled offerings (such as API Connect, MQ, or Aspera) are deployed as part of a Cloud Pak for Integration deployment, deployment of OpenShift is required. License entitlement for OpenShift is provided 3:1 with the number of Cloud Pak for Integration virtual processor cores (VPCs) that the customer has licensed. This means that the customer gets 3 cores of entitled OpenShift for each VPC of Cloud Pak for Integration that they have licensed.

The entitlements for OpenShift that are included in the Cloud Pak for Integration entitlement are restricted license entitlements. This means that the entitlements can be used only for deployments of Cloud Pak for Integration instances, not for third-party deployments or custom code. If you deploy other code or components (such as agents used for monitoring Cloud Pak for Integration instances), you must purchase separate OpenShift entitlements and make those available to the cluster. Otherwise, the deployment of the non-Cloud Pak workload on those OpenShift licenses will result in those OpenShift cores, and potentially the workload itself, being unsupported.

These additional OpenShift entitlements for running non-Cloud Pak workload must be procured separately from the OpenShift entitlements granted through IBM Cloud Paks. The workload that you run on separately-purchased OpenShift entitlement doesn’t need to be deployed separately from Cloud Pak workload running on Cloud Pak-procured OpenShift cores. But the number of separately purchased OpenShift cores must be equal to or greater than the number of cores of non-Cloud Pak workload deployed on them in order to receive support for the complete deployment of non-Cloud Pak workloads.

Agents for monitoring are one example of a non-Cloud Pak workload. These agents, which run alongside the Cloud Pak components and then send the monitoring data out to a separate monitoring server component, can be run in the same nodes and namespaces as components running in OpenShift cores using entitlements under IBM Cloud Pak. For all non-Cloud Pak workloads, not just monitoring agents, ensure that you have sufficient, separately-procured software subscription and support entitlements. For more information about deploying workload in mixed clusters of OpenShift entitlements, see Restricted OpenShift entitlement for IBM Cloud Paks.

The number of VPCs of OpenShift that are included in your Cloud Pak for Integration entitlement doesn’t vary by the ratio of the bundled offerings which are deployed under Cloud Pak entitlement. Therefore, the number of cores that are required for deployment of bundled offerings in IBM Cloud Pak for Integration can, in some scenarios, exceed the number of OpenShift cores available as part of the entitlement for Cloud Pak for Integration. In such cases, the customer should acquire additional entitlement for OpenShift to ensure that they are always correctly licensed. Only OpenShift cores that are deployed as worker nodes count against the OpenShift entitlement.

Cloud Pak for Integration includes IBM Cloud Pak foundational services as well as bundled offerings. The Cloud Pak foundational services, when deployed, also consume OpenShift entitlements.

The IBM backup policy and temporary use policy, as referenced in the International Program License Agreement, governs backups and temporary use for Red Hat products included in the Program.

Previous releases of Cloud Pak for Integration had access to limited-time offers for either IBM Storage Suite for Cloud Paks or IBM Storage Fusion. Customers deploying Cloud Pak for Integration 2023.4.1 into an OpenShift cluster now have entitlement to 12TB of usable storage per cluster from IBM Storage Fusion Essentials. There is no time limit associated with this entitlement. It is available while the customer has Cloud Pak for Integration entitlement and is current with Subscription and Support.

Entitlement to IBM Storage Fusion Essentials includes:

• Compression

• Cluster-wide encryption

• Cross-availability zone HA

For additional functionality, you can upgrade to IBM Storage Fusion Advanced, which includes:

• Capacity requirements of more than 12TB per cluster

• External mode deployment

• Backup

• Disaster recovery

• Global Data Platform (Storage Scale)

• Data catalog

• Advanced encryption with external key management

If you buy entitlement to Cloud Pak for Integration after the release announcement for version 2022.4.1, either as an initial purchase, or as an additional purchase of licenses, you get limited entitlement to on-premises (self-hosted) Instana monitoring. This entitlement requires you to deploy your own Instana Observability Server. The entitlement is limited to a reduced set of sensors, and for a 6-month period of use, starting from the time you request it.

Instana monitoring provides tracing and monitoring of integration instances that are deployed using the Cloud Pak for Integration license, whether the instances are deployed on OpenShift Container Platform or in other environments. Instana monitoring can be used on all Cloud Pak for Integration deployed entitlements, not only the additional, new entitlements of Cloud Pak for Integrationn that were purchased to provide the Instana entitlement, but also existing entitlements.

When deploying MQ in containers under Cloud Pak for Integration licensing, you can choose the Native high-availability (HA) configuration for high availability. This option is designed for container deployments of MQ without external dependencies, such as shared storage or kernel modifications. When deployed in this configuration, an active MQ Queue Manager replicates to 2 additional Queue Managers, which are used only as replicas for this active Queue Manager.

Licensing for this configuration requires that the active Queue Manager be licensed using the MQ Advanced ratio. However, the replica Queue Managers do not require licensing, because they don't consume Cloud Pak for Integration VPCs at any ratio. By contrast, if Queue Managers are deployed on Red Hat OpenShift Container Platform, all OpenShift cores require entitlement.

MQ Native HA can also be deployed in containers on other Kubernetes platforms. For more information, see Native HA.

When deploying MQ in containers under Cloud Pak for Integration licensing, another option for high availability (HA) is "multi-instance queue managers":

• This option is designed for deployments where an active MQ queue manager writes persistent messages and logging data to network-attached storage.

• The active MQ queue manager has a lock on the network-attached storage.

• A replica queue manager, which is connected to the same storage, is ready to take over in case of the failure of the active queue manager. This failure releases the storage lock and allows the replica queue manager to become the active queue manager.

When deploying MQ in multi-instance configurations outside of containers, the active queue manager is fully licensed by the regular MQ or MQ Advanced license, but the replica queue manager is licensed using the MQ HA Replica or MQ Advanced HA Replica part.

When deploying MQ in a multi-instance configuration in containers (under Cloud Pak for Integration licensing), a different approach is needed, because the replica queue manager is not tracked by the License Service. To ensure license consistency, the active queue manager uses a ratio that includes the licensing cost of the replica queue manager. To address this, the License Information document provides an option with a "Deployment model" called Multi-Instance Containers; select that option when deploying this type of configuration.

When deploying Aspera High Speed Transfer Server in a container in IBM Cloud Pak for Integration, the following entitlement enables the use of Aspera High Speed Transfer Server at a bandwidth speed of 1 Gigabit per second:

• For a production deployments, 4 VPCs of Cloud Pak for Integration.

• For nonproduction deployments, 2 VPCs of Cloud Pak for Integration.

Aspera High Speed Transfer Server must be deployed in a container within the OpenShift Container Service environment that supports Cloud Pak for Integration. The customer must have sufficient OpenShift entitlement for deployment in this container.

Deployments of Aspera High Speed Transfer Server in OpenShift containers now benefit from the support of the Aspera Proxy Gateway, which can be deployed without any additional license entitlement.

For deployments of Aspera High Speed Transfer Server outside Cloud Pak for Integration containers, the entitlement ratio remains the same as for deployment in containers, and is also fixed at a bandwidth speed of 1 Gigabit per second:

• For production use of stand-alone Aspera High Speed Transfer Server, 4 VPCs of Cloud Pak for Integration.

• For nonproduction use of stand-alone Aspera High Speed Transfer Server, 2 VPCs of Cloud Pak for Integration.

Note that bandwidth measure is used to represent the value provided by Aspera High Speed Transfer Server, rather than the ratio of Cloud Pak for Integration VPCs to deployment cores of Aspera High Speed Transfer Server.

The "API Connect Enterprise" license provides entitlement to the full API Connect product (API management instance) and tracks usage by the number of installed VPCs.

The "IBM Cloud Pak for Integration - API Calls" is an add-on that entitles you to track usage by the monthly number of API calls instead of the number of installed VPCs. Customers need to track and report the number of API Calls made each month. The entitlement is counted on a month-by-month basis rather than being averaged or aggregated over the period of the subscription license. For more information, see Tracking API volume for auditing and compliance.

For more information, see API Connect licenses in the API Connect documentation.

The "IBM DataPower Gateway Virtual Edition - Production Edition" license is included in Cloud Pak for Integration. You can deploy a gateway instance in either production or nonproduction mode, but a production image that is specific to Cloud Pak for Integration is always deployed with it. This means that the licensing metrics and annotations on the gateway pods always reflect the production edition, even if deployed in nonproduction usage. However, the Cloud Pak ratio does change depending on the license usage. When production is chosen as the license usage, the ratio is 1:1 for VPCs. When nonproduction is chosen as the license usage, the ratio is 2:1 for VPCs.

A custom datapower-cp4i image is always used when a gateway instance is created within Cloud Pak for Integration, including when used as an API runtime within API Connect. This datapower-cp4i image is based on the datapower-prod (production) image, and also includes the Integration Module. For more information, see Cloud Pak for Integration: Gateway runtime. In addition to the Integration Module, customers using DataPower with Cloud Pak for Integration entitlements are entitled to use the Application Optimization Module and the B2B Module at no additional charge.

Previous releases of Cloud Pak for Integration required the deployment of an API management instance if an Event Endpoint Management instance was also being deployed. With the 2023.2.1 release, Event Endpoint Management can be deployed without the IBM API Connect operator, and it is a separately chargeable component.

The licensing ratio remains at 1:1 for production deployments and 2:1 for non-production deployments. Chargeable components deployed when using Event Endpoint Management are ‘manager’ and ‘egw’. As with other components, the operator is not chargeable.

Event Endpoint Management is also available in the IBM Event Automation product. However, Cloud Pak for Integration is separate from the IBM Event Automation product and thus does not include the IBM Event Automation product.

Cloud Pak for Integration includes Event Streams as an implementation of Apache Kafka. Customers who choose to deploy this program need to have license entitlement for the deployment of Event Streams chargeable components at the following ratios: 1:1 ratio for production deployments, 2:1 ratio for non-production components.

Chargeable components deployed when using Event Streams are as follows: ‘kafka containers’, ‘georep containers’, ‘mirrormaker2 containers’, ‘connect containers’. Non-chargeable components associated with deployments of Event Streams include operators and containers such as ‘collector’, ‘zookeeper’, ‘cruiseControl’, ‘kafkaExporter’, ‘kafkaProxy’ and ‘kafkaBridge’, among others.

Event Streams is also available in the IBM Event Automation product. However, Cloud Pak for Integration is separate from the IBM Event Automation product and thus does not include the IBM Event Automation product.

In the 2022.4.1 release of Cloud Pak for Integration, the Operations Dashboard instance type was deprecated. In the 2023.2.1 release, Operations Dashboard is removed.