Creating an OpenShift Virtualization Service cluster

Required tools for console users

• Access to the IBM Cloud console
• Optional: OpenShift CLI (oc) for verifying the cluster after creation

Required tools for CLI users

• IBM Cloud CLI
• IBM Cloud Kubernetes Service CLI plugin
• OpenShift CLI (oc)

Creating VPC resources from the console

If you don't have the required VPC infrastructure, create it from the console.

1. Create a VPC in the region where you want to create the cluster.

2. Create subnets in each zone where you want to deploy worker nodes.

   • Create subnets in at least 3 zones for high availability
   • Create VPC subnets with enough IP addresses, such as 256

3. Verify bare metal capacity in your selected zones by checking the available flavors when you create your cluster in the next step.

Creating VPC resources from the CLI

If you don't have the required VPC infrastructure, create it from the CLI.

1. Create a VPC in the region where you want to create the cluster.

2. Create subnets in each zone where you want to deploy worker nodes.

   • Create subnets in at least 3 zones for high availability
   • Create VPC subnets with enough IP addresses, such as 256

3. Verify that bare metal capacity is available in your selected zones.

   ibmcloud ks flavors --zone <zone> --provider vpc-gen2 | grep metal
   

   Look for bare metal flavors ending in d, which indicates local NVME storage required for OpenShift Data Foundation. To verify that a specific flavor supports Virtualization Service, run ibmcloud ks flavor get --flavor <flavor> --zone <zone> --provider vpc-gen2 and check for the openshift-vs tag in the output. For a complete list of supported flavors, see Worker node flavors.

Creating a cluster from the console

1. In the IBM Cloud console, navigate to Infrastructure > OpenShift virtualization.

2. Click Create cluster.

3. Review the pre-configured cluster settings:

   The following settings are automatically configured for OpenShift Virtualization Service clusters and cannot be changed:

   • Orchestrator: Red Hat OpenShift on IBM Cloud
   • Infrastructure: VPC
   • Machine type: Bare metal
   • Operating system: Red Hat CoreOS (RHCOS)
   • Networking plugin: Open Virtual Network (OVN-Kubernetes)

4. Select the OpenShift version:

   OpenShift Virtualization requires version 4.21 or later. The latest supported version is automatically selected.

5. Configure Virtualization integrations:

   Extend your cluster with key virtualization components. These integrations are connected once the cluster provisioning is complete.

   OpenShift Virtualization operator

   Required. Automatically configured with default settings. Creates and maintains OpenShift Virtualization Deployment.

   Advanced Cluster Management (ACM)

   Optional. Configure this cluster as the ACM hub cluster to control and monitor other Kubernetes clusters.

   • Plan: ACM for Virtualization
   • Managed clusters: Import later
   • Disaster recovery: For disaster recovery, install ODF on a separate managed cluster

   OpenShift Data Foundation (ODF)

   Recommended. Provides portable and scalable software-defined file, block, and object persistent storage for your container workloads. Configured with default settings.

   • Version: Latest available
   • Plan: Advanced
   • Storage type: Local Storage

   File Storage for VPC

   Beta: Alternative to ODF. Provides file storage backed by VPC infrastructure. File Storage for VPC support is available as a beta feature.

   You must select at least one storage option (ODF or File Storage for VPC) to provision a Virtualization Service cluster.

6. Select your Virtual private cloud:

   Choose an existing VPC or create a new one. If no VPCs are available, you'll need to create one before proceeding.

7. Configure the Location:

   Choose your worker zones and configure your subnets. Select the Zones where you want to deploy worker nodes (at least 3 zones for high availability). For each selected zone, you can edit the automatically selected Subnet as needed.

8. Configure the Worker pool:

   Set up a worker pool with the flavor and number of worker nodes that you want to run your first workload.

   Flavor

   Select a supported bare metal flavor with local NVME storage (e.g., bx2d.metal.96x384).

   Only bare metal flavors with the openshift-vs tag are available. These flavors include local NVME storage required for OpenShift Data Foundation.

   Worker nodes per zone

   Specify the number of worker nodes per zone (minimum 3 recommended for high availability).

   Worker pool encryption

   Optional. Manage the encryption of the worker nodes by enabling a key management service (KMS) provider at the worker pool level.

   • Select the root key by Instance
   • Choose a root key CRN for encryption

