vania-janet/multiturn-rag-retrieval-data huggingface dataset:
If you have multiple worker pools, add the zone to all your worker pools so that your cluster is balanced in all zones.

A private and a public VLAN must exist before you can add a zone to multiple worker pools. If you don't have a private and a public VLAN in that zone, add the zone to one worker pool first so that a private and a public VLAN is created for you. Then, you can add the zone to other worker pools by specifying the private and the public VLAN that was created for you.

If you want to use different VLANs for different worker pools, repeat this command for each VLAN and its corresponding worker pools. Any new worker nodes are added to the VLANs that you specify, but the VLANs for any existing worker nodes are not changed.

ibmcloud oc zone add classic --zone <zone> --cluster <cluster_name_or_ID> -p <pool_name> [-p <pool2_name>] --private-vlan <private_VLAN_ID> --public-vlan <public_VLAN_ID>
5. Verify that the zone is added to your cluster. Look for the added zone in the Worker zones field of the output. Note that the total number of workers in the Workers field has increased as new worker nodes are provisioned in the added zone.

ibmcloud oc cluster get --cluster <cluster_name_or_ID>

Example output

NAME: mycluster
ID: df253b6025d64944ab99ed63bb4567b6
State: normal
Status: healthy cluster
Created: 2018-09-28T15:43:15+0000
Location: dal10
Pod Subnet: 172.30.0.0/16
Service Subnet: 172.21.0.0/16
Master URL: https://c3.<region>.containers.cloud.ibm.com:30426
Public Service Endpoint URL: https://c3.<region>.containers.cloud.ibm.com:30426
ibmcloud ks zone add classic --zone <zone> --cluster <cluster_name_or_ID> -p <pool_name> [-p <pool2_name>] --private-vlan <private_VLAN_ID> --public-vlan <public_VLAN_ID>
5. Verify that the zone is added to your cluster. Look for the added zone in the Worker zones field of the output. Note that the total number of workers in the Workers field has increased as new worker nodes are provisioned in the added zone.

ibmcloud ks cluster get --cluster <cluster_name_or_ID>

Example output

NAME: mycluster
ID: df253b6025d64944ab99ed63bb4567b6
State: normal
Status: healthy cluster
Created: 2018-09-28T15:43:15+0000
Location: dal10
Pod Subnet: 172.30.0.0/16
Service Subnet: 172.21.0.0/16
Master URL: https://c3.<region>.containers.cloud.ibm.com:30426
Public Service Endpoint URL: https://c3.<region>.containers.cloud.ibm.com:30426
Private Service Endpoint URL: https://c3-private.<region>.containers.cloud.ibm.com:31140
Master Location: Dallas
Master Status: Ready (21 hours ago)
Ingress Subdomain: mycluster-<hash>-0000.us-south.containers.appdomain.cloud
Ingress Secret: mycluster-<hash>-0000
Workers: 6
Worker Zones: dal10, dal12
Version: 1.26_1524
Owner: owner@email.com
Resource Group ID: a8a12accd63b437bbd6d58fb6a462ca7
Resource Group Name: Default









 Deprecated: Adding stand-alone worker nodes
