IBM Cloud Docs
Red Hat OpenShift on IBM Cloud CLI reference

Red Hat OpenShift on IBM Cloud CLI reference

Refer to these commands to create and manage both community Kubernetes or Red Hat OpenShift clusters in Red Hat® OpenShift® on IBM Cloud®.

In the command line, you are notified when updates to the ibmcloud CLI and plug-ins are available. Be sure to keep your CLI up-to-date so that you can use all available commands and options.

Looking for ibmcloud cr commands? See the IBM Cloud Container Registry CLI reference. Looking for kubectl commands? See the Kubernetes documentation.

Red Hat OpenShift on IBM Cloud commands

The following tables list the ibmcloud oc command groups. For a complete list of all ibmcloud oc commands as they are structured in the CLI, see the Red Hat OpenShift on IBM Cloud CLI map.

Red Hat OpenShift on IBM Cloud CLI command groups
Command group Description
Cluster commands Create, view, and modify clusters and cluster settings, such as add-on, subnet, and master settings.
Worker commands View and modify worker nodes for a cluster.
Worker-pool commands View and modify worker pools for a cluster.
Zone commands List availability zones and modify the zones attached to a worker pool.
Ingress commands View and modify Ingress services and settings.
NLB-DNS commands Create and manage host names for network load balancer (NLB) IP addresses in a cluster and health check monitors for host names.
Webhook-create commands Register a webhook in a cluster.
API-key commands View information about the API key for a cluster or reset it to a new key.
Credential commands Set and unset credentials that allow you to access the IBM Cloud classic infrastructure portfolio through your IBM Cloud account.
Infra-permissions commands Check classic IBM Cloud infrastructure permissions that are used in IBM Cloud Kubernetes Service.
KMS commands Enable a key management service (KMS) provider in your cluster to encrypt the etcd component and Kubernetes secrets with a root key that you control.
Quota commands View the quota and limits for cluster-related resources in your IBM Cloud account.
Subnets commands List available subnets in your IBM Cloud infrastructure account.
VLAN commands List public and private VLANs for a zone and view the VLAN spanning status.
VPCS commands List all VPCs in the targeted resource group. If no resource group is targeted, then all VPCs in the account are listed.
Flavor commands Get the information of a flavor or list available flavors for a zone.
Locations commands List the locations that are supported by IBM Cloud Kubernetes Service.
Messages commands View the current user messages.
Versions commands List the container platform versions that are available for IBM Cloud Kubernetes Service clusters.
Deprecated API commands View or target the API endpoint and API version for the service.
Deprecated init commands Initialize the IBM Cloud Kubernetes Service plug-in or specify the region where you want to create or access Kubernetes clusters.
Script commands Rewrite scripts that call IBM Cloud Kubernetes Service plug-in commands.
Beta Storage commands View and modify storage resources.

cluster commands

Create, view, and modify clusters and cluster settings, such as add-on, subnet, and master settings.

ibmcloud oc cluster addon disable

Disable a managed add-on in an existing cluster. This command must be combined with one of the following subcommands for the managed add-on that you want to disable.

ibmcloud oc cluster addon disable debug-tool

Virtual Private Cloud Classic infrastructure

Disable the add-on for the IBM Cloud Kubernetes Service Diagnostics and Debug Tool.

ibmcloud oc cluster addon disable debug-tool --cluster CLUSTER [-f]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
-f
Optional: Force the command to run with no user prompts.

ibmcloud oc cluster addon disable image-key-synchronizer

Virtual Private Cloud Classic infrastructure

Disable the add-on for the Image Key synchronizer.

ibmcloud oc cluster addon Disable image-key-synchronizer --cluster CLUSTER [--version VERSION]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--version VERSION
Optional: Specify the version of the add-on to install. If no version is specified, the default version is installed.
Example addon disable image-key-synchronizer command
ibmcloud oc cluster addon disable image-key-synchronizer --cluster my_cluster

ibmcloud oc cluster addon disable kube-terminal

Virtual Private Cloud Classic infrastructure

Disable the Kubernetes web terminal add-on. To use the Kubernetes web terminal in the IBM Cloud Kubernetes Service cluster console, you must re-enable the add-on first.

ibmcloud oc cluster addon disable kube-terminal --cluster CLUSTER [-f]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
-f
Optional: Force the command to run with no user prompts.

ibmcloud oc cluster addon disable openshift-data-foundation

Virtual Private Cloud Classic infrastructure

Disable the OpenShift Data Foundation add-on.

ibmcloud oc cluster addon disable openshift-data-foundation --cluster CLUSTER [-f] [-q]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
-f
Optional: Force the command to run with no user prompts.
-q
Optional: Do not show the message of the day or update reminders.

ibmcloud oc cluster addon disable static-route

Virtual Private Cloud Classic infrastructure

Disable the static route add-on.

ibmcloud oc cluster addon disable static-route --cluster CLUSTER
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

ibmcloud oc cluster addon enable

Enable a managed add-on in an existing cluster. This command must be combined with one of the following subcommands for the managed add-on that you want to enable.

ibmcloud oc cluster addon enable debug-tool

Virtual Private Cloud Classic infrastructure

Enable the add-on for the IBM Cloud Kubernetes Service Diagnostics and Debug Tool in a cluster.

ibmcloud oc cluster addon enable debug-tool --cluster CLUSTER [--version VERSION]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--version VERSION
Optional: Specify the version of the add-on to install. If no version is specified, the default version is installed.
Example addon enable debug-tool command
ibmcloud oc cluster addon enable debug-tool --cluster my_cluster

ibmcloud oc cluster addon enable image-key-synchronizer

Classic infrastructure Virtual Private Cloud

Enable the add-on for the Image Key synchronizer in a cluster to run an app by using an encrypted image.

ibmcloud oc cluster addon enable image-key-synchronizer --cluster CLUSTER [--version VERSION]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--version VERSION
Optional: Specify the version of the add-on to install. If no version is specified, the default version is installed.
Example addon enable image-key-synchronizer command
ibmcloud oc cluster addon enable image-key-synchronizer --cluster my_cluster

ibmcloud oc cluster addon enable openshift-data-foundation

Virtual Private Cloud Classic infrastructure

Enable the OpenShift Data Foundation add-on.

ibmcloud oc cluster addon enable openshift-data-foundation --cluster CLUSTER [-f] [--param PARAM] [-q] [--version VERSION]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
-f
Optional: Force the command to run with no user prompts.
--param PARAM
Optional: Specify an installation setting. To see available settings, run ibmcloud oc cluster addon options --addon openshift-data-foundation.
-q
Optional: Do not show the message of the day or update reminders.
--version VERSION
Optional: Specify the version of the add-on to install. To see available versions, run ibmcloud oc cluster addon versions. If no version is specified, the default version is installed.

ibmcloud oc cluster addon enable static-route

Virtual Private Cloud Classic infrastructure

Enable the static route add-on.

ibmcloud oc cluster addon enable static-route --cluster CLUSTER [--version VERSION]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

--cluster CLUSTER
Required: The name or ID of the cluster.
--version VERSION
Optional: Specify the version of the add-on to install. If no version is specified, the default version is installed.

ibmcloud oc cluster addon get

Virtual Private Cloud Classic infrastructure

View the details of an installed add-on.

ibmcloud oc cluster addon get --addon ADDON --cluster CLUSTER [--output OUTPUT] [-q]
Minimum required permissions
Viewer platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

--addon ADDON
Required: The name of the addon. To list installed add-ons, run ibmcloud oc cluster addon ls.
-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

ibmcloud oc cluster addon ls

Virtual Private Cloud Classic infrastructure

List any managed add-ons that are enabled in a cluster.

ibmcloud oc cluster addon ls --cluster CLUSTER
Minimum required permissions
Viewer platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--output json
Optional: Prints the command output in JSON format.

ibmcloud oc cluster addon options

Virtual Private Cloud Classic infrastructure

Before you enable an add-on, view its installation options.

ibmcloud oc cluster addon options --addon ADDON [--output OUTPUT] [-q] [--version VERSION]
Minimum required permissions
Viewer platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

--addon ADDON
Required: The name of the addon. To list available add-ons, run ibmcloud oc cluster addon versions.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.
--version VERSION
Optional: Specify an add-on version to display options for. If no version is specified, the default version's options are displayed. To list available add-on versions, run ibmcloud oc cluster addon versions.

ibmcloud oc cluster addon update

Virtual Private Cloud Classic infrastructure

Update an installed add-on.

ibmcloud oc cluster addon update ADD-ON_NAME --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]
Minimum required permissions
None

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
-f
Optional: Force the command to run with no user prompts.
-q
Optional: Do not show the message of the day or update reminders.
--version VERSION
Optional: Specify the version to update the add-on to. If no version is specified, the add-on is updated to the default version. To list available add-on versions, run ibmcloud oc cluster addon versions.

ibmcloud oc cluster addon versions

Virtual Private Cloud Classic infrastructure

View a list of supported versions for managed add-ons in IBM Cloud Kubernetes Service.

ibmcloud oc cluster addon versions [--addon ADD-ON_NAME] [--output json] [-q]
Minimum required permissions
None

Command options:

--addon ADD-ON_NAME
Optional: Specify an add-on name such as istio to filter versions for.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example addon versions command

ibmcloud oc cluster addon versions --addon istio

ibmcloud oc cluster ca create

Virtual Private Cloud Classic infrastructure

Create a new certificate authority (CA) for your cluster. After the CA is created and new CA certificates are issued for components in your cluster, the API server of the cluster is automatically refreshed.

After you run this command and before you run the ibmcloud oc cluster ca rotate command, follow the steps in Rotating CA certificates in your cluster to ensure that any tooling that uses certificates that are signed by the old CA is updated to use the new certificates and to update your worker nodes.

ibmcloud oc cluster ca create --cluster CLUSTER [-f] [-q]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
-f
Optional: Force the command to run with no user prompts.
-q
Optional: Do not show the message of the day or update reminders.

Example cluster ca create command

ibmcloud oc cluster ca create --cluster my_cluster

ibmcloud oc cluster ca get

Virtual Private Cloud Classic infrastructure

View the details of a cluster's CA certificate.

ibmcloud oc cluster ca get --cluster CLUSTER [ --output OUTPUT] [-q]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example cluster ca get command

ibmcloud oc cluster ca get --cluster my_cluster

ibmcloud oc cluster ca rotate

Virtual Private Cloud Classic infrastructure

Rotate the certificate authority (CA) certificates of a cluster. Rotating invalidates certificates signed by the cluster's previous CA and issues certificates signed by the cluster's new CA to worker nodes.

Before you run this command, follow the steps in Rotating CA certificates in your cluster to ensure that any tooling that uses the old CA certificates is updated to use the new certificates and to update your worker nodes.

ibmcloud oc cluster ca rotate --cluster CLUSTER [-f] [-q]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
-f
Optional: Force the command to run with no user prompts.
-q
Optional: Do not show the message of the day or update reminders.

Example cluster ca rotate command

ibmcloud oc cluster ca rotate --cluster my_cluster

ibmcloud oc cluster ca status

Virtual Private Cloud Classic infrastructure

After you run ibmcloud oc cluster ca rotate, view the rotation status of certificate authority (CA) certificates for a cluster.

ibmcloud oc cluster ca status --cluster CLUSTER [-q]
Minimum required permissions
Viewer platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
-q
Optional: Do not show the message of the day or update reminders.

Example cluster ca status command

ibmcloud oc cluster ca status --cluster my_cluster

ibmcloud oc cluster config

Virtual Private Cloud Classic infrastructure

After logging in to IBM Cloud, download the Kubernetes configuration data and certificates as a kubeconfig file to your local machine so that you can connect to your cluster and run oc commands.

The kubeconfig file is merged to your existing kubeconfig file in ~/.kube/config (<user_profile>/.kube/config in Windows), or to the last file that is set by the KUBECONFIG environment variable in your command line session. After you run ibmcloud oc cluster config, you can interact with your cluster immediately, and quickly change the context to other clusters in the Kubernetes context.

ibmcloud oc cluster config --cluster CLUSTER [--admin] [--endpoint ENDPOINT_TYPE] [--network] [--skip-rbac] [-q] [--yaml]
Minimum required permissions
Viewer or Reader IBM Cloud IAM service access role for the cluster in IBM Cloud Kubernetes Service. Further, if you have only a platform access role or only a service access role, additional constraints apply.
  • Platform: If you have only a platform access role, you can perform this command, but you need a service access role to perform Kubernetes actions in the cluster.
  • Service: If you have the service access role, you can perform this command. However, your cluster admin must gather the cluster details for you by either running the ibmcloud oc cluster ls command or using the IBM Cloud Kubernetes Service console. After you receive the cluster name and ID, you can open the Red Hat OpenShift web console by opening your browser to <master_URL>/console.

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--admin
Optional: Download the TLS certificates and permission files for the Super User role. You can use the certs to automate tasks in a cluster without having to reauthenticate. The files are downloaded to <user_home_directory>/.bluemix/plugins/kubernetes-service/clusters/<cluster_name>-admin.
--endpoint ENDPOINT_TYPE
Optional: Specify the type of endpoint to use to connect to the cluster. If you don't specify this option, the default service endpoint for your cluster is used.
  • private: If the private cloud service endpoint is enabled for your cluster, set to private to use the private cloud service endpoint for your cluster context. Note you must be in your IBM Cloud private network or connected to the private network through a VPC VPN connection, or for classic infrastructure, a classic VPN connection or IBM Cloud Direct Link.

  • link: To connect to IBM Cloud Satellite clusters from within the IBM Cloud private network, set to link to use your Satellite location's Link endpoint for the cluster context. If you specify this option, you must also specify the --admin option. If you are not connected to the IBM Cloud private network, this option is not required because the cluster service URL is used. Before you can use the link endpoint type, make sure you set up the required Source in your Location.

  • vpe: If it is a VPC cluster, set to vpe to use the Virtual Private Endpoint gateway for your cluster context. Note you must be connected to the same VPC where the cluster is deployed through VPC VPN connection.

--network
Optional: Download the Calico configuration file, TLS certificates, and permission files that are required to run calicoctl commands in your cluster. This option can't be used with the --yaml option.
--skip-rbac
Skip adding user Kubernetes RBAC roles based on the IBM Cloud IAM service access roles to the cluster configuration. Include this option only if you manage your own Kubernetes RBAC roles. If you use IBM Cloud IAM service access roles to manage all your RBAC users, don't include this option.
-q
Optional: Do not show the message of the day or update reminders.
--yaml
Optional: Prints the command output in YAML format.

Example cluster config command

ibmcloud oc cluster config --cluster my_cluster

ibmcloud oc cluster create classic

Classic infrastructure

Create a cluster with worker nodes on classic infrastructure.

Red Hat OpenShift on IBM Cloud clusters are created with a public only or both a public and private service endpoint. Public service endpoints can't be disabled, and therefore, you can't convert a public Red Hat OpenShift cluster to a private one. If you want your cluster to remain private, see Planning your cluster network setup.

ibmcloud oc cluster create classic [--hardware HARDWARE] --zone ZONE --flavor FLAVOR --name NAME  [--operating-system SYSTEM] [--version MAJOR.MINOR.PATCH] [--no-subnet] [--sm-group GROUP] [--sm-instance INSTANCE] [--private-vlan PRIVATE_VLAN] [--public-vlan PUBLIC_VLAN]  [--private-service-endpoint] [--public-service-endpoint] --workers WORKER [--disable-disk-encrypt] [--pod-subnet SUBNET] [--service-subnet SUBNET] [--skip-advance-permissions-check] [--entitlement ENTITLEMENT][-q]

To create a VPC cluster, use the ibmcloud oc cluster create vpc-gen2 command instead.

Minimum required permissions
Administrator platform access role for IBM Cloud Kubernetes Service at the account level
Administrator platform access role for IBM Cloud Container Registry at the account level
Super User role for IBM Cloud infrastructure

Command options:

--hardware HARDWARE

The level of hardware isolation for your worker node. Use dedicated so that available physical resources are dedicated to you only, or shared to allow physical resources to be shared with other IBM customers. The default is shared. For bare metal flavors, specify dedicated.

--zone ZONE

The zone where you want to create the cluster. This value is required for standard clusters.

Review available classic or VPC zones. When you select a zone that is located outside your country, keep in mind that you might require legal authorization before data can be physically stored in a foreign country.

--flavor FLAVOR

Choose a flavor, or machine type, for your worker nodes. You can deploy your worker nodes as virtual machines on shared or dedicated hardware, or as physical machines on bare metal. Available physical and virtual flavors vary by the zone in which you deploy the cluster. For more information, see the documentation for the ibmcloud oc flavors (machine-types) command.

--name NAME

Required: The name for the cluster. The name must start with a letter, can contain letters, numbers, periods (.), and hyphen (-), and must be 35 characters or fewer. Use a name that is unique across regions. The cluster name and the region in which the cluster is deployed form the fully qualified domain name for the Ingress subdomain. To ensure that the Ingress subdomain is unique within a region, the cluster name might be truncated and appended with a random value within the Ingress domain name.

--operating-system REDHAT_8_64|RHCOS

Optional. The operating system of the worker nodes in your cluster. For a list of available operating sysems by cluster version, see the Red Hat OpenShift on IBM Cloud version information. If no option is specified, the default operating system that corresponds to the cluster version is used.

--version MAJOR.MINOR.PATCH

Optional: The Kubernetes version for the cluster master node. When the version is not specified, the cluster is created with the default of supported Kubernetes versions. To see available versions, run ibmcloud oc versions.

--no-subnet

By default, a public and a private portable subnet are created on the VLAN associated with the cluster. Include the --no-subnet option to avoid creating subnets with the cluster. You can create or add subnets to a cluster later.

--sm-group GROUP

The secret group ID of the Secrets Manager instance where your secrets are persisted. To get a secret group ID, see the Secrets Manager CLI reference.

--sm-instance INSTANCE

The CRN of the Secrets Manager instance. To get the CRN of an instance, run ibmcloud oc ingress instance ls --cluster CLUSTER.

--private-vlan PRIVATE_VLAN

If this standard cluster is the first standard cluster that you create in this zone, don't include this option. A private VLAN is created for you when the cluster is created. If you created a standard cluster before in this zone or created a private VLAN in IBM Cloud infrastructure before, you must specify that private VLAN. Private VLAN routers always begin with bcr (back-end router) and public VLAN routers always begin with fcr (front-end router). When you create a cluster and specify the public and private VLANs, the number and letter combination after those prefixes must match.

To find out whether you already have a private VLAN for a specific zone or to find the name of an existing private VLAN, run ibmcloud oc vlan ls --zone ZONE.

--public-vlan PUBLIC_VLAN

If this standard cluster is the first standard cluster that you create in this zone, don't use this option. A public VLAN is created for you when the cluster is created. If you created a standard cluster before in this zone or created a public VLAN in IBM Cloud infrastructure before, specify that public VLAN. If you want to connect your worker nodes to a private VLAN only, don't specify this option. Private VLAN routers always begin with bcr (back-end router) and public VLAN routers always begin with fcr (front-end router). When you create a cluster and specify the public and private VLANs, the number and letter combination after those prefixes must match.

To find out whether you already have a public VLAN for a specific zone or to find the name of an existing public VLAN, run ibmcloud oc vlan ls --zone ZONE.

--private-service-endpoint

Standard clusters in accounts that are enabled with VRF and service endpoints: Enable the private cloud service endpoint so that your Kubernetes master and the worker nodes communicate over the private VLAN. If you specify this option, you must also enable the public cloud service endpoint by using the --public-service-endpoint option. Note that you can't later change the cloud service endpoints. After you create the cluster, you can get the endpoint by running ibmcloud oc cluster get --cluster <cluster_name_or_ID>.

--public-service-endpoint

Enable the public cloud service endpoint so that your Kubernetes master can be accessed over the public network, for example to run oc commands from your command line. Public-only clusters can only be created in accounts that don't have VRF enabled. If you have an account that is enabled with VRF and service endpoints and also include the --private-service-endpoint option, master-worker node communication goes over the private and the public network. After you create the cluster, you can get the endpoint by running ibmcloud oc cluster get --cluster <cluster_name_or_ID>.

--workers WORKERS

Optional: Specify the number of worker nodes to include in the cluster. The default value is 1. If you create a cluster with only one worker node per zone, you might experience issues with Ingress. For high availability, create a cluster with at least two workers per zone. Every worker node is assigned a unique worker node ID and domain name that must not be manually changed after the cluster is created. Changing the ID or domain name prevents the Kubernetes master from managing your cluster.

--disable-disk-encrypt

Worker nodes feature AES 256-bit disk encryption by default; learn more. To disable encryption, include this option.

--pod-subnet SUBNET

All pods that are deployed to a worker node are assigned a private IP address in the 172.17.0.0/18 range by default. If you plan to connect your cluster to on-premises networks through IBM Cloud® Direct Link or a VPN service, you can avoid subnet conflicts by specifying a custom subnet CIDR that provides the private IP addresses for your pods.

When you choose a subnet size, consider the size of the cluster that you plan to create and the number of worker nodes that you might add in the future. The subnet must have a CIDR of at least /23, which provides enough pod IPs for a maximum of four worker nodes in a cluster. For larger clusters, use /22 to have enough pod IP addresses for eight worker nodes, /21 to have enough pod IP addresses for 16 worker nodes, and so on.

The subnet that you choose must be within one of the following ranges:

  • 172.17.0.0 - 172.17.255.255

  • 172.21.0.0 - 172.31.255.255

  • 192.168.0.0 - 192.168.254.255

  • 198.18.0.0 - 198.19.255.255

Note that the pod and service subnets can't overlap. The service subnet is in the 172.21.0.0/16 range by default.

--service-subnet *SUBNET

All services that are deployed to the cluster are assigned a private IP address in the 172.21.0.0/16 range by default. If you plan to connect your cluster to on-premises networks through IBM Cloud Direct Link or a VPN service, you can avoid subnet conflicts by specifying a custom subnet CIDR that provides the private IP addresses for your services.

The subnet must be specified in CIDR format with a size of at least /24, which allows a maximum of 255 services in the cluster, or larger. The subnet that you choose must be within one of the following ranges:

  • 172.17.0.0 - 172.17.255.255

  • 172.21.0.0 - 172.31.255.255

  • 192.168.0.0 - 192.168.254.255

  • 198.18.0.0 - 198.19.255.255

Note that the pod and service subnets can't overlap. The pod subnet is in the 172.30.0.0/16 range by default.

--skip-advance-permissions-check

Optional: Skip the check for infrastructure permissions before creating the cluster. Note that if you don't have the correct infrastructure permissions, the cluster creation might only partially succeed, such as the master provisioning but the worker nodes unable to provision. You might skip the permissions check if you want to continue an otherwise blocked operation, such as when you use multiple infrastructure accounts and can handle the infrastructure resources separately from the master, if needed later.

--entitlement ENTITLEMENT

Set this option to cloud_pak only if you use this cluster with a Cloud Pak that has an OpenShift entitlement. 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 in IBM Passport Advantage. After your cluster is created, you are not charged the Red Hat OpenShift license fee for the entitled worker nodes in the default worker pool. 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.

-q

Optional: Do not show the message of the day or update reminders.

Example cluster create classic commands

Create your first cluster: The first standard cluster that is created in a zone also creates a private VLAN. Therefore, don't include the --public-vlan option.

ibmcloud oc cluster create classic --zone dal10 --private-vlan my_private_VLAN_ID --flavor b3c.4x16 --name my_cluster --hardware shared --workers 2 --operating-system REDHAT_8_64

Create subsequent standard clusters: If you already created a standard cluster in this zone or created a public VLAN in IBM Cloud infrastructure before, specify that public VLAN with the --public-vlan option. To find out whether you already have a public VLAN for a specific zone or to find the name of an existing public VLAN, run ibmcloud oc vlan ls --zone <zone>.

ibmcloud oc cluster create classic --zone dal10 --public-vlan my_public_VLAN_ID --private-vlan my_private_VLAN_ID --flavor b3c.4x16 --name my_cluster --hardware shared --workers 2 --operating-system REDHAT_8_64

ibmcloud oc cluster create vpc-gen2

Virtual Private Cloud

Create a Virtual Private Cloud (VPC) cluster with worker nodes on Generation 2 infrastructure. When you log in to your IBM Cloud account, target the IBM Cloud region and resource group where you want to create your VPC cluster. For supported regions, see Creating a VPC in a different region. The cluster's resource group can differ from the VPC resource group.

VPC Gen 2 cluster flavors with instance storage are available for allowlisted accounts. To get added to the allowlist, open a case with support.

Your VPC cluster is created with both a public and a private cloud service endpoint. Public service endpoints can't later be disabled, and therefore, you can't convert a public cluster to a private cluster.

ibmcloud oc cluster create vpc-gen2 --name NAME --zone ZONE --vpc-id VPC_ID --subnet-id VPC_SUBNET_ID --flavor WORKER_FLAVOR [--cluster-security-group GROUP_ID] [--operating-system SYSTEM] [--version VERSION] --cos-instance COS_CRN --workers NUMBER_WORKERS_PER_ZONE [--dedicated-host-pool POOL] [--disable-outbound-traffic-protection] [--disable-public-service-endpoint] [--pod-subnet SUBNET] [--service-subnet SUBNET] [--entitlement ENTITLEMENT] [--kms-account-id ID] [--kms-instance KMS_INSTANCE_ID] [--crk ROOT_KEY_ID][--skip-advance-permissions-check] [--sm-group GROUP] [--sm-instance INSTANCE] [-q] [--secondary-storage STORAGE]
Minimum required permissions
Administrator platform access role for VPC Infrastructure.
Administrator platform access role for IBM Cloud Kubernetes Service at the account level.
Writer or Manager service access role for IBM Cloud Kubernetes Service.
Administrator platform access role for IBM Cloud Container Registry at the account level.

Command options:

--name NAME

Required: The name for the cluster. The name must start with a letter, can contain letters, numbers, periods (.), and hyphen (-), and must be 35 characters or fewer. Use a name that is unique across regions. The cluster name and the region in which the cluster is deployed form the fully qualified domain name for the Ingress subdomain. To ensure that the Ingress subdomain is unique within a region, the cluster name might be truncated and appended with a random value within the Ingress domain name.

--zone ZONE

Required: Select a zone to deploy the initial cluster worker pool in. If you create the cluster in a multizone metro, you can add a zone to the worker pool later. To list available VPC zones, run ibmcloud oc zone ls --provider vpc-gen2.

When you select a zone that is located outside your country, keep in mind that you might require legal authorization before data can be physically stored in a foreign country.

--vpc-id VPC_ID

Required: The ID of the VPC in which to create the cluster and worker nodes. To list available IDs, run ibmcloud oc vpcs.

--subnet-id VPC_SUBNET_ID

Required: The VPC subnet to assign the cluster. To list available VPC subnets, run ibmcloud oc subnets --provider vpc-gen2.

--version VERSION

The Red Hat OpenShift version for the cluster master node. To see available versions, run ibmcloud oc versions.

--flavor FLAVOR

Choose a flavor for your worker nodes. You can deploy your worker nodes as virtual machines on shared or dedicated hardware. To see flavors that are available in a zone, run ibmcloud oc flavors --zone <vpc_zone> --provider vpc-gen2.

--cluster-security-group GROUP_ID