9. Configure Networking:

   Network plugin

   Open Virtual Network (OVN-Kubernetes) is automatically configured and cannot be changed.

   OVN-Kubernetes provides advanced, distributed virtual networking with native support for logical switches, routers, and security policies.

   Network settings

   Set up network communication to the master.

   • Both private & public endpoints: Communication to the master is accessible from the internet to your private and public network (default)
   • Private endpoint only: Communication is established securely to authorized cluster users in your private network, IBM Cloud services, or through a VPC VPN connection

   Internal registry

   Store images in the cluster internal registry with IBM Cloud Object Storage. A COS bucket will automatically be created for your cluster's internal registry.

   • Select an existing Cloud Object Storage instance or create a new one

10. Configure Security settings:

    Outbound traffic protection

    Optional. Protect network traffic by enabling only the connectivity necessary for the cluster to operate and preventing access to the public Internet.

    This setting is disabled by default for Virtualization Service clusters.

    Cluster encryption

    Optional. Enable a key management service (KMS) provider to encrypt the secrets in your cluster.

    • Select the root key by Instance
    • Choose a root key CRN for encryption

    Ingress secrets management

    Optional. Register an IBM Cloud Secrets Manager instance to the cluster for managing ingress subdomain certificates and secrets.

    Service authorization is required to allow OpenShift to communicate with Secrets Manager. Click Authorize now to create a policy scoped to all resources in this account, or go to IAM to create a policy with custom scoping.

    VPC security groups

    Optional. Provide up to four custom security groups to apply to all worker nodes on the VPC cluster instead of the default VPC security group. The default VPC security group will not be applied.

11. Configure Cluster details:

**Cluster name**
:   Enter a unique name for your cluster (e.g., `my-vs-cluster`).

**Resource group**
:   Select the resource group where you want to create the cluster.

**Tags**
:   Optional. Add tags to organize and manage your cluster resources.

12. Review the Integrations section:

Get more from your cluster by connecting integrations. Verify that the OpenShift Virtualization operator and any selected add-ons (ACM, ODF, or File Storage) are listed.

13. Review the Summary and estimated cost:

The summary shows:
- Number of worker nodes and their configuration
- Operating system (RHCOS)
- ROVE license fee
- Total estimated monthly cost

Additional charges for networking and bandwidth might apply. Estimate does not include usage-based charges.
{: note}

14. Click Create to provision your cluster.

15. Monitor the cluster creation progress in the IBM Cloud console. The cluster typically takes 30-45 minutes to provision.

Access the cluster from the console

1. In the IBM Cloud console, navigate to OpenShift > Clusters.

2. Click your cluster name to view details.

3. Verify that the cluster State shows Normal and the master status shows Ready.

4. Click OpenShift web console to access the cluster interface.

5. Optional: To use the CLI, click Actions > Connect via CLI for instructions.

Access the cluster from the CLI

1. Configure your CLI to use the cluster:

   ibmcloud ks cluster config --cluster <cluster-name> --admin
   

2. Verify cluster access:

   oc get nodes
   

Verify OpenShift Virtualization from the console

1. In the OpenShift web console, navigate to Ecosystem > Installed Operators.

2. Verify that the OpenShift Virtualization operator shows a status of Succeeded. You might need to select Show default projects to see the openshift-cnv project.

3. In the left navigation of the OpenShift web console, click Virtualization.

4. Verify that the Virtualization pages load without prompts to install additional operators.

Verify OpenShift Virtualization from the CLI

1. Check the OpenShift Virtualization Operator:

   oc get csv -n openshift-cnv
   

   Look for kubevirt-hyperconverged-operator with PHASE: Succeeded.

2. Verify the HyperConverged resource:

   oc get hyperconverged -n openshift-cnv
   

   The PHASE should show Deployed.

3. Check virtualization pods:

   oc get pods -n openshift-cnv
   

   All pods should be in Running or Completed state.

Access from the console

1. In the IBM Cloud console, navigate to OpenShift > Clusters.

2. Click your cluster name.

3. Click OpenShift web console to open the cluster interface.

4. In the left navigation, click Virtualization to access the virtual machine management interface.

5. Explore the available options:

   • Overview: Dashboard showing VM statistics
   • VirtualMachines: List and manage VMs
   • Templates: Pre-configured VM templates
   • InstanceTypes: VM sizing configurations
   • Preferences: VM preference settings

Access from the CLI

1. Get the OpenShift console URL:

   ibmcloud ks cluster get --cluster $CLUSTER_NAME | grep "Public Service Endpoint URL"
   

2. Log in to the OpenShift web console using your IBM Cloud credentials.

3. In the left navigation, click Virtualization to access the virtual machine management interface.

4. Explore the available options:

   • Overview: Dashboard showing VM statistics
   • VirtualMachines: List and manage VMs
   • Templates: Pre-configured VM templates
   • InstanceTypes: VM sizing configurations
   • Preferences: VM preference settings