vania-janet/multiturn-rag-retrieval-data huggingface dataset:
To create a VPC cluster, use the [ibmcloud oc cluster create vpc-gen2 command](https://cloud.ibm.com/docs/openshift?topic=openshift-kubernetes-service-clicli_cluster-create-vpc-gen2) 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](https://cloud.ibm.com/docs/openshift?topic=openshift-regions-and-zoneszones-mz) or [VPC](https://cloud.ibm.com/docs/openshift?topic=openshift-regions-and-zoneszones-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](https://cloud.ibm.com/docs/openshift?topic=openshift-kubernetes-service-clics_machine_types).

--name NAME
: Required: The name for the cluster. The name must start with a letter, can contain letters, numbers, periods (.)
1. Open the [Satellite console](https://cloud.ibm.com/satellite/locations) in your browser.
2. Select the location where you created your storage configuration.
3. Click the Locations tab, then click Storage.
4. Click the storage configuration that you want to assign to a cluster group.
5. On the Configuration details page, click Create storage assignment.
6. In the Create an assignment pane, enter a name for your assignment.
7. From the Version drop-down list, select the storage configuration version that you want to assign.
8. From the Cluster group drop-down list, select the cluster group that you want to assign to the storage configuration. Note that the clusters in your cluster group where you want to assign storage must all be in the same Satellite location.
9. Click Create to create the assignment.
10. Verify that your storage configuration is deployed to your cluster.



1. From the [Satellite console](https://cloud.ibm.com/satellite/locations), navigate to your Location and select Storage
2. Click the storage configuration that you created and review the Assignments tab.
3. Click the Assignment that you created and review the Rollout status for your configuration.









 Creating an assignment in the CLI 



1. List your storage configurations and make a note of the storage configuration that you want to assign to your clusters.

ibmcloud sat storage config ls
2. Get the ID of the cluster, cluster group, or service that you want to assign storage to.

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.
* Make sure that you have the correct [permissions](https://cloud.ibm.com/docs/containers?topic=containers-clusters&interface=ui) to create IBM Cloud Kubernetes Service clusters.
* [Create or use an existing cluster](https://cloud.ibm.com/docs/containers?topic=containers-clusters).
* If you want to use non-SDS worker nodes in a classic cluster [add a block storage device to your worker node](https://cloud.ibm.com/docs/containers?topic=containers-utilitiesmanual_block).
* Choose if you want to [use the internal Portworx key-value database (KVDB)](https://cloud.ibm.com/docs/containers?topic=containers-storage_portworx_kv_store) or [create a Databases for etcd service instance](https://cloud.ibm.com/docs/containers?topic=containers-storage_portworx_kv_store) to store the Portworx configuration and metadata.
* Decide whether you want to encrypt your Portworx volumes. To encrypt your volumes, you must [set up an IBM Key Protect or a Hyper Protect Crypto Services instance and store your service information in a Kubernetes secret](https://cloud.ibm.com/docs/containers?topic=containers-storage_portworx_encryption).
* Make sure that you [copied the image pull secrets from the default to the kube-system namespace](https://cloud.ibm.com/docs/containers?topic=containers-registrycopy_imagePullSecret) so that you can pull images from Container Registry. Make sure that you [add the image pull secrets to the Kubernetes service account](https://cloud.ibm.com/docs/containers?topic=containers-registrystore_imagePullSecret) of the kube-system namespace.
* Decide if you want to include your cluster in a Portworx disaster recovery configuration.
(https://cloud.ibm.com/docs/openshift?topic=openshift-faqssmallest_cluster).



8. Complete the Resource details to customize the cluster name and any tags that you want to use to organize your IBM Cloud resources.
9. In the Summary pane, review the order summary and then click Create. Your cluster creation might take some time to complete. After the cluster state shows Normal, the cluster network and load balancing components take about 10 more minutes to deploy and update the cluster domain that you use for the Red Hat OpenShift web console and other routes. Before you continue, wait until the cluster is ready by checking that the Ingress Subdomain follows a pattern of <cluster_name>.<globally_unique_account_HASH>-0001.<region>.containers.appdomain.cloud.
10. Verify that your cluster setup is finished before you continue to the next step by checking that the worker nodes on the Worker Nodes tab have a Status of normal.



Now that your cluster is ready, [deploying your first app](https://cloud.ibm.com/docs/openshift?topic=openshift-getting-starteddeploy-app)!





 Creating a VPC cluster in the console 

Create a VPC cluster by using the IBM Cloud console. VPC Red Hat OpenShift clusters run version 4.11, which includes Kubernetes version 1.25. The operating system is Red Hat Enterprise Linux 7.

Want to learn more about customizing your cluster setup with the CLI? Check out [Creating a VPC cluster](https://cloud.ibm.com/docs/openshift?topic=openshift-cluster-create-vpc-gen2).



1. Create a Virtual Private Cloud (VPC) on generation 2 compute.



1. Navigate to the [VPC create console](https://cloud.ibm.com/vpc/provision/vpc).
2. Give the VPC a name and select a resource group to deploy the VPC into.
3.
On the Browse templates page, select the Direct Upload template.
4. On the Configuration page, specify your configuration name and data location.
5. On the Version page, specify your version name and description. Then upload an existing file or use the YAML editor to paste in the file content.
6. On the Subscription page, specify your subscription name, subscription version, and cluster group to deploy to.
7. On the Summary page, confirm that the displayed information is correct and then click Complete.







 Creating Satellite configurations from the CLI 

Use the CLI plug-in for Satellite commands to create a configuration and upload the Kubernetes resource definition that you want to deploy to your clusters.

To create the configuration:



1. [Set up your clusters to use with Satellite Config](https://cloud.ibm.com/docs/satellite?topic=satellite-setup-clusters-satconfig). This setup includes creating a cluster group and granting Satellite Config access to your clusters.
2. Add clusters to your cluster group. The clusters can run in your location or in IBM Cloud.



1. List the clusters that are registered with the Satellite Config component and note their ID.

ibmcloud sat cluster ls
2. Add the cluster to your cluster group.

ibmcloud sat group attach --cluster <cluster_ID> --group <cluster_group_name>
3. Verify that your cluster is successfully added to your cluster group.

ibmcloud sat group get --group <cluster_group_name>



3. Create a Satellite configuration.

ibmcloud sat config create --name <config_name> [--data-location <location>] [-q]



Understanding this command's components

 Component Description 

 --name <config_name> Enter the name of the Satellite configuration. 
 --data-location <location> Enter the location to store your Satellite configurations, for example us-east.
Select the location and zone where you want to create the subnet.
4. Specify the number of IP addresses to create.



* VPC subnets provide IP addresses for your worker nodes and load balancer services in the cluster, so [create a VPC subnet with enough IP addresses](https://cloud.ibm.com/docs/containers?topic=containers-vpc-subnetsvpc_basics_subnets), such as 256. You can't change the number of IPs that a VPC subnet has later.
* If you enter a specific IP range and running Kubernetes 1.20 or earlier ., don't use the following reserved ranges: 172.16.0.0/16, 172.18.0.0/16, 172.19.0.0/16, and 172.20.0.0/16.



5. Choose if you want to attach a public network gateway to your subnet. A public network gateway is required when you want your cluster to access public endpoints, such as a public URL of another app, or an IBM Cloud service that supports public cloud service endpoints only.
6. Click Create subnet.
7. Use the subnet to [create a cluster](https://cloud.ibm.com/docs/containers?topic=containers-cluster-create-vpc-gen2), [create a new worker pool](https://cloud.ibm.com/docs/containers?topic=containers-add_workersvpc_add_pool), or [add the subnet to an existing worker pool](https://cloud.ibm.com/docs/containers?topic=containers-add_workersvpc_add_zone).> Do not delete the subnets that you attach to your cluster during cluster creation or when you add worker nodes in a zone. If you delete a VPC subnet that your cluster used, any load balancers that use IP addresses from the subnet might experience issues, and you might be unable to create new load balancers.







 Creating a VPC subnet in the CLI
* [Creating Red Hat OpenShift clusters on Satellite from the console](https://cloud.ibm.com/docs/openshift?topic=openshift-satellite-clusterssatcluster-create-console)
* [Creating Red Hat OpenShift clusters on Satellite from the CLI](https://cloud.ibm.com/docs/openshift?topic=openshift-satellite-clusterssatcluster-create-cli)
* [Creating single-node clusters for resource-constrained edge locations](https://cloud.ibm.com/docs/openshift?topic=openshift-satellite-clusterssingle-node)



* [Limitations](https://cloud.ibm.com/docs/openshift?topic=openshift-satellite-clusterssingle-node-limitations)
* [Requirements](https://cloud.ibm.com/docs/openshift?topic=openshift-satellite-clusterssingle-node-requirements)
* [Creating a single-node cluster](https://cloud.ibm.com/docs/openshift?topic=openshift-satellite-clusterssingle-node-create)



* [Accessing and working with your Satellite clusters](https://cloud.ibm.com/docs/openshift?topic=openshift-satellite-clusterssatcluster-access)
* [Setting up the internal container image registry](https://cloud.ibm.com/docs/openshift?topic=openshift-satellite-clusterssatcluster-internal-registry)



* [Setting up the internal container image registry with IBM Cloud Object Storage](https://cloud.ibm.com/docs/openshift?topic=openshift-satellite-clusterssatcluster-internal-registry-cos)



* [Exposing apps](https://cloud.ibm.com/docs/openshift?topic=openshift-satellite-clusterssatcluster-expose-apps)
Review the Portworx pricing information.
3. Enter a name for your Portworx service instance.
4. Select the resource group that your cluster is in.
5. In the Tag field, enter the name of the cluster where you want to install Portworx. After you create the Portworx service instance, you can't see the cluster that you installed Portworx into. To find the cluster more easily later, make sure that you enter the cluster name and any additional information as tags.
6. Enter an IBM Cloud API key to retrieve the list of clusters that you have access to. If you don't have an API key, see [Managing user API keys](https://cloud.ibm.com/docs/account?topic=account-userapikey). After you enter the API key, the Kubernetes or OpenShift cluster name field appears.
7. Enter a unique Portworx cluster name.
8. In the Cloud Drives menu:



1. Select Use Cloud Drives (VPC Clusters only) to dynamically provision Block Storage for VPC for Portworx. After selecting Use Cloud Drives, select the Storage class name and the Size of the block storage drives that you want to provision.
2. Select Use Already Attached Drives (Classic, VPC, or Satellite) to use the block storage that is already attached to your worker nodes.



9. From the Portworx metadata key-value store drop down, choose the type of key-value store that you want to use to store Portworx metadata. Select Portworx KVDB to automatically create a key-value store during the Portworx installation, or select Databases for etcd if you want to use an existing Databases for etcd instance. If you choose Databases for etcd, the Etcd API endpoints and Etcd secret name fields appear.
10. Namespace: Enter the namespace where you want to deploy the Portworx resources.
11. Required for Databases for etcd only: Enter the information of your Databases for etcd service instance.



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





To set up a monitoring configuration for your cluster:



1. Create an [IBM Cloud Monitoring service instance](https://cloud.ibm.com/docs/monitoring?topic=monitoring-provision) and note the name of the instance. The service instance must belong to the same IBM Cloud account where you created your cluster, but can be in a different resource group and IBM Cloud region than your cluster.
2. Set up a monitoring configuration for your cluster. When you create the monitoring configuration, a Kubernetes namespace ibm-observe is created and a Monitoring agent is deployed as a Kubernetes daemon set to all worker nodes in your cluster. This agent collects cluster and pod metrics, such as the worker node CPU and memory usage, or the amount incoming and outgoing network traffic to your pods.

In the console.



1. From the [Kubernetes clusters console](https://cloud.ibm.com/kubernetes/clusters), select the cluster for which you want to create a Monitoring configuration.
2. On the cluster Overview page, click Connect.
3. Select the region and the IBM Cloud Monitoring service instance that you created earlier, and click Connect.



In the CLI.



1. Create the Monitoring configuration. When you create the Monitoring configuration, the access key that was last added is retrieved automatically. If you want to use a different access key, add the --sysdig-access-key <access_key> option to the command.

To use a different service access key after you created the monitoring configuration, use the [ibmcloud ob monitoring config replace](https://cloud.ibm.com/docs/containers?topic=containers-observability_climonitoring_config_replace) command.

ibmcloud ob monitoring config create --cluster <cluster_name_or_ID> --instance <Monitoring_instance_name_or_ID>

Example output

Creating configuration...
[Attach a cluster to a cluster group](https://cloud.ibm.com/docs/satellite?topic=satellite-setup-clusters-satconfigsetup-clusters-satconfig-access), which grants Satellite Config access to manage the resources within the cluster.



As an advanced configuration, you can also deploy the application to the compute infrastructure in your on-premises data center or other cloud providers by using [IBM Cloud Satellite](https://cloud.ibm.com/docs/satellite?topic=satellite-getting-started).



1. [Create a Satellite location](https://cloud.ibm.com/satellite/locations/create) for the compute infrastructure in your on-premises data center or other cloud providers by using predefined templates.
2. [Deploy a Red Hat® OpenShift® cluster](https://cloud.ibm.com/kubernetes/catalog/create?platformType=openshift) to the Satellite location by using setup.
3. [Create a cluster group](https://cloud.ibm.com/docs/satellite?topic=satellite-setup-clusters-satconfigsetup-clusters-satconfig-groups), which is a logical grouping of clusters that run on a Satellite location.
4. [Attach a cluster to a cluster group](https://cloud.ibm.com/docs/satellite?topic=satellite-setup-clusters-satconfigsetup-clusters-satconfig-access), which grants Satellite Config access to manage the resources within the cluster.





 Prerequisites 



* This toolchain uses [Satellite Config](https://cloud.ibm.com/docs/satellite?topic=satellite-cluster-config) to deploy an application to a group of clusters.
* This toolchain assumes that you have a [Satellite cluster group](https://cloud.ibm.com/docs/satellite?topic=satellite-setup-clusters-satconfig) with the required clusters.
* This toolchain supports a Satellite cluster group that contains only one type of cluster (Red Hat® OpenShift®).







 Deployment
- <device-by-id> Example: dev/disk/by-id/scsi-2222222a22a22a22222a2aa222a22a2a2-part2
2. Save the file and create the OcsCluster custom resource to your cluster.

oc create -f <ocs_cluster_filename>
3. Verify that your OcsCluster custom resource is running.

oc describe OcsCluster ocscluster
4. [Deploy an app that uses ODF](https://cloud.ibm.com/docs/openshift?topic=openshift-odf-deploy-app)







 Parameter reference 

Refer to the following OpenShift Data Foundation parameters when you use the add-on or operator in classic clusters.



 Version 4.13 parameters 



Classic parameter reference for 4.10 to 4.12

 Parameter Description Default value 

 name Note that Kubernetes resource names can't contain capital letters or special characters. Enter a name for your resource that uses only lowercase letters, numbers, - or . N/A 
 osdStorageClassName Enter localblock. N/A 
 osdSize Enter a size for your storage devices. Example: 100Gi. The total storage capacity of your ODF cluster is equivalent to the osdSize multiplied by the numOfOsd. N/A 
 osdDevicePaths Enter a comma separated list of the device paths for the devices that you want to use for the OSD devices. The devices that you specify are used as your application storage in your configuration. Each device must have at least 100GiB of space and must be unformatted and unmounted. The parameter format is /dev/disk/by-id/<device-id>. Example device path value for a partitioned device: /dev/disk/by-id/scsi-0000000a00a00a00000a0aa000a00a0a0-part2. If you specify more than one device path, be sure there are no spaces between each path.
* [odf-remote](https://cloud.ibm.com/docs/satellite?topic=satellite-storage-odf-remote): Choose this template if you have a CSI driver installed in your cluster. For example, the azuredisk-csi-driver driver. You can use the CSI driver to dynamically provision storage volumes when deploying ODF.







 Prerequisites for using ODF for remote devices 



1. Make sure you have the following permissions.



* Editor for the Billing service.
* Manager and Editor for Kubernetes service.
* Satellite Link Administrator and Reader for the Satellite service.



2. Before you can create a storage configuration, follow the steps to set up a [Satellite location](https://cloud.ibm.com/docs/satellite?topic=satellite-locations).
3. [Create a Satellite cluster](https://cloud.ibm.com/docs/satellite?topic=openshift-satellite-clusters).



* Make sure that you select the Enable cluster admin access for Satellite Config option when you create the cluster. If you don't enable Administrator (admin) access for Satellite Config when creating your cluster, you must re-create your cluster and enable admin access before you can deploy storage.



4. Your cluster must have a minimum of 3 worker nodes with at least 16CPUs and 64GB RAM per worker node.
5. Your cluster must have a remote block storage provisioner available. For example, you can deploy the [AWS EBS](https://cloud.ibm.com/docs/satellite?topic=satellite-storage-aws-ebs-csi-driver) Satellite storage template to install the EBS block drivers that you can then use to provision AWS EBS volumes for ODF.
6. The OCP version must be compatible with the ODF template version that you want to install. For example, for version 4.8 clusters, you must use template version 4.8.
7.
ibmcloud ks cluster config --cluster my_cluster







 ibmcloud ks cluster create classic 

Classic infrastructure

Create a cluster with worker nodes on classic infrastructure. For free clusters, you specify the cluster name; everything else is set to a default value. A free cluster is automatically deleted after 30 days. You can have one free cluster at a time. To take advantage of the full capabilities of Kubernetes, create a standard cluster.

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

To create a VPC cluster, use the [ibmcloud ks cluster create vpc-gen2 command](https://cloud.ibm.com/docs/cli?topic=cli-kubernetes-service-clicli_cluster-create-vpc-gen2) 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. This value is optional for VM standard clusters and is not available for free clusters.
Then, create your worker pool by using the reserved instances. Note that autoscaling can't be enable on worker pools that use reservations.



 Creating a new worker pool 

You can add worker nodes to your classic cluster by creating a new worker pool.

Before you begin, make sure that you have the [Operator or Administrator IBM Cloud IAM platform access role](https://cloud.ibm.com/docs/openshift?topic=openshift-users).



1. Retrieve the Worker Zones of your cluster and choose the zone where you want to deploy the worker nodes in your worker pool. If you have a single zone cluster, you must use the zone that you see in the Worker Zones field. For multizone clusters, you can choose any of the existing Worker Zones of your cluster, or add one of the [multizone locations](https://cloud.ibm.com/docs/openshift?topic=openshift-regions-and-zoneszones-mz) for the region that your cluster is in. You can list available zones by running ibmcloud oc zone ls.

ibmcloud oc cluster get --cluster <cluster_name_or_ID>

Example output

...
Worker Zones: dal10, dal12, dal13
2. For each zone, list available private and public VLANs. Note the private and the public VLAN that you want to use. If you don't have a private or a public VLAN, the VLAN is automatically created for you when you add a zone to your worker pool.

ibmcloud oc vlan ls --zone <zone>
3. For each zone, review the [available flavors for worker nodes](https://cloud.ibm.com/docs/openshift?topic=openshift-planning_worker_nodesplanning_worker_nodes).

ibmcloud oc flavors --zone <zone>
4. Create a worker pool.