Optional. Specify additional security group IDs to apply to all workers on the cluster. You must include a separate --cluster-security-group option for each individual security group you want to add. To apply the IBM-created kube-clusterID, use --cluster-security-group cluster. If no value is specified, only the kube-clusterID and the default VPC security group are applied. A maximum of five security groups can be applied to workers, including the default security groups. Note that the VPC security group is only applied if no other security groups are specified. For more information, see Adding VPC security groups to clusters and worker pools during create time. The security groups applied to a cluster cannot be changed once the cluster is created. You can change the rules of the security groups that are applied to the cluster, but you cannot add or remove security groups at the cluster level. If you apply the incorrect security groups at cluster create time, you must delete the cluster and create a new one. For more information, see Adding VPC security groups to clusters and worker pools during create time.

--operating-system REDHAT_8_64|RHCOS

Optional. The operating system of the worker nodes in your cluster. For a list of available operating sysems by cluster version, see the Red Hat OpenShift on IBM Cloud version information. If no option is specified, the default operating system that corresponds to the cluster version is used.

--cos-instance COS_CRN

Include the CRN ID of a standard IBM Cloud Object Storage instance to back up the internal registry of your cluster. To list the CRN of existing instances, run ibmcloud resource service-instances --long and find the ID of your object storage instance. To create a standard object storage instance, run ibmcloud resource service-instance-create <name> cloud-object-storage standard global and note its ID.

--preview PREVIEW

Optional: Specify one or more cluster level preview features, such as fips.

--dedicated-host-pool POOL

Optional: The ID of the dedicated host pool where you want to run your workers.

--workers NUMBER_WORKERS_PER_ZONE

Optional: Specify the number of worker nodes to include in the cluster. The default value is 1.

--disable-outbound-traffic-protection

Include this option to allow public outbound access from the cluster workers. By default, public outbound access is blocked in OpenShift versions 4.15 and later and Kubernetes versions 1.30 and later.

--disable-public-service-endpoint

To ensure that worker nodes and authorized cluster users communicate with the master through the private cloud service endpoint only, include this option to create the cluster without the public cloud service endpoint. If you include this option, your cluster is created with routers and Ingress controllers that expose your apps on the private network only by default. If you later want to expose apps to a public network, you must manually create public routers and Ingress controllers.

--pod-subnet SUBNET

In the first cluster that you create in a VPC, the default pod subnet is 172.17.0.0/18. In the second cluster that you create in that VPC, the default pod subnet is 172.17.64.0/18. In each subsequent cluster, the pod subnet range is the next available, non-overlapping /18 subnet. If you plan to connect your cluster to on-premises networks through IBM Cloud® Direct Link or a VPN service, you can avoid subnet conflicts by specifying a custom subnet CIDR that provides the private IP addresses for your pods.

When you choose a subnet size, consider the size of the cluster that you plan to create and the number of worker nodes that you might add in the future. The subnet must have a CIDR of at least /23, which provides enough pod IPs for a maximum of four worker nodes in a cluster. For larger clusters, use /22 to have enough pod IP addresses for eight worker nodes, /21 to have enough pod IP addresses for 16 worker nodes, and so on.

: All pods that are deployed to a worker node are assigned a private IP address in the 172.17.0.0/18 range by default. If you plan to connect your cluster to on-premises networks through IBM Cloud® Direct Link or a VPN service, you can avoid subnet conflicts by specifying a custom subnet CIDR that provides the private IP addresses for your pods.

For VPC clusters, you can specify the subnet size by including it in the --pod-subnet option. For example: --pod-subnet 0.0.0.0/X where X is the required pod subnet size. Then pod subnet is then automatically selected. When allocating the pod subnet automatically, the allocation will start from 172.17.0.0, the biggest subnet is limited to 13, and the smallest subnet size is limited to 23. For more information, see Configuring VPC subnets. The subnet that you choose must be within one of the following ranges.

  • 172.17.0.0 - 172.17.255.255

  • 172.21.0.0 - 172.31.255.255

  • 192.168.0.0 - 192.168.254.255

  • 198.18.0.0 - 198.19.255.255

Note that the pod and service subnets can't overlap. If you use custom-range subnets for your worker nodes, you must ensure that your worker node subnets don't overlap with your cluster's pod subnet.

--service-subnet SUBNET

All services that are deployed to the cluster are assigned a private IP address in the 172.21.0.0/16 range by default. If you plan to connect your cluster to on-premises networks through IBM Cloud Direct Link or a VPN service, you can avoid subnet conflicts by specifying a custom subnet CIDR that provides the private IP addresses for your services. The subnet must be specified in CIDR format with a size of at least /24, which allows a maximum of 255 services in the cluster, or larger. The subnet that you choose must be within one of the following ranges.

  • 172.17.0.0 - 172.17.255.255
  • 172.21.0.0 - 172.31.255.255
  • 192.168.0.0 - 192.168.254.255
  • 198.18.0.0 - 198.19.255.255

Note that the pod and service subnets can't overlap.

--entitlement ocp_entitled

Include this option only if you use this cluster that has a Red Hat OpenShift entitlement. 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 in IBM Passport Advantage. After your cluster is created, you are not charged the Red Hat OpenShift license fee for the entitled worker nodes in the default worker pool. 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.

--skip-advance-permissions-check

Optional: Skip the check for infrastructure permissions before creating the cluster. Note that if you don't have the correct infrastructure permissions, the cluster creation might only partially succeed, such as the master provisioning but the worker nodes unable to provision. You might skip the permissions check if you want to continue an otherwise blocked operation, such as when you use multiple infrastructure accounts and can handle the infrastructure resources separately from the master, if needed later.

--kms-account-id ID

Optional: The ID of the account that contains the KMS instance you want to use for local disk or secret encryption.

--kms-instance KMS_INSTANCE_ID

Optional: Include the ID of a key management service (KMS) instance to use to encrypt the local disk on the worker nodes in the default worker pool. To list available KMS instances, run ibmcloud oc kms instance ls. If you include this option, you must also include the --crk option. Before you can use KMS encryption, you must create a KMS instance and set up the required service authorization in IAM. See Managing encryption for the worker nodes in your cluster.

--crk ROOT_KEY

Optional: Include the ID of the root key in the KMS instance to use to encrypt the local disk on the worker nodes in the default worker pool. To list available root keys, run ibmcloud oc kms crk ls --instance-id. If you include this option, you must also include the --kms-instance option. Before you can use KMS encryption, you must create a KMS instance and set up the required service authorization in IAM. See Managing encryption for the worker nodes in your cluster.

--sm-group GROUP

The secret group ID of the Secrets Manager instance where your secrets are persisted. To get a secret group ID, see the Secrets Manager CLI reference.

--sm-instance INSTANCE

The CRN of the Secrets Manager instance. To find the CRN of an instance, run ibmcloud oc ingress instance ls --cluster CLUSTER.

--secondary-storage STORAGE

Optional: The storage option for the flavor. For example, 900gb.5iops-tier. When you add a secondary disk, that disk is used for the container runtime, while the primary disk is used for the operating system. To view the storage options for a flavor, run the **ibmcloud oc flavor get --flavor FLAVOR --zone ZONE --provider vpc-gen2 command.

-q

Optional: Do not show the message of the day or update reminders.

Example cluster create vpc-gen2 command

ibmcloud oc cluster create vpc-gen2 --name mycluster --version 4.15_openshift --zone us-south-1 --vpc-id a0123456-78b9-0c1d-23d4-567890123ef4 --subnet-id 1ab23c45-6789-0123-456d-789ef01gh234 --flavor bx2.4x16 --workers 3

ibmcloud oc cluster get

Virtual Private Cloud Classic infrastructure

View the details of a cluster.

ibmcloud oc cluster get --cluster CLUSTER [--show-resources] [--output json] [-q]
Minimum required permissions
Viewer platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--show-resources
Show more cluster resources such as add-ons, VLANs, subnets, and storage.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example cluster get command

ibmcloud oc cluster get --cluster my_cluster --show-resources

ibmcloud oc cluster image-security disable

Virtual Private Cloud Classic infrastructure

Disable image security enforcement. When you disable the feature, the underlying ClusterImagePolicy CRD is removed, which removes all the default image policies and any custom images policies that you created.

ibmcloud oc cluster image-security disable --cluster CLUSTER [-q]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
-q
Optional: Do not show the message of the day or update reminders.

Example cluster image-security disable command

ibmcloud oc cluster image-security disable --cluster my_cluster

ibmcloud oc cluster image-security enable

Virtual Private Cloud Classic infrastructure

Enable image security enforcement by installing the Portieris Kubernetes admission controller and the associated default image policies in your cluster.

ibmcloud oc cluster image-security enable --cluster CLUSTER [-f] [-q]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
-f
Optional: Force the command to run with no user prompts.
-q
Optional: Do not show the message of the day or update reminders.

Example cluster image-security enable command

ibmcloud oc cluster image-security enable --cluster my_cluster

ibmcloud oc cluster ls

Virtual Private Cloud Classic infrastructure Satellite

List all clusters in your IBM Cloud account.

Clusters in all locations are returned. To filter clusters by a specific location, include the --location option. For example, if you filter clusters for the dal metro, multizone clusters in that metro and single-zone clusters in data centers (zones) within that metro are returned. If you filter clusters for the dal10 data center (zone), multizone clusters that have a worker node in that zone and single-zone clusters in that zone are returned. You can pass one location or a comma-separated list of locations.

ibmcloud oc cluster ls [--provider (classic | vpc-gen2)] [--location LOCATION] [--output json] [-q]
Minimum required permissions
Viewer platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

--provider (classic | vpc-gen2)
Optional: Filter output based on infrastructure provider type.
-l, --location LOCATION
Filter output by a specific location. To see supported locations, run ibmcloud oc locations. To specify multiple locations, use one option for each location, such as -l dal -l seo.
--output json
Optional: Prints the command output in JSON format. Note: If you don't include the --provider option, only classic clusters are returned.
-q
Optional: Do not show the message of the day or update reminders.

Example cluster ls command

ibmcloud oc cluster ls -l ams03 -l wdc -l ap

ibmcloud oc cluster master console-oauth-access get

Get the OpenShift web console and OAuth server access type.

ibmcloud oc cluster master console-oauth-access get --cluster CLUSTER [--output OUTPUT] [-q]

Command options

--cluster CLUSTER, -c CLUSTER
Specify the cluster name or ID.
--output OUTPUT
Prints the command output in the provided format. Accepted values: json
-q
Do not show the message of the day or update reminders.

ibmcloud oc cluster master console-oauth-access set

Set the OpenShift web console and OAuth server access type.

ibmcloud oc cluster master console-oauth-access set --cluster CLUSTER [-f] [-q] [--type TYPE]

Command options

--cluster CLUSTER, -c CLUSTER
Specify the cluster name or ID.
-f
Force the command to run without user prompts.
-q
Do not show the message of the day or update reminders.
--type TYPE
Specify the OpenShift web console and OAuth server access type. Accepted values: vpe-gateway, legacy

ibmcloud oc cluster master pod-security get

Virtual Private Cloud Classic infrastructure

View the pod security admission configuration for a cluster's Kubernetes API server.

ibmcloud oc cluster master pod-security get --cluster CLUSTER [--output OUTPUT] [-q]
Minimum required permissions
Viewer platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example cluster master pod-security get command

ibmcloud oc cluster master pod-security get --cluster mycluster

ibmcloud oc cluster master pod-security policy disable

Virtual Private Cloud Classic infrastructure

Disable the pod security policy for a cluster's Kubernetes API server.

ibmcloud oc cluster master pod-security policy disable --cluster CLUSTER [-q]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
-q
Optional: Do not show the message of the day or update reminders.

Example cluster master pod-security policy disable command

ibmcloud oc cluster master pod-security policy disable --cluster mycluster

ibmcloud oc cluster master pod-security policy enable

Virtual Private Cloud Classic infrastructure

Enable the pod security policy for a cluster's Kubernetes API server. Note that pod security policies are not available in clusters that run version 1.25 or later.

ibmcloud oc cluster master pod-security policy enable --cluster CLUSTER [--output OUTPUT] [-q]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example cluster master pod-security policy enable command

ibmcloud oc cluster master pod-security policy enable --cluster mycluster

ibmcloud oc cluster master pod-security policy get

Virtual Private Cloud Classic infrastructure

View the pod security policy configuration for a cluster's Kubernetes API server. Note that pod security policies are not available in clusters that run version 1.25 or later.

ibmcloud oc cluster master pod-security policy get --cluster CLUSTER [--output OUTPUT] [-q]
Minimum required permissions
Viewer platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example cluster master pod-security policy get command

ibmcloud oc cluster master pod-security policy get --cluster mycluster

ibmcloud oc cluster master pod-security set

Virtual Private Cloud Classic infrastructure

Set and enable the pod security admission for a cluster's Kubernetes API server.

