vania-janet/multiturn-rag-retrieval-data huggingface dataset:
Cluster states 

You can view the current cluster state by running the ibmcloud oc cluster ls command and locating the State field.



 Aborted 

Review the following description of the Aborted cluster state. To view the state of your cluster, run ibmcloud oc cluster get --cluster <cluster_name_or_ID>.

You sent a delete request before the Kubernetes master deployment completed. After your cluster is deleted, it is removed from your dashboard. If your cluster is stuck in this state for a long time, open an [IBM Cloud support case](https://cloud.ibm.com/docs/openshift?topic=openshift-get-help).





 Critical 

Review the following description of the Critical cluster state. To view the state of your cluster, run ibmcloud oc cluster get --cluster <cluster_name_or_ID>.

The Kubernetes master can't be reached or all worker nodes in the cluster are down. If you enabled IBM Key Protect in your cluster, the Key Protect container might fail to encrypt or decrypt your cluster secrets. If so, you can view an error with more information when you run oc get secrets.





 Create failed 

Review the following description of the Create failed cluster state. To view the state of your cluster, run ibmcloud oc cluster get --cluster <cluster_name_or_ID>.

The cluster cannot be created. Delete the failed cluster and try to create another one. If the issue persists when creating additional clusters, open an [IBM Cloud support case](https://cloud.ibm.com/docs/openshift?topic=openshift-get-help).





 Delete failed 

Review the following description of the Delete failed cluster state. To view the state of your cluster, run ibmcloud oc cluster get --cluster <cluster_name_or_ID>.

The Kubernetes master or at least one worker node can't be deleted. List worker nodes by running ibmcloud oc worker ls --cluster <cluster_name_or_ID>.
The ones with -show and -list are old command names, which are deprecated but can still work. We recommend using the new commands without -list and -show, as documented in the following sections.







 Cluster commands 



 ibmcloud dbaas cluster 

This command shows the detailed information about a database cluster, including information about each node.

ibmcloud dbaas cluster RESOURCE_NAME [--output json]



 Command option 

RESOURCE_NAME
: The name or CRN of your DBaaS service instance. To find the resource name or CRN, use the IBM Cloud command ibmcloud resource service-instances --long. To find the resource name, use the IBM Cloud command ibmcloud resource service-instances.

--output
: Use the --output option with value json to format output in JSON.







 ibmcloud dbaas resource-scale 

This command scales the cluster resources (disk, RAM, or vCPU). For the valid value range, see the [value table](https://cloud.ibm.com/docs/hyper-protect-dbaas-for-mongodb?topic=hyper-protect-dbaas-for-mongodb-resources-scalingbefore-scaling) (the same for MongoDB and PostgreSQL).

ibmcloud dbaas resource-scale RESOURCE_NAME [--cpu|-c NUM_CPU] [--memory|-m MEM_GIB] [--storage|-s STORAGE_GIB] [--force] [--output json]



 Command options 

RESOURCE_NAME
: The name or CRN of your DBaaS service instance. To find the resource name or CRN, use the IBM Cloud command ibmcloud resource service-instances --long.

--cpu value
: Total number of dedicated CPU cores.

--memory value
: Total memory allocation in GiB. For example, --memory 4.

--storage value
: Total storage allocation in GiB. For example, --storage 10.

--force
: Force scaling without the y/N confirmation.

--output
[Cluster commands](https://cloud.ibm.com/docs/cli?topic=cli-kubernetes-service-clicluster) Create, view, and modify clusters and cluster settings, such as add-on, subnet, and master settings. 
 [Worker commands](https://cloud.ibm.com/docs/cli?topic=cli-kubernetes-service-cliworker_node_commands) View and modify worker nodes for a cluster. 
 [Worker-pool commands](https://cloud.ibm.com/docs/cli?topic=cli-kubernetes-service-cliworker-pool) View and modify worker pools for a cluster. 
 [Zone commands](https://cloud.ibm.com/docs/cli?topic=cli-kubernetes-service-clizone) List availability zones and modify the zones attached to a worker pool. 
 [Ingress commands](https://cloud.ibm.com/docs/cli?topic=cli-kubernetes-service-clialb-commands) View and modify Ingress services and settings. 
 [Logging commands](https://cloud.ibm.com/docs/cli?topic=cli-kubernetes-service-clilogging_commands) Forward logs from your cluster. 
 [NLB-DNS commands](https://cloud.ibm.com/docs/cli?topic=cli-kubernetes-service-clinlb-dns) 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](https://cloud.ibm.com/docs/cli?topic=cli-kubernetes-service-clics_webhook_create) Register a webhook in a cluster. 
 [API-key commands](https://cloud.ibm.com/docs/cli?topic=cli-kubernetes-service-cliapi_key-commands) View information about the API key for a cluster or reset it to a new key.
The ID of the cluster group that you want to add to your assignment. To list cluster groups, run ibmcloud sat group ls.

--name NAME
: Optional. Enter a new name for your storage assignment.

-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 storage assignment update --assignment ASSIGNMENT --group GROUP --name NAME [-f] [-q]







 ibmcloud sat storage assignment upgrade 

Upgrade a Satellite storage assignment. You can use the assignment upgrade command to upgrade a Satellite storage assignment to the latest storage configuration version.

ibmcloud sat storage assignment upgrade --assignment ASSIGNMENT [-f] [-q]



 Minimum required permissions 

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





 Command options 

--assignment ASSIGNMENT
: Required. The name of the storage assignment. To list storage assignments, run ibmcloud sat storage assignment 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 storage assignment upgrade --assignment my-storage-assignment







 ibmcloud sat storage config create 

Create a Satellite storage configuration that you can assign to your clusters to install storage drivers in your clusters.

Before you can use storage templates and configurations to manage your storage resources across locations and clusters, make sure you [Set up Satellite Config](https://cloud.ibm.com/docs/satellite?topic=satellite-setup-clusters-satconfig).

ibmcloud sat storage config create --location LOCATION --name NAME --template-name NAME [--template-version VERSION] [--param PARAM ...]
Since no operations are specified, resources in the NETWORK-ZONE-ID zone can access both the cluster and management APIs.

{
"description": "Example rule 1",
"resources": [
{
"attributes":
{
"name": "accountId",
"value": "ACCOUNT-ID"
},
{
"name": "serviceName",
"value": "containers-kubernetes"
},
{
"name": "serviceInstance",
"value": "CLUSTER-ID"
}
]
}
],
"contexts": [
{
"attributes":
{
"name": "networkZoneId",
"value": "NETWORK-ZONE-ID"
},
{
"name": "endpointType",
"value": "private"
}
]
}
]
}

The following example payload creates a rule that protects the CLUSTER-ID cluster. Only the resources defined in the NETWORK-ZONE-ID zone can access the cluster. Since the cluster API type is specified, resources in the NETWORK-ZONE-ID zone can access the cluster through the cluster APIs over the private network.

{
"description": "Example rule 2",
"resources": [
{
"attributes":
{
"name": "accountId",
"value": "ACCOUNT-ID"
},
{
"name": "serviceName",
"value": "containers-kubernetes"
},
{
"name": "serviceInstance",
"value": "CLUSTER-ID"
}
]
}
],
"operations": {
"api_types": [
{
"api_type_id": "crn:v1:bluemix:public:containers-kubernetes::::api-type:cluster"
}
]
* The CLI tools including the IBM Cloud CLI, the Containers service CLI plug-in, and the CBR plug-in. For more information, see [Getting started with the IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-getting-started).
* An IBM Cloud Kubernetes Service cluster. For more information, see [Creating clusters](https://cloud.ibm.com/docs/containers?topic=containers-clusters).
* Review the [What are context-based restrictions](https://cloud.ibm.com/docs/account?topic=account-context-restrictions-whatis) docs to get an understanding of network zones and rules.
* Review the [Protecting IBM Cloud Kubernetes Service resources with context-based restrictions](https://cloud.ibm.com/docs/openshift?topic=openshift-cbr) docs to understand how you can leverage CBR for your IBM Cloud Kubernetes Service resources.
* Review the [limitations for using CBR with IBM Cloud Kubernetes Service](https://cloud.ibm.com/docs/openshift?topic=openshift-cbr&interface=clicbr-limitations).







 Step 1: Creating your network zone 

[Log in to your account. If applicable, target the appropriate resource group. Set the context for your cluster.](https://cloud.ibm.com/docs/containers?topic=containers-access_cluster)



1. Run the following example command to create a network that includes only one client IP that you want to use.

ibmcloud cbr zone-create --addresses 129.XX.XX.XX --description "Allow only client IP" --name allow-client-ip
2. Verify the network zone was created.

ibmcloud cbr zones







 Step 2: Creating your CBR rule 



1. After you create your network zone (allowlist), create a CBR rule and add the network zone you created in the previous step. The following example creates a rule that uses the cluster API type.
Since the cluster API type is specified, resources in the NETWORK-ZONE-ID zone can access the cluster through the cluster APIs over the private network.

{
"description": "Example rule 2",
"resources": [
{
"attributes":
{
"name": "accountId",
"value": "ACCOUNT-ID"
},
{
"name": "serviceName",
"value": "containers-kubernetes"
},
{
"name": "serviceInstance",
"value": "CLUSTER-ID"
}
]
}
],
"operations": {
"api_types": [
{
"api_type_id": "crn:v1:bluemix:public:containers-kubernetes::::api-type:cluster"
}
]
},
"contexts": [
{
"attributes":
{
"name": "networkZoneId",
"value": "NETWORK-ZONE-ID"
},
{
"name": "endpointType",
"value": "private"
}
]
}
]
}





 Creating rules from the CLI 



1. To create rules from the CLI, [install the CBR CLI plug-in](https://cloud.ibm.com/docs/cli?topic=cli-cbr-plugininstall-cbr-plugin).
2. You can use the ibmcloud cbr rule-create[command](https://cloud.ibm.com/docs/cli?topic=cli-cbr-plugincbr-cli-rule-create-command) to create CBR rules. For more information, see the CBR [CLI reference](https://cloud.ibm.com/docs/cli?topic=cli-cbr-plugincbr-zones-cli).
If you select a region in your CBR rule, then only traffic from resources in the network zones that you associate with the rule can interact with resources in that region.
: If you use the CLI, you can specify the --region REGION option to protect resources in a specific region.
: If you use the API, you can specify "name": "region","value": "REGION" field in the resource attributes.

Resource group
: Protects IBM Cloud Kubernetes Service resources in a specific resource group.
: If you use the CLI, you can specify the --resource-group-id RESOURCE-GROUP-ID option to protect resources in a specific resource group.
: If you use the API, you can specify "name": "resourceGroupId","value": "RESOURCE-GROUP-ID" field in the resource attributes.





 Protecting specific APIs 

You can create CBR rules to protect the following API types for IBM Cloud Kubernetes Service.

Cluster control plane APIs
: Protect access to the APIs inside your clusters, such as the APIs for creating namespaces, pods, and more. CBR rules that apply to the cluster API type control access to your cluster API server, which includes all kubectl commands to that cluster. If you select the cluster control plane APIs in your CBR rule, then only traffic from resources in the network zones that associate with that rule can interact with the cluster control plane APIs. All other requests are blocked.
: If you use the CLI, you can specify the --api-types option and the crn:v1:bluemix:public:containers-kubernetes::::api-type:cluster type.
: If you use the API, you can specify "api_type_id": "crn:v1:bluemix:public:containers-kubernetes::::api-type:cluster" in the "operations" spec.

Management APIs
: Protect access to the APIs for provisioning and managing clusters, worker pools, and more.
Creating cluster...
OK
Cluster created with ID brkhsd220b6ktv7sjl50
4. Wait for the cluster to reach a Warning state. The Warning state indicates that the cluster master is fully deployed, but no worker nodes could be detected in the cluster.

ibmcloud oc cluster ls

Example output

OK
Name ID State Created Workers Location Version Resource Group Name Provider
satcluster brkhsd220b6ktv7sjl50 warning 12 minutes ago 0 mylocation 4.5.23_1525_openshift Default satellite
5. Make sure that hosts are assigned as worker nodes to the cluster.



* Autoassignment: If you included --host-labels when you created the cluster and you have available hosts with matching labels in your Satellite location, the worker nodes are automatically assigned to the cluster. If you don't have any available and matching hosts, the cluster is still created but enters a Warning state. [Attach hosts](https://cloud.ibm.com/docs/satellite?topic=satellite-attach-hosts) to your Satellite location so that hosts can be assigned as worker nodes to the worker pool. If the hosts are not automatically assigned, you can also manually [assign Satellite hosts to your cluster](https://cloud.ibm.com/docs/satellite?topic=satellite-assigning-hostshost-assign-manual).
* Manual assignment: [Assign Satellite hosts to your cluster](https://cloud.ibm.com/docs/satellite?topic=satellite-assigning-hostshost-assign-manual). After the hosts successfully bootstrap, the hosts function as the worker nodes for your cluster to run Red Hat OpenShift workloads. Generally, assign at least 3 hosts as worker nodes in your cluster.



6. Verify that your cluster reaches a normal state.

ibmcloud oc cluster ls

Example output

OK
Name ID State Created Workers Location Version Resource Group Name Provider
satcluster brkhsd220b6ktv7sjl50 normal 2 hours ago 3 mylocation 4.3.23_1525_openshift Default satellite
Minimum required permissions
: None

Command options:

--cluster CLUSTER
: Required: Specify the cluster name or ID. To list available clusters, run ibmcloud ks cluster ls.

--security-group GROUP_ID
: Required: Specify the security group ID.

Example:

ibmcloud ks 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 ks 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 ks 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 ks cluster ls.

--volume VOLUME
: Required: Specify the volume ID. To list available workers, run ibmcloud ks storage volume ls.

--worker WORKER
: Required: Specify the worker ID. To list available workers, run ibmcloud ks worker ls.

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

Example:

ibmcloud ks storage attachment create --cluster aa1111aa11aaaaa11aa1 --volume 111111111 --worker kube-aa1111aa11aaaaa11aa1-my_cluster-default-00000110 [--output json]





 ibmcloud ks 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 ks storage attachment get --cluster CLUSTER_ID --attachment ATTACHMENT --worker WORKER [--output json]

--cluster CLUSTER_ID
--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 ks 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](https://cloud.ibm.com/docs/containers?topic=containers-kubernetes-service-clicli_zone-add-vpc-gen2) to the worker pool. This value is required, and must be 1 or greater. For more information, see [What is the smallest size cluster that I can make?](https://cloud.ibm.com/docs/containers?topic=containers-faqssmallest_cluster).

--operating-system SYSTEM
: Optional. The operating system of the worker nodes you want to provision in your cluster. For a list of available operating systems by cluster version, see [IBM Cloud Kubernetes Service version information](https://cloud.ibm.com/docs/containers?topic=containers-cs_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 VPC zone, run ibmcloud ks flavors --zone <vpc_zone> --provider vpc-gen2.

--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 ks 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
Deleting clusters from vCenter Server instances 

You can delete clusters from VMware vCenter Server® instances when you do not need them.

Deleting clusters from vCenter Server instances with VMware vSphere® 6.5 is not supported.



 Before you delete clusters from vCenter Server instances 



* Whenever possible, delete clusters by using the IBM Cloud® for VMware Solutions console and not the VMware vSphere® Web Client. Changes that you make on the vSphere Web Client are not synchronized with the VMware Solutions console. If you want to delete clusters from vCenter Server instances by using the vSphere Web Client, do so only for on-premises clusters or clusters that you don't manage in the VMware Solutions console.
* You can delete any cluster except for the first cluster (the one that is created during initial deployment).
* You can delete multiple clusters at a time. You can also delete a cluster while another cluster is being created or deleted.
* Ensure that all nodes in a cluster are powered on and operational before you delete the cluster.
* When you delete a cluster, all VMs from the cluster are also deleted and they can't be recovered. If you want to keep the VMs, migrate them to other clusters.
* When you delete a cluster, all storage and subnets that are associated with the cluster are deleted as well. To view the storage and subnets that are associated with a cluster, see the cluster details page.
* You do not have to delete any services that are installed on the cluster, including services on a gateway cluster. The services are automatically deleted when you delete the cluster.







 Procedure to delete clusters from vCenter Server instances 



1. From the IBM Cloud for VMware Solutions console, click Resources > vCenter Server from the left navigation pane.
2. In the vCenter Server table, click the instance that you want to delete clusters from.

Ensure that the instance status is Available. Otherwise, you can't delete clusters from the instance.
3. Click the Infrastructure tab.
* [Available flavors for VMs](https://cloud.ibm.com/docs/containers?topic=containers-planning_worker_nodesvm-table)



* [Physical machines (bare metal)](https://cloud.ibm.com/docs/containers?topic=containers-planning_worker_nodesbm)



* [Planning considerations for bare metal](https://cloud.ibm.com/docs/containers?topic=containers-planning_worker_nodesbm-planning)
* [Available flavors for bare metal](https://cloud.ibm.com/docs/containers?topic=containers-planning_worker_nodesbm-table)



* [Software-defined storage (SDS) machines](https://cloud.ibm.com/docs/containers?topic=containers-planning_worker_nodessds)



* [Planning considerations for SDS](https://cloud.ibm.com/docs/containers?topic=containers-planning_worker_nodessds-planning)
* [Available flavors for SDS](https://cloud.ibm.com/docs/containers?topic=containers-planning_worker_nodessds-table)



* [Worker node resource reserves](https://cloud.ibm.com/docs/containers?topic=containers-planning_worker_nodesresource_limit_node)







 Creating clusters 

[Preparing to create clusters](https://cloud.ibm.com/docs/containers?topic=containers-clustersclusters)



* [Preparing to create clusters at the account level](https://cloud.ibm.com/docs/containers?topic=containers-clusterscluster_prepare)
* [Deciding on your cluster setup](https://cloud.ibm.com/docs/containers?topic=containers-clustersprepare_cluster_level)
* [Next steps](https://cloud.ibm.com/docs/containers?topic=containers-clustersnext_steps)



[Creating classic clusters](https://cloud.ibm.com/docs/containers?topic=containers-cluster-create-classiccluster-create-classic)
* [Satellite components in IBM Cloud](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-satellite-architecture-aboutcomponents-ibm-cloud)
* [Satellite location components](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-satellite-architecture-aboutcomponents-satellite-location)



* [Infrastructure](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-satellite-architecture-aboutcomponents-satellite-location)
* [Satellite control plane worker nodes](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-satellite-architecture-aboutcomponents-satellite-location-control-plane-workers)
* [Workload clusters](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-satellite-architecture-aboutcomponents-satellite-location-workload-clusters)



* [Other supporting components on-premises](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-satellite-architecture-aboutcomponents-other-supporting)
* [Next steps](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-satellite-architecture-aboutnext-steps)



[Satellite reference architecture use cases](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-satellite-architecture-use-casessatellite-architecture-use-cases)



* [US regional bank](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-satellite-architecture-use-casessatellite-architecture-use-cases-1)