Adding Cloud Paks, entitlements, or licenses to your cluster
Review the following steps for adding IBM Cloud Paks, Red Hat OpenShift licenses, and other entitlements to your Red Hat OpenShift on IBM Cloud clusters
Assigning a Cloud Pak entitlement to your IBM Cloud account
To deploy a Cloud Pak to your Red Hat OpenShift on IBM Cloud cluster, your entitlement to the Cloud Pak must be assigned to your IBM Cloud account.
- Verify that your Cloud Pak entitlement is in your Container software library. If you don't see the entitlement, the entitlement might be owned by a different user. Verify the user, and if you still have issues, click Contact IBM from the container software library page.
- Make sure that the IBM Cloud account owner gives you permission to assign entitlements.
- From the IBM Cloud console menu bar, click Manage > Access (IAM).
- From the Users tab, click the user that you want to assign permissions.
- Click Access policies > Assign access +.
- Click Account management.
- From the What type of access do you want to assign? drop-down menu, select License and Entitlement.
- Select at least the Editor platform access role, then click Add.
- Assign the Cloud Pak entitlement to your IBM Cloud account.
- Continue to create the Cloud Pak instance.
Adding entitlements to your cluster
Before you begin:
- Verify that your account administrator set up your IBM Cloud account with the Cloud Pak entitlement.
- Make sure that you have the required permissions to create a cluster.
-
Add your entitlement from IBM Passport Advantage to your Red Hat OpenShift on IBM Cloud cluster.
- For new clusters: Create a cluster with the
--entitlement ocp_entitled
option. When you specify the number of workers (--workers
) and flavor (--flavor
), make sure to specify only the number and size of worker nodes that you are entitled to use. You can optionally specify the worker node operating system (--operating-system
). After your cluster is created, you are not charged the Red Hat OpenShift license fee for the entitled worker nodes in thedefault
worker pool. If you want to use a different worker pool for your Cloud Pak, follow the steps for existing clusters. - For existing clusters or worker pools other than the
default
: Create a worker pool with the--entitlement ocp_entitled
option. When you specify the number of workers (--size-per-zone
) and flavor (--flavor
), make sure to specify only the number and size of worker nodes that you are entitled to use. After creation, your worker pool does not charge you the Red Hat OpenShift license fee for your entitled worker nodes.
Do not exceed your entitlement. Keep in mind that your OpenShift Container Platform entitlements can be used with other cloud providers or in other environments. To avoid billing issues later, make sure that you use only what you are entitled to use. For example, you might have an entitlement for the OCP licenses for two worker nodes of 4 CPU and 16 GB memory, and you create this worker pool with two worker nodes of 4 CPU and 16 GB memory. You used your entire entitlement, and you can't use the same entitlement for other worker pools, cloud providers, or environments.
- For new clusters: Create a cluster with the
-
In the IBM Cloud catalog, in the Software tab, under Offering Type, check Cloud Paks.
-
Select the Cloud Pak that you want to deploy, and follow the installation instructions. Each Cloud Pak requires an entitlement from IBM Passport Advantage, and has its own configuration settings. For more information, view the About tab and Cloud Pak documentation.
Adding Cloud Pak images from an entitled registry
You can deploy Cloud Pak images that you are already licensed to use in IBM Passport Advantage to your Red Hat OpenShift on IBM Cloud cluster by using the IBM Cloud Container Registry entitled registry.
- Set up your cluster to pull images from the entitled registry.
- Set up Helm in your cluster and add the entitled Helm repository.
- Find and review the Helm chart from the Helm catalog or from the CLI by running
helm search repo entitled
andhelm show entitled/<chart_name>
. - Follow the instructions that are particular to each Cloud Pak installation, such as configuring the Helm chart values to work within Red Hat OpenShift security context constraints.
Now you can run your Cloud Pak on your Red Hat OpenShift cluster!