ibmcloud oc cluster master pod-security set --cluster CLUSTER [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example cluster master pod-security set command

ibmcloud oc cluster master pod-security set --cluster mycluster

ibmcloud oc cluster master pod-security unset

Virtual Private Cloud Classic infrastructure

Remove the pod security admission configuration for a cluster's Kubernetes API server.

ibmcloud oc cluster master pod-security unset --cluster CLUSTER [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example cluster master pod-security unset command

ibmcloud oc cluster master pod-security unset --cluster mycluster

ibmcloud oc cluster master private-service-endpoint allowlist

Manage a private cloud service endpoint allowlist so that authorized users can access your private cloud service endpoint from only the subnets that are specified in the allowlist.

ibmcloud oc cluster master private-service-endpoint allowlist add

Virtual Private Cloud Classic infrastructure

After you enable a private cloud service endpoint allowlist, add subnets from which authorized users can access your private cloud service endpoint to the allowlist.

For example, to access your cluster's private cloud service endpoint, you must connect to your IBM Cloud classic network or your VPC network through a VPN or IBM Cloud Direct Link. You can add the subnet for the VPN or IBM Cloud Direct Link tunnel so that authorized users in your organization can only access the private cloud service endpoint from that subnet.

Worker node subnets are automatically added to and removed from your allowlist so that worker nodes can always access the master through the private cloud service endpoint.

ibmcloud oc cluster master private-service-endpoint allowlist add --cluster CLUSTER --subnet SUBNET [--subnet SUBNET ...] [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--subnet SUBNET
Required: The subnet in CIDR format. Specify more than one subnet by using multiple repeated options.
-q
Optional: Do not show the message of the day or update reminders.
Example cluster master private-service-endpoint allowlist add command
ibmcloud oc cluster master private-service-endpoint allowlist add --cluster mycluster --subnet 1.1.1.1/16

ibmcloud oc cluster master private-service-endpoint allowlist disable

Virtual Private Cloud Classic infrastructure

Disable the subnet allowlist feature for a cluster's private cloud service endpoint.

After you disable this feature, authorized requests to your cluster master through the cluster's private cloud service endpoint can originate from any subnet.

ibmcloud oc cluster master private-service-endpoint allowlist disable --cluster CLUSTER [-f] [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
-f
Optional: Force the command to run without user prompts.
-q
Optional: Do not show the message of the day or update reminders.
Example cluster master private-service-endpoint allowlist disable command
ibmcloud oc cluster master private-service-endpoint allowlist disable --cluster mycluster

ibmcloud oc cluster master private-service-endpoint allowlist enable

Virtual Private Cloud Classic infrastructure

Enable the subnet allowlist feature for a cluster's private cloud service endpoint.

After you run this command, use the ibmcloud oc cluster master private-service-endpoint allowlist command to add subnets to the allowlist. Only authorized requests to your cluster master that originate from subnets in the allowlist are permitted through the cluster's private cloud service endpoint. If the public cloud service endpoint is enabled for your cluster, authorized requests are still permitted through the public cloud service endpoint.

ibmcloud oc cluster master private-service-endpoint allowlist enable --cluster CLUSTER [-f] [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
-f
Optional: Force the command to run without user prompts.
-q
Optional: Do not show the message of the day or update reminders.
Example cluster master private-service-endpoint allowlist enable command
ibmcloud oc cluster master private-service-endpoint allowlist enable --cluster mycluster

ibmcloud oc cluster master private-service-endpoint allowlist get

Virtual Private Cloud Classic infrastructure

List all subnets in the allowlist for a cluster's private cloud service endpoint.

This list includes subnets that you manually added by using the ibmcloud oc cluster master private-service-endpoint allowlist add command and subnets that are automatically added and managed by IBM, such as worker node subnets.

ibmcloud oc cluster master private-service-endpoint allowlist get --cluster CLUSTER [-q]
Minimum required permissions
Viewer platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
-q
Optional: Do not show the message of the day or update reminders.
Example cluster master private-service-endpoint allowlist get command
ibmcloud oc cluster master private-service-endpoint allowlist get --cluster mycluster

ibmcloud oc cluster master private-service-endpoint allowlist rm

Virtual Private Cloud Classic infrastructure

Remove subnets that you previously added to the allowlist for a cluster's private cloud service endpoint.

After a subnet is removed, any requests that originate from this subnet to the cluster master through the private cloud service endpoint are denied.

ibmcloud oc cluster master private-service-endpoint allowlist rm --cluster CLUSTER --subnet SUBNET [--subnet SUBNET ...] [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--subnet SUBNET
Required: The subnet CIDR. Specify more than one subnet by using multiple repeated options.
-f
Optional: Force the command to run without user prompts.
-q
Optional: Do not show the message of the day or update reminders.
Example cluster master private-service-endpoint allowlist rm command
ibmcloud oc cluster master private-service-endpoint allowlist rm --cluster mycluster
 --subnet 1.1.1.1/16

ibmcloud oc cluster master private-service-endpoint disable

Classic infrastructure

Disable the private cloud service endpoint to remove private accessibility to your cluster master.

Important: Before you disable the private endpoint, you first must complete the following steps to enable the public cloud service endpoint:

  1. Enable the public cloud service endpoint by running ibmcloud oc cluster master public-service-endpoint enable --cluster <cluster_name>.
  2. Follow the prompt in the CLI to refresh the Kubernetes master API server.
  3. Reload all the worker nodes in your cluster to pick up the public endpoint configuration.
ibmcloud oc cluster master private-service-endpoint disable --cluster CLUSTER [-f] [-q] [-y]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-f
Optional: Force the command to run with no user prompts.
-q
Optional: Do not show the message of the day or update reminders.
-y
Optional: Refresh the cluster master and reload worker nodes with no user prompts.

Example cluster master private-service-endpoint disable command

ibmcloud oc cluster master private-service-endpoint disable --cluster my_cluster

ibmcloud oc cluster master private-service-endpoint enable

Classic infrastructure

Enable the private cloud service endpoint to make your cluster master privately accessible.

To run this command:

  1. Enable VRF in your IBM Cloud infrastructure account. To check whether a VRF is already enabled, use the ibmcloud account show command.
  2. Enable your IBM Cloud account to use service endpoints.
  3. Run ibmcloud oc cluster master private-service-endpoint enable --cluster <cluster_name>.
  4. Follow the prompt in the CLI to refresh the Kubernetes master API server.
  5. Reload all the worker nodes in your cluster to pick up the private endpoint configuration.
ibmcloud oc cluster master private-service-endpoint enable --cluster CLUSTER [-q]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
-q
Optional: Do not show the message of the day or update reminders.
-y
Optional: Refresh the cluster master and reload worker nodes with no user prompts.

Example cluster master private-service-endpoint enable command

ibmcloud oc cluster master private-service-endpoint enable --cluster my_cluster

ibmcloud oc cluster master public-service-endpoint enable

Virtual Private Cloud Classic infrastructure

Enable the public cloud service endpoint to make your cluster master publicly accessible.

For Red Hat OpenShift on IBM Cloud clusters, public service endpoints can't be disabled. If you enable a public service endpoint in a Red Hat OpenShift cluster, you can't later convert the cluster from public to private.

After you run this command, you must refresh the API server to use the service endpoint by following the prompt in the CLI.

ibmcloud oc cluster master public-service-endpoint enable --cluster CLUSTER [-q]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
-q
Optional: Do not show the message of the day or update reminders.
-y
Optional: Refresh the cluster master with no user prompts.

Example cluster master public-service-endpoint enable command

ibmcloud oc cluster master public-service-endpoint enable --cluster my_cluster

ibmcloud oc cluster master refresh

Virtual Private Cloud Classic infrastructure

Apply configuration changes for the Kubernetes master that are requested with the ibmcloud oc cluster master commands. The highly available Kubernetes master components are restarted in a rolling restart. Your worker nodes, apps, and resources are not modified and continue to run.

The apiserver-refresh and cluster-refresh aliases for this command are deprecated.

ibmcloud oc cluster master refresh --cluster CLUSTER [-q]
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
-q
Optional: Do not show the message of the day or update reminders.

ibmcloud oc cluster master update

Virtual Private Cloud Classic infrastructure Satellite

Update the Kubernetes master and API server. During the update, you can't access or change the cluster. Worker nodes, apps, and resources that were deployed are not modified and continue to run.

You might need to change your YAML files for future deployments. Review this release note for details.

The cluster-update alias for this command is deprecated.

ibmcloud oc cluster master update --cluster CLUSTER [--version MAJOR.MINOR.PATCH] [--force-update] [-f] [-q]
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--version MAJOR.MINOR.PATCH
Optional: The Kubernetes version of the cluster. If you don't specify a version, the Kubernetes master is updated to the default API version. To see available versions, run ibmcloud oc versions.
--force-update
Optional: Attempt the update even if the change is greater than two minor versions from the worker node version.
-f
Optional: Force the command to run with no user prompts.
-q
Optional: Do not show the message of the day or update reminders.

Example cluster master update command

ibmcloud oc cluster master update --cluster my_cluster

ibmcloud oc cluster pull-secret apply

Virtual Private Cloud Classic infrastructure

Make an IBM Cloud IAM service ID for the cluster, create a policy for the service ID that assigns the Reader service access role in IBM Cloud Container Registry, and then create an API key for the service ID. The API key is then stored in a Kubernetes image pull secret so that you can pull images from your IBM Cloud Container Registry namespaces for containers that are in the default Red Hat OpenShift project. This process happens automatically when you create a cluster. If you got an error during the cluster creation process or have an existing cluster, you can use this command to apply the process again.

This API key method replaces the previous method of authorizing a cluster to access IBM Cloud Container Registry by automatically creating a token and storing the token in an image pull secret. Now, by using IAM API keys to access IBM Cloud Container Registry, you can customize IAM policies for the service ID to restrict access to your namespaces or specific images. For example, you can change the service ID policies in the cluster's image pull secret to pull images from only a certain registry region or namespace. Before you can customize IAM policies, you must enable IBM Cloud IAM policies for IBM Cloud Container Registry. For more information, see Understanding how your cluster is authorized to pull images from IBM Cloud Container Registry.

When you run this command, the creation of IAM credentials and image pull secrets is initiated and can take some time to complete. You can't deploy containers that pull an image from the IBM Cloud Container Registry icr.io domains until the image pull secrets are created. To check the image pull secrets, run oc get secrets | grep icr-io. If you added IAM policies to an existing service ID, such as to restrict access to a regional registry, the service ID, IAM policies, and API key for the image pull secret are reset by this command.

ibmcloud oc cluster pull-secret apply --cluster CLUSTER

Minimum required permissions:

  • Operator or Administrator platform access role for the cluster in IBM Cloud Kubernetes Service
  • Administrator platform access role in IBM Cloud Container Registry across all regions and resource groups. The policy can't be scoped to a particular region or resource group.

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.

ibmcloud oc cluster rm

Virtual Private Cloud Classic infrastructure

Delete a cluster. All worker nodes, apps, and containers are permanently deleted. This action can't be undone.

ibmcloud oc cluster rm --cluster CLUSTER [--force-delete-storage] [--skip-advance-permissions-check] [-f] [-q]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--force-delete-storage
Optional: Deletes the cluster and any persistent storage that the cluster uses. Attention: If you include this option, the data that is stored in the cluster or its associated storage instances can't be recovered.
--skip-advance-permissions-check
Optional: Skip the check for infrastructure permissions before deleting the cluster. Note that if you don't have the correct infrastructure permissions, the cluster deletion might only partially succeed, such as the IBM-managed master being removed but the worker nodes unable to be removed from your infrastructure account. You might skip the permissions check if you want to continue an otherwise blocked operation, such as when you use multiple infrastructure accounts and can handle the infrastructure resources separately from the master, if needed later.
-f
Optional: Force the command to run with no user prompts.
-q
Optional: Do not show the message of the day or update reminders.

Example cluster rm command

ibmcloud oc cluster rm --cluster my_cluster

ibmcloud oc cluster service bind

Virtual Private Cloud Classic infrastructure

Add an IBM Cloud service to a cluster by binding the service instance to a Red Hat OpenShift project. This command creates service credentials of an IBM Cloud service and stores these credentials in a Kubernetes secret in your cluster.

To view available IBM Cloud services from the IBM Cloud catalog, run ibmcloud service offerings. Note: You can add only IBM Cloud services that support service keys. For more information about service binding and what services you can add to your cluster, see Adding services by using IBM Cloud service binding.

ibmcloud oc cluster service bind --cluster CLUSTER --namespace KUBERNETES_NAMESPACE [--key SERVICE_INSTANCE_KEY] [--role IAM_SERVICE_ROLE] --service SERVICE_INSTANCE [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
-n, --namespace KUBERNETES_NAMESPACE
Required: The name of the Red Hat OpenShift project where you want to create the Kubernetes secret for your service credentials.
--key SERVICE_INSTANCE_KEY
Optional: The name or GUID of an existing service key. When you use the service-binding command, new service credentials are automatically created for your service instance and assigned the IAM Writer service access role for IAM-enabled services. If you want to use an existing service key that you created earlier, use this option. If you define a service key, you can't set the --role option at the same time because your service keys are already created with a specific IAM service access role.
--role IAM_SERVICE_ROLE
The IBM Cloud IAM role that you want the service key to have. This value is optional and can be used for IAM-enabled services only. If you don't set this option, your service credentials are automatically created and assigned the IAM Writer service access role. If you want to use existing service keys by specifying the --key option, don't include this option. To list available roles for the service, run ibmcloud iam roles --service <service_name>. The service name is the name of the service in the catalog, which you can get by running ibmcloud catalog search.
--service SERVICE_INSTANCE
Required: The name of the IBM Cloud service instance that you want to bind. To find the name, run ibmcloud resource service-instances.
-q
Optional: Do not show the message of the day or update reminders.

Example cluster service bind command

ibmcloud oc cluster service bind --cluster my_cluster --namespace my_namespace --service my_service_instance

ibmcloud oc cluster service ls

Virtual Private Cloud Classic infrastructure

List the services that are bound to one or all the Red Hat OpenShift project in a cluster. If no options are specified, the services for the default project are displayed.

ibmcloud oc cluster service ls --cluster CLUSTER [--namespace KUBERNETES_NAMESPACE] [--all-namespaces] [--output json] [-q]
Minimum required permissions
Viewer platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
-n, --namespace KUBERNETES_NAMESPACE
Optional: Include the services that are bound to a specific project in a cluster.
--all-namespaces
Optional: Include the services that are bound to all the projects in a cluster.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example cluster service ls command

ibmcloud oc cluster service ls --cluster my_cluster --namespace my_namespace

ibmcloud oc cluster service unbind

Virtual Private Cloud Classic infrastructure

Remove an IBM Cloud service from a cluster by unbinding it from a Red Hat OpenShift project.

When you remove an IBM Cloud service, the service credentials are removed from the cluster. If a pod is still using the service, it fails because the service credentials can't be found.

ibmcloud oc cluster service unbind --cluster CLUSTER --namespace KUBERNETES_NAMESPACE --service SERVICE_INSTANCE [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
-n, --namespace KUBERNETES_NAMESPACE
Required: The name of the Red Hat OpenShift project.
--service SERVICE_INSTANCE
Required: The name of the IBM Cloud service instance that you want to remove. To find the name of the service instance, run ibmcloud oc cluster service ls --cluster <cluster_name_or_ID>.
-q
Optional: Do not show the message of the day or update reminders.

Example cluster service unbind command

ibmcloud oc cluster service unbind --cluster my_cluster --namespace my_namespace --service 8567221

ibmcloud oc cluster subnet add

Classic infrastructure

Make an existing portable public or private classic subnet in your IBM Cloud infrastructure account available to a cluster or reuse subnets from a deleted cluster instead of using the automatically provisioned subnets.

When you make a subnet available to a cluster, IP addresses of this subnet are used for cluster networking purposes. To avoid IP address conflicts, make sure that you use a subnet with one cluster only. Do not use a subnet for multiple clusters or for other purposes outside of IBM Cloud Kubernetes Service at the same time. If you use the same subnet across multiple clusters, your default Ingress TLS certificate might become invalidated. To enable communication between workers that are on different subnets on the same VLAN in non-VRF accounts, you must enable routing between subnets on the same VLAN.

ibmcloud oc cluster subnet add --cluster CLUSTER --subnet-id SUBNET [-q]
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--subnet-id SUBNET
Required: The ID of the subnet.
-q
Optional: Do not show the message of the day or update reminders.

Example cluster subnet add command

ibmcloud oc cluster subnet add --cluster my_cluster --subnet-id 1643389

ibmcloud oc cluster subnet create

Classic infrastructure

Create a portable classic subnet in an IBM Cloud infrastructure account on your public or private VLAN and make it available to a cluster.

Portable public IP addresses are charged monthly. If you remove portable public IP addresses after your cluster is provisioned, you still must pay the monthly charge, even if you used them only for a short amount of time. When you make a subnet available to a cluster, IP addresses of this subnet are used for cluster networking purposes. To avoid IP address conflicts, make sure that you use a subnet with one cluster only. Do not use a subnet for multiple clusters or for other purposes outside of IBM Cloud Kubernetes Service at the same time. If you use the same subnet across multiple clusters, your default Ingress TLS certificate might become invalidated. In classic clusters, if you have multiple VLANs for your cluster, multiple subnets on the same VLAN, or a multizone classic cluster, you must enable a Virtual Router Function (VRF) for your IBM Cloud infrastructure account so your worker nodes can communicate with each other on the private network. To enable VRF, see Enabling VRF. To check whether a VRF is already enabled, use the ibmcloud account show command. If you can't or don't want to enable VRF, enable VLAN spanning. To perform this action, you need the Network > Manage Network VLAN Spanning infrastructure permission, or you can request the account owner to enable it. To check whether VLAN spanning is already enabled, use the ibmcloud oc vlan spanning get --region <region> command.

ibmcloud oc cluster subnet create --cluster CLUSTER --size SIZE --vlan VLAN_ID [-q]
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster. To list your clusters, use the ibmcloud oc cluster ls command.
--size SIZE
The number of IP addresses that you want to create in the portable subnet. Accepted values are 8, 16, 32, or 64. When you add portable IP addresses for your subnet, three IP addresses are used to establish cluster-internal networking. You can't use these three IP addresses for your Ingress application load balancers (ALBs) or to create network load balancer (NLB) services. For example, if you request eight portable public IP addresses, you can use five of them to expose your apps to the public.
--vlan VLAN_ID
The ID of the public or private VLAN on which you want to create the subnet. You must select a public or private VLAN that an existing worker node is connected to. To review the public or private VLANs that your worker nodes are connected to, run ibmcloud oc cluster get --cluster <cluster> --show-resources and look for the Subnet VLANs section in the output. The subnet is provisioned in the same zone that the VLAN is in.
-q
Optional: Do not show the message of the day or update reminders.

Example cluster subnet create command

ibmcloud oc cluster subnet create --cluster my_cluster --size 8 --vlan 1764905

ibmcloud oc cluster subnet detach

Classic infrastructure

Detach a public or private portable classic subnet in an IBM Cloud infrastructure account from a cluster. The subnet remains available in your IBM Cloud infrastructure account. Note: Any services that were deployed to an IP address from the subnet remain active after the subnet is removed.

ibmcloud oc cluster subnet detach --cluster CLUSTER --subnet-id SUBNET_ID [-f] [-q]
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster. To list your clusters, use the ibmcloud oc cluster ls command.
--vlan VLAN_ID
The ID of the public or private subnet that you want to detach. To find the subnet ID, first run ibmcloud oc cluster get --cluster <cluster> --show-resources and look for the subnet CIDR in the Subnet VLANs section of the output. Then, using the subnet CIDR, run ibmcloud oc subnets --provider classic and look for the subnet's ID.
-f
Optional: Force the command to run with no user prompts.
-q
Optional: Do not show the message of the day or update reminders.

Example cluster subnet detach command

ibmcloud oc cluster subnet detach --cluster my_cluster --subnet-id 1602829

Deprecated: ibmcloud oc cluster user-subnet add

Classic infrastructure

Bring your own private subnet to your IBM Cloud Kubernetes Service clusters. This private subnet is not one provided by IBM Cloud infrastructure. As such, you must configure any inbound and outbound network traffic routing for the subnet.

This command is deprecated. Add an existing IBM Cloud infrastructure subnet to your cluster by running ibmcloud oc cluster subnet add.

When you make a subnet available to a cluster, IP addresses of this subnet are used for cluster networking purposes. To avoid IP address conflicts, make sure that you use a subnet with one cluster only. Do not use a subnet for multiple clusters or for other purposes outside of IBM Cloud Kubernetes Service at the same time. If you use the same subnet across multiple clusters, your default Ingress TLS certificate might become invalidated. In classic clusters, if you have multiple VLANs for your cluster, multiple subnets on the same VLAN, or a multizone classic cluster, you must enable a Virtual Router Function (VRF) for your IBM Cloud infrastructure account so your worker nodes can communicate with each other on the private network. To enable VRF, see Enabling VRF. To check whether a VRF is already enabled, use the ibmcloud account show command. If you can't or don't want to enable VRF, enable VLAN spanning. To perform this action, you need the Network > Manage Network VLAN Spanning infrastructure permission, or you can request the account owner to enable it. To check whether VLAN spanning is already enabled, use the ibmcloud oc vlan spanning get --region <region> command.

ibmcloud oc cluster user-subnet add --cluster CLUSTER --subnet-cidr SUBNET_CIDR --private-vlan PRIVATE_VLAN
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--subnet-cidr SUBNET_CIDR
The subnet Classless InterDomain Routing (CIDR). This value is required, and must not conflict with any subnet that is used by IBM Cloud infrastructure. Supported prefixes range from /30 (1 IP address) to /24 (253 IP addresses). If you set the CIDR at one prefix length and later need to change it, first add the new CIDR, then remove the old CIDR.
--private-vlan PRIVATE_VLAN
Required: The ID of the private VLAN. The ID must be for a private VLAN in the cluster that one or more of the worker nodes are on. To see private VLANs in your cluster, run ibmcloud oc cluster get --cluster <cluster_name_or_ID> --show-resources. In the Subnet VLANs section of the output, look for VLANs that have a Public value of false.

Example cluster user-subnet add command

ibmcloud oc cluster user-subnet add --cluster my_cluster --subnet-cidr 169.xx.xxx.xxx/29 --private-vlan 1502175

Deprecated: ibmcloud oc cluster user-subnet rm

Classic infrastructure

Remove your own private subnet from a specified cluster. Any service that was deployed with an IP address from your own private subnet remains active after the subnet is removed.

This command is deprecated. To remove an IBM Cloud infrastructure subnet from your cluster instead, run ibmcloud oc cluster subnet detach.

ibmcloud oc cluster user-subnet rm --cluster CLUSTER --subnet-cidr SUBNET_CIDR --private-vlan PRIVATE_VLAN
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--subnet-cidr SUBNET_CIDR
The subnet Classless InterDomain Routing (CIDR). This value is required, and must match the CIDR that was set by the ibmcloud oc cluster user-subnet add command.
--private-vlan PRIVATE_VLAN
The ID of the private VLAN. This value is required, and must match the VLAN ID that was set by the ibmcloud oc cluster user-subnet add command.

Example cluster user-subnet rm command

ibmcloud oc cluster user-subnet rm --cluster my_cluster --subnet-cidr 169.xx.xxx.xxx/29 --private-vlan 1502175

Beta: dedicated commands

View, create, and remove a dedicated host or dedicated host pool.

The dedicated commands are available in beta.

Beta: ibmcloud oc dedicated flavors

Virtual Private Cloud

View dedicated host flavors.

ibmcloud oc dedicated flavors --zone ZONE --provider PROVIDER
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service.

Command options:

--zone ZONE
The zone to search for dedicated host flavors.
--provider PROVIDER
The provider to use to search for dedicated host flavors.
--output json
Optional: Prints the command output in JSON format.

Example:

ibmcloud oc dedicated flavors --zone us-south-1 --provider myprovider1

Beta: ibmcloud oc dedicated host create

Virtual Private Cloud

Create a dedicated host.

ibmcloud oc dedicated host create --flavor FLAVOR --pool POOL --zone ZONE [--output OUTPUT] [-q]
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service.

Command options:

-- flavor FLAVOR
The flavor of the dedicated host.
-- pool POOL
The name of the dedicated host pool where the dedicated host is added.
--zone ZONE
The zone to create the dedicated host in.
--output json
Optional: Prints the command output in JSON format.

Example:

ibmcloud oc dedicated host create --flavor b3c.4x16 --pool mypool --zone wdc

Beta: ibmcloud oc dedicated host get

Virtual Private Cloud

Get the details of a dedicated host.

ibmcloud oc dedicated host get --host HOST --pool POOL [--output OUTPUT] [-q]
Minimum required permissions
Viewer platform access role for the cluster in IBM Cloud Kubernetes Service.

Command options:

--host HOST
The ID of the dedicated host.
--pool POOL
The ID of the dedicated host pool that the dedicated host is located in. To list dedicated host pools run ibmcloud oc dedicated pool ls.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example:

ibmcloud oc dedicated host get --host myhost  --pool mypool

Beta: ibmcloud oc dedicated host ls

Virtual Private Cloud

List all dedicated hosts in a dedicated host pool.

ibmcloud oc dedicated host ls --pool POOL [--output OUTPUT] [-q]
Minimum required permissions
Viewer platform access role for the cluster in IBM Cloud Kubernetes Service.

Command options:

--pool POOL
The ID of the dedicated host pool. To list dedicated host pools run ibmcloud oc dedicated pool ls.
-q
Optional: Do not show the message of the day or update reminders.

Example:

ibmcloud oc dedicated host ls --pool mypool

Beta: ibmcloud oc dedicated host placement disable

Virtual Private Cloud

Disable dedicated host placement.

ibmcloud oc dedicated host placement disable --host HOST --pool POOL
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service.

Command options:

--host HOST
The ID of the dedicated host to disable placement for.
--pool POOL
The ID of the dedicated host pool that the dedicated host is located in. To list dedicated host pools run ibmcloud oc dedicated pool ls.
--q
Optional: Do not show the message of the day or update reminders.

Example:

ibmcloud oc dedicated host placement disable --host myhost --pool mypool

Beta: ibmcloud oc dedicated host placement enable

Virtual Private Cloud

Enable dedicated host placement.

ibmcloud oc dedicated host placement enable --host HOST --pool POOL
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service.

Command options:

--host HOST
The ID of the dedicated host to enable placement for.
--pool POOL
The ID of the dedicated host pool that the dedicated host is located in. To list dedicated host pools run ibmcloud oc dedicated pool ls.
--q
Optional: Do not show the message of the day or update reminders.

Example:

ibmcloud oc dedicated host placement enable --host myhost --pool mypool

Beta: ibmcloud oc dedicated host rm

Virtual Private Cloud

Delete a dedicated host. This action can't be undone.

ibmcloud oc dedicated host rm --host HOST --pool POOL [-q]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service.

Command options:

--pool POOL
The ID of the dedicated host pool that contains the dedicated host to delete. To list dedicated host pools run ibmcloud oc dedicated pool ls.
--output json
Optional: Prints the command output in JSON format.
--q
Optional: Do not show the message of the day or update reminders.

Example:

ibmcloud oc dedicated host rm --host myhost --pool mypool

Beta: ibmcloud oc dedicated pool create

Virtual Private Cloud

Create a dedicated host pool.

ibmcloud oc dedicated pool create --flavor-class CLASS --metro METRO --name NAME [--output OUTPUT]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service.

Command options:

--flavor-class CLASS
The flavor-class of the dedicated host pool. To see available options, run ibmcloud ks flavors.
--metro METRO
The metro to create the dedicated host pool in, such as dal or wdc.
--name NAME
The name of the dedicated host pool.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example:

ibmcloud oc dedicated pool --flavor-class mb4c.20x64 --metro dal --name mypool

Beta: ibmcloud oc dedicated pool get

Virtual Private Cloud

Get the details of a dedicated host pool.

ibmcloud oc dedicated pool get --pool POOL [--output OUTPUT] [-q]
Minimum required permissions
Viewer platform access role for the cluster in IBM Cloud Kubernetes Service.

Command options:

--pool POOL
The ID of the dedicated host pool. To list dedicated host pools run ibmcloud oc dedicated pool ls.

--output OUTPUT

-q
Optional: Do not show the message of the day or update reminders.

Example:

ibmcloud oc dedicated pool get --pool mypool

Beta: ibmcloud oc dedicated pool ls

Virtual Private Cloud

List all dedicated host pools.

ibmcloud oc dedicated pool ls [--output OUTPUT] [-q]
Minimum required permissions
Viewer platform access role for the cluster in IBM Cloud Kubernetes Service.

Command options:

--output json
Optional: Prints the command output in JSON format.
--q
Optional: Do not show the message of the day or update reminders.

Example:

ibmcloud oc dedicated pool ls

Beta: ibmcloud oc dedicated pool rm

Virtual Private Cloud

Delete a dedicated host pool. This action can't be undone.

ibmcloud oc dedicated pool rm --pool POOL [-q]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service.

Command options:

--pool POOL
The ID of the dedicated host pool to delete. To list dedicated host pools run ibmcloud oc dedicated pool ls.
--q
Optional: Do not show the message of the day or update reminders.

Example:

ibmcloud oc dedicated pool rm --pool mypool

worker commands

View and modify worker nodes for a cluster.

Deprecated: ibmcloud oc worker add

Virtual Private Cloud Classic infrastructure

Add stand-alone worker nodes to a cluster.

This command is deprecated. Create a worker pool by running ibmcloud oc worker-pool create classic or ibmcloud oc worker-pool create vpc-gen2, or add workers to an existing worker pool by running ibmcloud oc worker-pool resize.

ibmcloud oc worker add --cluster CLUSTER [--hardware HARDWARE] --flavor FLAVOR --workers NUMBER --private-vlan PRIVATE_VLAN --public-vlan PUBLIC_VLAN [--disable-disk-encrypt] [--operating-system SYSTEM] [-q]
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--hardware HARDWARE
Optional: The level of hardware isolation for your worker node. Use dedicated so that available physical resources are dedicated to you only, or shared to allow physical resources to be shared with other IBM customers. The default is shared. For bare metal flavors, specify dedicated.
--flavor FLAVOR
Choose a machine type, or flavor, for your worker nodes. You can deploy your worker nodes as virtual machines on shared or dedicated hardware, or as physical machines on bare metal. Available physical and virtual machines types vary by the zone in which you deploy the cluster. For more information, see the documentation for the ibmcloud oc flavors (machine-types) command.
--workers NUMBER
An integer that represents the number of worker nodes to create in the cluster.
--private-vlan PRIVATE_VLAN
Required: The private VLAN that was specified when the cluster was created. Private VLAN routers always begin with bcr (back-end router) and public VLAN routers always begin with fcr (front-end router). When you create a cluster and specify the public and private VLANs, the number and letter combination after those prefixes must match.
--public-vlan PUBLIC_VLAN
Optional: The public VLAN that was specified when the cluster was created. If you want your worker nodes to exist on a private VLAN only, don't provide a public VLAN ID. Private VLAN routers always begin with bcr (back-end router) and public VLAN routers always begin with fcr (front-end router). When you create a cluster and specify the public and private VLANs, the number and letter combination after those prefixes must match. If worker nodes are set up with a private VLAN only, you must allow worker nodes and the cluster master to communicate by enabling the private cloud service endpoint or configuring a gateway appliance.
--disable-disk-encrypt
Worker nodes feature AES 256-bit disk encryption by default; learn more. To disable encryption, include this option.
--operating-system REDHAT_8_64|RHCOS
Optional. The operating system of the worker nodes in your cluster. For a list of available operating sysems by cluster version, see the Red Hat OpenShift on IBM Cloud version information. If no option is specified, the default operating system that corresponds to the cluster version is used.
-q
Optional: Do not show the message of the day or update reminders.

Example worker add command

ibmcloud oc worker add --cluster my_cluster --workers 3 --public-vlan my_public_VLAN_ID --private-vlan my_private_VLAN_ID --flavor b3c.4x16 --hardware shared

ibmcloud oc worker get

Virtual Private Cloud Classic infrastructure

View the details of a worker node.

ibmcloud oc worker get --cluster CLUSTER_NAME_OR_ID --worker WORKER_NODE_ID [--output json] [-q]
Minimum required permissions
Viewer platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER_NAME_OR_ID
Optional: The name or ID of the worker node's cluster.
--worker WORKER_NODE_ID
Required: The name of your worker node. Run ibmcloud oc worker ls --cluster CLUSTER to view the IDs for the worker nodes in a cluster.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example worker get command

ibmcloud oc worker get --cluster my_cluster --worker kube-dal10-cr18a61a63a6a94b658596aa93d087aaa9-w1

ibmcloud oc worker ls

Virtual Private Cloud Classic infrastructure

List all worker nodes in a cluster.

ibmcloud oc worker ls --cluster CLUSTER [--worker-pool POOL] [--show-pools] [--show-deleted] [--output json] [-q]
Minimum required permissions
Viewer platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster for the available worker nodes.
-p, --worker-pool POOL
Optional: View only worker nodes that belong to the worker pool. To list available worker pools, run ibmcloud oc worker-pool ls --cluster <cluster_name_or_ID>.
--show-pools
Optional: List the worker pool that each worker node belongs to.
--show-deleted
Optional: View worker nodes that were deleted from the cluster, including the reason for deletion.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example worker ls command

ibmcloud oc worker ls --cluster my_cluster

ibmcloud oc worker reboot

Virtual Private Cloud Classic infrastructure

Reboot a worker node in a cluster.

During the reboot, the state of your worker node does not change. For example, you might use a reboot if the worker node status in classic IBM Cloud infrastructure is Powered Off and you need to turn on the worker node. A reboot clears temporary directories, but does not clear the entire file system or reformat the disks. The worker node IP address remains the same after the reboot operation.

Rebooting a worker node can cause data corruption on the worker node. Use this command with caution and when you know that a reboot can help recover your worker node. In all other cases, reload your worker node instead.

Before you reboot your worker node, make sure that you have enough capacity in other worker nodes to reschedule the pods on the worker node. Rescheduling pods helps to avoid downtime for your app or data corruption on your worker node.

  1. List all worker nodes in your cluster and note the name of the worker node that you want to remove.

    oc get nodes
    

    The name that is returned in this command is the private IP address that is assigned to your worker node. You can find more information about your worker node when you run the ibmcloud oc worker ls --cluster <cluster_name_or_ID> command and look for the worker node with the same Private IP address.

  2. Force pods to be removed from your worker node and rescheduled onto remaining worker nodes in the cluster. The worker node is also cordoned, or marked as unavailable for future pod scheduling. Replace <worker_name> with the private IP address of the worker node that you previously retrieved.

    oc adm drain <worker_name>
    

    This process can take a few minutes.

  3. Reboot the worker node. Use the worker ID that is returned from the ibmcloud oc worker ls --cluster <cluster_name_or_ID> command.

    ibmcloud oc worker reboot --cluster <cluster_name_or_ID> --worker <worker_name_or_ID>
    
  4. Wait about 5 minutes before you make your worker node available for pod scheduling to ensure that the reboot is finished. During the reboot, the state of your worker node does not change. The reboot of a worker node is usually completed in a few seconds.

  5. Make your worker node available for pod scheduling. Use the name for your worker node that is returned from the oc get nodes command.

    oc adm uncordon <worker_name>
    
ibmcloud oc worker reboot [--hard] --cluster CLUSTER --worker WORKER_ID [--skip-master-healthcheck] [-f] [-q]
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--hard
Optional: Use this option to force a hard restart of a worker node by cutting off power to the worker node. Use this option if the worker node is unresponsive or the worker node's container runtime is unresponsive.
-w, --worker WORKER
Specify a worker node ID. To reload multiple worker nodes, use multiple options, such as -w worker1_id -w worker2_id.
--skip-master-healthcheck
Skip a health check of your master before reloading or rebooting your worker nodes.
-f
Optional: Force the command to run with no user prompts.
-q
Optional: Do not show the message of the day or update reminders.

Example worker reboot command

ibmcloud oc worker reboot --cluster my_cluster -w kube-dal10-cr18a61a63a6a94b658596aa93d087aaa9-w1 -w kube-dal10-cr18a61a63a6a94b658596aa93d087aaa9-w2

ibmcloud oc worker reload

Classic infrastructure

Reload the configurations for a Classic worker node. To reload a worker node in a VPC cluster, use the ibmcloud oc worker replace command instead.

A reload can be useful if your worker node experiences problems, such as slow performance or if your worker node is stuck in an unhealthy state. During the reload, your worker node machine is updated with the latest image and data is deleted if not stored outside the worker node. The worker node public and private IP address remain the same after the reload operation.

Reloading a worker node applies patch version updates to your worker node, but not major or minor updates. To see the changes from one patch version to the next, review the Version change log documentation.

Before you reload your worker node, make sure that you have enough capacity in other worker nodes to reschedule the pods on the worker node. Rescheduling pods helps to avoid downtime for your app or data corruption on your worker node.

  1. List all worker nodes in your cluster and note the name of the worker node that you want to reload.

    oc get nodes
    

    The name that is returned in this command is the private IP address that is assigned to your worker node. You can find more information about your worker node when you run the ibmcloud oc worker ls --cluster <cluster_name_or_ID> command and look for the worker node with the same Private IP address.

  2. Reload the worker node. As part of the reload process, the pods that run on the worker node are drained and rescheduled onto remaining worker nodes in the cluster. The worker node is also cordoned, or marked as unavailable for future pod scheduling. Use the worker node ID that is returned from the ibmcloud oc worker ls --cluster <cluster_name_or_ID> command.

    ibmcloud oc worker reload --cluster <cluster_name_or_ID> --worker <worker_name_or_ID>
    
  3. Wait for the reload to complete. When your worker node is in a Normal state, the worker node becomes available for pod scheduling again.

ibmcloud oc worker reload --cluster CLUSTER --worker WORKER_ID [--skip-master-healthcheck] [-f] [-q]
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
-w, --worker WORKER
Specify a worker node ID. To reload multiple worker nodes, use multiple options, such as -w worker1_id -w worker2_id.
--skip-master-healthcheck
Skip a health check of your master before reloading or rebooting your worker nodes.
-f
Optional: Force the command to run with no user prompts.
-q
Optional: Do not show the message of the day or update reminders.

Example worker reload command

ibmcloud oc worker reload --cluster my_cluster -w kube-dal10-cr18a61a63a6a94b658596aa93d087aaa9-w1 -w kube-dal10-cr18a61a63a6a94b658596aa93d087aaa9-w2

ibmcloud oc worker replace

Virtual Private Cloud Classic infrastructure

Delete a worker node and replace it with a new worker node in the same worker pool.

The replacement worker node is created in the same zone and has the same flavor as the old worker node, but might be assigned new public or private IP addresses. You might replace a worker node if you can't reload or update the worker node, such as if it enters a troubled state.

You can also use this command to update the Kubernetes version of the worker node to match the major and minor version of the Kubernetes master by including the --update option. If you don't include the --update option, patch version updates are applied to your worker node, but not major or minor updates. To see the changes from one major, minor, or patch version to the next, review the Version change log documentation. Remember that your worker nodes can be only up to two versions behind the master version (n-2).

When you replace a worker node, keep in mind the following considerations.

To update Satellite worker nodes, see Updating hosts that are assigned as worker nodes to Satellite-enabled services.

  • Multiple worker nodes are replaced concurrently: If you replace multiple worker nodes at the same time, they are deleted and replaced concurrently, not one by one. Make sure that you have enough capacity in your cluster to reschedule your workloads before you replace worker nodes.
  • Node-level customizations are not preserved: Any custom labels or taints that you applied at the individual worker node level are not applied to the replacement worker node. Instead, apply labels or taints at the worker pool level so that the replacement worker node gets these attributes.
  • Automatic rebalancing: A replacement worker node is not created if the worker pool does not have automatic rebalancing enabled.

Before you begin, make sure that your cluster has enough other worker nodes so that your pods can be rescheduled and continue to run.

  1. List all worker nodes in your cluster and note the name of the worker node that you want to replace.

    oc get nodes
    

    The name that is returned in this command is the private IP address that is assigned to your worker node. You can find more information about your worker node when you run the ibmcloud oc worker ls --cluster <cluster_name_or_ID> command and look for the worker node with the same Private IP address.

  2. Replace the worker node. As part of the replace process, the pods that run on the worker node are drained and rescheduled onto remaining worker nodes in the cluster. The worker node is also cordoned, or marked as unavailable for future pod scheduling. Use the worker node ID that is returned from the ibmcloud oc worker ls --cluster <cluster_name_or_ID> command.

    ibmcloud oc worker replace --cluster <cluster_name_or_ID> --worker <worker_node_ID>
    
  3. Verify that the worker node is replaced.

    ibmcloud oc worker ls --cluster <cluster_name_or_ID>
    
ibmcloud oc worker replace --cluster CLUSTER_NAME_OR_ID --worker WORKER_ID [--update] [-f] [-q]
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service.

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--worker WORKER
Required: The name or ID of a worker node.
--update
Include this option to update the worker node to the same major and minor version of the master and the latest patch.
-f
Optional: Force the command to run with no user prompts.
-q
Optional: Do not show the message of the day or update reminders.

Example worker replace command

ibmcloud oc worker replace --cluster my_cluster --worker kube-dal10-cr18a61a63a6a94b658596aa93d087aaa9-w1

ibmcloud oc worker rm

Virtual Private Cloud Classic infrastructure

Remove one or more worker nodes from a cluster. If you remove a worker node, your cluster becomes unbalanced, and replacing a worker node no longer creates a replacement worker node. You can automatically rebalance your worker pool by running the ibmcloud oc worker-pool rebalance command after you remove a worker node.

ibmcloud oc worker rm --cluster CLUSTER --worker WORKER [-f] [-q]
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
-w, --worker WORKER
Specify a worker node ID. To reload multiple worker nodes, use multiple options, such as -w worker1_id -w worker2_id.
-f
Optional: Force the command to run with no user prompts.
-q
Optional: Do not show the message of the day or update reminders.

Example worker rm command

ibmcloud oc worker rm --cluster my_cluster -w kube-dal10-cr18a61a63a6a94b658596aa93d087aaa9-w1 -w kube-dal10-cr18a61a63a6a94b658596aa93d087aaa9-w2

ibmcloud oc worker update

Classic infrastructure

Update worker nodes to apply the latest security updates and patches to the operating system, and to update the Kubernetes version to match the version of the Kubernetes master. You can update the master Kubernetes version with the ibmcloud oc cluster master update command. Remember that your worker nodes can be only up to two versions behind the master version (n-2). The worker node IP address remains the same after the update operation.

To update a worker node in a VPC cluster, use the ibmcloud oc worker replace command instead.

Running ibmcloud oc worker update can cause downtime for your apps and services. During the update, all pods are rescheduled onto other worker nodes, the worker node is reimaged, and data is deleted if not stored outside the pod. To avoid downtime, ensure that you have enough worker nodes to handle your workload while the selected worker nodes are updating.

To update Satellite worker nodes, see Updating hosts that are assigned as worker nodes to Satellite-enabled services.

You might need to change your YAML files for deployments before you update. Review this release note for details.

ibmcloud oc worker update --cluster CLUSTER --worker WORKER_ID [-f] [-q]
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster where you list available worker nodes.
-w, --worker WORKER
Specify a worker node ID. To reload multiple worker nodes, use multiple options, such as -w worker1_id -w worker2_id.
-f
Optional: Force the command to run with no user prompts.
-q
Optional: Do not show the message of the day or update reminders.

Example worker update command

ibmcloud oc worker update --cluster my_cluster -w kube-dal10-cr18a61a63a6a94b658596aa93d087aaa9-w1 -w kube-dal10-cr18a61a63a6a94b658596aa93d087aaa9-w2

worker-pool commands

View and modify worker pools for a cluster.

ibmcloud oc worker-pool create classic

Classic infrastructure

You can create a worker pool in your cluster. When you add a worker pool, it is not assigned a zone by default. You specify the number of workers that you want in each zone and the flavors for the workers. The worker pool is given the default Kubernetes versions. To finish creating the workers, add a zone or zones to your pool.

To create a worker pool in a VPC cluster, use the ibmcloud oc worker-pool create vpc-gen2 command.

ibmcloud oc worker-pool create classic --name POOL_NAME --cluster CLUSTER --flavor FLAVOR --size-per-zone WORKERS_PER_ZONE --hardware ISOLATION [--disable-disk-encrypt] [--label KEY1=VALUE1] [--operating-system SYSTEM] [--entitlement ENTITLEMENT] [-q] [--output json]
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

--name POOL_NAME
The name that you want to give your worker pool.
-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--flavor FLAVOR
Choose a machine type, or flavor. You can deploy your worker nodes as virtual machines on shared or dedicated hardware, or as physical machines on bare metal. Available physical and virtual machines types vary by the zone in which you deploy the cluster. For more information, see the documentation for the ibmcloud oc flavors (machine-types) command.
--size-per-zone WORKERS_PER_ZONE
The number of workers to create in each zone.
--hardware ISOLATION
Required: The level of hardware isolation for your worker node. Use dedicated if you want to have available physical resources that are dedicated to you only, or shared to allow physical resources to be shared with other IBM customers. The default is shared. For bare metal flavors, specify dedicated.
--disable-disk-encrypt
Specifies that the disk is not encrypted. The default value is false.
-l, --label KEY1=VALUE1
Optional: Apply key-value labels to each worker node in the worker pool. To specify multiple labels, use multiple options, such as -l key1=value1 -l key2=value2.
--operating-system REDHAT_8_64|RHCOS
Optional. The operating system of the worker nodes in your cluster. For a list of available operating sysems by cluster version, see the Red Hat OpenShift on IBM Cloud version information. If no option is specified, the default operating system that corresponds to the cluster version is used.
--entitlement ocp_entitled
Include this option only for a cluster that has a Red Hat OpenShift entitlement. 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 in IBM Passport Advantage. 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.

-q
Optional: Do not show the message of the day or update reminders.
--output json
Optional: Prints the command output in JSON format.

Example worker-pool create classic command

ibmcloud oc worker-pool create classic --name my_pool --cluster my_cluster --flavor b3c.4x16 --size-per-zone 6

ibmcloud oc worker-pool create vpc-gen2

Virtual Private Cloud

Add a worker pool to a VPC cluster. No worker nodes are created until you add zones to the worker pool.

ibmcloud oc worker-pool create vpc-gen2 --name <worker_pool_name> --cluster <cluster_name_or_ID> --flavor <flavor> --size-per-zone <number_of_workers_per_zone> [--operating-system SYSTEM][--dedicated-host-pool POOL][--vpc-id <VPC ID>] [--label KEY1=VALUE1] [--entitlement ENTITLEMENT] [--kms-account-id ID] [--kms-instance KMS_INSTANCE_ID] [--crk ROOT_KEY_ID] [--operating-system SYSTEM] [-q] [--secondary-storage STORAGE] [--security-group GROUP ...] [--output json]
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service.

Command options:

--name NAME
Required: Set the name for the worker pool.
-c, --cluster CLUSTER
Required: Specify the name or ID of the cluster. To list VPC clusters, run ibmcloud oc cluster ls --provider vpc-gen2.
--size-per-zone NUMBER_WORKERS_PER_ZONE
Specify the number of worker nodes to create per zone in this worker pool. No worker nodes are created until you add zones to the worker pool.
--operating-system REDHAT_8_64|RHCOS
Optional. The operating system of the worker nodes in your cluster. For a list of available operating sysems by cluster version, see the Red Hat OpenShift on IBM Cloud version information. If no option is specified, the default operating system that corresponds to the cluster version is used.
--flavor FLAVOR
Choose a flavor for your worker nodes. You can deploy your worker nodes as virtual machines on shared or dedicated hardware. To see flavors that are available in a VPC zone, run ibmcloud oc flavors --zone <vpc_zone> --provider vpc-gen2.
--dedicated-host-pool POOL
Optional. The ID of the dedicated host pool where you want to run your workers.
--vpc-id VPC_ID
Optional: Specify the ID of the VPC in which to create the worker pool's worker nodes. The value must match the VPC ID that the cluster is in. To list the cluster's VPC ID, run ibmcloud oc cluster get -c <cluster_name_or_ID>. If this option is not provided, then the worker pool defaults to the VPC ID of existing worker pools in the cluster.
-l, --label KEY1=VALUE1
Optional: Apply key-value labels to each worker node in the worker pool. To specify multiple labels, use multiple options, such as -l key1=value1 -l key2=value2.
--entitlement ocp_entitled
Include this option only for a cluster that has a Red Hat OpenShift entitlement. 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 in IBM Passport Advantage. 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.
--kms-account-id ID
Optional: The ID of the account that contains the KMS instance you want to use for local disk or secret encryption.
--kms-instance KMS_INSTANCE_ID
Optional: Include the ID of a key management service (KMS) instance to use to encrypt the local disk on the worker nodes in the default worker pool. To list available KMS instances, run ibmcloud oc kms instance ls. If you include this option, you must also include the --crk option. For more information including steps to create, see Managing encryption for the worker nodes in your cluster.
--crk ROOT_KEY
Optional: Include the ID of the root key in the KMS instance to use to encrypt the local disk on the worker nodes in this worker pool. To list available root keys, run ibmcloud oc kms crk ls --instance-id. If you include this option, you must also include the --kms-instance option. Before you can use KMS encryption, you must create a KMS instance and set up the required service authorization in IAM. See Managing encryption for the worker nodes in your cluster.
-q
Optional: Do not show the message of the day or update reminders.
--secondary-storage STORAGE
Optional: The storage option for the flavor. For example, 900gb.5iops-tier. When you add a secondary disk, that disk is used for the container runtime, while the primary disk is used for the operating system. To view the storage options for a flavor, run the **ibmcloud oc flavor get --flavor FLAVOR --zone ZONE --provider vpc-gen2 command.
--security-group GROUP
Optional. Specify one or more security group IDs to apply to all workers on the cluster. For OpenShift version 4.15 and Kubernetes version 1.30 and later, these security groups are applied in addition to the IBM-managed kube-clusterID security group. For earlier cluster versions, specify the --cluster-security-group cluster option to apply the kube-clusterID security group. If no value is specified, a default set of security groups including kube-clusterID are applied.
--output json
Optional: Prints the command output in JSON format.

Example worker-pool create vpc-gen2 command

ibmcloud oc worker-pool create vpc-gen2 --name my_pool --cluster my_cluster --flavor bx2.4x16 --size-per-zone 3

ibmcloud oc worker-pool get

Virtual Private Cloud Classic infrastructure

View the details of a worker pool.

ibmcloud oc worker-pool get --worker-pool WORKER_POOL --cluster CLUSTER [--output json] [-q]
Minimum required permissions
Viewer platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-p, --worker-pool WORKER_POOL
Required: The name of the worker node pool that you want to view the details of. To list available worker pools, run ibmcloud oc worker-pool ls --cluster <cluster_name_or_ID>.
-c, --cluster CLUSTER
Required: The name or ID of the cluster where the worker pool is located.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example worker-pool get command

ibmcloud oc worker-pool get --worker-pool pool1 --cluster my_cluster

ibmcloud oc worker-pool label rm

Virtual Private Cloud Classic infrastructure

Remove all custom Kubernetes labels from all worker nodes in a worker pool.

An individual taint cannot be removed from a working pool. Instead use kubectl taint node <worker_privateIP> key:effect- command to remove a taint from an individual worker node.

ibmcloud oc worker-pool label rm --cluster CLUSTER --worker-pool POOL [-f] [-q]
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster where the worker pool is located.
-p, --worker-pool WORKER_POOL
Required: The name of the worker node pool that you want to view the details of. To list available worker pools, run ibmcloud oc worker-pool ls --cluster <cluster_name_or_ID>.
-f
Optional: Force the command to run with no user prompts.
-q
Optional: Do not show the message of the day or update reminders.

Example worker-pool label rm command

ibmcloud oc worker-pool label rm --worker-pool pool1 --cluster my_cluster

ibmcloud oc worker-pool label set

Virtual Private Cloud Classic infrastructure

Set custom Kubernetes labels in the format key=value for all the worker nodes in the worker pool. To keep any existing custom labels on the worker pool, you must include those labels in this command.

ibmcloud oc worker-pool label set --cluster CLUSTER --label LABEL [--label LABEL ...] --worker-pool POOL [-f] [-q]
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster where the worker pool is located.
--label LABEL
Required: A custom label in the format key=value to set for all the worker nodes in the worker pool. For multiple labels, repeat this option. To keep any existing custom labels on the worker pool, include those labels with this option. You can list the existing custom labels on worker nodes in the worker pool by running ibmcloud oc worker-pool get -c <cluster_name_or_ID> --worker-pool <pool>.
-p, --worker-pool WORKER_POOL
Required: The name of the worker node pool that you want to view the details of. To list available worker pools, run ibmcloud oc worker-pool ls --cluster <cluster_name_or_ID>.
-f
Optional: Force the command to run with no user prompts.
-q
Optional: Do not show the message of the day or update reminders.

Example worker-pool label set command

ibmcloud oc worker-pool label set --worker-pool pool1 --cluster my_cluster --label app=dev

ibmcloud oc worker-pool ls

Virtual Private Cloud Classic infrastructure

List all worker pools in a cluster.

ibmcloud oc worker-pool ls --cluster CLUSTER [--output json] [-q]
Minimum required permissions
Viewer platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER_NAME_OR_ID
Required: The name or ID of the cluster for which you want to list worker pools.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example worker-pool ls command

ibmcloud oc worker-pool ls --cluster my_cluster

ibmcloud oc worker-pool rebalance

Virtual Private Cloud Classic infrastructure

Rebalance a worker pool in a cluster after you delete a worker node. When you run this command, a new worker or workers are added to your worker pool so that the worker pool has the same number of nodes per zone that you specified.

ibmcloud oc worker-pool rebalance --cluster CLUSTER --worker-pool WORKER_POOL [-q]
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
-p, --worker-pool WORKER_POOL
Required: The worker pool that you want to rebalance.
-q
Optional: Do not show the message of the day or update reminders.

Example worker-pool rebalance command

ibmcloud oc worker-pool rebalance --cluster my_cluster --worker-pool my_pool

ibmcloud oc worker-pool resize

Virtual Private Cloud Classic infrastructure

Resize your worker pool to increase or decrease the number of worker nodes that are in each zone of your cluster.

ibmcloud oc worker-pool resize --cluster CLUSTER --worker-pool WORKER_POOL --size-per-zone WORKERS_PER_ZONE [-q]
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster for which you want to resize worker pools.
--worker-pool WORKER_POOL
Required: The name of the worker node pool that you want to update.
--size-per-zone WORKERS_PER_ZONE
The number of workers that you want to have in each zone.
-q
Optional: Do not show the message of the day or update reminders.

Example worker-pool resize command

ibmcloud oc worker-pool resize --cluster my_cluster --worker-pool my_pool --size-per-zone 3

ibmcloud oc worker-pool rm

Virtual Private Cloud Classic infrastructure

Remove a worker pool from your cluster. All worker nodes in the pool are deleted. Your pods are rescheduled when you delete. To avoid downtime, be sure that you have enough workers to run your workload.

ibmcloud oc worker-pool rm --worker-pool WORKER_POOL --cluster CLUSTER [-q] [-f]
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-p, --worker-pool WORKER_POOL
Required: The name of the worker node pool that you want to remove.
-c, --cluster CLUSTER
Required: The name or ID of the cluster that you want to remove the worker pool from.
-q
Optional: Do not show the message of the day or update reminders.
-f
Optional: Force the command to run with no user prompts.

Example worker-pool rm command

ibmcloud oc worker-pool rm --cluster my_cluster --worker-pool pool1

ibmcloud oc worker-pool taint

Set or remove Kubernetes taints for all the worker nodes in a worker pool. After you set up taints, pods without a matching toleration can't run on the worker pool. You might use taints to dedicate your worker pool exclusively for a certain type of workload, such as for networking edge nodes or the cluster autoscaler. For more information about how taints and tolerations work, see the Kubernetes documentation.

ibmcloud oc worker-pool taint set

Virtual Private Cloud Classic infrastructure

Set Kubernetes taints for all the worker nodes in a worker pool. Taints prevent pods without matching tolerations from running on the worker nodes. After you set your custom taint for the worker pool, confirm that the taints are set on the worker nodes by getting the private IP address of the worker node (ibmcloud oc worker ls -c <cluster_name_or_ID>) and running oc describe node <worker_private_IP>.

When you set taints for the worker pool, any custom taints that you previously set with this command are overwritten. To keep your existing custom taints and set new taints, check the worker pool's existing taints and include them when you rerun this command.

ibmcloud oc worker-pool taint set --worker-pool WORKER_POOL --cluster CLUSTER --taint KEY=VALUE:EFFECT [--taint KEY=VALUE2:EFFECT] [-f]
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-p, --worker-pool WORKER_POOL
Required: The name of the worker node pool that you want to add the taint to. To list available worker pools, run ibmcloud oc worker-pool ls -c <cluster_name_or_ID>.
-c, --cluster CLUSTER
Required: The name or ID of the cluster with the worker pool that you want to taint.
--taint KEY=VALUE:EFFECT
Required: The label and effect for the Kubernetes taint that you want to set for the worker pool. Specify the taint in the format key=value:effect. The key=value is a label pair such as env=prod that you use to manage the worker node taint and matching pod tolerations. The effect is a Kubernetes taint effect such as NoSchedule, PreferNoSchedule, or NoExecute that describes how the taint works. Depending on the effect of the taint that you set, pods that are running on your worker nodes might be evicted.
-f
Optional: Force the command to run with no user prompts.

Example worker-pool taint set command

ibmcloud oc worker-pool taint set --cluster my_cluster --worker-pool pool1 --taint env=prod:NoSchedule

ibmcloud oc worker-pool taint rm

Virtual Private Cloud Classic infrastructure

Remove all Kubernetes taints for all the worker nodes in a worker pool. To check the taints before you remove them, run ibmcloud oc worker-pool get -c <cluster_name_or_ID> --worker-pool <worker_pool_name_or_ID>.

When you remove taints for the worker pool, all Kubernetes taints are removed from the worker pool and its worker nodes. To remove an individual taint from all worker nodes, rerun the ibmcloud oc worker-pool taint set command and include only the taints that you want to keep. Or, use oc taint node <worker_privateIP> key:effect- command to remove a taint from an individual worker node.

ibmcloud oc worker-pool taint rm --worker-pool WORKER_POOL --cluster CLUSTER [-f]
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-p, --worker-pool WORKER_POOL
Required: The name of the worker node pool that you want to add the taint to. To list available worker pools, run ibmcloud oc worker-pool ls -c <cluster_name_or_ID>.
-c, --cluster CLUSTER
Required: The name or ID of the cluster with the worker pool that you want to taint.
-f
Optional: Force the command to run with no user prompts.

Example worker-pool taint rm command

ibmcloud oc worker-pool taint rm --cluster my_cluster --worker-pool pool1

ibmcloud oc worker-pool zones

Virtual Private Cloud Classic infrastructure

View the zones that are attached to a worker pool.

ibmcloud oc worker-pool zones --worker-pool WORKER_POOL --cluster CLUSTER [-q] [-f]
Minimum required permissions
Viewer platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster where the worker pool exists.
-p, --worker-pool WORKER_POOL
Required: The name of the worker node pool that you want to see zones for.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example worker-pool zones command

ibmcloud oc worker-pool zones --cluster my_cluster --worker-pool pool1

zone commands

ibmcloud oc zone add classic

Classic infrastructure

After you create a classic cluster or worker pool, you can add a zone. When you add a zone, worker nodes are added to the new zone to match the number of workers per zone that you specified for the worker pool. You can add more than one zone only if your cluster is in a multizone metro.

To add a zone to worker pools in a VPC cluster, use the ibmcloud oc zone add vpc-gen2 command.

ibmcloud oc zone add classic --zone ZONE --cluster CLUSTER [--worker-pool WORKER_POOL] [--private-vlan PRIVATE_VLAN] [--public-vlan PUBLIC_VLAN] [--output json] [-q]
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

--zone ZONE
Required: The zone that you want to add. The zone must be a multizone-capable zone within the cluster's region.
-c, --cluster CLUSTER
Required: The name or ID of the cluster.
-p, --worker-pool WORKER_POOL
The name of the worker pool to add the zone to. To specify multiple worker pools, use multiple options, such as -p pool1 -p pool2.
--private-vlan PRIVATE_VLAN
The ID of the private VLAN. This value is conditional. If you have a private VLAN in the zone, this value must match the private VLAN ID of one or more of the worker nodes in the cluster. To see the VLANs that you have available, run ibmcloud oc cluster get --cluster <cluster> --show-resources. New worker nodes are added to the VLAN that you specify, but the VLANs for any existing worker nodes are not changed. If you don't have a private or public VLAN in that zone, don't specify this option. A private and a public VLAN are automatically created for you when you initially add a zone to your worker pool. In classic clusters, if you have multiple VLANs for your cluster, multiple subnets on the same VLAN, or a multizone classic cluster, you must enable a Virtual Router Function (VRF) for your IBM Cloud infrastructure account so your worker nodes can communicate with each other on the private network. To enable VRF, see Enabling VRF. To check whether a VRF is already enabled, use the ibmcloud account show command. If you can't or don't want to enable VRF, enable VLAN spanning. To perform this action, you need the Network > Manage Network VLAN Spanning infrastructure permission, or you can request the account owner to enable it. To check whether VLAN spanning is already enabled, use the ibmcloud oc vlan spanning get --region <region> command.
--public-vlan PUBLIC_VLAN
The ID of the public VLAN. This value is required if you want to expose workloads on the nodes to the public after you create the cluster. It must match the public VLAN ID of one or more of the worker nodes in the cluster for the zone. To see the VLANs that you have available, run ibmcloud oc cluster get --cluster <cluster> --show-resources. New worker nodes are added to the VLAN that you specify, but the VLANs for any existing worker nodes are not changed. If you don't have a private or public VLAN in that zone, don't specify this option. A private and a public VLAN are automatically created for you when you initially add a zone to your worker pool. In classic clusters, if you have multiple VLANs for your cluster, multiple subnets on the same VLAN, or a multizone classic cluster, you must enable a Virtual Router Function (VRF) for your IBM Cloud infrastructure account so your worker nodes can communicate with each other on the private network. To enable VRF, see Enabling VRF. To check whether a VRF is already enabled, use the ibmcloud account show command. If you can't or don't want to enable VRF, enable VLAN spanning. To perform this action, you need the Network > Manage Network VLAN Spanning infrastructure permission, or you can request the account owner to enable it. To check whether VLAN spanning is already enabled, use the ibmcloud oc vlan spanning get --region <region> command.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example zone add classic command

ibmcloud oc zone add classic --zone dal10 --cluster my_cluster -p pool1 -w pool2 --private-vlan 2294021

ibmcloud oc zone add vpc-gen2

Virtual Private Cloud

After you create a Generation 2 VPC cluster or worker pool, you can add a zone. When you add a zone, worker nodes are added to the new zone to match the number of workers per zone that you specified for the worker pool. You can add more than one zone only if your cluster is in a multizone metro.

ibmcloud oc zone add vpc-gen2 --zone ZONE --subnet-id VPC_SUBNET_ID --cluster CLUSTER --worker-pool WORKER_POOL [--output json] [-q]
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

--zone ZONE
Required: The zone that you want to add. It must be a VPC zone within the cluster's region. To see available VPC zones, run ibmcloud oc zone ls --provider vpc-gen2.
--subnet-id SUBNET_ID
Required: The ID of the subnet that you want to add. The VPC subnet must be within the zone that you specify. To see available VPC subnets, run ibmcloud oc subnets --provider vpc-gen2 --vpc-id <vpc> --zone <vpc_zone>. VPC subnets provide IP addresses for your worker nodes and load balancer services in the cluster, so use a VPC subnet with enough IP addresses, such as 256.
-c, --cluster CLUSTER
Required: The name or ID of the cluster. To list VPC clusters, run ibmcloud oc cluster ls --provider vpc-gen2.
-p, --worker-pool WORKER_POOL
The name of the worker pool to add the zone to. To specify multiple worker pools, use multiple options, such as -p pool1 -p pool2.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example zone add vpc-gen2 command

ibmcloud oc zone add vpc-gen2 --zone us-south-3 --cluster my_cluster -p pool1 -w pool2

ibmcloud oc zone ls

Virtual Private Cloud Classic infrastructure Satellite

View a list of available zones that you can create a cluster in.

The locations alias for this command is deprecated.

ibmcloud oc zone ls --provider (classic | satellite | vpc-gen2) [--location LOCATION] [--region-only] [--output json] [-q]

Minimum permissions: None

Command options:

--provider (classic | satellite | vpc-gen2)
The infrastructure provider type to list zones for. This option is required.
-l, --location LOCATION
Filter output by a specific location. To see supported locations, run ibmcloud oc locations. To specify multiple locations, use one option for each location, such as -l dal -l seo.
--region-only
Optional: List multizones only within the region that you are logged in to.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example:

ibmcloud oc zone ls -l ap

ibmcloud oc zone network-set

Classic infrastructure

Multizone classic clusters only: Set the network metadata for a worker pool to use a different public or private VLAN for the zone than it previously used. Worker nodes that were already created in the pool continue to use the previous public or private VLAN, but new worker nodes in the pool use the new network data.

ibmcloud oc zone network-set --zone ZONE --cluster CLUSTER  --private-vlan PRIVATE_VLAN [--worker-pool WORKER_POOL] [--public-vlan PUBLIC_VLAN] [-f] [-q]
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

--zone ZONE
Required: The zone that you want to add. The zone must be a multizone-capable zone within the cluster's region.
-c, --cluster CLUSTER
Required: The name or ID of the cluster.
-p, --worker-pool WORKER_POOL
The name of the worker pool to add the zone to. To specify multiple worker pools, use multiple options, such as -p pool1 -p pool2.
--private-vlan PRIVATE_VLAN
The ID of the private VLAN. This value is required, whether you want to use the same or a different private VLAN than the one that you used for your other worker nodes. New worker nodes are added to the VLAN that you specify, but the VLANs for any existing worker nodes are not changed. The private and public VLANs must be compatible, which you can determine from the Router ID prefix.
--public-vlan PUBLIC_VLAN
The ID of the public VLAN. This value is required only if you want to change the public VLAN for the zone. To change the public VLAN, you must always provide a compatible private VLAN. New worker nodes are added to the VLAN that you specify, but the VLANs for any existing worker nodes are not changed. The private and public VLANs must be compatible, which you can determine from the Router ID prefix.
-f
Optional: Force the command to run with no user prompts.
-q
Optional: Do not show the message of the day or update reminders.

Usage:

  1. Check the VLANs that are available in your cluster.

    ibmcloud oc cluster get --cluster <cluster_name_or_ID> --show-resources
    

    Example output

    Subnet VLANs
    VLAN ID   Subnet CIDR         Public   User-managed
    229xxxx   169.xx.xxx.xxx/29   true     false
    229xxxx   10.xxx.xx.x/29      false    false
    
  2. Check that the public and private VLAN IDs that you want to use are compatible. To be compatible, the Router must have the same pod ID. Private VLAN routers always begin with bcr (back-end router) and public VLAN routers always begin with fcr (front-end router). When you create a cluster and specify the public and private VLANs, the number and letter combination after those prefixes must match.

    ibmcloud oc vlan ls --zone <zone>
    

    In the example output, note that Router pod IDs match: 01a and 01a. If one pod ID was 01a and the other was 02a, you can't set these public and private VLAN IDs for your worker pool.

    ID        Name   Number   Type      Router         Supports Virtual Workers
    229xxxx          1234     private   bcr01a.dal12   true
    229xxxx          5678     public    fcr01a.dal12   true
    
  3. If you don't have any VLANs available, you can order new VLANs.

Example zone network-set command

ibmcloud oc zone network-set --zone dal10 -c my_cluster -p pool1 -p pool2 --private-vlan 2294021

ibmcloud oc zone rm

Virtual Private Cloud Classic infrastructure

Multizone clusters only: Remove a zone from one or more worker pools in your cluster. All worker nodes in the worker pool for this zone are deleted.

Before you remove a zone, make sure that you have enough worker nodes in other zones in the cluster so that your pods can reschedule. Rescheduling your pods can avoid a downtime for your app or data corruption on your worker node.

ibmcloud oc zone rm --cluster CLUSTER --zone ZONE [--worker-pool WORKER_POOL] [-f] [-q]
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--zone ZONE
Required: The zone that you want to remove.
-p, --worker-pool WORKER_POOL
The name of the worker pool to remove the zone from. To specify multiple worker pools, use multiple options, such as -p pool1 -p pool2. To remove the zone from all worker pools in the cluster, don't include this option.
-f
Optional: Force the command to run with no user prompts.
-q
Optional: Do not show the message of the day or update reminders.

Example zone rm command

ibmcloud oc zone rm --zone dal10 --cluster my_cluster

ingress commands

View and configure Ingress application load balancers (ALBs).

In CLI version 1.0.157 and later, the ibmcloud oc alb category is deprecated, and these commands are now listed in the ibmcloud oc ingress alb subcategory. For more information, see the CLI change log.

ibmcloud oc ingress alb autoscale get

Virtual Private Cloud Classic infrastructure

Get the details and status of an Ingress ALB autoscaling configuration.

ibmcloud oc ingress alb autoscale get --alb ALB --cluster CLUSTER [--output OUTPUT] [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

--alb ALB
Required: The name or ID of the ALB to configure autoscaling on.
-c, --cluster CLUSTER
Required: The name or ID of the cluster.
-q
Optional: Do not show the message of the day or update reminders.
--output json
Optional: Prints the command output in JSON format.

Example ingress alb autoscale get command

ibmcloud oc ingress alb autoscale get --alb myalb123 --cluster mycluster 

ibmcloud oc ingress alb autoscale set

Virtual Private Cloud Classic infrastructure

Configure autoscaling to automatically increase or decrease the number of Ingress ALB pods based on the current load. You can choose to scale pods based on CPU utilization, or you can use custom metrics that you specify. If you base autoscaling configuration on CPU utilization, you specify an average CPU utilization rate as well as a maximum and minimum number of pods to be deployed at any given time. If you choose to specify custom metrics for autoscaling, you pass in a path to a custom metric file.

ibmcloud oc ingress alb autoscale set --alb ALB --cluster CLUSTER --max-replicas REPLICAS --min-replicas REPLICAS [--output OUTPUT] [-q] (--cpu-average-utilization PERCENT | --custom-metrics-file FILE)
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

--alb ALB
Required: The name or ID of the ALB to configure autoscaling on.
-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--max-replicas REPLICAS
The maximum number of replicas to deployed at any time. This value is required if you include the ---cpu-average-utilization option.
--min-replicas REPLICAS
The minimum number of replicas to deploy at any time. This value is required if you include the ---cpu-average-utilization option.
--cpu-average-utilization PERCENTAGE
The average utilization threshold used to dynamically calculate the number of replicas.
--custom-metrics-file
The path to the custom metrics file.
-q
Optional: Do not show the message of the day or update reminders.
--output json
Optional: Prints the command output in JSON format.

Example ingress alb autoscale set command

ibmcloud oc ingress alb autoscale set --alb myalb123 --cluster mycluster --max-replicas 5 --min-replicas 2 --cpu-average-utilization 5

ibmcloud oc ingress alb autoscale unset

Virtual Private Cloud Classic infrastructure

Remove autoscaling from your Ingress ALBs by deleting the autoscaling configuration.

ibmcloud oc ingress alb autoscale unset --alb ALB --cluster CLUSTER [--output OUTPUT] [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

--alb ALB
Required: The name or ID of the ALB to configure autoscaling on.
-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example ingress alb autoscale unset command

ibmcloud oc ingress alb autoscale unset --alb myalb123 --cluster mycluster 

ibmcloud oc ingress alb autoupdate disable

Virtual Private Cloud Classic infrastructure

Disable automatic updates of all Ingress ALB pods in a cluster.

By default, automatic updates to Ingress application load balancers (ALBs) are enabled. ALB pods are automatically updated when a new image version is available. To instead update the add-on manually, use this command to disable automatic updates. You can then update ALB pods by running the ibmcloud oc ingress alb update command.

When you update the major or minor Kubernetes version of your cluster, IBM automatically makes necessary changes to the Ingress deployment, but does not change the image version of your Ingress ALB add-on. You are responsible for checking the compatibility of the latest Kubernetes versions and your Ingress ALB add-on images.

ibmcloud oc ingress alb autoupdate disable --cluster CLUSTER [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
-q
Optional: Do not show the message of the day or update reminders.

Example ingress alb autoupdate disable command

ibmcloud oc ingress alb autoupdate disable --cluster mycluster

ibmcloud oc ingress alb autoupdate enable

Virtual Private Cloud Classic infrastructure

Enable automatic updates of all Ingress ALB pods in a cluster.

If automatic updates for the Ingress ALB add-on are disabled, you can re-enable automatic updates. Whenever the next image version becomes available, the ALBs are automatically updated to the latest build.

ibmcloud oc ingress alb autoupdate enable --cluster CLUSTER [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
-q
Optional: Do not show the message of the day or update reminders.

ibmcloud oc ingress alb autoupdate get

Virtual Private Cloud Classic infrastructure

Check whether automatic updates for the Ingress ALB add-on are enabled and whether your ALBs are updated to the latest image version.

ibmcloud oc ingress alb autoupdate get --cluster CLUSTER [--output json] [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

ibmcloud oc ingress alb create classic

Classic infrastructure

Create a public or private ALB in a classic cluster. The ALB that you create is enabled by default.

ibmcloud oc ingress alb create classic --cluster CLUSTER --type (PUBLIC|PRIVATE) --vlan VLAN_ID --zone ZONE [--ip IP] [--version IMAGE_VERSION] [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
The name or ID of the cluster.
--type (PUBLIC|PRIVATE)
The type of ALB: public or private. This type must match the vlan.
--vlan VLAN_ID
The ID of the VLAN to create the ALB on. This VLAN must match the ALB type and must be in the same zone as the ALB that you want to create.
--zone ZONE
The zone to create the ALB in.
--ip IP
Optional: An IP address to assign to the ALB. This IP must be on the vlan that you specified and must be in the same zone as the ALB that you want to create. This IP address must not be in use by another load balancer or ALB in the cluster. To see the IP addresses that are currently in use, run oc get svc --all-namespaces.
--version IMAGE_VERSION
Optional: The version of the image that you want the ALB to run. To list available versions, run ibmcloud oc ingress alb versions. To specify a version other than the default, you must first disable automatic updates by running the ibmcloud oc ingress alb autoupdate disable command. If you omit this option, the ALB runs the default version of the Kubernetes Ingress image type.
-q
Optional: Do not show the message of the day or update reminders.

Example ingress alb create classic command

ibmcloud oc ingress alb create classic --cluster mycluster --type public --vlan 2234945 --zone dal10 --ip 1.1.1.1 --version 1.1.2_2507_iks

ibmcloud oc ingress alb disable

Virtual Private Cloud Classic infrastructure

Disable an ALB in your cluster. The ALB and its pods still exist, but stop routing traffic to your apps.

The previous alias for this command, ibmcloud oc ingress alb configure, is deprecated.

ibmcloud oc ingress alb disable --alb ALB_ID --cluster CLUSTER [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

--alb ALB_ID
Required: The ID for an ALB. To view the IDs for the ALBs in a cluster, run ibmcloud oc ingress alb ls --cluster CLUSTER.
-c, --cluster CLUSTER
The name or ID of the cluster.
-q
Optional: Do not show the message of the day or update reminders.

Example ingress alb disable command

ibmcloud oc ingress alb disable --alb public-cr18a61a63a6a94b658596aa93a087aaa9-alb1 --cluster mycluster

ibmcloud oc ingress alb enable classic

Classic infrastructure

Enable an ALB in your classic cluster.

The previous alias for this command, ibmcloud oc ingress alb configure classic, is deprecated.

You can use this command to:

  • Enable a default private ALB. When you create a cluster, a default private ALB is created for you in each zone where you have workers and an available private subnet, but the default private ALBs are not enabled. However, all default public ALBs are automatically enabled, and any public or private ALBs that you create with the ibmcloud oc ingress alb create classic command are enabled by default too.
  • Enable an ALB that you previously disabled.
ibmcloud oc ingress alb enable classic --alb ALB_ID --cluster CLUSTER [--ip IP_ADDRESS] [--version IMAGE_VERSION] [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

--alb ALB_ID
Required: The ID for an ALB. To view the IDs for the ALBs in a cluster, run ibmcloud oc ingress alb ls --cluster CLUSTER.
-c, --cluster CLUSTER
The name or ID of the cluster.
--ip IP_ADDRESS
Optional: Specify an IP address that is on a VLAN in the zone that the ALB was created in. The ALB is enabled with and uses this public or private IP address. This IP address must not be in use by another load balancer or ALB in the cluster. If no IP address is provided, the ALB is deployed with a public or private IP address from the portable public or private subnet that was provisioned automatically when you created the cluster, or if you re-enable an ALB that was previously enabled, the public or private IP address that was previously assigned to the ALB.
--version IMAGE_VERSION
Optional: The version of the image that you want the ALB to run. To list available versions, run ibmcloud oc ingress alb versions. To specify a version other than the default, you must first disable automatic updates by running the ibmcloud oc ingress alb autoupdate disable command. If you omit this option, the ALB runs the default version of the same image that the ALB previously ran: either the Kubernetes Ingress image or the Red Hat OpenShift on IBM Cloud Ingress image.
-q
Optional: Do not show the message of the day or update reminders.

Example ingress alb enable classic command

ibmcloud oc ingress alb enable classic --alb private-cr18a61a63a6a94b658596aa93a087aaa9-alb1 --cluster mycluster --ip 169.XX.XXX.XX --version 1.1.2_2507_iks

ibmcloud oc ingress alb get

Virtual Private Cloud Classic infrastructure

View the details of an Ingress ALB in a cluster.

ibmcloud oc ingress alb get --alb ALB_ID --cluster CLUSTER [--output json] [-q]
Minimum required permissions
Viewer platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

--alb ALB_ID
Required: The ID for an ALB. To view the IDs for the ALBs in a cluster, run ibmcloud oc ingress alb ls --cluster CLUSTER.
-c, --cluster CLUSTER
The name or ID of the cluster.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example ingress alb get command

ibmcloud oc ingress alb get --alb public-cr18a61a63a6a94b658596aa93a087aaa9-alb1 --cluster mycluster

ibmcloud oc ingress alb health-checker disable

Virtual Private Cloud Classic infrastructure

Disable the health checker for an Ingress ALB in a cluster.

ibmcloud oc ingress alb health-checker disable --cluster CLUSTER [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
The name or ID of the cluster.
-q
Optional: Do not show the message of the day or update reminders.

Example ingress alb health-checker disable command

ibmcloud oc ingress alb health-checker disable --cluster mycluster

ibmcloud oc ingress alb health-checker enable

Virtual Private Cloud Classic infrastructure

Enable the health checker for an Ingress ALB in a cluster.

ibmcloud oc ingress alb health-checker enable --cluster CLUSTER [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
The name or ID of the cluster.
-q
Optional: Do not show the message of the day or update reminders.

Example ingress alb health-checker enable command

ibmcloud oc ingress alb health-checker enable --cluster mycluster

ibmcloud oc ingress alb health-checker get

Virtual Private Cloud Classic infrastructure

View the details of the health checker for an Ingress ALB in a cluster.

ibmcloud oc ingress alb health-checker get --cluster CLUSTER [--output OUTPUT] [-q]
Minimum required permissions
Viewer platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
The name or ID of the cluster.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example ingress alb health-checker get command

ibmcloud oc ingress alb health-checker get --cluster mycluster

ibmcloud oc ingress alb ls

Virtual Private Cloud Classic infrastructure

List all Ingress ALB IDs in a cluster and view whether an update for the ALB pods is available.

If no ALB IDs are returned, then the cluster does not have a portable subnet. You can create or add subnets to a cluster. Afterward, ALBs are automatically created for you.

ibmcloud oc ingress alb ls --cluster CLUSTER [--output json] [-q]
Minimum required permissions
Viewer platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

*-c, --cluster *CLUSTER
Required: The name or ID of the cluster where you list available ALBs.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example ingress alb ls command

ibmcloud oc ingress alb ls --cluster my_cluster

ibmcloud oc ingress alb update

Virtual Private Cloud Classic infrastructure

Force an update of the pods for individual or all Ingress ALBs in the cluster to the latest or a specific version.

If automatic updates for the Ingress ALB add-on are disabled and you want to update the add-on, you can force a one-time update of your ALB pods. If your ALB pods were recently updated, but a custom configuration for your ALBs is affected by the latest build, you can also use this command to roll back ALB pods to an earlier, supported version. Note that you can use this command to update your ALB image to a different version, but you can't use this command to change your ALB from one type of image to another. After you force a one-time update, automatic updates remain disabled, but can be re-enabled with the ibmcloud oc ingress alb autoupdate enable command.

ibmcloud oc ingress alb update --cluster CLUSTER [--alb ALB1_ID --alb ALB2_ID ...] [--version IMAGE_VERSION] [--output json] [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster where you want to update the ALBs.
--alb CLUSTER
Optional: The ID of the individual ALB to update. To list ALB IDs, run ibmcloud oc ingress alb ls -c <cluster>. To update multiple ALBs, use multiple options, such as --alb ALB1_ID --alb ALB2_ID. If you omit this option, all ALBs in the cluster are updated.
--version IMAGE_VERSION
Optional: The version of the image that you want to update ALBs to.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.
  • To update all ALB pods in the cluster:
    ibmcloud oc ingress alb update -c mycluster --version 1.1.2_2507_iks
    
  • To update the ALB pods for one or more specific ALBs:
    ibmcloud oc ingress alb update -c mycluster --version 1.1.2_2507_iks --alb public-crdf253b6025d64944ab99ed63bb4567b6-alb1
    

ibmcloud oc ingress alb versions

Virtual Private Cloud Classic infrastructure

View the available Ingress ALB versions.

ibmcloud oc ingress alb versions [--output json] [-q]
Minimum required permissions
Viewer platform access role for IBM Cloud Kubernetes Service

Command options:

--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

ibmcloud oc ingress domain create

Create an Ingress domain for a cluster.

ibmcloud oc ingress domain create --cluster CLUSTER [--crn CRN] [--default] [--domain DOMAIN] [--hostname HOSTNAME] [--ip IP] [--output OUTPUT] [--domain-provider PROVIDER] [-q] [--secret-namespace NAMESPACE] [--domain-zone ZONE]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster where you want to create the domain.
--crn CRN
Required for IBM Cloud Internet Services domains. The CRN for the IBM Cloud Internet Services instance.
--is-default
Optional. Include this option to set the relevant domain as the default domain for the cluster.
--domain DOMAIN
The Ingress domain. You can specify an existing domain, or create a new one. For provider specific information on specifying domains, see Creating your own Ingress domain.
--hostname HOSTNAME
Optional. For VPC clusters. The hostname to register for the domain.
--ip IP
Optional. The IP addresses to register for the domain.
--output OUTPUT
Optional: Prints the command output in JSON format.
--domain-provider PROVIDER
Optional. The external DNS provider type. Available options are akamai-ext, cloudflare-ext, or cis-ext. If no provider is specified, a domain is created with the IBM-managed internal provider.
--secret-namespace NAMESPACE
Optional. The namespace that the TLS secret is created in. If no namespace is specified, the secret is created in the default namespace.
--domain-zone ZONE
Optional. The Domain ID for your IBM Cloud Internet Services instance. This is a GUID value.

Example ingress domain create command

This example command creates a domain registered with the IBM Cloud internal provider. For examples to create domains with different providers, see Creating your own Ingress domain.

ibmcloud oc ingress domain create --cluster my-cluster --domain exampledomain

ibmcloud oc ingress domain credential get

View the details of the external domain provider credentials that have been added to your cluster.

ibmcloud oc ingress domain credential get --cluster CLUSTER [--output OUTPUT] [-q]
Minimum required permissions
Viewer platform access role for IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster where the credential is applied.
--output OUPUT
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example ingress domain credential command

ibmcloud oc ingress domain credential get --cluster mycluster 

ibmcloud oc ingress domain credential rm

Remove external domain provider credentials from the cluster.

ibmcloud oc ingress domain credential rm --cluster CLUSTER [-q]
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster where the credential is applied.
-q
Optional: Do not show the message of the day or update reminders.

Example ingress domain credential rm command

ibmcloud oc ingress domain credential rm --cluster mycluster

ibmcloud oc ingress domain credential set akamai

Add external Akamai domain credentials to your cluster.

ibmcloud oc ingress domain credential set akamai --cluster CLUSTER [--access-token TOKEN] [--client-secret SECRET] [--client-token TOKEN] [--host HOST] [-q] [--domain-zone ZONE]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster where you want to add the credentials.
--access-token TOKEN
The access token for the Akamai API Client credentials. This token is provided by Akamai.
--client-secret SECRET
The client secret for the Akamai API Client credentials. This secret is provided by Akamai.
--client-token TOKEN
The client token for the Akamai API Client credentials. This token is provided by Akamai.
--host HOST
The host for the Akamai API Client credentials.
-q
Optional: Do not show the message of the day or update reminders.
--domain-zone ZONE
The DNS zone that exists in your external account and is specified in the Akamai credentials. Specify the full zone name, such as example.external.adppdomain.cloud.

Example ingress domain credential set akamai command

ibmcloud oc ingress domain credential set akamai --cluster mycluster [--access-token TOKEN] [--client-secret SECRET] [--client-token TOKEN] [--host HOST] [-q] [--domain-zone ZONE]

ibmcloud oc ingress domain credential set cloudflare

Add external Cloudflare domain credentials to your cluster.

ibmcloud oc ingress domain credential set cloudflare --cluster CLUSTER [-q] [--token TOKEN] [--domain-zone ZONE]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster where you want to add the credentials.
-q
Optional: Do not show the message of the day or update reminders.
--token TOKEN
The access token for Cloudflare credentials. This token is provided by Cloudflare.
--domain-zone ZONE
The DNS zone that exists in your external account and is specified in your Cloudflare credentials. This value is a GUID.

Example ingress domain credential set cloudflare command

ibmcloud oc ingress domain credential set akamai --cluster mycluster [--access-token TOKEN] [--client-secret SECRET] [--client-token TOKEN] [--host HOST] [-q] [--domain-zone ZONE]

ibmcloud oc ingress domain default replace

Change a cluster's default Ingress domain.

ibmcloud oc ingress domain default replace --cluster CLUSTER --domain DOMAIN [-q]
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service.

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster where the domain is applied.
--domain DOMAIN
Required. The domain that you want to specify as the new default domain for the cluster. You must specify an existing domain.
-q
Optional: Do not show the message of the day or update reminders.

Example ingress domain default replace command

ibmcloud oc ingress domain default replace --cluster CLUSTER --domain DOMAIN [-q]

ibmcloud oc ingress domain get

View the details of an Ingress domain.

ibmcloud oc ingress domain get --cluster CLUSTER --domain DOMAIN [--output OUTPUT] [-q]
Minimum required permissions
Viewer platform access role for IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster where the domain is applied.
--domain DOMAIN
Required. The domain that you want to view details for.
--output OUTPUT
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example ingress domain get command

ibmcloud oc ingress domain get --cluster CLUSTER --domain DOMAIN [--output OUTPUT] [-q]

ibmcloud oc ingress domain ls

List all Ingress domains for a cluster.

ibmcloud oc ingress domain ls --cluster CLUSTER [--output OUTPUT] [-q]
Minimum required permissions
Viewer platform access role for IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--output OUTPUT
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example ingress domain ls command

ibmcloud oc ingress domain ls --cluster CLUSTER [--output OUTPUT] [-q]

ibmcloud oc ingress domain rm

Remove an Ingress domain from a cluster.

ibmcloud oc ingress domain rm --cluster CLUSTER --domain DOMAIN [-f] [-q]
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster where the domain is applied.
--domain DOMAIN
Required. The domain that you want to remove from the cluster. You cannot specify the default domain. If you want to remove the domain that is currently set as the default for your cluster, you must first replace the default with another domain.

-f

-q
Optional: Do not show the message of the day or update reminders.

Example ingress domain rm command

ibmcloud oc ingress domain rm --cluster CLUSTER --domain DOMAIN [-f] [-q]

ibmcloud oc ingress domain secret regenerate

Regenerate the certificate for an Ingress domain. Run this command to generate a new token in your DNS provider and apply it to your cluster

ibmcloud oc ingress domain secret regenerate --cluster CLUSTER --domain DOMAIN [--output OUTPUT] [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster where the domain is applied.
--domain DOMAIN
Required. The domain you want to regenerate.
--output OUTPUT
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example ingress domain secret regenerate command

ibmcloud oc ingress domain secret regenerate --cluster mycluster --domain exampledomain [--output OUTPUT] [-q]

ibmcloud oc ingress domain secret rm

Delete the secret for an Ingress domain and prevent future renewal of the certificate.

ibmcloud oc ingress domain secret rm --cluster CLUSTER --domain DOMAIN [-f] [--output OUTPUT] [-q]
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster where the domain is applied.
--domain DOMAIN
Required. The domain you want to remove the secret from.

-f

--output OUTPUT
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example ingress domain secret rm command

ibmcloud oc ingress domain secret rm --cluster CLUSTER --domain DOMAIN [-f] [--output OUTPUT] [-q]

ibmcloud oc ingress domain update

Update an Ingress domain for a cluster to change the hostnames or IP addresses associated with the domain. This command updates all the resources in your cluster with the specified IP addresses or hostnames and changes your app URLs.

ibmcloud oc ingress domain update --cluster CLUSTER --domain DOMAIN [--hostname HOSTNAME] [--ip IP] [--ip IP] [-q]

Note that when you add IP addresses or hostnames, you must include any IPs or hostnames that are currently registered to the domain. The domain updates with the exact values specified, so any current IP addresses or hostnames are overwritten if they are not included. For example, if 52.137.182.166 is currently registered to your domain and you want to add 52.137.182.270, you must specify --ip 52.137.182.166 --ip 52.137.182.270 in the command.

Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster where the domain is applied.
--domain DOMAIN
Required. The domain you want to update.
--hostname HOSTNAME
For VPC clusters. The hostname to register for the domain.
--ip IP
The IP addresses to register for the domain. The IP addresses passed in fully replace those that are currently associated with the domain. If you want to keep the current IP addresses, you must include them. Specifying this flag with no values unregisters the current IP addresses from the domain.
-q
Optional: Do not show the message of the day or update reminders.

Example ingress domain update command

ibmcloud oc ingress domain update --cluster CLUSTER --domain DOMAIN [--hostname HOSTNAME] [--ip IP] [-q]

ibmcloud oc ingress instance default set

Virtual Private Cloud Classic infrastructure

Set a registered an IBM Cloud Secrets Manager instance to default. If an existing default instance exists, it will be unset from default.

When you set a new default Secrets Manager instance, any existing secrets that are not managed by IBM Cloud must have their certificate CRN manually updated to match the CRN of the new default instance. To update the CRN, use the ibmcloud oc ingress secret update command. If you do not update the CRN, these secrets do not update at the next scheduled certificate renewal.

ibmcloud oc ingress instance default set --cluster CLUSTER --crn CRN --name NAME [-q] [--secret-group GROUP]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

--c, --cluster CLUSTER
Required. The name or ID of the cluster.
--crn
Required. The CRN of the IBM Cloud Secret Manager instance.
--name NAME
Required. The name of the Secret Manager instance.
-q
Optional: Do not show the message of the day or update reminders.
--secret-group GROUP
Secret group ID of the IBM Cloud Secret Manager instance where the secrets are persisted. To get a secret group ID, see the Secrets Manager CLI reference.

Example:

ibmcloud oc ingress instance default set --cluster --cluster a111aaa11a1aaaaaaa1 --crn crn:v1:staging:public:secrets-manager:eu-gb:a/1a11a1a111aa11aa111aa1a1111aa1a1:1aaa1a1a-aaaa-11aa-1a11-a11aaa1a11a1:secret:a1a11a11-111a-11a1-aa11-11aaa1a11a11 --name my-secret-manager --namespace default --secret-group 90e059dd-d04e-a32b-010f-4d303b9050b8

ibmcloud oc ingress instance default unset

Virtual Private Cloud Classic infrastructure

Remove a Secrets Manager instance as the default instance.

If no default instance is set, your secrets are only written directly to the cluster and are not written to any Secrets Manager instance.

ibmcloud oc ingress instance default unset --cluster CLUSTER --crn CRN --name NAME [-q]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

--c, --cluster CLUSTER
Required. The name or ID of the cluster.
--crn
Required. The CRN of the IBM Cloud Secret Manager instance.
--name NAME
Required. The name of the Secret Manager instance.
-q
Optional: Do not show the message of the day or update reminders.

Example:

ibmcloud oc ingress instance default unset --cluster --cluster a111aaa11a1aaaaaaa1 --crn crn:v1:staging:public:secrets-manager:eu-gb:a/1a11a1a111aa11aa111aa1a1111aa1a1:1aaa1a1a-aaaa-11aa-1a11-a11aaa1a11a1:secret:a1a11a11-111a-11a1-aa11-11aaa1a11a11 --name my-secret-manager --namespace default

ibmcloud oc ingress instance get

Virtual Private Cloud Classic infrastructure

View the details of a Secrets Manager instance.

ibmcloud oc ingress instance get --cluster CLUSTER --name NAME [--output OUTPUT] [-q]
Minimum required permissions
Viewer platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

--c, --cluster CLUSTER
Required. The name or ID of the cluster.
--name NAME
Required. The name of the Secret Manager instance.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example:

ibmcloud oc ingress instance get --cluster my-cluster --name my-secrets-manager

ibmcloud oc ingress instance ls

Virtual Private Cloud Classic infrastructure

List all Secrets Manager instances registered to a cluster.

ibmcloud oc ingress instance ls --cluster CLUSTER [--output OUTPUT] [-q] [--show-deleted]
Minimum required permissions
Viewer platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

--c, --cluster CLUSTER
Required. The name or ID of the cluster.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.
--show-deleted
Optional. Add this option to include instances that were unregistered from the cluster.

Example:

ibmcloud oc ingress instance ls --cluster my-cluster --show-deleted

ibmcloud oc ingress instance register

Virtual Private Cloud Classic infrastructure

Register a Secrets Manager instance to a cluster.

ibmcloud oc ingress instance register --cluster CLUSTER --crn CRN [--is-default] [--secret-group GROUP] [-q]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

--c, --cluster CLUSTER
Required. The name or ID of the cluster.
--crn
Required. The CRN of the IBM Cloud Secret Manager instance.
--is-default
Optional. Include this option to also set the registered instance as the default Secrets Manager instance where all Ingress subdomain certificates are stored. If another instance is already set as default, it is removed. Note that you must manually update any certificates or secrets to upload them to the new default instance. Otherwise, they are uploaded at the next scheduled update time for the secret.
-q
Optional: Do not show the message of the day or update reminders.
--secret-group GROUP
Secret group ID of the IBM Cloud Secret Manager instance where the secrets are persisted. To get a secret group ID, see the Secrets Manager CLI reference.

Example:

ibmcloud oc ingress instance register --cluster my-cluster --crn crn:v1:staging:public:secrets-manager:eu-gb:a/1a11a1a111aa11aa111aa1a1111aa1a1:1aaa1a1a-aaaa-11aa-1a11-a11aaa1a11a1:secret:a1a11a11-111a-11a1-aa11-11aaa1a11a11 --secret-group 90e059dd-d04e-a32b-010f-4d303b9050b8

ibmcloud oc ingress instance unregister

Virtual Private Cloud Classic infrastructure

Remove a Secrets Manager instance from a cluster.

ibmcloud oc ingress instance unregister --cluster CLUSTER --name NAME [-q]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

--c, --cluster CLUSTER
Required. The name or ID of the cluster.
--name
Required. The name of the Secrets Manager instance to remove.
-q
Optional: Do not show the message of the day or update reminders.

Example:

ibmcloud oc ingress instance unregister --cluster my-cluster --name my-secrets-manager-instance

ibmcloud oc ingress lb get

Virtual Private Cloud Classic infrastructure

Get the configuration of load balancers that expose Ingress ALBs in your cluster.

For example, if you previously ran commands such as ibmcloud oc ingress lb proxy-protocol enable, you can use this command to view your configuration changes.

ibmcloud oc ingress lb get --cluster CLUSTER [--output OUTPUT] [-q]
Minimum required permissions
Viewer platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
-f
Optional: Force the command to run with no user prompts.
-q
Optional: Do not show the message of the day or update reminders.

Example ingress lb get command

ibmcloud oc ingress lb get --cluster mycluster

ibmcloud oc ingress lb proxy-protocol disable

Virtual Private Cloud

Disable the NGINX PROXY protocol for the load balancers in front of all Ingress ALBs in your cluster so that client connection information is no longer passed in request headers to ALBs.

After you run this command, the existing load balancers are deleted and re-created, which can cause service disruptions. Two unused IP addresses must be available in each subnet during the load balancer recreation.

ibmcloud oc ingress lb proxy-protocol disable --cluster CLUSTER [-f] [-q]
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
-f
Optional: Force the command to run with no user prompts.
-q
Optional: Do not show the message of the day or update reminders.

Example ingress lb proxy-protocol disable command

ibmcloud oc ingress lb proxy-protocol disable --cluster mycluster

ibmcloud oc ingress lb proxy-protocol enable

Virtual Private Cloud

Enable the NGINX PROXY protocol for all load balancers that expose Ingress ALBs in your cluster so that client connection information is passed in request headers to ALBs.

The PROXY protocol enables load balancers to pass client connection information that is contained in headers on the client request to the ALBs. This client information can include the client IP address, the proxy server IP address, and both port numbers.

After you run this command, the existing load balancers are deleted and re-created, which can cause service disruptions. Two unused IP addresses must be available in each subnet during the load balancer recreation.

ibmcloud oc ingress lb proxy-protocol enable --cluster CLUSTER [--cidr CIDR ...] [--header-timeout TIMEOUT] [-f] [-q]
Minimum required permissions
Operator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--cidr CIDR
Optional: Load balancer CIDRs from which ALBs process information in PROXY protocol headers. If requests that contain PROXY headers originate from load balancers in other IP ranges, the information in the headers is not process by the ALB. This option is supported only for ALBs that run the community Kubernetes Ingress image. Default: 0.0.0.0/0
--header-timeout TIMEOUT
Optional: The timeout value, in seconds, for the load balancer to receive the PROXY protocol headers that contain the client connection information. This option is supported only for ALBs that run the community Kubernetes Ingress image. Default: 5
-f
Optional: Force the command to run with no user prompts.
-q
Optional: Do not show the message of the day or update reminders.

Example ingress lb proxy-protocol enable command

ibmcloud oc ingress lb proxy-protocol enable --cluster mycluster --cidr 1.1.1.1/16

ibmcloud oc ingress secret create

Virtual Private Cloud Classic infrastructure

Create an Ingress secret in a cluster for a certificate that is stored in IBM Cloud® Secrets Manager. This command can be used to create TLS or non-TLS secrets.

The previous alias for this command, ibmcloud oc ingress alb cert deploy, is deprecated. In CLI version 1.0.157 and later, the ibmcloud oc ingress alb cert category is deprecated, and these commands are now listed in the ibmcloud oc ingress secret subcategory. For more information, see the CLI change log.

To use the ibmcloud oc ingress secret create command, you must have a default Secrets Manager instance registered to your cluster. If you do not have a Secrets Manager instance and your secrets are instead written directly to your cluster, your secrets do not have the required CRN value and you must manage them with oc commands.

ibmcloud oc ingress secret create --cert-crn CERTIFICATE_CRN --cluster CLUSTER --name SECRET_NAME  [--namespace NAMESPACE] [--field CRN] [--persist] [--type] [-q]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

--cert-crn CERTIFICATE_CRN
Required: The certificate CRN.
-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--name SECRET_NAME
Required: Specify a name for the secret. Make sure that you don't create the secret with the same name as the IBM-provided Ingress secret, which you can find by running ibmcloud oc cluster get --cluster <cluster_name_or_ID> | grep Ingress.
--field CRN
Required for non-TLS secrets. Add a field to the secret. You can specify more than one field at a time. For more information, see Managing non-TLS secret fields. This option is not supported for TLS secrets.
  • To pull in the secret with the default field name for the secret type, use the default field option: --field <crn>. This option is available for all non-TLS secret types.
  • To specify the field name, use the named field option: --field name=<crn>. This option is available for arbitrary and IAM credential secret types.
  • To use the IBM Cloud Secrets Manager secret as the prefix, use the prefixed field option: --field prefix=<crn>. This option is available for IAM credential, username and password, and key value secret types.
--namespace NAMESPACE
Optional: Specify the project that your Ingress resource is deployed to. If your ALB runs the Kubernetes Ingress image, this value is required, because the ALB can identify secrets only in the same project as your Ingress resource. If your ALB runs the Red Hat OpenShift on IBM Cloud Ingress image, and you don't specify a project, the certificate secret is created in a project called ibm-cert-store. A reference to this secret is then created in the default project, which any Ingress resource in any project can access. While processing requests, the ALB follows the reference to pick up and use the certificate secret from the ibm-cert-store project.
--persist
Optional: Persist the secret data in your cluster. If the secret is later deleted from the CLI or Red Hat OpenShift web console, the secret is automatically re-created in your cluster. To permanently delete the secret, you must use the /ingress/v2/secret/deleteSecret API.
--type
Optional. The type of secret. Choose from tls for certificate CRNs or opaque for non-certificate CRNs. For tls, specify up to one CRN. Foropaque, you can specify multiple CRNs. If no secret type is specified, tls is applied by default.
-q
Optional: Do not show the message of the day or update reminders.

Example ingress secret create command

ibmcloud oc ingress secret create --cert-crn crn:v1:staging:public:cloudcerts:us-south:a/06580c923e40314421d3b6cb40c01c68:0db4351b-0ee1-479d-af37-56a4da9ef30f:certificate:4bc35b7e0badb304e60aef00947ae7ff --cluster my_cluster --type tls --name my_alb_secret --namespace demo_ns

ibmcloud oc ingress secret field add

Virtual Private Cloud Classic infrastructure

Add a non-TLS CRN field to an Opaque secret. There are three ways to specify the field type. The one you choose depends on the secret type and how you want to name the field in the non-TLS secret. For more information, see Managing non-TLS secret fields.

ibmcloud oc ingress secret field add --cluster CLUSTER --name SECRET_NAME --field CRN --namespace NAMESPACE [-q]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

--c, --cluster CLUSTER
Required. The name or ID of the cluster.
--name NAME
Required. The name of the secret to add the field to.
--field CRN
Required. The secret CRN to add to the field. You can specify more than one field at a time. For more information, see Managing non-TLS secret fields.
  • To pull in the secret with the default field name for the secret type, use the default field option: --field <crn>. This option is available for all non-TLS secret types.
  • To specify the field name, use the named field option: --field name=<crn>. This option is available for arbitrary and IAM credential secret types.
  • To use the IBM Cloud Secrets Manager secret as the prefix, use the prefixed field option: --field prefix=<crn>. This option is available for IAM credential, username and password, and key value secret types.
--namespace NAMESPACE
Required. The namespace that the secret is deployed to.
-q
Optional: Do not show the message of the day or update reminders.

Example to add default, named, and prefixed fields to a set of IAM credentials:

ibmcloud oc ingress secret field add --cluster example-cluster --name example-iam-secret --namespace default  --field crn:v1:bluemix:public:secrets-manager:us-south:a/1aa111aa1a11111aaa1a1111aa1aa111:111a1111-11a1 --field unique_iam_name=crn:v1:bluemix:public:secrets-manager:us-south:a/1aa111aa1a11111aaa1a1111aa1aa111:111a1111-11a1 --field prefix=crn:v1:bluemix:public:secrets-manager:us-south:a/1aa111aa1a11111aaa1a1111aa1aa111:111a1111-11a1

ibmcloud oc ingress secret field ls

Virtual Private Cloud Classic infrastructure

View the CRN fields of an Ingress secret. This command applies only to Opaque secrets.

ibmcloud oc ingress secret field ls --cluster CLUSTER --name SECRET_NAME --namespace NAMESPACE [--output OUTPUT] [-q]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

--c, --cluster CLUSTER
Required. The name or ID of the cluster.
--name NAME
Required. The name of the secret to add the field to.
--namespace NAMESPACE
Required. The namespace that the secret is deployed to.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example ingress secret field ls command

ibmcloud oc ingress secret field ls --cluster a11a11a11a111a1a111a --name my-secret --namespace default

ibmcloud oc ingress secret field rm

Virtual Private Cloud Classic infrastructure

ibmcloud oc ingress secret field rm --cluster CLUSTER --name NAME --namespace NAMESPACE [--field-name NAME]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

--c, --cluster CLUSTER
Required. The name or ID of the cluster.
--name NAME
Required. The name of the secret to remove the field from.
--namespace NAMESPACE
Required. The namespace that the secret is deployed to.
--field-name NAME
The name of the field to remove. To see a list of fields, run ibmcloud oc ingress secret field ls.

Example ingress secret field rm command

ibmcloud oc ingress secret field rm --cluster a11a11a11a111a1a111a --name my-secret --namespace default --field-name test-field-name

ibmcloud oc ingress secret get

Virtual Private Cloud Classic infrastructure

View information about Ingress secrets in your cluster, including secrets stored in IBM Cloud® Secrets Manager.

The previous alias for this command, ibmcloud oc ingress alb cert get, is deprecated. In CLI version 1.0.157 and later, the ibmcloud oc ingress alb cert category is deprecated, and these commands are now listed in the ibmcloud oc ingress secret subcategory. For more information, see the CLI change log.

ibmcloud oc ingress secret get --cluster CLUSTER --name SECRET_NAME --namespace NAMESPACE [--output json] [-q]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--name SECRET_NAME
Required: The name of the secret.
--namespace NAMESPACE
Required: The project that the secret is deployed to.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example ingress secret get command

ibmcloud oc ingress secret get --cluster my_cluster --name my_alb_secret --namespace demo_ns

ibmcloud oc ingress secret ls

Virtual Private Cloud Classic infrastructure

List Ingress secrets in your cluster, including secrets stored in IBM Cloud® Secrets Manager.

The previous alias for this command, ibmcloud oc ingress alb cert ls, is deprecated.

ibmcloud oc ingress secret ls --cluster CLUSTER [--show-deleted] [--output json] [-q]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--show-deleted
Optional: View secrets that were deleted from the cluster.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example ingress secret ls command

ibmcloud oc ingress secret ls --cluster my_cluster

ibmcloud oc ingress secret rm

Virtual Private Cloud Classic infrastructure

Delete an Ingress secret from your cluster. If you created a secret for a certificate from Secrets Manager, only the secret in the cluster is deleted and the certificate remains in your Secrets Manager instance.

The previous alias for this command, ibmcloud oc ingress alb cert rm, is deprecated. In CLI version 1.0.157 and later, the ibmcloud oc ingress alb cert category is deprecated, and these commands are now listed in the ibmcloud oc ingress secret subcategory. For more information, see the CLI change log.

ibmcloud oc ingress secret rm --cluster CLUSTER --name SECRET_NAME --namespace NAMESPACE [-q]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--name SECRET_NAME
Required: The name of the secret.
--namespace NAMESPACE
Required: The project that the secret is deployed to.
-q
Optional: Do not show the message of the day or update reminders.

Example ingress secret rm command

ibmcloud oc ingress secret rm --cluster my_cluster --name my_alb_secret --namespace demo_ns

ibmcloud oc ingress secret update

Virtual Private Cloud Classic infrastructure

Update an Ingress secret for a certificate that is not hosted in the default Secrets Manager instance that was created for your cluster.

Any changes that you make to a certificate in the default Secrets Manager instance in your cluster are automatically reflected in the secret in your cluster. If you make changes to a certificate that is not hosted in your cluster Secrets Manager instance, you must use this command to update the secret in your cluster the pick up the certificate changes.

ibmcloud oc ingress secret update --cluster CLUSTER --name SECRET_NAME --namespace NAMESPACE [--cert-crn CRN] [-q]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--name SECRET_NAME
Required: The name of the secret. To see available secrets, run ibmcloud oc ingress secret ls.
--namespace NAMESPACE
Required: The project that the secret is deployed to. To see the secret namespace, run ibmcloud oc ingress secret get --cluster cluster_name_or_ID <--name secret_name> --namespace <project>.
--cert-crn CERTIFICATE_CRN
Optional: The certificate CRN. To see the secret CRN, run ibmcloud oc ingress secret get --cluster <cluster_name_or_ID> --name secret_name> --namespace <project>. This option requires a default Secrets Manager instance in your cluster.
-q
Optional: Do not show the message of the day or update reminders.

Example ingress secret update command

Virtual Private Cloud Classic infrastructure

ibmcloud oc ingress secret update --cluster my_cluster --name my_alb_secret --namespace demo_ns

ibmcloud oc ingress status-report disable

Virtual Private Cloud Classic infrastructure

Disable status reporting for Ingress components in a cluster.

ibmcloud oc ingress status-report disable --cluster CLUSTER [--output json] [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example ingress status-report disable command

ibmcloud oc ingress status-report disable --cluster mycluster

ibmcloud oc ingress status-report enable

Virtual Private Cloud Classic infrastructure

Enable the status reporting of the Ingress components in a cluster.

ibmcloud oc ingress status-report enable --cluster CLUSTER [--output json] [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example ingress status-report enable command

ibmcloud oc ingress status-report enable --cluster mycluster

ibmcloud oc ingress status-report get

Virtual Private Cloud Classic infrastructure

Get the status report for Ingress components in a cluster.

ibmcloud oc ingress status-report get --cluster CLUSTER [--output json] [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example ingress status-report get command

ibmcloud oc ingress status-report get --cluster mycluster

ibmcloud oc ingress status-report ignored-errors add

Virtual Private Cloud Classic infrastructure

Add warnings to be ignored by Ingress status for a cluster.

ibmcloud oc ingress status-report ignored-errors add --cluster CLUSTER --code CODE [--code CODE ...] [--output OUTPUT] [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
-code, --code CODE
Required: Code of the warning to be ignored.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example ingress status-report ignored-errors add command

ibmcloud oc ingress status-report ignored-errors add --cluster mycluster --code CODE

ibmcloud oc ingress status-report ignored-errors ls

Virtual Private Cloud Classic infrastructure

List warnings that are currently ignored by Ingress status for a cluster.

ibmcloud oc ingress status-report ignored-errors ls --cluster CLUSTER [--output OUTPUT] [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example ingress status-report ignored-errors ls command

ibmcloud oc ingress status-report ignored-errors ls --cluster mycluster

ibmcloud oc ingress status-report ignored-errors rm

Virtual Private Cloud Classic infrastructure

Remove warnings that are currently ignored by Ingress status for a cluster. Once removed, these warnings are no longer ignored.

ibmcloud oc ingress status-report ignored-errors rm --cluster CLUSTER --code CODE [--code CODE ...] [--output OUTPUT] [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
-code, --code CODE
Required: Code of the warning to be removed from the ignored list.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example ingress status-report ignored-errors rm command

ibmcloud oc ingress status-report ignored-errors rm --cluster mycluster

nlb-dns commands

Create and manage subdomains for network load balancer (NLB) IP addresses and health check monitors for subdomains. For more information, see Registering a load balancer subdomain.

DNS microservice updates are asynchronous and might take several minutes to apply. Note that if you run an ibmcloud oc nlb-dns command and receive a 200 confirmation message, you might still have to wait for your changes to be implemented. To check the status of your subdomain, run ibmcloud oc nlb-dns ls and find the Status column in the output.

ibmcloud oc nlb-dns add

Classic infrastructure

Add one or more network load balancer (NLB) IP addresses to an existing subdomain that you created with the ibmcloud oc nlb-dns create command.

For example, in a multizone classic cluster, you might create an NLB in each zone to expose an app. You register the NLB IPs with a subdomain by running ibmcloud oc nlb-dns create classic. Later, you add another zone to your cluster and another NLB for that zone. You can use this command to add the new NLB IP to this existing subdomain. When a user accesses your app subdomain, the client accesses one of these IPs at random, and the request is sent to that NLB.

ibmcloud oc nlb-dns add --cluster CLUSTER --ip NLB_IP [--ip NLB2_IP2 --ip NLB3_IP ...] --nlb-host SUBDOMAIN [--output json] [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--ip NLB_IP
The NLB IP address(es) that you want to add to the subdomain. To see your NLB IPs, run oc get svc. To specify multiple IP addresses, use multiple --ip options.
--nlb-host SUBDOMAIN
The subdomain that you want to add IPs to. To see existing subdomains, run ibmcloud oc nlb-dns ls.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example nlb-dns add command

ibmcloud oc nlb-dns add --cluster mycluster --ip 1.1.1.1 --nlb-host mycluster-a1b2cdef345678g9hi012j3kl4567890-0001.us-south.containers.appdomain.cloud

ibmcloud oc nlb-dns create classic

Classic infrastructure

Publicly expose your app by creating a DNS subdomain to register a network load balancer (NLB) IP.

ibmcloud oc nlb-dns create classic --cluster CLUSTER --ip NLB_IP [--ip NLB2_IP --ip NLB3_IP ...] [--secret-namespace NAMESPACE] [--output json] [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--ip IP
The network load balancer IP address that you want to register. To see your NLB IP addresses, run oc get svc. To specify multiple IP addresses, use multiple --ip options.
--secret-namespace NAMESPACE
The Red Hat OpenShift project where you want to create the Kubernetes secret that holds the SSL certificate information for the NLB. If you don't specify a project, the secret is automatically created in the default project.
--type public
The subdomain type. Currently, only public is supported.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example nlb-dns create classic command

ibmcloud oc nlb-dns create classic --cluster mycluster --ip 1.1.1.1

ibmcloud oc nlb-dns create vpc-gen2

Virtual Private Cloud

Create a DNS record for a Network Load Balancer for VPC or Application Load Balancer for VPC.

When you create a Network Load Balancer for VPC, the load balancer is assigned external IP addresses for each zone in your cluster. When you create an Application Load Balancer for VPC, the load balancer is assigned a hostname. If you want an app subdomain with TLS termination, you can use the ibmcloud oc nlb-dns create vpc-gen2 command to create a DNS record for the IP addresses or hostname. IBM Cloud takes care of generating and maintaining the wildcard SSL certificate for the subdomain for you. You can create subdomains for both public and private VPC load balancers.

ibmcloud oc nlb-dns create vpc-gen2 --cluster CLUSTER (--lb-host VPC_ALB_HOSTNAME | --ip VPC_NLB_IP) [--secret-namespace NAMESPACE] [--type (public|private)] [--output json] [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--lb-host VPC_ALB_HOSTNAME | --ip VPC_NLB_IP
For VPC application load balancers, the load balancer hostname. To see load balancer hostnames, run oc get svc -o wide. For VPC network load balancers, the external IP addresses. To specify multiple IP addresses, use multiple --ip options. To see load balancer IP addresses, run oc get svc -o wide.
--secret-namespace NAMESPACE
The Red Hat OpenShift project where you want to create the Kubernetes secret that holds the SSL certificate information for the NLB. If you don't specify a project, the secret is automatically created in the default project.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example nlb-dns create vpc-gen2 command

ibmcloud oc nlb-dns create vpc-gen2 --cluster mycluster --lb-host 1234abcd-us-south.lb.appdomain.cloud --type public

ibmcloud oc nlb-dns get

Virtual Private Cloud Classic infrastructure

View the details of a registered NLB host name in a cluster.

ibmcloud oc nlb-dns get --cluster CLUSTER --nlb-subdomain SUBDOMAIN [--output OUTPUT] [-q]
Minimum required permissions
Viewer platform access role for the cluster in IBM Cloud Kubernetes Service
-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--nlb-subdomain SUBDOMAIN
The DNS subdomain where your network load balancer (NLB) IP address is registered. To list NLBs, run ibmcloud oc nlb-dns ls --cluster mycluster.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example nlb-dns get command

Virtual Private Cloud Classic infrastructure

ibmcloud oc nlb-dns get --cluster mycluster --nlb-subdomain subDomain1

ibmcloud oc nlb-dns ls

In a classic cluster, list the network load balancer (NLB) IP addresses that are registered to DNS subdomains. In a VPC cluster, list the VPC load balancer hostnames that are registered to DNS subdomains.

ibmcloud oc nlb-dns ls --cluster CLUSTER [--output json] [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example nlb-dns ls command

ibmcloud oc nlb-dns ls --cluster mycluster

ibmcloud oc nlb-dns monitor configure

Classic infrastructure

Configure and optionally enable a health check monitor for an existing NLB subdomain in a cluster. When you enable a monitor for your subdomain, the monitor health checks the NLB IP in each zone and keeps the DNS lookup results updated based on these health checks.

You can use this command to create and enable a health check monitor, or to update the settings for an existing health check monitor. To create a new monitor, include the --enable option and the options for all settings that you want to configure.

To update an existing monitor, you must include all the options for the settings that you want, including existing settings.

ibmcloud oc nlb-dns monitor configure --cluster CLUSTER --nlb-host SUBDOMAIN [--enable] [--description DESCRIPTION] [--type TYPE] [--method METHOD] [--path PATH] [--timeout TIMEOUT] [--retries RETRIES] [--interval INTERVAL] [--port PORT] [--header HEADER] [--expected-body BODY STRING] [--expected-codes HTTP CODES] [--follows-redirects TRUE] [--allows-insecure TRUE] [--output json] [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
The name or ID of the cluster where the subdomain is registered.
--nlb-host SUBDOMAIN
The subdomain to configure a health check monitor for. To list subdomains, run ibmcloud oc nlb-dns ls --cluster CLUSTER.
--enable
Include this option to enable a new health check monitor for a subdomain.
--description DESCRIPTION
A description of the health monitor.
--type TYPE
The protocol to use for the health check: HTTP, HTTPS, or TCP. Default: HTTP
--method METHOD
The method to use for the health check. Default for type HTTP and HTTPS: GET. Default for type TCP: connection_established.
--path PATH
When type is HTTPS: The endpoint path to health check against. Default: /
--timeout TIMEOUT
The timeout, in seconds, before the IP is considered unreachable. The health check waits the number of seconds specified in the interval parameter before trying to reach the IP again. The value must be an integer in the range 1 - 15. Default: 5
--retries RETRIES
When a timeout occurs, the number of retries to attempt before the unreachable IP is considered unhealthy. Retries are attempted immediately. The value must be an integer in the range 1 - 5. Default: 2
--interval INTERVAL
The interval, in seconds, between each health check. Short intervals might improve failover time, but increase load on the IPs. The value must be an integer in the range 10 - 3600 and must be greater than (RETRIES + 1) * TIMEOUT. Default: 60
--port PORT
The port number to connect to for the health check. When type is TCP, this parameter is required. When type is HTTP or HTTPS, define the port only if you use a port other than 80 for HTTP or 443 for HTTPS. Default for TCP: 0. Default for HTTP: 80. Default for HTTPS: 443.
--header HEADER
Required when type is HTTP or HTTPS: HTTP request headers to send in the health check, such as a Host header. The User-Agent header can't be overridden. This option is valid only for type 'HTTP' or 'HTTPS'. To add more than one header to the requests, specify this option multiple times. This option accepts values in the following format: --header Header-Name=value. When updating a monitor, the existing headers are replaced by the ones you specify. To delete all existing headers specify the option with an empty value --header "".
--expected-body BODY STRING
When type is HTTP or HTTPS: A case-insensitive substring that the health check looks for in the response body. If this string is not found, the IP is considered unhealthy.
--expected-codes HTTP CODES
When type is HTTP or HTTPS: HTTP codes that the health check looks for in the response. If the HTTP code is not found, the IP is considered unhealthy. Default: 2xx
--allows-insecure TRUE
When type is HTTP or HTTPS: Set to true to not validate the certificate.
--follows-redirects TRUE
When type is HTTP or HTTPS: Set to true to follow any redirects that are returned by the IP.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example nlb-dns monitor configure command

ibmcloud oc nlb-dns monitor configure --cluster mycluster --nlb-host mycluster-a1b2cdef345678g9hi012j3kl4567890-0001.us-south.containers.appdomain.cloud --enable --description "Login page monitor" --type HTTPS --method GET --path / --timeout 5 --retries 2 --interval 60  --expected-body "healthy" --expected-codes 2xx --follows-redirects true

ibmcloud oc nlb-dns monitor disable

Classic infrastructure

Disable an existing health check monitor for a subdomain in a cluster.

ibmcloud oc nlb-dns monitor disable --cluster CLUSTER --nlb-host SUBDOMAIN [--output json] [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--nlb-host SUBDOMAIN
The subdomain that the monitor health checks. To list subdomains, run ibmcloud oc nlb-dns ls --cluster CLUSTER.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example nlb-dns monitor disable command

ibmcloud oc nlb-dns monitor disable --cluster mycluster --nlb-host mycluster-a1b2cdef345678g9hi012j3kl4567890-0001.us-south.containers.appdomain.cloud

ibmcloud oc nlb-dns monitor enable

Classic infrastructure

Enable a health check monitor that you configured.

The first time that you create a health check monitor, you must configure and enable it with the ibmcloud oc nlb-dns monitor configure command. Use the ibmcloud oc nlb-dns monitor enable command only to enable a monitor that you configured but did not yet enable, or to re-enable a monitor that you previously disabled.

ibmcloud oc nlb-dns monitor enable --cluster CLUSTER --nlb-host SUBDOMAIN [--output json] [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--nlb-host SUBDOMAIN
The subdomain that the monitor health checks. To list subdomains, run ibmcloud oc nlb-dns ls --cluster CLUSTER.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example nlb-dns monitor enable command

ibmcloud oc nlb-dns monitor enable --cluster mycluster --nlb-host mycluster-a1b2cdef345678g9hi012j3kl4567890-0001.us-south.containers.appdomain.cloud

ibmcloud oc nlb-dns monitor get

Classic infrastructure

View the settings for an existing health check monitor.

ibmcloud oc nlb-dns monitor get --cluster CLUSTER --nlb-host SUBDOMAIN [--output json] [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--nlb-host SUBDOMAIN
The subdomain that the monitor health checks. To list subdomains, run ibmcloud oc nlb-dns ls --cluster CLUSTER.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example nlb-dns monitor get command

ibmcloud oc nlb-dns monitor get --cluster mycluster --nlb-host mycluster-a1b2cdef345678g9hi012j3kl4567890-0001.us-south.containers.appdomain.cloud

ibmcloud oc nlb-dns monitor ls

Classic infrastructure

List the health check monitor settings for each NLB subdomain in a cluster.

ibmcloud oc nlb-dns monitor ls --cluster CLUSTER [--output json] [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example nlb-dns monitor ls command

ibmcloud oc nlb-dns monitor ls --cluster mycluster

ibmcloud oc nlb-dns replace

Virtual Private Cloud

Replace the load balancer hostname that is registered with a DNS subdomain. For example, if you create a new VPC load balancer for your app, but you don't want to create a new DNS subdomain through which users can access your app, you can replace the hostname of the old load balancer with the hostname of the new load balancer.

ibmcloud oc nlb-dns replace --cluster CLUSTER --lb-host NEW_LB_HOSTNAME --nlb-subdomain SUBDOMAIN [--output json] [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--lb-host NEW_LB_HOSTNAME
The hostname of the new VPC load balancer to update the subdomain with. To see VPC load balancer hostnames, run oc get svc -o wide.
nlb-subdomain SUBDOMAIN
The DNS subdomain that you want to replace the load balancer hostname for. To see existing subdomains, run ibmcloud oc nlb-dns ls --cluster <cluster>.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example nlb-dns replace command

ibmcloud oc nlb-dns replace --cluster mycluster --lb-host 1234abcd-us-south.lb.appdomain.cloud nlb-subdomain mycluster-a1b2cdef345678g9hi012j3kl4567890-0001.us-south.containers.appdomain.cloud

ibmcloud oc nlb-dns rm classic

Classic infrastructure

Remove a network load balancer (NLB) IP address from a subdomain. If you remove all IPs from a subdomain, the subdomain still exists but no IPs are associated with it. Note: You must run this command for each IP address that you want to remove.

ibmcloud oc nlb-dns rm classic --cluster CLUSTER --ip IP --nlb-host SUBDOMAIN [--output json] [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--ip IP
The NLB IP that you want to remove. To see the IPs registered with each subdomain, run ibmcloud oc nlb-dns ls --cluster <cluster>.
--nlb-host SUBDOMAIN
The subdomain that you want to remove an IP from. To see existing subdomains, run ibmcloud oc nlb-dns ls.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example nlb-dns rm classic command

ibmcloud oc nlb-dns rm classic --cluster mycluster --ip 1.1.1.1 --nlb-host mycluster-a1b2cdef345678g9hi012j3kl4567890-0001.us-south.containers.appdomain.cloud

ibmcloud oc nlb-dns rm vpc-gen2

Virtual Private Cloud

Remove the load balancer hostname (VPC application load balancers) or IP addresses (VPC network load balancers) from the DNS record for that load balancer.

After you remove the hostname or IP addresses, the DNS subdomain still exists, but no load balancer is registered with it.

ibmcloud oc nlb-dns rm vpc-gen2 --cluster CLUSTER --nlb-subdomain SUBDOMAIN [ --ip IP] [--output json] [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--nlb-subdomain SUBDOMAIN
The subdomain that you want to disassociate from the VPC load balancer hostname. To see existing subdomains, run ibmcloud oc nlb-dns ls --cluster <cluster>.
--ip IP
For VPC network load balancers, the IP address that you want to remove. To see the IPs registered with each subdomain, run ibmcloud oc nlb-dns ls --cluster <cluster>. Note that you must repeat this command for each IP address that you want to remove.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example nlb-dns rm vpc-gen2 command

ibmcloud oc nlb-dns rm vpc-gen2 --cluster mycluster --nlb-subdomain mycluster-a1b2cdef345678g9hi012j3kl4567890-0001.us-south.containers.appdomain.cloud

Experimental: ibmcloud oc nlb-dns secret regenerate

Virtual Private Cloud Classic infrastructure

Regenerate the certificate and secret for an NLB subdomain. Secret regeneration is not disruptive, and traffic continues to flow while the secret regenerates.

If the Let’s Encrypt certificate creation fails during secret regeneration, a 10 minute wait period must pass before the regeneration is automatically attempted again. The regeneration of the secret takes another 5 minutes to complete, making it a total of 15 minutes before the process is completed.

To avoid the Let’s Encrypt rate limit, don't regenerate a secret more than 5 times per day.

ibmcloud oc nlb-dns secret regenerate --cluster CLUSTER --nlb-subdomain SUBDOMAIN [--output json] [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--nlb-subdomain SUBDOMAIN
The subdomain to regenerate the secret for. To list subdomains, run ibmcloud oc nlb-dns ls --cluster CLUSTER.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example nlb-dns secret regenerate command

ibmcloud oc nlb-dns secret regenerate --cluster mycluster --nlb-subdomain mycluster-a1b2cdef345678g9hi012j3kl4567890-0001.us-south.containers.appdomain.cloud

Experimental: ibmcloud oc nlb-dns secret rm

Virtual Private Cloud Classic infrastructure

Delete a secret from an NLB subdomain and prevent future renewal of the certificate.

You might delete the secret for an NLB subdomain if you no longer use the subdomain, or if the owner of the secret leaves your organization.

ibmcloud oc nlb-dns secret rm --cluster CLUSTER --nlb-subdomain SUBDOMAIN [-f] [--output json] [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--nlb-subdomain SUBDOMAIN
The subdomain to delete the secret for. To list subdomains, run ibmcloud oc nlb-dns ls --cluster CLUSTER.
-f
Optional: Force the command to run with no user prompts.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example nlb-dns secret rm command

ibmcloud oc nlb-dns secret rm --cluster mycluster --nlb-subdomain mycluster-a1b2cdef345678g9hi012j3kl4567890-0001.us-south.containers.appdomain.cloud

webhook-create command

Virtual Private Cloud Classic infrastructure

Register a webhook.

ibmcloud oc webhook-create --cluster CLUSTER --level LEVEL --type slack --url URL  [-q]
Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--level LEVEL
Optional: The notification level, such as Normal or Warning. Warning is the default value.
--type slack
Required: The webhook type. Currently, Slack is supported.
--url URL
Required: The URL for the webhook.
-q
Optional: Do not show the message of the day or update reminders.

Example webhook-create command

ibmcloud oc webhook-create --cluster my_cluster --level Normal --type slack --url http://github.com/mywebhook

api-key commands

View information about the API key for a cluster or reset it to a new key.

ibmcloud oc api-key info

Virtual Private Cloud Classic infrastructure

View the name and email address for the owner of the IBM Cloud Identity and Access Management (IAM) API key that Red Hat OpenShift on IBM Cloud uses to authenticate certain requests like infrastructure in the region and resource group.

To create a different API key for the resource group and region, use the ibmcloud oc api-key reset command.

If you manually set IBM Cloud infrastructure credentials by using the ibmcloud oc credential set command, the API key that is returned in this command is not used for infrastructure permissions.

ibmcloud oc api-key info --cluster CLUSTER [--output json] [-q]
Minimum required permissions
Viewer platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

-c, --cluster CLUSTER
Required: The name or ID of the cluster.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example api-key info command

ibmcloud oc api-key info --cluster my_cluster

ibmcloud oc api-key reset

Virtual Private Cloud Classic infrastructure

Create an IBM Cloud IAM API key that impersonates the user's permissions to authenticate requests for all clusters in the current resource group and region.

If you use the Block Storage for VPC or cluster autoscaler add-ons in your cluster, you must re-create the add-on controller pods after you reset your API key. For more information, see Block Storage for VPC PVC creation fails after API key reset and Autoscaling fails after API key reset.

Before you use this command, make sure that the user who runs this command has the required IBM Cloud Kubernetes Service and IBM Cloud infrastructure permissions. Target the resource group and region that you want to set the API key for. When the API key is reset, the previous API key that was used, if any, for the region and resource group is now obsolete. You can then delete the old API key from your list of API keys. Before you reset the API key, check whether you have other services that use the existing API key, such as a key management service (KMS) provider or Secrets Manager.

ibmcloud oc api-key reset --region REGION [-q]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

--region REGION
Specify a region in Red Hat OpenShift on IBM Cloud: jp-osa, jp-tok, au-syd, eu-de, eu-gb, us-east, or us-south.
-q
Optional: Do not show the message of the day or update reminders.

Example api-key reset command

ibmcloud oc api-key reset --region us-south

credential commands

Set and unset credentials that allow you to access the classic IBM Cloud infrastructure portfolio through your IBM Cloud account.

You can manually set infrastructure credentials to a different account only for classic clusters, not for VPC clusters.

ibmcloud oc credential get

Classic infrastructure

If you set up your IBM Cloud account to use different credentials to access the IBM Cloud infrastructure portfolio, get the infrastructure username for the region and resource group that you are currently targeted to.

ibmcloud oc credential get --region REGION [-q] [--output json]
Minimum required permissions
Viewer platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

--region REGION
Specify a region in Red Hat OpenShift on IBM Cloud: jp-osa, jp-tok, au-syd, eu-de, eu-gb, us-east, or us-south.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example credential get command

ibmcloud oc credential get --region us-south

ibmcloud oc credential set classic

Classic infrastructure

Set credentials for a resource group and region so that you can access the IBM Cloud infrastructure portfolio through your IBM Cloud account.

If you have an IBM Cloud Pay-As-You-Go account, you have access to the IBM Cloud infrastructure portfolio by default. However, you might want to use a different, existing IBM Cloud infrastructure account to order infrastructure. You can link this infrastructure account to your IBM Cloud account by using this command.

If IBM Cloud infrastructure credentials are manually set for a region and a resource group, these credentials are used to order infrastructure for all clusters within that region in the resource group. These credentials are used to determine infrastructure permissions, even if an IBM Cloud IAM API key exists for the resource group and region. If the user whose credentials are stored does not have the required permissions to order infrastructure, then infrastructure-related actions, such as creating a cluster or reloading a worker node can fail.

You can't set multiple credentials for the same IBM Cloud Kubernetes Service resource group and region.

Before you use this command, make sure that the user whose credentials are used has the required IBM Cloud Kubernetes Service and IBM Cloud infrastructure permissions.

ibmcloud oc credential set classic --infrastructure-api-key API_KEY --infrastructure-username USERNAME --region REGION [-q]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

--infrastructure-username USERNAME
Required: IBM Cloud infrastructure account API username. The infrastructure API username is not the same as the IBMid. To view the infrastructure API username, see Managing classic infrastructure API keys.
--infrastructure-api-key API_KEY
Required: IBM Cloud infrastructure account API key. To view or generate an infrastructure API key, see Managing classic infrastructure API keys.
--region REGION
Specify a region in Red Hat OpenShift on IBM Cloud: jp-osa, jp-tok, au-syd, eu-de, eu-gb, us-east, or us-south.
-q
Optional: Do not show the message of the day or update reminders.

Example credential set classic command

ibmcloud oc credential set classic --infrastructure-api-key <api_key> --infrastructure-username dbmanager --region us-south

ibmcloud oc credential unset

Classic infrastructure

Remove the credentials for a resource group and region to remove access to the IBM Cloud infrastructure portfolio through your IBM Cloud account.

After you remove the credentials, the IBM Cloud IAM API key is used to order resources in IBM Cloud infrastructure.

ibmcloud oc credential unset --region REGION [-q]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

--region REGION
Specify a region in Red Hat OpenShift on IBM Cloud: jp-osa, jp-tok, au-syd, eu-de, eu-gb, us-east, or us-south.
-q
Optional: Do not show the message of the day or update reminders.

Example credential unset command

ibmcloud oc credential unset --region us-south

infra-permissions commands

Check classic IBM Cloud infrastructure permissions that are used in Red Hat OpenShift on IBM Cloud.

The ibmcloud oc infra-permissions commands check only classic IBM Cloud infrastructure, not VPC permissions.

ibmcloud oc infra-permissions get

Classic infrastructure

Check whether the credentials that allow access to the IBM Cloud infrastructure portfolio for the targeted resource group and region are missing suggested or required infrastructure permissions.

If the infrastructure credentials for the region and resource group are missing any permissions, the output of this command returns a list of required and suggested permissions.

  • Required: These permissions are needed to successfully order and manage infrastructure resources such as worker nodes. If the infrastructure credentials are missing one of these permissions, common actions such as worker reload can fail for all clusters in the region and resource group.
  • Suggested: These permissions are helpful to include in your infrastructure permissions, and might be necessary in certain use cases. For example, the Add Compute with Public Network Port infrastructure permission is suggested because if you want public networking, you need this permission. However, if your use case is a cluster on the private VLAN only, the permission is not needed so it is not considered required.

For a list of common use cases by permission, see Infrastructure roles.

What if I see an infrastructure permission that I can't find in the console or Infrastructure roles table?
Support Case permissions are managed in a different part of the console than infrastructure permissions. See Customizing infrastructure permissions.
Which infrastructure permissions do I assign?
If your company's policies for permissions are strict, you might need to limit the suggested permissions for your cluster's use case. Otherwise, make sure that your infrastructure credentials for the region and resource group include all the required and suggested permissions.

For most use cases, set up the API key for the region and resource group with the appropriate infrastructure permissions. If you need to use another infrastructure account that differs from your current account, set up manual credentials.

How do I control what actions the users can perform?
After infrastructure credentials are set up, you can control what actions your users can perform by assigning them IBM Cloud IAM platform access roles.
ibmcloud oc infra-permissions get --region REGION [--output json] [-q]
Minimum required permissions
Viewer platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

--region REGION
Required: Specify a region in Red Hat OpenShift on IBM Cloud: jp-osa, jp-tok, au-syd, eu-de, eu-gb, us-east, or us-south.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example infra-permissions get command

ibmcloud oc infra-permissions get --region us-south

Example output

Missing Virtual Worker Permissions

Add Server                    suggested
Cancel Server                 suggested
View Virtual Server Details   required

Missing Physical Worker Permissions

No changes are suggested or required.

Missing Network Permissions

No changes are suggested or required.

Missing Storage Permissions

Add Storage       required
Manage Storage    required

kms commands

Enable a key management service (KMS) provider in your cluster to encrypt the etcd component and Kubernetes secrets with a root key that you control.

ibmcloud oc kms crk ls

Virtual Private Cloud Classic infrastructure

List available customer root keys (CRKs) in a key management service instance. Root keys wrap and unwrap the local data encryption keys (DEKs) that the cluster uses to encrypt its secrets. For more information, see Understanding Key Management Service (KMS) providers.

Do not delete root keys in your KMS instance, even if you rotate to use a new key. If you delete a root key that a cluster uses, the cluster becomes unusable, loses all its data, and can't be recovered.

ibmcloud oc kms crk ls --instance-id KMS_INSTANCE_ID [--output json] [-q]
Minimum required permissions
Viewer platform access role in IBM Cloud Kubernetes Service

Command options:

--instance-id KMS_INSTANCE_ID
The ID of the key management service instance that you want to list root keys for. To list available KMS instances, run ibmcloud oc kms instance ls.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example kms crk ls command

ibmcloud oc kms crk ls --instance-id 1aa1a111-1111-1111-a111-a1aaaa1a1a1a

ibmcloud oc kms enable

Virtual Private Cloud Classic infrastructure

Encrypt your Kubernetes secrets by enabling a key management service (KMS) provider in your cluster. To rotate a key in a cluster with existing key encryption, rerun this command with a new root key ID.

Do not delete root keys in your KMS instance, even if you rotate to use a new key. If you delete a root key that a cluster uses, the cluster becomes unusable, loses all its data, and can't be recovered. When you rotate a root key, you can't reuse a previous root key for the same cluster.

ibmcloud oc kms enable --cluster CLUSTER_NAME_OR_ID --instance-id KMS_INSTANCE_ID --crk ROOT_KEY_ID [--kms-account-id ID] [--public-endpoint] [-q]
Minimum required permissions
Administrator platform access role for the cluster in IBM Cloud Kubernetes Service

Command options:

--container, -c CLUSTER_NAME_OR_ID
The name or ID of the cluster.
--instance-id KMS_INSTANCE_ID
The ID of the KMS instance that you want to use to encrypt the secrets in your cluster. To list available KMS instances, run ibmcloud oc kms instance ls.
--crk ROOT_KEY_ID
The ID of the customer root key (CRK) in your KMS instance that you want to use to wrap the data encryption keys (DEK) that are stored locally in your cluster. To list available root keys, run ibmcloud oc kms crk ls --instance-id <kms_instance_id>.
--kms-account-id ID
Optional: The ID of the account that contains the KMS instance you want to use for local disk or secret encryption.
--public-endpoint
Optional: Specify this option to use the KMS public cloud service endpoint. If you don't include this option, the private cloud service endpoint is used by default.
-q
Optional: Do not show the message of the day or update reminders.

Example kms enable command

ibmcloud oc kms enable -c mycluster --instance-id a11aa11a-bbb2-3333-d444-e5e555e5ee5 --crk 1a111a1a-bb22-3c3c-4d44-55e555e55e55

ibmcloud oc kms instance ls

Virtual Private Cloud Classic infrastructure

List available key management service (KMS) instances in your IBM Cloud account that you can choose to enable in your cluster.

ibmcloud oc kms instance ls [--output json] [-q]
Minimum required permissions
Viewer platform access role in IBM Cloud Kubernetes Service

Command options:

--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example:

ibmcloud oc kms instance ls

quota commands

ibmcloud oc quota ls

Virtual Private Cloud Classic infrastructure

List all quota and limits for cluster-related resources in your IBM Cloud account.

ibmcloud oc quota ls [--provider PROVIDER] [--output json]
Minimum required permissions
Viewer platform access role for IBM Cloud Kubernetes Service

Command options:

--provider (classic | vpc-gen2)
The infrastructure provider type to list quota and limits for.
--output json
Optional: Prints the command output in JSON format.

Example:

ibmcloud oc quota ls

subnets command

Virtual Private Cloud Classic infrastructure

List available subnets in all resource groups in your IBM Cloud infrastructure account.

ibmcloud oc subnets [--provider (classic | vpc-gen2)] [--vpc-id <VPC_ID> --zone <VPC_ZONE>] [--location LOCATION] [--output json] [-q]
Minimum required permissions
Viewer platform access role for IBM Cloud Kubernetes Service

Command options:

--provider (classic | vpc-gen2)
The infrastructure provider type to list subnets for. This option is required to list VPC subnets.
--vpc-id VPC_ID
The ID of the VPC to list subnets for. This option is required when you specify the vpc-gen2 provider type. To list VPC IDs, run ibmcloud oc vpcs.
--zone VPC_ZONE
The zone to list VPC subnets for. This option is required when you specify a VPC provider type.
-l, --location LOCATION
Filter output by a specific location. To see supported locations, run ibmcloud oc locations. To specify multiple locations, use one option for each location, such as -l dal -l seo.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example:

ibmcloud oc subnets -l ams03 -l wdc -l ap

vlan commands

Classic infrastructure

List public and private VLANs for a zone and view the VLAN spanning status.

ibmcloud oc vlan ls

Classic infrastructure

List the public and private VLANs that are available for a zone in your classic IBM Cloud infrastructure account. To list available VLANs, you must have a paid account.

ibmcloud oc vlan ls --zone ZONE [--all] [--output json] [-q]

Minimum required permissions:

  • To view the VLANs that the cluster is connected to in a zone: Viewer platform access role for the cluster in IBM Cloud Kubernetes Service
  • To list all available VLANs in a zone: Viewer platform access role for the region in IBM Cloud Kubernetes Service

Command options:

--zone ZONE
Required: Enter the zone where you want to list your private and public VLANs. To see available zones, run ibmcloud oc zone ls.
--all
Lists all available VLANs. By default VLANs are filtered to show only those VLANs that are valid. To be valid, a VLAN must be associated with infrastructure that can host a worker with local disk storage.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example vlan ls command

ibmcloud oc vlan ls --zone dal10

ibmcloud oc vlan spanning get

Classic infrastructure

View the VLAN spanning status for an IBM Cloud infrastructure account. VLAN spanning enables all devices on an account to communicate with each other through the private network, regardless of its assigned VLAN.

The VLAN spanning option is disabled for clusters that are created in a VRF-enabled account. When VRF is enabled, all VLANs in the account can automatically communicate with each other over the private network. To check whether a VRF is enabled, use the ibmcloud account show command. For more information, see Planning your cluster network setup: Worker-to-worker communication.

ibmcloud oc vlan spanning get --region REGION [--output json] [-q]
Minimum required permissions
Viewer platform access role for IBM Cloud Kubernetes Service

Command options:

--region REGION
Specify a region in Red Hat OpenShift on IBM Cloud: jp-osa, jp-tok, au-syd, eu-de, eu-gb, us-east, or us-south.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example vlan spanning get command

ibmcloud oc vlan spanning get --region us-south

ibmcloud oc vpc ls

List all VPCs in the targeted resource group. If no resource group is targeted, all VPCs in the account are listed.

ibmcloud oc vpc ls [--output OUTPUT] [--provider PROVIDER] [-q]

Command options

--output OUTPUT
Prints the command output in the provided format. Accepted values: json --provider PROVIDER
The VPC infrastructure provider type. Supported values are vpc-classic and vpc-gen2. By default, VPCs of all provider types are returned.
-q
Do not show the message of the day or update reminders.

ibmcloud oc vpc outbound-traffic-protection disable

Disable outbound traffic protection for a Secure By Default VPC cluster.

ibmcloud oc vpc outbound-traffic-protection disable --cluster CLUSTER [-f] [-q]

Command options

--cluster CLUSTER, -c CLUSTER
Specify the cluster name or ID.
-f
Force the command to run without user prompts.
-q
Do not show the message of the day or update reminders.

ibmcloud oc vpc outbound-traffic-protection enable

Enable outbound traffic protection for a Secure By Default VPC cluster.

ibmcloud oc vpc outbound-traffic-protection enable --cluster CLUSTER [-f] [-q]

Command options

--cluster CLUSTER, -c CLUSTER
Specify the cluster name or ID.
-f
Force the command to run without user prompts.
-q
Do not show the message of the day or update reminders.

flavor command

Each flavor includes the amount of virtual CPU, memory, and disk space for each worker node in the cluster.

By default, the secondary storage disk directory where all container data is stored, is encrypted with LUKS encryption. If the disable-disk-encrypt option is included during cluster creation, then the host's container runtime data is not encrypted. Learn more about the encryption.

You can provision your worker node as a virtual machine on shared or dedicated hardware, or for classic clusters only, as a physical machine on bare metal. Learn more about your flavor options.

flavor get command

Virtual Private Cloud Classic infrastructure

Get the information of a flavor for a zone and provider.

ibmcloud oc flavor get --flavor FLAVOR --provider PROVIDER --zone ZONE [--output OUTPUT] [-q]
Minimum required permissions
None

Command options:

--flavor FLAVOR
The flavor you want to get information for. Flavors determine how much virtual CPU, memory, and disk space is available to each worker node.
--provider PROVIDER
The infrastructure provider for which you want to get flavor information for. Available options are classic, vpc-classic and vpc-gen2.
--zone ZONE
The zone where you want to get flavor information for. To see available zones for classic clusters, run ibmcloud oc zone ls. To see available zones for VPC clusters, run ibmcloud oc zone ls --provider vpc-gen2 for Generation 2 compute.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example flavor get command

Virtual Private Cloud Classic infrastructure

ibmcloud oc flavor get --zone us-south-1 --provider vpc-gen2 --flavor bx2d.48x192.900gb

flavor ls command

Virtual Private Cloud Classic infrastructure

List available flavors for a zone.

ibmcloud oc flavor ls --zone ZONE [--output OUTPUT] [--provider PROVIDER] [-q] [--show-storage]
Minimum required permissions
None

Command options:

--zone ZONE
The zone where you want to get flavor information for. To see available zones for classic clusters, run ibmcloud oc zone ls. To see available zones for VPC clusters, run ibmcloud oc zone ls --provider vpc-gen2 for Generation 2 compute.
--provider PROVIDER
Optional: The infrastructure provider for which you want to get flavor information for. Available options are classic, vpc-classic and vpc-gen2.
--show-storage
Optional: Show additional raw disks that are available for SDS worker node flavors. For more information, see Software-defined storage (SDS) machines.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example flavor ls command

ibmcloud oc flavor ls --zone us-south-1 --provider vpc-gen2 --show-storage

messages command

Virtual Private Cloud Classic infrastructure

View current messages from the IBM Cloud Kubernetes Service CLI plug-in for the IBMid user.

ibmcloud oc messages
Minimum required permissions
None

Command options: None

locations command

Virtual Private Cloud Classic infrastructure

List the locations that are supported by IBM Cloud Kubernetes Service. For more information about the locations that are returned, see IBM Cloud Kubernetes Service locations.

ibmcloud oc locations [--output json]
Minimum required permissions
None

Command options:

--output json
Optional: Prints the command output in JSON format.

versions command

Virtual Private Cloud Classic infrastructure

List all the container platform versions that are available for IBM Cloud Kubernetes Service clusters. Update your cluster master and worker nodes to the default version for the latest, stable capabilities.

The kube-versions alias for this command is deprecated.

ibmcloud oc versions [--show-version (KUBERNETES|OPENSHIFT)] [--output json] [-q]
Minimum required permissions
None

Command options:

--show-version (KUBERNETES|OPENSHIFT)
Show only the versions for the specified container platform. Supported values are kubernetes or openshift.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example:

ibmcloud oc versions

api command

Virtual Private Cloud Classic infrastructure

Target the API endpoint for IBM Cloud Kubernetes Service. If you don't specify an endpoint, you can view information about the current endpoint that is targeted.

Region-specific endpoints are deprecated. Use the global endpoint instead.

If you need to list and work with resources from one region only, you can use the ibmcloud oc api command to target a regional endpoint instead of the global endpoint.

  • Dallas (US South, us-south): https://us-south.containers.cloud.ibm.com
  • Frankfurt (EU Central, eu-de): https://eu-de.containers.cloud.ibm.com
  • London (UK South, eu-gb): https://eu-gb.containers.cloud.ibm.com
  • Osaka (jp-osa): https://jp-osa.containers.cloud.ibm.com
  • São Paulo (br-sao): https://br-sao.containers.cloud.ibm.com
  • Sydney (AP South, au-syd): https://au-syd.containers.cloud.ibm.com
  • Tokyo (AP North, jp-tok): https://jp-tok.containers.cloud.ibm.com
  • Toronto (ca-tor): https://ca-tor.containers.cloud.ibm.com
  • Washington, D.C. (US East, us-east): https://us-east.containers.cloud.ibm.com

To use the global functionality, you can use the ibmcloud oc api command again to target the global endpoint: https://containers.cloud.ibm.com

ibmcloud oc api --endpoint ENDPOINT [--insecure] [--skip-ssl-validation] [--api-version VALUE] [-q]
Minimum required permissions
None

Command options:

--endpoint ENDPOINT
The IBM Cloud Kubernetes Service API endpoint. Note: This endpoint is different than the IBM Cloud endpoints. This value is required to set the API endpoint.
--insecure
Allow an insecure HTTP connection. This option is optional.
--skip-ssl-validation
Allow insecure SSL certificates. This option is optional.
--api-version VALUE
Optional: Specify the API version of the service that you want to use.
-q
Optional: Do not show the message of the day or update reminders.

Example: View information about the current API endpoint that is targeted.

ibmcloud oc api
API Endpoint:          https://containers.cloud.ibm.com
API Version:           v1
Skip SSL Validation:   false
Region:                us-south

init command

Virtual Private Cloud Classic infrastructure

Initialize the Red Hat OpenShift on IBM Cloud plug-in or specify the region where you want to create or access Red Hat OpenShift clusters.

Region-specific endpoints are deprecated. Use the global endpoint instead.

If you need to list and work with resources from one region only, you can use the ibmcloud oc init command to target a regional endpoint instead of the global endpoint.

  • Dallas (US South, us-south): https://us-south.containers.cloud.ibm.com
  • Frankfurt (EU Central, eu-de): https://eu-de.containers.cloud.ibm.com
  • London (UK South, eu-gb): https://eu-gb.containers.cloud.ibm.com
  • Osaka (jp-osa): https://jp-osa.containers.cloud.ibm.com
  • São Paulo (br-sao): https://br-sao.containers.cloud.ibm.com
  • Sydney (AP South, au-syd): https://au-syd.containers.cloud.ibm.com
  • Tokyo (AP North, jp-tok): https://jp-tok.containers.cloud.ibm.com
  • Toronto (ca-tor): https://ca-tor.containers.cloud.ibm.com
  • Washington, D.C. (US East, us-east): https://us-east.containers.cloud.ibm.com

To use the global functionality, you can use the ibmcloud oc init command again to target the global endpoint: https://containers.cloud.ibm.com

ibmcloud oc init [--host HOST] [--insecure] [-p] [-u] [-q]
Minimum required permissions
None

Command options:

--host HOST
Optional: The IBM Cloud Kubernetes Service API endpoint to use.
--insecure
Allow an insecure HTTP connection.
-p
Your IBM Cloud password.
-u
Your IBM Cloud username.
-q
Optional: Do not show the message of the day or update reminders.

Examples:

  • Example to target the US South regional endpoint:
    ibmcloud oc init --host https://us-south.containers.cloud.ibm.com
    
  • Example to target the global endpoint again:
    ibmcloud oc init --host https://containers.cloud.ibm.com
    

script commands

ibmcloud oc script update

Virtual Private Cloud Classic infrastructure

Rewrite scripts that call kubernetes-service commands. Legacy-structured commands are replaced with beta-structured commands. For a list of all changes between the legacy and beta formats, see the comparison table in Using the beta Red Hat OpenShift on IBM Cloud plug-in.

Most command behavior and syntax changes in version 1.0. These changes are not compatible with earlier versions. After you update your scripts, you must continue to use version 1.0 of the plug-in within the script or the environment where the script is run. Do not change the IKS_BETA_VERSION environment variable to a different version.

ibmcloud oc script update [--in-place] FILE [FILE ...]
Minimum required permissions
None

Command options:

--in-place
Optional: Rewrite the source file with the updated command structure. If this option is not specified, you can see a summary of the changes to the script file in STDOUT.
FILE [FILE ...]
The file that contains the scripts that you want to update.

To use this command to prepare your automation scripts for the release of version 1.0 of the Red Hat OpenShift on IBM Cloud plug-in:

  1. Run the command on a test script without the --in-place option.
    ibmcloud oc script update ./mytestscript.sh
    
  2. Review the proposed changes to the script in the difference that is shown in the command line STDOUT. Example output
    --- a/script-test-2
    +++ b/script-test-2
    @@ -1,5 +1,5 @@
    -ibmcloud ks logging-config-get --cluster mycluster
    -ibmcloud ks logging-config-update --cluster mycluster --id myconfig --logsource application --type ibm --app-containers app1,app2,app3 --app-paths /var/log/path/
    -ibmcloud ks logging-config-update --cluster mycluster --id myconfig --logsource application --type ibm --app-paths=/var/log/path/,/var/log/other/path/
    -ibmcloud ks clusters -s --locations dal09,dal12 --output json
    -ibmcloud ks subnets --locations sao01
    +ibmcloud ks logging config get --cluster mycluster
    +ibmcloud ks logging config update --cluster mycluster --id myconfig --logsource application --type ibm -C app1 -C app2 -C app3 -p /var/log/path/
    +ibmcloud ks logging config update --cluster mycluster --id myconfig --logsource application --type ibm -p /var/log/path/ -p /var/log/other/path/
    +ibmcloud ks clusters -s -l dal09 -l dal12 --output json
    +ibmcloud ks subnets -l sao01
    
  3. To rewrite the script with the proposed updates, run the command again with the --in-place option.
    ibmcloud oc script update ./mytestscript.sh --in-place
    
  4. Search for and address any commands that are flagged in the script with # WARNING messages. For example, some commands are deprecated and don't have a replacement command.
  5. Within the script or the environment where the script is run, set the IKS_BETA_VERSION environment variable to 1.0.
    export IKS_BETA_VERSION=1.0
    
  6. Test your automation with the updated script. Note that you might incur charges if your automation includes creating clusters.
  7. Update all your scripts.
  8. Update your CLI plug-in to version 1.0.
    ibmcloud plugin update kubernetes-service
    

security-group commands

Virtual Private Cloud Classic infrastructure

Reset or sync a security group to the default traffic rules.

ibmcloud oc security-group ls

List all security groups associated with a cluster.

ibmcloud oc security-group ls --cluster CLUSTER [--attached-to ATTACHED] [--managed-by MANAGER] [--output OUTPUT] [-q] [--scope SCOPE]

Command options

--attached-to ATTACHED
Filter the security groups by the components they are attached to. Accepted values: cluster, load-balancer, vpc, vpe-gateway, worker-pool
--cluster CLUSTER, -c CLUSTER
Specify the cluster name or ID.
--managed-by MANAGER
Specify user to return the security groups created by user. Specify ibm to return only the security groups managed by IBM. Accepted values: ibm, user
--output OUTPUT
Prints the command output in the provided format. Accepted values: json
-q
Do not show the message of the day or update reminders.
--scope SCOPE
Specify cluster to return security groups scoped to the cluster. Specify vpc to return security groups scoped to the entire VPC. Accepted values: cluster, vpc

ibmcloud oc security-group reset

Virtual Private Cloud Classic infrastructure

Deletes all existing security group rules and reapplies the default rules.

ibmcloud oc security-group reset --cluster CLUSTER --security-group GROUP [-f] [-q]
Minimum required permissions
None

Command options:

--cluster CLUSTER
Required: Specify the cluster name or ID. To list available clusters, run ibmcloud oc cluster ls.
--security-group GROUP_ID
Required: Specify the security group ID.

Example:

ibmcloud oc security-group reset --cluster mycluster --security-group mygroup

ibmcloud oc security-group sync

Virtual Private Cloud Classic infrastructure

Reapplies the default security group rules to add any missing rules. Does not delete preexisting rules.

ibmcloud oc security-group sync --cluster CLUSTER --security-group GROUP [-q]
Minimum required permissions
None

Command options:

--cluster CLUSTER
Required: Specify the cluster name or ID. To list available clusters, run ibmcloud oc cluster ls.
--security-group GROUP_ID
Required: Specify the security group ID.

Example:

ibmcloud oc security-group sync --cluster mycluster --security-group mygroup 

Beta: storage commands

Virtual Private Cloud Classic infrastructure

Create, get, list, or remove storage volume attachments.

The storage commands are available in beta.

ibmcloud oc storage attachment create

Virtual Private Cloud

Attach a storage volume to a worker node in your cluster.

Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service
ibmcloud oc storage attachment create --cluster CLUSTER_ID --volume VOLUME --worker WORKER [--output json]

Command options:

--cluster CLUSTER_ID
Required: Specify the cluster ID. To list available clusters, run ibmcloud oc cluster ls.
--volume VOLUME
Required: Specify the volume ID. To list available workers, run ibmcloud oc storage volume ls.
--worker WORKER
Required: Specify the worker ID. To list available workers, run ibmcloud oc worker ls.
--output json
Optional: Prints the command output in JSON format.

Example:

ibmcloud oc storage attachment create --cluster aa1111aa11aaaaa11aa1 --volume 111111111 --worker kube-aa1111aa11aaaaa11aa1-my_cluster-default-00000110 [--output json]

ibmcloud oc storage attachment get

Virtual Private Cloud

Get the details of a storage volume attachment in your cluster.

Minimum required permissions
Viewer platform access role for the cluster in IBM Cloud Kubernetes Service
ibmcloud oc storage attachment get --cluster CLUSTER_ID --attachment ATTACHMENT --worker WORKER [--output json]
--cluster CLUSTER_ID
Required: Specify the cluster ID. To list available clusters, run ibmcloud oc cluster ls.
--attachment ATTACHMENT
Required: Specify the volume attachment ID. To list available attachments, run ibmcloud oc storage attachment ls.
--worker WORKER
Required: Specify the worker ID. To list available workers, run ibmcloud oc worker ls.
--output json
Optional: Prints the command output in JSON format.

Example:

ibmcloud oc storage attachment get --cluster aa1111aa11aaaaa11aa1 --attachment 0111-1a111aaa-1111-1111-111a-aaa1a1a11a11 --worker kube-aa1111aa11aaaaa11aa1-my_cluster-default-00000110 [--output json]

ibmcloud oc storage attachment ls

Virtual Private Cloud

List the storage volume attachments for a worker node in your cluster.

Minimum required permissions
Viewer platform access role for the cluster in IBM Cloud Kubernetes Service
ibmcloud oc storage attachment ls --cluster CLUSTER_ID --worker WORKER [--output json]
--cluster CLUSTER_ID
Required: Specify the cluster ID. To list available clusters, run ibmcloud oc cluster ls.
--worker WORKER
Required: Specify the worker ID. To list available workers, run ibmcloud oc worker ls.
--output json
Optional: Prints the command output in JSON format.

Example:

ibmcloud oc storage attachment ls --cluster aa1111aa11aaaaa11aa1 --worker kube-aa1111aa11aaaaa11aa1-my_cluster-default-00000110 [--output json]

ibmcloud oc storage attachment rm

Virtual Private Cloud

Remove a storage volume from a worker node in your cluster.

Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service
ibmcloud oc storage attachment rm --cluster CLUSTER_ID --attachment ATTACHMENT --worker WORKER [--output json]

Command options:

--cluster CLUSTER_ID
Required: Specify the cluster ID. To list available clusters, run ibmcloud oc cluster ls.
--attachment ATTACHMENT
Required: Specify the volume attachment ID. To list available attachments, run ibmcloud oc storage attachment ls.
--worker WORKER
Required: Specify the worker ID. To list available workers, run ibmcloud oc worker ls.
--output json
Optional: Prints the command output in JSON format.

Example:

ibmcloud oc storage attachment rm --cluster aa1111aa11aaaaa11aa1 --attachment 0111-1a111aaa-1111-1111-111a-aaa1a1a11a11 --worker kube-aa1111aa11aaaaa11aa1-my_cluster-default-00000110 [--output json]

ibmcloud oc storage volume get

Virtual Private Cloud Classic infrastructure

List storage volumes for your classic clusters.

Minimum required permissions
Viewer platform access role for the cluster in IBM Cloud Kubernetes Service
ibmcloud oc storage volume get --volume VOLUME

Command options:

--volume VOLUME
Required: Specify the volume ID. To list available volumes, run ibmcloud ks storage volume ls.
--output json
Optional: Prints the command output in JSON format.

Example:

ibmcloud oc storage volume get --volume 111111111

ibmcloud oc storage volume ls

Virtual Private Cloud Classic infrastructure

Get a list of storage volumes.

Minimum required permissions
Editor platform access role for the cluster in IBM Cloud Kubernetes Service
ibmcloud oc storage volume ls [--cluster CLUSTER_ID] [--provider PROVIDER] [--zone ZONE] [--output json]

Command options:

--cluster CLUSTER_ID
Optional: Specify the cluster ID. To list available clusters, run ibmcloud oc cluster ls.
--provider PROVIDER
Optional: Specify the provider. Supported values are classic and vpc-gen2.
--zone ZONE
Optional: Specify the zone. To list available zones, run ibmcloud oc locations.
--output json
Optional: Prints the command output in JSON format.

Example:

ibmcloud oc storage volume ls --cluster aa1111aa11aaaaa11aa1

Satellite commands

Create and manage IBM Cloud Satellite clusters.

ibmcloud oc cluster create satellite

Satellite

Create an IBM Cloud Satellite cluster on your own infrastructure that you add to a Satellite location as hosts. The hosts are used as worker nodes in your Satellite cluster.

Before you begin, create a Satellite and assign at least 3 hosts to the location for control plane operations. After you create a Satellite cluster, assign hosts for the worker nodes. For more information, see Creating Red Hat OpenShift clusters in Satellite.

ibmcloud oc cluster create satellite --location LOCATION --name NAME --version VERSION [--enable-config-admin] [--host-label LABEL ...] [--infrastructure-topology TOPOLOGY] [--operating-system SYSTEM] [--pod-subnet SUBNET] [--pod-network-interface-selection METHOD] [--pull-secret SECRET] [-q] [--service-subnet SUBNET] [--sm-group GROUP] [--sm-instance INSTANCE] [--workers COUNT] [--zone ZONE] [--entitlement ENTITLEMENT]

Minimum required permissions: IBM Cloud IAM Administrator platform access role for Satellite.

Command options:

--location LOCATION

Required. Enter the ID or name of the location where you want to create the cluster. To retrieve the location ID or name, run ibmcloud sat location ls.

--name NAME

Required. Enter a name for your cluster. The name must start with a letter, can contain letters, numbers, and hyphen (-), and must be 35 characters or fewer.

--version VERSION

Required. Enter the Red Hat OpenShift on IBM Cloud version that you want to run in your cluster. For a list of supported versions, run ibmcloud oc versions.

--enable-config-admin

Optional. Grant the Satellite Config service accounts access to the cluster admin role to manage Kubernetes resources. If you don't grant Satellite Config access, you can't later use the Satellite Config functionality to view or deploy Kubernetes resources for your clusters. If you want to enable access later, you can create custom RBAC roles for Satellite Config.

--host-label, -hl LABEL

Optional. Enter existing labels that describe Satellite hosts, formatted as -hl key=value pairs, so hosts with matching labels can be automatically assigned as worker nodes for the cluster. To find available host labels, run ibmcloud sat host get --host <host_name_or_ID> --location <location_name_or_ID>.

--infrastructure-topology TOPOLOGY

Optional. Specify whether the cluster runs a single worker node or the default setup of three of worker nodes. To create a single-node cluster, specify single-replica. This option is only supported for Red Hat OpenShift on IBM Cloud version 4.11 or later and requires that you specify a Satellite location with CoreOS enabled. Note that single-node clusters lack high availability and are only recommended for specific circumstances. By provisioning a single-node cluster, you accept that you are more likely to experience downtime and disruptions in your workload.

--operating-system REDHAT_8_64|RHCOS

Optional. The operating system of the worker nodes in your cluster. For a list of available operating sysems by cluster version, see the Red Hat OpenShift on IBM Cloud version information. If no option is specified, the default operating system that corresponds to the cluster version is used.

--pod-subnet SUBNET

Optional. All pods that are deployed to a worker node are assigned a private IP address in the 172.30.0.0/16 range by default. You can avoid subnet conflicts with the network that you use to connect to your location by specifying a custom subnet CIDR that provides the private IP addresses for your pods.

When you choose a subnet size, consider the size of the cluster that you plan to create and the number of worker nodes that you might add in the future. The subnet must have a CIDR of at least /23, which provides enough pod IPs for a maximum of four worker nodes in a cluster. For larger clusters, use /22 to have enough pod IP addresses for eight worker nodes, /21 to have enough pod IP addresses for 16 worker nodes, and so on.

The subnet that you choose must be within one of the following ranges.

  • 172.17.0.0 - 172.17.255.255
  • 172.21.0.0 - 172.31.255.255
  • 192.168.0.0 - 192.168.254.255
  • 198.18.0.0 - 198.19.255.255

Note that the pod and service subnets can't overlap. The service subnet is in the 172.21.0.0/16 range by default. This value can't be set to the value of the related location's pod-subnet or service-subnet.

--pod-network-interface-selection METHOD

Optional. The method for selecting the node network interface for the internal pod network. The available methods are can-reach and interface. This option can only be used if you also enable Red Hat CoreOS with the --operating-system option.

  • To provide a direct URL or IP address, specify can-reach=<url> or can-reach=<ip_address>. If the network interface can reach the provided URL or IP address, this option is used. For example, use can-reach=www.exampleurl.com for specifying a URL and can-reach=172.19.0.0 for specifying an IP address.
  • To choose an interface with a Regex string, specify interface=<regex_string>; for example, interface=eth.*.
--pull-secret SECRET

Optional. Specify an existing OCP entitlement for the worker nodes in this cluster by providing your Red Hat® account pull secret. The cluster also uses this pull secret to download Red Hat OpenShift images from your own Red Hat account.

-q

Optional: Do not show the message of the day or update reminders.

--service-subnet SUBNET

Optional. All services that are deployed to the cluster are assigned a private IP address in the 172.21.0.0/16 range by default. You can avoid subnet conflicts with the network that you use to connect to your location by specifying a custom subnet CIDR that provides the private IP addresses for your services.

The subnet must be specified in CIDR format with a size of at least /24, which allows a maximum of 255 services in the cluster, or larger. The subnet that you choose must be within one of the following ranges.

  • 172.17.0.0 - 172.17.255.255
  • 172.21.0.0 - 172.31.255.255
  • 192.168.0.0 - 192.168.254.255
  • 198.18.0.0 - 198.19.255.255

Note that the pod and service subnets can't overlap. The pod subnet is in the 172.30.0.0/16 range by default. This value can't be set to the value of the related location's pod-subnet or service-subnet.

--sm-group GROUP

The secret group ID of the Secrets Manager instance where your secrets are persisted. To get a secret group ID, see the Secrets Manager CLI reference.

--sm-instance INSTANCE

The CRN of the Secrets Manager instance. To get the CRN of an instance, run ibmcloud oc ingress instance ls --cluster CLUSTER.

--workers COUNT

Required when --host-label is specified or if you want to automatically assign hosts. Specify the number of worker nodes per zone in the default worker pool. The default value is 0. If you do not specify a value, workers do not automatically assign and you must instead manually assign workers to your Satellite resources.

--zone ZONE

Optional. The name of the zone to create the default worker pool in. You can start with one zone, and then add the two other zones to your cluster later for high availability. To see the zone names for your location, run ibmcloud sat location get --location <location_name_or_ID> and look for the Host Zones field. If you don't specify a zone name, the zone name that is alphabetically first is chosen.

--entitlement

Set this option to cloud_pak only if you use this cluster with an IBM Cloud Pak that has a Red Hat OpenShift entitlement. 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 in IBM Passport Advantage. After your cluster is created, you are not charged the Red Hat OpenShift license fee for the entitled worker nodes in the default worker pool.

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.

The following example creates a Satellite cluster with the REDHAT_8_64 operating system.

ibmcloud sat cluster create satellite --name mysatcluster --location my-location --pull-secret <secret> --operating-system REDHAT_8_64 --version 4.15_openshift -hl cpu=4 -hl memory=16265432 --workers 3 --zone myzone1

The following example creates a Satellite cluster running Red Hat OpenShift on IBM Cloud version 4.9.23_openshift and RHCOS hosts.

ibmcloud sat cluster create satellite --name mysatcluster-coreos --location my-location --version 4.9.23_openshift --operating-system RHCOS --workers 6

ibmcloud oc cluster master satellite-service-endpoint allowlist add

Satellite

Add a subnet to a Satellite cluster's service endpoint allowlist. Authorized requests to the cluster master that originate from the subnet are permitted through the Satellite service endpoint. The allowlist must be enabled for the restrictions to apply. This command can be used only with Satellite clusters that are CoreOS-enabled.

ibmcloud oc cluster master satellite-service-endpoint allowlist add --cluster CLUSTER --subnet SUBNET [--subnet SUBNET ...] [-q]

Minimum required permissions: IBM Cloud IAM Editor platform access role for Satellite.

Command options:

-c, --cluster CLUSTER
Required. The name or ID of the cluster.
--subnet SUBNET
Required: The subnet in CIDR format. Specify more than one subnet by using multiple repeated entries.
-q
Optional: Do not show the message of the day or update reminders.

Example:

ibmcloud oc cluster master satellite-service-endpoint allowlist add --cluster my-cluster --subnet 1.1.1.1/16 --subnet SUBNET 1.1.1.1/32 [-q]

ibmcloud oc cluster master satellite-service-endpoint allowlist disable

Satellite

Disable the allowlist for a Satellite cluster. When the allowlist is disabled, authorized requests to the cluster master that originate from any subnet are permitted through the Satellite service endpoint. This command can be used only with Satellite clusters that are CoreOS-enabled.

ibmcloud oc cluster master satellite-service-endpoint allowlist disable --cluster CLUSTER [-f] [-q]

Minimum required permissions: IBM Cloud IAM Administrator platform access role for Satellite.

Command options:

-c, --cluster CLUSTER
Required. The name or ID of the cluster.
--subnet SUBNET
Required: The subnet in CIDR format. Specify more than one subnet by using multiple repeated entries.
-f
Optional: Force the command to run with no user prompts.
-q
Optional: Do not show the message of the day or update reminders.

Example:

ibmcloud oc cluster master satellite-service-endpoint allowlist disable --cluster my-cluster 

ibmcloud oc cluster master satellite-service-endpoint allowlist enable

Satellite

Enable the allowlist for a Satellite cluster. When the allowlist is enabled, authorized requests to the cluster master are permitted through the Satellite service endpoint only if they originate from a subnet specified in the allowlist. This command can be used only with Satellite clusters that are CoreOS-enabled.

ibmcloud oc cluster master satellite-service-endpoint allowlist enable --cluster CLUSTER [-f] [-q]

Minimum required permissions: IBM Cloud IAM Administrator platform access role for Satellite.

Command options:

-c, --cluster CLUSTER
Required. The name or ID of the cluster.
-f
Optional: Force the command to run with no user prompts.
-q
Optional: Do not show the message of the day or update reminders.

Example:

ibmcloud oc cluster master satellite-service-endpoint allowlist enable --cluster my-cluster 

ibmcloud oc cluster master satellite-service-endpoint allowlist get

Satellite

Get a Satellite cluster's service endpoint allowlist. The allowlist contains the subnets from which requests to the cluster master are permitted through the Satellite service endpoint. This command can be used only with Satellite clusters that are CoreOS-enabled.

ibmcloud oc cluster master satellite-service-endpoint allowlist get --cluster CLUSTER [-q]

Minimum required permissions: IBM Cloud IAM Viewer platform access role for Satellite.

Command options:

-c, --cluster CLUSTER
Required. The name or ID of the cluster.
-q
Optional: Do not show the message of the day or update reminders.

Example:

ibmcloud oc cluster master satellite-service-endpoint allowlist get --cluster my-cluster 

ibmcloud oc cluster master satellite-service-endpoint allowlist remove

Satellite

Remove a subnet from a Satellite cluster's service endpoint allowlist. Authorized requests to the cluster master that originate from the subnet are no longer permitted through the Satellite service endpoint. This command can be used only with Satellite clusters that are CoreOS-enabled.

ibmcloud oc cluster master satellite-service-endpoint allowlist remove --cluster CLUSTER --subnet SUBNET [--subnet SUBNET ...] [-f] [-q]

Minimum required permissions: IBM Cloud IAM Editor platform access role for Satellite.

Command options:

-c, --cluster CLUSTER
Required. The name or ID of the cluster.
-f
Optional: Force the command to run with no user prompts.
-q
Optional: Do not show the message of the day or update reminders.

Example:

ibmcloud oc cluster master satellite-service-endpoint allowlist remove --cluster my-cluster --subnet 1.1.1.1/16 --subnet SUBNET 1.1.1.1/32 [-q]

ibmcloud oc worker-pool create satellite

Satellite

Create a worker pool for your Red Hat OpenShift cluster in IBM Cloud Satellite.

ibmcloud oc worker-pool create satellite --cluster CLUSTER --host-label LABEL [--host-label LABEL ...] --name NAME [--operating-system SYSTEM] --size-per-zone WORKERS_PER_ZONE --zone ZONE [--entitlement ENTITLEMENT] [--label LABEL ...] [--output OUTPUT] [-q]

Minimum required permissions: IBM Cloud IAM Administrator platform access role for Satellite.

Command options:

-c, --cluster CLUSTER
Required. The name or ID of the cluster.
--host-label, -hl LABEL
Required. Enter at least one existing label that describes Satellite hosts, formatted as -hl key=value pairs, so hosts with matching labels can be automatically assigned to this worker pool. The labels that you specify must match the host labels exactly. For example, if you want a host that has 3 labels to be assigned to this worker pool, you must specify all 3 labels in 3 repeated options. To find available host labels, run ibmcloud sat host get --host <host_name_or_ID> --location <location_name_or_ID>.
--name POOL_NAME
Required. The name that you want to give your worker pool.
--operating-system REDHAT_8_64|RHCOS
Optional. The operating system of the worker nodes in your cluster. For a list of available operating sysems by cluster version, see the Red Hat OpenShift on IBM Cloud version information. If no option is specified, the default operating system that corresponds to the cluster version is used.
--size-per-zone WORKERS_PER_ZONE
Required. The number of worker nodes to request in each zone. Ensure that you attach enough hosts to your location to be used as worker nodes. For example, if you enter 2 and then add 2 more zones to this worker pool after you create it, ensure that at least 6 unassigned hosts are attached to your location so that they can be assigned as 2 worker nodes in each of the 3 zones in your worker pool.
--zone ZONE
Required. The name of the zone where you want hosts to be assigned as worker nodes. To see the zone names for your location, run ibmcloud sat location get --location <location_name_or_ID> and look for the Host Zones field. Note that after you create this worker pool, you can add more zones for high availability.
--entitlement ENTITLEMENT
Set this flag to cloud_pak only if you use this cluster with an IBM Cloud Pak that has a Red Hat OpenShift entitlement. 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 in IBM Passport Advantage. After your cluster is created, you are not charged the Red Hat OpenShift license fee for the entitled worker nodes in the default worker pool. 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.
-l, --label KEY1=VALUE1
Optional. Apply key-value labels to each worker node in the worker pool. Note that these worker node labels are used in the context of Red Hat OpenShift to, for example, manage workload deployment within your cluster, and are separate from the host labels that you previously applied to your Satellite hosts that are used for host assignment to your cluster. To specify multiple labels, use multiple options, such as -l key1=value1 -l key2=value2.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example worker-pool create satellite command

ibmcloud oc worker-pool create satellite --cluster mycluster --host-label use=clusterworker --host-label cpu=4 --host-label memory=16260936 --name mypool --operating-system REDHAT_8_64 --size-per-zone 2 --zone myzone1

ibmcloud oc zone add satellite

Satellite

After you create an IBM Cloud Satellite cluster or worker pool, you can add a zone. When you add a zone, worker nodes are added to the new zone to match the number of workers per zone that you specified for the worker pool. You can add more than one zone only if your cluster is in a multizone metro.

ibmcloud oc zone add satellite --zone ZONE --cluster CLUSTER [--worker-pool WORKER_POOL] [--output json] [-q]

Minimum required permissions: IBM Cloud IAM Administrator platform access role for Satellite.

Command options:

--zone ZONE
Required. The name of the zone that you want to add. To see the zone names for your location, run ibmcloud sat location get --location <location_name_or_ID> and look for the Host Zones field.
-c, --cluster CLUSTER
Required: The name or ID of the cluster.
-p, --worker-pool WORKER_POOL
The name of the worker pool to add the zone to. To specify multiple worker pools, use multiple options, such as -p pool1 -p pool2.
--output json
Optional: Prints the command output in JSON format.
-q
Optional: Do not show the message of the day or update reminders.

Example zone add satellite command

Satellite

ibmcloud oc zone add satellite --zone myzone2 --cluster my_cluster -p pool1 -p pool2