vania-janet/multiturn-rag-retrieval-data huggingface dataset:
GET/v1/subnets/vlan-spanning View the VLAN spanning status. containers-kubernetes.cluster.read N/A 
 GET/v1/user-config View a user's ability to create clusters in a region and resource group. containers-kubernetes.cluster.read N/A 
 GET/v1/versions List available IBM Cloud Kubernetes Service versions. containers-kubernetes.cluster.read N/A 
 GET/v1/zones List available zones (data centers). N/A N/A 
 GET/v2/getMessages View the current user messages. N/A N/A 
 GET/v2/getQuota View the quota for resources per region in the account. containers-kubernetes.cluster.read N/A 
 GET/v2/getVersions List available IBM Cloud Kubernetes Service versions. containers-kubernetes.cluster.read N/A 
 GET/v2/vpc/getZones List available zones in a region. N/A N/A 
 POST/v1/credentials Set IBM Cloud infrastructure account credentials for your IBM Cloud Kubernetes Service account. containers-kubernetes.cluster.create N/A 
 POST/v1/keys Reset the IAM API key. containers-kubernetes.cluster.create N/A 







 Certificate authority 



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

 API Method Description IAM action for the API Event sent to Activity Tracker 

 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
To list the clusters that are included in your cluster group, run ibmcloud sat group get --group <cluster_group_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 

ibmcloud sat group detach --group mygroup --cluster mycluster







 ibmcloud sat group get 

Retrieve details of a cluster group, such as the clusters that are included in your cluster group.

ibmcloud sat group get --group GROUP [-q]



 Minimum required permissions 

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





 Command options 

--group, -g GROUP
: Required. The name or ID of the cluster group that you want to retrieve details for. To list available cluster groups, run ibmcloud sat group ls.

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





 Example 

ibmcloud sat group get --group mygroup







 ibmcloud sat group ls 

List all cluster groups in your IBM Cloud account.

ibmcloud sat group ls [-q]



 Minimum required permissions 

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





 Command options 

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





 Example 

ibmcloud sat group ls







 ibmcloud sat group rm 

Remove a cluster group.

ibmcloud sat group rm --group GROUP [-f] [-q]



 Minimum required permissions
* [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)