* 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](https://cloud.ibm.com/docs/containers?topic=containers-kubernetes-service-cliinfra_permissions_get) 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.

-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 ks cluster create classic --zone dal10 --private-vlan my_private_VLAN_ID --flavor b3c.4x16 --name my_cluster --hardware shared --workers 2 --operating-system UBUNTU_20_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 ks vlan ls --zone <zone>.
: The name of the cluster that you want to register.

--silent
: Optional. Return only the registration command in the CLI output.

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





 Example 

ibmcloud sat cluster register --name mycluster







 ibmcloud sat cluster unregister 

Unregister a cluster from the Satellite Config component. You can no longer subscribe the cluster to automatically deploy Kubernetes resources from a configuration, but the cluster and its existing resources still run.

ibmcloud sat cluster unregister --cluster CLUSTER [-f] [-q]



 Minimum required permissions 

IBM Cloud IAM Operator platform role for the Cluster resource in Satellite. For more information, see [Checking user permissions](https://cloud.ibm.com/docs/satellite?topic=satellite-iam-assign-accesschecking-perms).





 Command options 

--cluster, -c CLUSTER
: Required. The cluster that you want to unregister from Satellite. To list registered clusters, run ibmcloud sat cluster ls.

-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 sat cluster unregister -c mycluster









 Cluster group commands 

Use these commands to create cluster groups. Then, subscribe your cluster group to a Satellite configuration to automatically deploy Kubernetes resources to these clusters.



 ibmcloud sat group attach 

Add a Red Hat OpenShift on IBM Cloud cluster to your cluster group. The cluster can run in your Satellite location or in IBM Cloud. To add a cluster that runs in IBM Cloud, you must first [register the cluster](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencecli-cluster-register) with the Satellite Config component.

ibmcloud sat group attach --cluster CLUSTER [--cluster CLUSTER] --group GROUP [-q]
Why does my cluster stay in a pending state? 

Virtual Private Cloud

Classic infrastructure

  What’s happening 

When you deploy your cluster, it remains in a pending state and doesn't start.

  Why it’s happening 

If you just created the cluster, the worker nodes might still be configuring. If you already wait for a while, you might have an invalid VLAN.

  How to fix it 

You can try one of the following solutions:

- Check the status of your cluster by running ibmcloud oc cluster ls. Then, check to be sure that your worker nodes are deployed by running ibmcloud oc worker ls --cluster <cluster_name>.
- Check to see whether your VLAN is valid. To be valid, a VLAN must be associated with infrastructure that can host a worker with local disk storage. You can [list your VLANs](/docs/openshift?topic=openshift-kubernetes-service-clics_vlans) by running ibmcloud oc vlan ls --zone <zone> if the VLAN does not show in the list, then it is not valid. Choose a different VLAN.
* [ibmcloud ks cluster addon options](https://cloud.ibm.com/docs/containers?topic=containers-kubernetes-service-clics_cluster_addon_options)
* [ibmcloud ks cluster addon update](https://cloud.ibm.com/docs/containers?topic=containers-kubernetes-service-clics_cluster_addon_update)
* [ibmcloud ks cluster addon versions](https://cloud.ibm.com/docs/containers?topic=containers-kubernetes-service-clics_addon_versions)



* cluster ca: Manage the Certificate Authority (CA) certificates of a cluster.



* [ibmcloud ks cluster ca create](https://cloud.ibm.com/docs/containers?topic=containers-kubernetes-service-clics_cluster_ca_create)
* [ibmcloud ks cluster ca get](https://cloud.ibm.com/docs/containers?topic=containers-kubernetes-service-clics_cluster_ca_get)
* [ibmcloud ks cluster ca rotate](https://cloud.ibm.com/docs/containers?topic=containers-kubernetes-service-clics_cluster_ca_rotate)
* [ibmcloud ks cluster ca status](https://cloud.ibm.com/docs/containers?topic=containers-kubernetes-service-clics_cluster_ca_status)



* [ibmcloud ks cluster config](https://cloud.ibm.com/docs/containers?topic=containers-kubernetes-service-clics_cluster_config)
* cluster create: Create a classic or VPC cluster.



* [ibmcloud ks cluster create classic](https://cloud.ibm.com/docs/containers?topic=containers-kubernetes-service-clics_cluster_create)
"id": "2234947",
"subnets":
{
"id": "2215454",
"ips":
"10.XXX.XXX.XXX",
"10.XXX.XXX.XXX",
"10.XXX.XXX.XXX",
"10.XXX.XXX.XXX",
"10.XXX.XXX.XXX"
],
"is_public": false,
"is_byoip": false,
"cidr": "10.XXX.XXX.X/29"
}
],
"zone": "dal10",
"region": "us-south"
},
{
"id": "2234945",
"subnets":
{
"id": "2219170",
"ips":
"169.XX.XXX.XX",
"169.XX.XXX.XX",
"169.XX.XXX.XX",
"169.XX.XXX.XX",
"169.XX.XXX.XX"
],
"is_public": true,
"is_byoip": false,
"cidr": "169.XX.XXX.X/29"
}
],
"zone": "dal10",
"region": "us-south"
}
],
"vlan_errors": [],
"reserved_ips": []
}
cluster_id:
----
bmnj1b1d09lpvv3oof0g
reserved_private_ip:
----

reserved_private_vlan_id:
----

reserved_public_ip:
----

Events: <none>
: The name of the cluster that you want to register.

--silent
: Optional. Return only the registration command in the CLI output.

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





 Example 

ibmcloud sat cluster register --name mycluster







 ibmcloud sat cluster unregister 

Unregister a cluster from the Satellite Config component. You can no longer subscribe the cluster to automatically deploy Kubernetes resources from a configuration, but the cluster and its existing resources still run.

ibmcloud sat cluster unregister --cluster CLUSTER [-f] [-q]



 Minimum required permissions 

IBM Cloud IAM Operator platform role for the Cluster resource in Satellite. For more information, see [Checking user permissions](https://cloud.ibm.com/docs/satellite?topic=satellite-iam-assign-accesschecking-perms).





 Command options 

--cluster, -c CLUSTER
: Required. The cluster that you want to unregister from Satellite. To list registered clusters, run ibmcloud sat cluster ls.

-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 sat cluster unregister -c mycluster









 Cluster group commands 

Use these commands to create cluster groups. Then, subscribe your cluster group to a Satellite configuration to automatically deploy Kubernetes resources to these clusters.



 ibmcloud sat group attach 

Add a Red Hat OpenShift on IBM Cloud cluster to your cluster group. The cluster can run in your Satellite location or in IBM Cloud. To add a cluster that runs in IBM Cloud, you must first [register the cluster](https://cloud.ibm.com/docs/cli?topic=cli-satellite-cli-referencecli-cluster-register) with the Satellite Config component.
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 ks 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 ks cluster create vpc-gen2 --name mycluster --version 1.26 --zone us-south-1 --vpc-id a0123456-78b9-0c1d-23d4-567890123ef4 --subnet-id 1ab23c45-6789-0123-456d-789ef01gh234 --flavor bx2.4x16 --workers 3







 ibmcloud ks cluster get 

Virtual Private Cloud

Classic infrastructure

View the details of a cluster.

ibmcloud ks 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 ks cluster get --cluster my_cluster --show-resources







 ibmcloud ks cluster image-security disable 

Virtual Private Cloud

Classic infrastructure

Disable [image security enforcement](https://cloud.ibm.com/docs/containers?topic=containers-imagesportieris-image-sec).
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 ks 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 ks cluster create vpc-gen2 --name mycluster --version 1.25 --zone us-south-1 --vpc-id a0123456-78b9-0c1d-23d4-567890123ef4 --subnet-id 1ab23c45-6789-0123-456d-789ef01gh234 --flavor bx2.4x16 --workers 3







 ibmcloud ks cluster get 

Virtual Private Cloud

Classic infrastructure

View the details of a cluster.

ibmcloud ks 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 ks cluster get --cluster my_cluster --show-resources







 ibmcloud ks cluster image-security disable 

Virtual Private Cloud

Classic infrastructure

Disable [image security enforcement](https://cloud.ibm.com/docs/containers?topic=containers-imagesportieris-image-sec).
IBM Cloud Activity Tracker events 

You can view, manage, and audit user-initiated activities in your Red Hat® OpenShift® on IBM Cloud® community Kubernetes or Red Hat OpenShift cluster by using the IBM Cloud® Activity Tracker service.

Red Hat OpenShift on IBM Cloud automatically generates cluster management events and forwards these event logs to IBM Cloud Activity Tracker. To access these logs, you must [provision an instance of IBM Cloud Activity Tracker](https://cloud.ibm.com/docs/activity-tracker?topic=activity-tracker-getting-started).



 Cluster events 

The following list of cluster events are sent to IBM Cloud Activity Tracker.



Cluster events

 Action Description 

 containers-kubernetes.cluster.config The Kubernetes configuration file (kubeconfig) for a cluster is requested. Depending on the request, the kubeconfig might contain administrator or network certificates and secrets to access the cluster. 
 containers-kubernetes.cluster.create The creation of a cluster is requested. This event is sent for any type of cluster, such as clusters that are created in different infrastructure providers. 
 containers-kubernetes.cluster.list Clusters are listed. The list might be filtered by details such as the infrastructure provider. 
 containers-kubernetes.cluster.delete A cluster is deleted. 
 containers-kubernetes.cluster.get Details for a cluster are returned. 
 containers-kubernetes.cluster-apikey-owner.get The API key owner for the region and resource group that the cluster is in is returned. 
 containers-kubernetes.cluster-audit-webhook.delete A cluster audit webhook for forwarding master API server audit logs is removed. 
 containers-kubernetes.cluster-audit-webhook.get Audit webhooks for a cluster are listed. 
 containers-kubernetes.cluster-audit-webhook.update A cluster audit webhook for forwarding master API server audit logs is updated. 
 containers-kubernetes.cluster-ca-certificate.create A certificate authority (CA) for a cluster is created.
* [ibmcloud oc cluster addon options](https://cloud.ibm.com/docs/openshift?topic=openshift-kubernetes-service-clics_cluster_addon_options)
* [ibmcloud oc cluster addon update](https://cloud.ibm.com/docs/openshift?topic=openshift-kubernetes-service-clics_cluster_addon_update)
* [ibmcloud oc cluster addon versions](https://cloud.ibm.com/docs/openshift?topic=openshift-kubernetes-service-clics_addon_versions)



* cluster ca: Manage the Certificate Authority (CA) certificates of a cluster.



* [ibmcloud oc cluster ca create](https://cloud.ibm.com/docs/openshift?topic=openshift-kubernetes-service-clics_cluster_ca_create)
* [ibmcloud oc cluster ca get](https://cloud.ibm.com/docs/openshift?topic=openshift-kubernetes-service-clics_cluster_ca_get)
* [ibmcloud oc cluster ca rotate](https://cloud.ibm.com/docs/openshift?topic=openshift-kubernetes-service-clics_cluster_ca_rotate)
* [ibmcloud oc cluster ca status](https://cloud.ibm.com/docs/openshift?topic=openshift-kubernetes-service-clics_cluster_ca_status)



* [ibmcloud oc cluster config](https://cloud.ibm.com/docs/openshift?topic=openshift-kubernetes-service-clics_cluster_config)
* cluster create: Create a classic or VPC cluster.



* [ibmcloud oc cluster create classic](https://cloud.ibm.com/docs/openshift?topic=openshift-kubernetes-service-clics_cluster_create)
For example, you might choose to set up a [Virtual Router Appliance](https://cloud.ibm.com/docs/virtual-router-appliance?topic=virtual-router-appliance-about-the-vra) or a [Fortigate Security Appliance](https://cloud.ibm.com/docs/vmwaresolutions/services?topic=vmwaresolutions-fsa_considerations) to act as your firewall to allow required network traffic and to block unwanted network traffic.
2. [Open up the required private IP addresses and ports](https://cloud.ibm.com/docs/containers?topic=containers-firewallfirewall_outbound) for each region so that the master and the worker nodes can communicate and for the IBM Cloud services that you plan to use.













 Deciding on your cluster setup 

After you set up your account to create clusters, decide on the setup for your cluster. You must make these decisions every time that you create a cluster. Review the following decision tree image for more information, such as comparisons of Kubernetes and Red Hat OpenShift, and VPC and classic infrastructure.





 Next steps 

When the cluster is up and running, you can check out the following cluster administration tasks:



* If you created the cluster in a multizone capable zone, [spread worker nodes by adding a zone to your cluster](https://cloud.ibm.com/docs/containers?topic=containers-add_workers).
* [Deploy an app in your cluster.](https://cloud.ibm.com/docs/containers?topic=containers-deploy_appapp_cli)
* [Set up your own private registry in IBM Cloud to store and share Docker images with other users.](https://cloud.ibm.com/docs/Registry?topic=Registry-getting-started)
* [Set up the cluster autoscaler](https://cloud.ibm.com/docs/containers?topic=containers-cluster-scaling-classic-vpc) to automatically add or remove worker nodes from your worker pools based on your workload resource requests.
GET/v2/getCACert Get the cluster's CA certificate. containers-kubernetes.cluster.view cluster-ca-certificate.get 
 POST/v2/rotateCACert Rotate the cluster's CA certificate. containers-kubernetes.cluster.create cluster-ca-certificate.rotate 
 POST/v2/createCA Create a CA certificate. cluster-ca-certificate.create containers-kubernetes.cluster.create 







 Cluster 

Review the following cluster API methods, their corresponding actions in IBM Cloud IAM, and the events that are sent to IBM Cloud Activity Tracker for IBM Cloud Kubernetes Service.



Cluster API methods, IAM actions, and Activity Tracker events.

 API Method Description IAM action for the API Activity Tracker event 

 DELETE/v1/clusters/{idOrName} Delete a cluster. containers-kubernetes.cluster.create containers-kubernetes.cluster.delete 
 DELETE/v1/clusters/{idOrName}/apiserverconfigs/auditwebhook Delete an audit webhook configuration. containers-kubernetes.cluster.operate containers-kubernetes.cluster.delete 
 DELETE/v1/clusters/{idOrName}/services/{namespace}/{serviceInstanceId} Unbind an IBM Cloud service from a cluster. containers-kubernetes.cluster.operate containers-kubernetes.service.delete 
 DELETE/v1/clusters/{idOrName}/usersubnets/{subnetId}/vlans/{vlanId} Remove a user-managed subnet from a cluster. containers-kubernetes.cluster.operate containers-kubernetes.vlan.delete 
 GET/v1/clusters List the clusters that you have access to. containers-kubernetes.cluster.read N/A 
 GET/v1/clusters/{idOrName} View details for a cluster. containers-kubernetes.cluster.read N/A
Why does my cluster stay in a pending state? 

Virtual Private Cloud

Classic infrastructure

  What’s happening 

When you deploy your cluster, it remains in a pending state and doesn't start.

  Why it’s happening 

If you just created the cluster, the worker nodes might still be configuring. If you already wait for a while, you might have an invalid VLAN.

  How to fix it 

You can try one of the following solutions:

- Check the status of your cluster by running ibmcloud ks cluster ls. Then, check to be sure that your worker nodes are deployed by running ibmcloud ks worker ls --cluster <cluster_name>.
- Check to see whether your VLAN is valid. To be valid, a VLAN must be associated with infrastructure that can host a worker with local disk storage. You can [list your VLANs](/docs/containers?topic=containers-kubernetes-service-clics_vlans) by running ibmcloud ks vlan ls --zone <zone> if the VLAN does not show in the list, then it is not valid. Choose a different VLAN.
To perform this action, you need the Network > Manage Network VLAN Spanning[infrastructure permission](https://cloud.ibm.com/docs/containers?topic=containers-access-credsinfra_access), or you can request the account owner to enable it. To check whether VLAN spanning is already enabled, use the ibmcloud ks vlan spanning get --region <region>[command](https://cloud.ibm.com/docs/containers?topic=containers-kubernetes-service-clics_vlan_spanning_get).

ibmcloud ks zone add classic --zone <zone> --cluster <cluster_name_or_ID> -w <pool_name1> -w <pool_name2> -w <pool_name3> --private-vlan <private_VLAN_ID> --public-vlan <public_VLAN_ID>
3. To add multiple zones to your worker pools: Repeat the ibmcloud ks zone add classic command with a different zone and specify the worker pools that you want to provision in that zone. By adding more zones to your cluster, you change your cluster from a single zone cluster to a [multizone cluster](https://cloud.ibm.com/docs/containers?topic=containers-ha_clustersmz-clusters).



6. Wait for the worker nodes to be deployed in each zone.

ibmcloud ks worker ls --cluster <cluster_name_or_ID>

When the worker node state changes to Normal the deployment is finished.
7. Remove your stand-alone worker nodes. If you have multiple stand-alone worker nodes, remove one at a time.



1. List the worker nodes in your cluster and compare the private IP address from this command with the private IP address that you retrieved in the beginning to find your stand-alone worker nodes.

kubectl get nodes
2. Remove your stand-alone worker node. Use the ID of the worker node that you retrieved with the ibmcloud ks worker ls --cluster <cluster_name_or_ID> command.