* [Creating a classic cluster in the console](https://cloud.ibm.com/docs/containers?topic=containers-cluster-create-classicclusters_ui)
* [Creating a standard classic cluster in the CLI](https://cloud.ibm.com/docs/containers?topic=containers-cluster-create-classicclusters_cli_steps)
* [Example commands to create classic clusters](https://cloud.ibm.com/docs/containers?topic=containers-cluster-create-classiccluster_create_classic)
* [Creating a single-zone classic cluster with Terraform](https://cloud.ibm.com/docs/containers?topic=containers-cluster-create-classiccluster_classic_tf)



[Creating VPC clusters](https://cloud.ibm.com/docs/containers?topic=containers-cluster-create-vpc-gen2cluster-create-vpc-gen2)



* [Prerequisites and notes](https://cloud.ibm.com/docs/containers?topic=containers-cluster-create-vpc-gen2cluster-create-vpc-prereq)
* [Creating a VPC cluster in the console](https://cloud.ibm.com/docs/containers?topic=containers-cluster-create-vpc-gen2clusters_vpcg2_ui)
* [Creating VPC clusters from the CLI](https://cloud.ibm.com/docs/containers?topic=containers-cluster-create-vpc-gen2cluster_vpcg2_cli)
"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"
}
]
},
"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.
(https://cloud.ibm.com/docs-content/v1/content/c8335d66af691d19e837116fd633481c477061eb/satellite/images/icon-checkmark-filled.svg) 







 Cluster group service access roles 



Actions that you can take with service access roles.

 Action API CLI None Reader Writer Deployer Manager 

 Add clusters to a cluster group. groupClusters [cluster-group attach](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencecluster-group-attach) ![Feature available.](https://cloud.ibm.com/docs-content/v1/content/c8335d66af691d19e837116fd633481c477061eb/satellite/images/icon-checkmark-filled.svg) 
 Remove clusters from a cluster group. unGroupClusters [cluster-group detach](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencecluster-group-detach) ![Feature available.](https://cloud.ibm.com/docs-content/v1/content/c8335d66af691d19e837116fd633481c477061eb/satellite/images/icon-checkmark-filled.svg) 
 Create a cluster group. addGroup [cluster-group create](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencecluster-group-create) ![Feature available.](https://cloud.ibm.com/docs-content/v1/content/c8335d66af691d19e837116fd633481c477061eb/satellite/images/icon-checkmark-filled.svg) 
 View cluster groups that are attached to Satellite Config.
To make sure that your cluster is registered with Satellite Config or to create groups, see [Setting up clusters to use with Satellite Config](https://cloud.ibm.com/docs/satellite?topic=satellite-setup-clusters-satconfig).

Example command to list cluster groups.

ibmcloud sat group ls

Example command to list clusters.

ibmcloud oc cluster ls --provider satellite

Example command to list Satellite services.

ibmcloud sat service ls --location <location>
3. Assign your storage configuration to the cluster, group, or service that you retrieved earlier. For more information, see the ibmcloud sat storage assignment create[command](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencecli-storage-assign-create).

Example command to assign a configuration to a cluster group.

ibmcloud sat storage assignment create --group GROUP --config CONFIG --name NAME

Example command to assign a configuration to a cluster.

ibmcloud sat storage assignment create --cluster CLUSTER --config CONFIG --name NAME

Example command to assign a configuration to a service cluster.

ibmcloud sat storage assignment create --service-cluster-id CLUSTER --config CONFIG --name NAME
4. Verify that your assignment is created.

ibmcloud sat storage assignment ls (--cluster CLUSTER | --config CONFIG | --location LOCATION | --service-cluster-id CLUSTER)







 Creating a storage assignment in the API 



1. Copy one of the following example requests.

Example request to assign a [configuration to a cluster](https://containers.cloud.ibm.com/global/swagger-global-api//satellite/createAssignmentByCluster).
* From the [Cluster resources page](https://cloud.ibm.com/satellite/resources).
* From the [Configurations page](https://cloud.ibm.com/satellite/configuration), click a configuration. Then, click a subscription and review the Resources tab.
* From the [Clusters page](https://cloud.ibm.com/satellite/clusters), click a cluster. Then, review the Resources tab.







 Reviewing resources with the CLI 

Review resources with the CLI.

Use the ibmcloud sat resource ls[command](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencecli-resource-ls) and its options to list resources. To view the details of a particular resource, use the ibmcloud sat resource get[command](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencecli-resource-get).
* [Put everything learned to practice, run the JPetStore app in your cluster](https://cloud.ibm.com/docs/Registry?topic=Registry-vm-to-containers-and-kubernetesvm-to-containers-and-kubernetes-runthejpetstore)
* [Related Content](https://cloud.ibm.com/docs/Registry?topic=Registry-vm-to-containers-and-kubernetesvm-to-containers-and-kubernetes-related)



[Resilient and secure multi-region Kubernetes clusters with IBM Cloud Internet Services](https://cloud.ibm.com/docs/Registry?topic=Registry-multi-region-k8s-cismulti-region-k8s-cis)



* [Objectives](https://cloud.ibm.com/docs/Registry?topic=Registry-multi-region-k8s-cismulti-region-k8s-cis-objectives)
* [Before you begin](https://cloud.ibm.com/docs/Registry?topic=Registry-multi-region-k8s-cismulti-region-k8s-cis-prereqs)
* [Deploy an application to one location](https://cloud.ibm.com/docs/Registry?topic=Registry-multi-region-k8s-cismulti-region-k8s-cis-2)



* [Create a Kubernetes cluster](https://cloud.ibm.com/docs/Registry?topic=Registry-multi-region-k8s-cismulti-region-k8s-cis-3)
* [Deploy the application to the Kubernetes cluster](https://cloud.ibm.com/docs/Registry?topic=Registry-multi-region-k8s-cismulti-region-k8s-cis-deploy_application)
[View and manage Satellite cluster groups](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencecluster-group-commands).



* [ibmcloud sat group attach](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencecluster-group-attach).
* [ibmcloud sat group create](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencecluster-group-create).
* [ibmcloud sat group detach](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencecluster-group-detach).
* [ibmcloud sat group get](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencecluster-group-get).
* [ibmcloud sat group ls](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencecluster-group-ls).
* [ibmcloud sat group rm](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencecluster-group-rm).







 ibmcloud sat host 

[View and modify Satellite host settings](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencesat-host-commands).



* [ibmcloud sat host assign](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencehost-assign).
* [ibmcloud sat host attach](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencehost-attach).
* [ibmcloud sat host get](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-referencehost-get).
* [Cluster](https://cloud.ibm.com/docs/containers?topic=containers-api-at-iamks-cluster)
* [Image security](https://cloud.ibm.com/docs/containers?topic=containers-api-at-iamimage-security)
* [Ingress](https://cloud.ibm.com/docs/containers?topic=containers-api-at-iamks-ingress)
* [Ingress ALB](https://cloud.ibm.com/docs/containers?topic=containers-api-at-iamks-alb)
* [Ingress load balancer](https://cloud.ibm.com/docs/containers?topic=containers-api-at-iamapi-ingress-loadbalancer)
* [Ingress status](https://cloud.ibm.com/docs/containers?topic=containers-api-at-iamapi-ingress-status)
* [Fluentd logging](https://cloud.ibm.com/docs/containers?topic=containers-api-at-iamks-logging)
* [NLB DNS](https://cloud.ibm.com/docs/containers?topic=containers-api-at-iamks-nlb-dns)
* [Observability: Log Analysis](https://cloud.ibm.com/docs/containers?topic=containers-api-at-iamks-observability-logging)
* [Observability: Monitoring](https://cloud.ibm.com/docs/containers?topic=containers-api-at-iamks-observability-monitoring)
* [Private service endpoint allowlist](https://cloud.ibm.com/docs/containers?topic=containers-api-at-iamks-acl)
* [Satellite](https://cloud.ibm.com/docs/containers?topic=containers-api-at-iamsat-api)
-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](https://cloud.ibm.com/docs/openshift?topic=openshift-imagesportieris-image-sec). 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](https://cloud.ibm.com/docs/openshift?topic=openshift-imagesportieris-image-sec) 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
-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.
3. List available zones and note which one you want to create the cluster in.

ibmcloud oc zones --provider vpc-gen2

Example output.

ID Name Metro Flavors
us-east-1 us-east-1 Washington D.C. -
us-east-2 us-east-2 Washington D.C. -
us-east-3 us-east-3 Washington D.C. -
us-south-1 us-south-1 Dallas -
us-south-2 us-south-2 Dallas -
us-south-3 us-south-3 Dallas -



7. Create the cluster. Specify the dedicated host pool, the subnet, vpc and zone you previously noted, and the cluster flavor. Note that it may take several minutes for the cluster to fully provision.

ibmcloud oc cluster create vpc-gen2 --name my_cluster --flavor bx2d.4x16 --dedicated-host-pool dh_a1aaa1111aaa1aaa1a11 --subnet-id 1111-a11aaaa1-1a11-1111-1a1a-aaaaa1111111 --vpc-id a111-11a111a1-11a1-1a11-11a1-a1a1111a11a1 --zone dal10 --workers 3
8. Verify that the cluster is created.

ibmcloud oc cluster ls

Example output.

Name ID State Created Workers Location Version Resource Group Name Provider
my_cluster a111a11a11aa1aa11a11 normal 1 hour ago 4 Dallas 1.26.6 default vpc-gen2
* [Structuring your Kubernetes environment](https://cloud.ibm.com/docs/containers?topic=containers-strategykube_env)



* [What type of cluster and flavors should I get?](https://cloud.ibm.com/docs/containers?topic=containers-strategyenv_flavors)
* [Do I use multiple clusters, or just add more workers to an existing cluster?](https://cloud.ibm.com/docs/containers?topic=containers-strategyenv_multicluster)
* [How can I set up my resources within the cluster?](https://cloud.ibm.com/docs/containers?topic=containers-strategyenv_resources)
* [How can I keep my cluster in a supported state?](https://cloud.ibm.com/docs/containers?topic=containers-strategyupdating_kube)



* [Making your resources highly available](https://cloud.ibm.com/docs/containers?topic=containers-strategykube_ha)



[Planning your cluster network setup](https://cloud.ibm.com/docs/containers?topic=containers-plan_clustersplan_clusters)

[Understanding network basics of VPC clusters](https://cloud.ibm.com/docs/containers?topic=containers-plan_vpc_basicsplan_vpc_basics)



* [Worker-to-worker communication using VPC subnets](https://cloud.ibm.com/docs/containers?topic=containers-plan_vpc_basicsvpc-worker-worker)
* [Worker-to-master and user-to-master communication using Virtual private endpoints or cloud service endpoints](https://cloud.ibm.com/docs/containers?topic=containers-plan_vpc_basicsvpc-workeruser-master)
* [Worker-to-master communication in VPC clusters](https://cloud.ibm.com/docs/containers?topic=containers-plan_vpc_basicsworker-to-master-comms)
Within the cluster, you can further organize resources by using namespaces and labels. Choose the best mix of cluster, flavors, and organization strategies so that you can make sure that your teams and workloads get the resources that they need.



 What type of cluster and flavors should I get? 

Types of clusters: Decide whether you want a [single zone, multizone, or multiple cluster setup](https://cloud.ibm.com/docs/containers?topic=containers-ha_clustersha_clusters). Multizone clusters are available in worldwide worldwide IBM Cloud [multizone regions](https://cloud.ibm.com/docs/containers?topic=containers-regions-and-zoneszones-mz). Also keep in mind that worker nodes vary by zone.

Types of worker nodes: In general, your intensive workloads are more suited to run on bare metal physical machines, whereas for cost-effective testing and development work, you might choose virtual machines on shared or dedicated hardware. [Check out the machine isolation and flavors that are available](https://cloud.ibm.com/docs/containers?topic=containers-planning_worker_nodesplanning_worker_nodes). For a list of available flavors, see [VPC Gen 2 flavors](https://cloud.ibm.com/docs/containers?topic=containers-vpc-flavors) or [Classic flavors](https://cloud.ibm.com/docs/containers?topic=containers-classic-flavors).





 Do I use multiple clusters, or just add more workers to an existing cluster? 

The number of clusters that you create depends on your workload, company policies and regulations, and what you want to do with the computing resources. You can also review security information about this decision in [Container isolation and security](https://cloud.ibm.com/docs/containers?topic=containers-securitycontainer).

Multiple clusters: You need to set up [a global load balancer](https://cloud.ibm.com/docs/containers?topic=containers-ha_clustersmultiple-clusters-glb) and copy and apply the same configuration YAML files in each to balance workloads across the clusters.
A minimal cluster with one (1) zone, one (1) worker node and the smallest available size (Flavor) is sufficient for this tutorial. The name mycluster will be used in this tutorial.

Open the [Kubernetes clusters](https://cloud.ibm.com/kubernetes/clusters) and click Create cluster. See the documentation referenced below for more details based on the cluster type. Summary:



* Click Standard tier cluster
* For Kubernetes on VPC infrastructure see reference documentation[Creating VPC clusters](https://cloud.ibm.com/docs/containers?topic=containers-cluster-create-vpc-gen2&interface=ui).



* Click Create VPC:



* Enter a name for the VPC.
* Chose the same resource group as the cluster.
* Click Create.



* Attach a Public Gateway to each of the subnets that you create:



* Navigate to the [Virtual private clouds](https://cloud.ibm.com/vpc-ext/network/vpcs).
* Click the previously created VPC used for the cluster.
* Scroll down to subnets section and click a subnet.
* In the Public Gateway section, click Detached to change the state to Attached.
* Click the browser back button to return to the VPC details page.
* Repeat the previous three steps to attach a public gateway to each subnet.





* For Kubernetes on Classic infrastructure see reference documentation [Creating classic cluster](https://cloud.ibm.com/docs/containers?topic=containers-cluster-create-classic&interface=ui).
* Choose a resource group.
* Uncheck all zones except one.
* Scale down to 1 Worker nodes per zone.
* Choose the smallest Worker Pool flavor.
* Enter a Cluster name.
* Click Create.







 Step 2: Deploy and configure a Kubernetes app to forward logs 

The ready-to-run [code for the logging app is located in this GitHub repository](https://github.com/IBM-Cloud/application-log-analysis).