Chapter 3. Getting started
3.1. Getting started with OpenShift Virtualization
You can explore the features and functionalities of OpenShift Virtualization by installing and configuring a basic environment.
Cluster configuration procedures require cluster-admin
privileges.
3.1.1. Planning and installing OpenShift Virtualization
Plan and install OpenShift Virtualization on an OpenShift Container Platform cluster:
Planning and installation resources
3.1.2. Creating and managing virtual machines
Create a virtual machine (VM):
Create a VM from a Red Hat image.
You can create a VM by using a Red Hat template or an instance type.
{FeatureName} is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.
For more information about the support scope of Red Hat Technology Preview features, see Technology Preview Features Support Scope.
Create a VM from a custom image.
You can create a VM by importing a custom image from a container registry or a web page, by uploading an image from your local machine, or by cloning a persistent volume claim (PVC).
Connect a VM to a secondary network:
- Linux bridge network.
- Open Virtual Network (OVN)-Kubernetes secondary network.
Single Root I/O Virtualization (SR-IOV) network.
NoteVMs are connected to the pod network by default.
Connect to a VM:
- Connect to the serial console or VNC console of a VM.
- Connect to a VM by using SSH.
- Connect to the desktop viewer for Windows VMs.
Manage a VM:
3.1.3. Next steps
3.2. Using the virtctl and libguestfs CLI tools
You can manage OpenShift Virtualization resources by using the virtctl
command line tool.
You can access and modify virtual machine (VM) disk images by using the libguestfs
command line tool. You deploy libguestfs
by using the virtctl libguestfs
command.
3.2.1. Installing virtctl
To install virtctl
on Red Hat Enterprise Linux (RHEL) 9, Linux, Windows, and MacOS operating systems, you download and install the virtctl
binary file.
To install virtctl
on RHEL 8, you enable the OpenShift Virtualization repository and then install the kubevirt-virtctl
package.
3.2.1.1. Installing the virtctl binary on RHEL 9, Linux, Windows, or macOS
You can download the virtctl
binary for your operating system from the OpenShift Container Platform web console and then install it.
Procedure
-
Navigate to the Virtualization
Overview page in the web console. -
Click the Download virtctl link to download the
virtctl
binary for your operating system. Install
virtctl
:For RHEL 9 and other Linux operating systems:
Decompress the archive file:
$ tar -xvf <virtctl-version-distribution.arch>.tar.gz
Run the following command to make the
virtctl
binary executable:$ chmod +x <path/virtctl-file-name>
Move the
virtctl
binary to a directory in yourPATH
environment variable.You can check your path by running the following command:
$ echo $PATH
Set the
KUBECONFIG
environment variable:$ export KUBECONFIG=/home/<user>/clusters/current/auth/kubeconfig
For Windows:
- Decompress the archive file.
-
Navigate the extracted folder hierarchy and double-click the
virtctl
executable file to install the client. Move the
virtctl
binary to a directory in yourPATH
environment variable.You can check your path by running the following command:
C:\> path
For macOS:
- Decompress the archive file.
Move the
virtctl
binary to a directory in yourPATH
environment variable.You can check your path by running the following command:
echo $PATH
3.2.1.2. Installing the virtctl RPM on RHEL 8
You can install the virtctl
RPM package on Red Hat Enterprise Linux (RHEL) 8 by enabling the OpenShift Virtualization repository and installing the kubevirt-virtctl
package.
Prerequisites
- Each host in your cluster must be registered with Red Hat Subscription Manager (RHSM) and have an active OpenShift Container Platform subscription.
Procedure
Enable the OpenShift Virtualization repository by using the
subscription-manager
CLI tool to run the following command:# subscription-manager repos --enable cnv-4.14-for-rhel-8-x86_64-rpms
Install the
kubevirt-virtctl
package by running the following command:# yum install kubevirt-virtctl
3.2.2. virtctl commands
The virtctl
client is a command-line utility for managing OpenShift Virtualization resources.
The virtual machine (VM) commands also apply to virtual machine instances (VMIs) unless otherwise specified.
3.2.2.1. virtctl information commands
You use virtctl
information commands to view information about the virtctl
client.
Command | Description |
---|---|
|
View the |
|
View a list of |
| View a list of options for a specific command. |
|
View a list of global command options for any |
3.2.2.2. VM information commands
You can use virtctl
to view information about virtual machines (VMs) and virtual machine instances (VMIs).
Command | Description |
---|---|
| View the file systems available on a guest machine. |
| View information about the operating systems on a guest machine. |
| View the logged-in users on a guest machine. |
3.2.2.3. VM management commands
You use virtctl
virtual machine (VM) management commands to manage and migrate virtual machines (VMs) and virtual machine instances (VMIs).
Command | Description |
---|---|
|
Create a |
| Start a VM. |
| Start a VM in a paused state. This option enables you to interrupt the boot process from the VNC console. |
| Stop a VM. |
| Force stop a VM. This option might cause data inconsistency or data loss. |
| Pause a VM. The machine state is kept in memory. |
| Unpause a VM. |
| Migrate a VM. |
| Cancel a VM migration. |
| Restart a VM. |
|
Create an |
|
Create a |
3.2.2.4. VM connection commands
You use virtctl
connection commands to expose ports and connect to virtual machines (VMs) and virtual machine instances (VMIs).
Command | Description |
---|---|
| Connect to the serial console of a VM. |
| Create a service that forwards a designated port of a VM and expose the service on the specified port of the node.
Example: |
| Copy a file from your machine to a VM. This command uses the private key of an SSH key pair. The VM must be configured with the public key. |
| Copy a file from a VM to your machine. This command uses the private key of an SSH key pair. The VM must be configured with the public key. |
| Open an SSH connection with a VM. This command uses the private key of an SSH key pair. The VM must be configured with the public key. |
| Connect to the VNC console of a VM.
You must have |
| Display the port number and connect manually to a VM by using any viewer through the VNC connection. |
| Specify a port number to run the proxy on the specified port, if that port is available. If a port number is not specified, the proxy runs on a random port. |
3.2.2.5. VM export commands
Use virtctl vmexport
commands to create, download, or delete a volume exported from a VM, VM snapshot, or persistent volume claim (PVC). Certain manifests also contain a header secret, which grants access to the endpoint to import a disk image in a format that OpenShift Virtualization can use.
Command | Description |
---|---|
|
Create a
|
|
Delete a |
|
Download the volume defined in a
Optional:
|
|
Create a |
| Retrieve the manifest for an existing export. The manifest does not include the header secret. |
| Create a VM export for a VM example, and retrieve the manifest. The manifest does not include the header secret. |
| Create a VM export for a VM snapshot example, and retrieve the manifest. The manifest does not include the header secret. |
| Retrieve the manifest for an existing export. The manifest includes the header secret. |
| Retrieve the manifest for an existing export in json format. The manifest does not include the header secret. |
| Retrieve the manifest for an existing export. The manifest includes the header secret and writes it to the file specified. |
3.2.2.6. VM memory dump commands
You can use the virtctl memory-dump
command to output a VM memory dump on a PVC. You can specify an existing PVC or use the --create-claim
flag to create a new PVC.
Prerequisites
-
The PVC volume mode must be
FileSystem
. The PVC must be large enough to contain the memory dump.
The formula for calculating the PVC size is
(VMMemorySize + 100Mi) * FileSystemOverhead
, where100Mi
is the memory dump overhead.You must enable the hot plug feature gate in the
HyperConverged
custom resource by running the following command:$ oc patch hyperconverged kubevirt-hyperconverged -n openshift-cnv \ --type json -p '[{"op": "add", "path": "/spec/featureGates", \ "value": "HotplugVolumes"}]'
Downloading the memory dump
You must use the virtctl vmexport download
command to download the memory dump:
$ virtctl vmexport download <vmexport_name> --vm|pvc=<object_name> \ --volume=<volume_name> --output=<output_file>
Command | Description |
---|---|
|
Save the memory dump of a VM on a PVC. The memory dump status is displayed in the Optional:
|
|
Rerun the This command overwrites the previous memory dump. |
| Remove a memory dump. You must remove a memory dump manually if you want to change the target PVC.
This command removes the association between the VM and the PVC, so that the memory dump is not displayed in the |
3.2.2.7. Hot plug and hot unplug commands
You use virtctl
to add or remove resources from running virtual machines (VMs) and virtual machine instances (VMIs).
Command | Description |
---|---|
| Hot plug a data volume or persistent volume claim (PVC). Optional:
|
| Hot unplug a virtual disk. |
| Hot plug a Linux bridge network interface. |
| Hot unplug a Linux bridge network interface. |
3.2.2.8. Image upload commands
You use the virtctl image-upload
commands to upload a VM image to a data volume.
Command | Description |
---|---|
| Upload a VM image to a data volume that already exists. |
| Upload a VM image to a new data volume of a specified requested size. |
3.2.3. Deploying libguestfs by using virtctl
You can use the virtctl guestfs
command to deploy an interactive container with libguestfs-tools
and a persistent volume claim (PVC) attached to it.
Procedure
To deploy a container with
libguestfs-tools
, mount the PVC, and attach a shell to it, run the following command:$ virtctl guestfs -n <namespace> <pvc_name> 1
- 1
- The PVC name is a required argument. If you do not include it, an error message appears.
3.2.3.1. Libguestfs and virtctl guestfs commands
Libguestfs
tools help you access and modify virtual machine (VM) disk images. You can use libguestfs
tools to view and edit files in a guest, clone and build virtual machines, and format and resize disks.
You can also use the virtctl guestfs
command and its sub-commands to modify, inspect, and debug VM disks on a PVC. To see a complete list of possible sub-commands, enter virt-
on the command line and press the Tab key. For example:
Command | Description |
---|---|
| Edit a file interactively in your terminal. |
| Inject an ssh key into the guest and create a login. |
| See how much disk space is used by a VM. |
| See the full list of all RPMs installed on a guest by creating an output file containing the full list. |
|
Display the output file list of all RPMs created using the |
| Seal a virtual machine disk image to be used as a template. |
By default, virtctl guestfs
creates a session with everything needed to manage a VM disk. However, the command also supports several flag options if you want to customize the behavior:
Flag Option | Description |
---|---|
|
Provides help for |
| To use a PVC from a specific namespace.
If you do not use the
If you do not include a |
|
Lists the
You can configure the container to use a custom image by using the |
|
Indicates that
By default,
If a cluster does not have any
If not set, the |
|
Shows the pull policy for the
You can also overwrite the image’s pull policy by setting the |
The command also checks if a PVC is in use by another pod, in which case an error message appears. However, once the libguestfs-tools
process starts, the setup cannot avoid a new pod using the same PVC. You must verify that there are no active virtctl guestfs
pods before starting the VM that accesses the same PVC.
The virtctl guestfs
command accepts only a single PVC attached to the interactive pod.
3.3. Web console overview
The Virtualization section of the OpenShift Container Platform web console contains the following pages for managing and monitoring your OpenShift Virtualization environment.
Page | Description |
---|---|
Manage and monitor the OpenShift Virtualization environment. | |
Create virtual machines from a catalog of templates. | |
Create and manage virtual machines. | |
Create and manage templates. | |
Create and manage virtual machine instance types. | |
Create and manage virtual machine preferences. | |
Create and manage DataSources for bootable volumes. | |
Create and manage migration policies for workloads. |
Icon | Description |
---|---|
| Edit icon |
| Link icon |
3.3.1. Overview page
The Overview page displays resources, metrics, migration progress, and cluster-level settings.
Example 3.1. Overview page
Element | Description |
---|---|
Download virtctl |
Download the |
Resources, usage, alerts, and status. | |
Top consumers of CPU, memory, and storage resources. | |
Status of live migrations. | |
The Settings tab contains the Cluster tab and the User tab. | |
Settings | OpenShift Virtualization version, update status, live migration, templates project, preview features, and load balancer service settings. |
Settings | Authorized SSH keys, user permissions, and welcome information settings. |
3.3.1.1. Overview tab
The Overview tab displays resources, usage, alerts, and status.
Example 3.2. Overview tab
Element | Description |
---|---|
Getting started resources card |
|
Memory tile | Memory usage, with a chart showing the last 7 days' trend. |
Storage tile | Storage usage, with a chart showing the last 7 days' trend. |
VirtualMachines tile | Number of virtual machines, with a chart showing the last 7 days' trend. |
vCPU usage tile | vCPU usage, with a chart showing the last 7 days' trend. |
VirtualMachine statuses tile | Number of virtual machines, grouped by status. |
Alerts tile | OpenShift Virtualization alerts, grouped by severity. |
VirtualMachines per resource chart | Number of virtual machines created from templates and instance types. |
3.3.1.2. Top consumers tab
The Top consumers tab displays the top consumers of CPU, memory, and storage.
Example 3.3. Top consumers tab
Element | Description |
---|---|
View virtualization dashboard |
Link to Observe |
Time period list | Select a time period to filter the results. |
Top consumers list | Select the number of top consumers to filter the results. |
CPU chart | Virtual machines with the highest CPU usage. |
Memory chart | Virtual machines with the highest memory usage. |
Memory swap traffic chart | Virtual machines with the highest memory swap traffic. |
vCPU wait chart | Virtual machines with the highest vCPU wait periods. |
Storage throughput chart | Virtual machines with the highest storage throughput usage. |
Storage IOPS chart | Virtual machines with the highest storage input/output operations per second usage. |
3.3.1.3. Migrations tab
The Migrations tab displays the status of virtual machine migrations.
Example 3.4. Migrations tab
Element | Description |
---|---|
Time period list | Select a time period to filter virtual machine migrations. |
VirtualMachineInstanceMigrations information table | List of virtual machine migrations. |
3.3.1.4. Settings tab
The Settings tab displays cluster-wide settings.
Example 3.5. Tabs on the Settings tab
Tab | Description |
---|---|
OpenShift Virtualization version and update status, live migration, templates project, preview features, and load balancer service settings. | |
Authorized SSH key management, user permissions, and welcome information settings. |
3.3.1.4.1. Cluster tab
The Cluster tab displays the OpenShift Virtualization version and update status. You configure preview features, live migration, and other settings on the Cluster tab.
Example 3.6. Cluster tab
Element | Description |
---|---|
Installed version | OpenShift Virtualization version. |
Update status | OpenShift Virtualization update status. |
Channel | OpenShift Virtualization update channel. |
Preview features section | Expand this section to manage preview features. Preview features are disabled by default and must not be enabled in production environments. |
Live Migration section | Expand this section to configure live migration settings. |
Live Migration | Select the maximum number of live migrations per cluster. |
Live Migration | Select the maximum number of live migrations per node. |
Live Migration | Select a dedicated secondary network for live migration. |
Automatic subscription of new RHEL VirtualMachines section | Expand this section to enable automatic subscription for Red Hat Enterprise Linux (RHEL) virtual machines. To enable this feature, you need cluster administrator permissions, an organization ID, and an activation key. |
LoadBalancer section | Expand this section to enable the creation of load balancer services for SSH access to virtual machines. The cluster must have a load balancer configured. |
Template project section |
Expand this section to select a project for Red Hat templates. The default project is To store Red Hat templates in multiple projects, clone the template and then select a project for the cloned template. |
3.3.1.4.2. User tab
You view user permissions and manage authorized SSH keys and welcome information on the User tab.
Example 3.7. User tab
Element | Description |
---|---|
Manage SSH keys section | Expand this section to add authorized SSH keys to a project. The keys are added automatically to all virtual machines that you subsequently create in the selected project. |
Permissions section | Expand this section to view cluster-wide user permissions. |
Welcome information section | Expand this section to show or hide the Welcome information dialog. |
3.3.2. Catalog page
You create a virtual machine from a template or instance type on the Catalog page.
Example 3.8. Catalog page
Element | Description |
---|---|
Displays a catalog of templates for creating a virtual machine. | |
Displays bootable volumes and instance types for creating a virtual machine. |
3.3.2.1. Template catalog tab
You select a template on the Template catalog tab to create a virtual machine.
Example 3.9. Template catalog tab
Element | Description |
---|---|
Template project list | Select the project in which Red Hat templates are located.
By default, Red Hat templates are stored in the |
All items|Default templates | Click All items to display all available templates. |
Boot source available checkbox | Select the checkbox to display templates with an available boot source. |
Operating system checkboxes | Select checkboxes to display templates with selected operating systems. |
Workload checkboxes | Select checkboxes to display templates with selected workloads. |
Search field | Search templates by keyword. |
Template tiles | Click a template tile to view template details and to create a virtual machine. |
3.3.2.2. InstanceTypes tab
You create a virtual machine from an instance type on the InstanceTypes tab.
Creating a virtual machine from an instance type is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.
For more information about the support scope of Red Hat Technology Preview features, see Technology Preview Features Support Scope.
Element | Description |
---|---|
Volumes project field |
Project in which bootable volumes are stored. The default is |
Add volume button | Click to upload a new volume or to use an existing persistent volume claim. |
Filter field | Filter boot sources by operating system or resource. |
Search field | Search boot sources by name. |
Manage columns icon | Select up to 9 columns to display in the table. |
Volume table | Select a bootable volume for your virtual machine. |
Red Hat provided tab | Select an instance type provided by Red Hat. |
User provided tab | Select an instance type that you created on the InstanceType page. |
VirtualMachine details pane | Displays the virtual machine settings. |
Name field | Optional: Enter the virtual machine name. |
SSH key name | Click the edit icon to add a public SSH key. |
Start this VirtualMachine after creation checkbox | Clear this checkbox to prevent the virtual machine from starting automatically. |
Create VirtualMachine button | Creates a virtual machine. |
YAML & CLI button |
Displays the YAML configuration file and the |
3.3.3. VirtualMachines page
You create and manage virtual machines on the VirtualMachines page.
Example 3.10. VirtualMachines page
Element | Description |
---|---|
Create button | Create a virtual machine from a template, volume, or YAML configuration file. |
Filter field | Filter virtual machines by status, template, operating system, or node. |
Search field | Search for virtual machines by name or by label. |
Manage columns icon | Select up to 9 columns to display in the table. The Namespace column is only displayed when All Projects is selected from the Projects list. |
Virtual machines table | List of virtual machines. Click the actions menu beside a virtual machine to select Stop, Restart, Pause, Clone, Migrate, Copy SSH command, Edit labels, Edit annotations, or Delete. If you select Stop, Force stop replaces Stop in the action menu. Use Force stop to initiate an immediate shutdown if the operating system becomes unresponsive. Click a virtual machine to navigate to the VirtualMachine details page. |
3.3.3.1. VirtualMachine details page
You configure a virtual machine on the VirtualMachine details page.
Example 3.11. VirtualMachine details page
Element | Description |
---|---|
Actions menu | Click the Actions menu to select Stop, Restart, Pause, Clone, Migrate, Copy SSH command, Edit labels, Edit annotations, or Delete. If you select Stop, Force stop replaces Stop in the action menu. Use Force stop to initiate an immediate shutdown if the operating system becomes unresponsive. |
Resource usage, alerts, disks, and devices. | |
Virtual machine details and configurations. | |
Memory, CPU, storage, network, and migration metrics. | |
Virtual machine YAML configuration file. | |
Contains the Disks, Network interfaces, Scheduling, Environment, and Scripts tabs. | |
Disks. | |
Network interfaces. | |
Scheduling a virtual machine to run on specific nodes. | |
Config map, secret, and service account management. | |
Cloud-init settings, authorized SSH key and dynamic key injection for Linux virtual machines, Sysprep settings for Windows virtual machines. | |
Virtual machine event stream. | |
Console session management. | |
Snapshot management. | |
Status conditions and volume snapshot status. |
3.3.3.1.1. Overview tab
The Overview tab displays resource usage, alerts, and configuration information.
Example 3.12. Overview tab
Element | Description |
---|---|
Details tile | General virtual machine information. |
Utilization tile | CPU, Memory, Storage, and Network transfer charts. By default, Network transfer displays the sum of all networks. To view the breakdown for a specific network, click Breakdown by network. |
Hardware devices tile | GPU and host devices. |
Alerts tile | OpenShift Virtualization alerts, grouped by severity. |
Snapshots tile | Take snapshot and snapshots table. |
Network interfaces tile | Network interfaces table. |
Disks tile | Disks table. |
3.3.3.1.2. Details tab
You view information about the virtual machine and edit labels, annotations, and other metadata and on the Details tab.
Example 3.13. Details tab
Element | Description |
---|---|
YAML switch | Set to ON to view your live changes in the YAML configuration file. |
Name | Virtual machine name. |
Namespace | Virtual machine namespace or project. |
Labels | Click the edit icon to edit the labels. |
Annotations | Click the edit icon to edit the annotations. |
Description | Click the edit icon to enter a description. |
Operating system | Operating system name. |
CPU|Memory | Click the edit icon to edit the CPU|Memory request. Restart the virtual machine to apply the change.
The number of CPUs is calculated by using the following formula: |
Machine type | Machine type. |
Boot mode | Click the edit icon to edit the boot mode. Restart the virtual machine to apply the change. |
Start in pause mode | Click the edit icon to enable this setting. Restart the virtual machine to apply the change. |
Template | Name of the template used to create the virtual machine. |
Created at | Virtual machine creation date. |
Owner | Virtual machine owner. |
Status | Virtual machine status. |
Pod |
|
VirtualMachineInstance | Virtual machine instance name. |
Boot order | Click the edit icon to select a boot source. Restart the virtual machine to apply the change. |
IP address | IP address of the virtual machine. |
Hostname | Hostname of the virtual machine. Restart the virtual machine to apply the change. |
Time zone | Time zone of the virtual machine. |
Node | Node on which the virtual machine is running. |
Workload profile | Click the edit icon to edit the workload profile. |
SSH access | These settings apply to Linux. |
SSH using virtctl |
Click the copy icon to copy the |
SSH service type | Select SSH over LoadBalancer. After you create a service, the SSH command is displayed. Click the copy icon to copy the command to the clipboard. |
GPU devices | Click the edit icon to add a GPU device. Restart the virtual machine to apply the change. |
Host devices | Click the edit icon to add a host device. Restart the virtual machine to apply the change. |
Headless mode | Click the edit icon to set headless mode to ON and to disable VNC console. Restart the virtual machine to apply the change. |
Services | Displays a list of services if QEMU guest agent is installed. |
Active users | Displays a list of active users if QEMU guest agent is installed. |
3.3.3.1.3. Metrics tab
The Metrics tab displays memory, CPU, storage, network, and migration usage charts.
Example 3.14. Metrics tab
Element | Description |
---|---|
Time range list | Select a time range to filter the results. |
Virtualization dashboard | Link to the Workloads tab of the current project. |
Utilization | Memory and CPU charts. |
Storage | Storage total read/write and Storage IOPS total read/write charts. |
Network | Network in, Network out, Network bandwidth, and Network interface charts. Select All networks or a specific network from the Network interface list. |
Migration | Migration and KV data transfer rate charts. |
3.3.3.1.4. YAML tab
You configure the virtual machine by editing the YAML file on the YAML tab.
Example 3.15. YAML tab
Element | Description |
---|---|
Save button | Save changes to the YAML file. |
Reload button | Discard your changes and reload the YAML file. |
Cancel button | Exit the YAML tab. |
Download button | Download the YAML file to your local machine. |
3.3.3.1.5. Configuration tab
You configure scheduling, network interfaces, disks, and other options on the Configuration tab.
Example 3.16. Tabs on the Configuration tab
Element | Description |
---|---|
YAML switch | Set to ON to view your live changes in the YAML configuration file. |
Disks. | |
Network interfaces. | |
Scheduling and resource requirements. | |
Config maps, secrets, and service accounts. | |
Cloud-init settings, authorized SSH key for Linux virtual machines, Sysprep answer file for Windows virtual machines. |
3.3.3.1.5.1. Disks tab
You manage disks on the Disks tab.
Example 3.17. Disks tab
Setting | Description |
---|---|
Add disk button | Add a disk to the virtual machine. |
Filter field | Filter by disk type. |
Search field | Search for a disk by name. |
Mount Windows drivers disk checkbox |
Select to mount a |
Disks table | List of virtual machine disks. Click the actions menu beside a disk to select Edit or Detach. |
File systems table | List of virtual machine file systems. |
3.3.3.1.5.2. Network interfaces tab
You manage network interfaces on the Network interfaces tab.
Example 3.18. Network interfaces tab
Setting | Description |
---|---|
Add network interface button | Add a network interface to the virtual machine. |
Filter field | Filter by interface type. |
Search field | Search for a network interface by name or by label. |
Network interface table | List of network interfaces. Click the actions menu beside a network interface to select Edit or Delete. |
3.3.3.1.5.3. Scheduling tab
You configure virtual machines to run on specific nodes on the Scheduling tab.
Restart the virtual machine to apply changes.
Example 3.19. Scheduling tab
Setting | Description |
---|---|
Node selector | Click the edit icon to add a label to specify qualifying nodes. |
Tolerations | Click the edit icon to add a toleration to specify qualifying nodes. |
Affinity rules | Click the edit icon to add an affinity rule. |
Descheduler switch | Enable or disable the descheduler. The descheduler evicts a running pod so that the pod can be rescheduled onto a more suitable node. This field is disabled if the virtual machine cannot be live migrated. |
Dedicated resources | Click the edit icon to select Schedule this workload with dedicated resources (guaranteed policy). |
Eviction strategy | Click the edit icon to select LiveMigrate as the virtual machine eviction strategy. |
3.3.3.1.5.4. Environment tab
You manage config maps, secrets, and service accounts on the Environment tab.
Example 3.20. Environment tab
Element | Description |
---|---|
Add Config Map, Secret or Service Account | Click the link and select a config map, secret, or service account from the resource list. |
3.3.3.1.5.5. Scripts tab
You manage cloud-init settings, add SSH keys, or configure Sysprep for Windows virtual machines on the Scripts tab.
Restart the virtual machine to apply changes.
Example 3.21. Scripts tab
Element | Description |
---|---|
Cloud-init | Click the edit icon to edit the cloud-init settings. |
Authorized SSH key | Click the edit icon to add a public SSH key to a Linux virtual machine. The key is added as a cloud-init data source at first boot. |
Dynamic SSH key injection switch | Set Dynamic SSH key injection to on to enable dynamic public SSH key injection. Then, you can add or revoke the key at runtime. Dynamic SSH key injection is only supported by Red Hat Enterprise Linux (RHEL) 9. If you manually disable this setting, the virtual machine inherits the SSH key settings of the image from which it was created. |
Sysprep |
Click the edit icon to upload an |
3.3.3.1.6. Events tab
The Events tab displays a list of virtual machine events.
3.3.3.1.7. Console tab
You can open a console session to the virtual machine on the Console tab.
Example 3.22. Console tab
Element | Description |
---|---|
Guest login credentials section |
Expand Guest login credentials to view the credentials created with |
Console list | Select VNC console or Serial console. The Desktop viewer option is displayed for Windows virtual machines. You must install an RDP client on a machine on the same network. |
Send key list | Select a key-stroke combination to send to the console. |
Disconnect button | Disconnect the console connection. You must manually disconnect the console connection if you open a new console session. Otherwise, the first console session continues to run in the background. |
Paste button | Paste a string from your clipboard to the VNC console. |
3.3.3.1.8. Snapshots tab
You create snapshots and restore virtual machines from snapshots on the Snapshots tab.
Example 3.23. Snapshots tab
Element | Description |
---|---|
Take snapshot button | Create a snapshot. |
Filter field | Filter snapshots by status. |
Search field | Search for snapshots by name or by label. |
Snapshot table | List of snapshots Click the snapshot name to edit the labels or annotations. Click the actions menu beside a snapshot to select Restore or Delete. |
3.3.3.1.9. Diagnostics tab
You view the status conditions and volume snapshot status on the Diagnostics tab.
Example 3.24. Diagnostics tab
Element | Description |
---|---|
Status conditions table | Display a list of conditions that are reported for the virtual machine. |
Filter field | Filter status conditions by category and condition. |
Search field | Search status conditions by reason. |
Manage columns icon | Select up to 9 columns to display in the table. |
Volume snapshot status table | List of volumes, their snapshot enablement status, and reason. |
3.3.4. Templates page
You create, edit, and clone virtual machine templates on the VirtualMachine Templates page.
You cannot edit a Red Hat template. However, you can clone a Red Hat template and edit it to create a custom template.
Example 3.25. VirtualMachine Templates page
Element | Description |
---|---|
Create Template button | Create a template by editing a YAML configuration file. |
Filter field | Filter templates by type, boot source, template provider, or operating system. |
Search field | Search for templates by name or by label. |
Manage columns icon | Select up to 9 columns to display in the table. The Namespace column is only displayed when All Projects is selected from the Projects list. |
Virtual machine templates table | List of virtual machine templates. Click the actions menu beside a template to select Edit, Clone, Edit boot source, Edit boot source reference, Edit labels, Edit annotations, or Delete. You cannot edit a Red Hat provided template. You can clone the Red Hat template and then edit the custom template. |
3.3.4.1. Template details page
You view template settings and edit custom templates on the Template details page.
Example 3.26. Template details page
Element | Description |
---|---|
YAML switch | Set to ON to view your live changes in the YAML configuration file. |
Actions menu | Click the Actions menu to select Edit, Clone, Edit boot source, Edit boot source reference, Edit labels, Edit annotations, or Delete. |
Template settings and configurations. | |
YAML configuration file. | |
Scheduling configurations. | |
Network interface management. | |
Disk management. | |
Cloud-init, SSH key, and Sysprep management. | |
Name and cloud user password management. |
3.3.4.1.1. Details tab
You configure a custom template on the Details tab.
Example 3.27. Details tab
Element | Description |
---|---|
Name | Template name. |
Namespace | Template namespace. |
Labels | Click the edit icon to edit the labels. |
Annotations | Click the edit icon to edit the annotations. |
Display name | Click the edit icon to edit the display name. |
Description | Click the edit icon to enter a description. |
Operating system | Operating system name. |
CPU|Memory | Click the edit icon to edit the CPU|Memory request.
The number of CPUs is calculated by using the following formula: |
Machine type | Template machine type. |
Boot mode | Click the edit icon to edit the boot mode. |
Base template | Name of the base template used to create this template. |
Created at | Template creation date. |
Owner | Template owner. |
Boot order | Template boot order. |
Boot source | Boot source availability. |
Provider | Template provider. |
Support | Template support level. |
GPU devices | Click the edit icon to add a GPU device. |
Host devices | Click the edit icon to add a host device. |
Headless mode | Click the edit icon to set headless mode to ON and to disable VNC console. |
3.3.4.1.2. YAML tab
You configure a custom template by editing the YAML file on the YAML tab.
Example 3.28. YAML tab
Element | Description |
---|---|
Save button | Save changes to the YAML file. |
Reload button | Discard your changes and reload the YAML file. |
Cancel button | Exit the YAML tab. |
Download button | Download the YAML file to your local machine. |
3.3.4.1.3. Scheduling tab
You configure scheduling on the Scheduling tab.
Example 3.29. Scheduling tab
Setting | Description |
---|---|
Node selector | Click the edit icon to add a label to specify qualifying nodes. |
Tolerations | Click the edit icon to add a toleration to specify qualifying nodes. |
Affinity rules | Click the edit icon to add an affinity rule. |
Descheduler switch | Enable or disable the descheduler. The descheduler evicts a running pod so that the pod can be rescheduled onto a more suitable node. |
Dedicated resources | Click the edit icon to select Schedule this workload with dedicated resources (guaranteed policy). |
Eviction strategy | Click the edit icon to select LiveMigrate as the virtual machine eviction strategy. |
3.3.4.1.4. Network interfaces tab
You manage network interfaces on the Network interfaces tab.
Example 3.30. Network interfaces tab
Setting | Description |
---|---|
Add network interface button | Add a network interface to the template. |
Filter field | Filter by interface type. |
Search field | Search for a network interface by name or by label. |
Network interface table | List of network interfaces. Click the actions menu beside a network interface to select Edit or Delete. |
3.3.4.1.5. Disks tab
You manage disks on the Disks tab.
Example 3.31. Disks tab
Setting | Description |
---|---|
Add disk button | Add a disk to the template. |
Filter field | Filter by disk type. |
Search field | Search for a disk by name. |
Disks table | List of template disks. Click the actions menu beside a disk to select Edit or Detach. |
3.3.4.1.6. Scripts tab
You manage the cloud-init settings, SSH keys, and Sysprep answer files on the Scripts tab.
Example 3.32. Scripts tab
Element | Description |
---|---|
Cloud-init | Click the edit icon to edit the cloud-init settings. |
Authorized SSH key | Click the edit icon to create a new secret or to attach an existing secret to a Linux virtual machine. |
Sysprep |
Click the edit icon to upload an |
3.3.4.1.7. Parameters tab
You edit selected template settings on the Parameters tab.
Example 3.33. Parameters tab
Element | Description |
---|---|
NAME | Set the name parameters for a virtual machine created from this template. |
CLOUD_USER_PASSWORD | Set the cloud user password parameters for a virtual machine created from this template. |
3.3.5. InstanceTypes page
You view and manage virtual machine instance types on the InstanceTypes page.
Example 3.34. VirtualMachineClusterInstancetypes page
Element | Description |
---|---|
Create button | Create an instance type by editing a YAML configuration file. |
Search field | Search for an instance type by name or by label. |
Manage columns icon | Select up to 9 columns to display in the table. The Namespace column is only displayed when All Projects is selected from the Projects list. |
Instance types table | List of instance. Click the actions menu beside an instance type to select Clone or Delete. |
Click an instance type to view the VirtualMachineClusterInstancetypes details page.
3.3.5.1. VirtualMachineClusterInstancetypes details page
You configure an instance type on the VirtualMachineClusterInstancetypes details page.
Example 3.35. VirtualMachineClusterInstancetypes details page
Element | Description |
---|---|
Details tab | Configure an instance type by editing a form. |
YAML tab | Configure an instance type by editing a YAML configuration file. |
Actions menu | Select Edit labels, Edit annotations, Edit VirtualMachineClusterInstancetype, or Delete VirtualMachineClusterInstancetype. |
3.3.5.1.1. Details tab
You configure an instance type by editing a form on the Details tab.
Example 3.36. Details tab
Element | Description |
---|---|
Name | VirtualMachineClusterInstancetype name. |
Labels | Click the edit icon to edit the labels. |
Annotations | Click the edit icon to edit the annotations. |
Created at | Instance type creation date. |
Owner | Instance type owner. |
3.3.5.1.2. YAML tab
You configure an instance type by editing the YAML file on the YAML tab.
Example 3.37. YAML tab
Element | Description |
---|---|
Save button | Save changes to the YAML file. |
Reload button | Discard your changes and reload the YAML file. |
Cancel button | Exit the YAML tab. |
Download button | Download the YAML file to your local machine. |
3.3.6. Preferences page
You view and manage virtual machine preferences on the Preferences page.
Example 3.38. VirtualMachineClusterPreferences page
Element | Description |
---|---|
Create button | Create a preference by editing a YAML configuration file. |
Search field | Search for a preference by name or by label. |
Manage columns icon | Select up to 9 columns to display in the table. The Namespace column is only displayed when All Projects is selected from the Projects list. |
Preferences table | List of preferences. Click the actions menu beside a preference to select Clone or Delete. |
Click a preference to view the VirtualMachineClusterPreference details page.
3.3.6.1. VirtualMachineClusterPreference details page
You configure a preference on the VirtualMachineClusterPreference details page.
Example 3.39. VirtualMachineClusterPreference details page
Element | Description |
---|---|
Details tab | Configure a preference by editing a form. |
YAML tab | Configure a preference by editing a YAML configuration file. |
Actions menu | Select Edit labels, Edit annotations, Edit VirtualMachineClusterPreference, or Delete VirtualMachineClusterPreference. |
3.3.6.1.1. Details tab
You configure a preference by editing a form on the Details tab.
Example 3.40. Details tab
Element | Description |
---|---|
Name | VirtualMachineClusterPreference name. |
Labels | Click the edit icon to edit the labels. |
Annotations | Click the edit icon to edit the annotations. |
Created at | Preference creation date. |
Owner | Preference owner. |
3.3.6.1.2. YAML tab
You configure a preference type by editing the YAML file on the YAML tab.
Example 3.41. YAML tab
Element | Description |
---|---|
Save button | Save changes to the YAML file. |
Reload button | Discard your changes and reload the YAML file. |
Cancel button | Exit the YAML tab. |
Download button | Download the YAML file to your local machine. |
3.3.7. Bootable volumes page
You view and manage available bootable volumes on the Bootable volumes page.
Example 3.42. Bootable volumes page
Element | Description |
---|---|
Add volume button | Add a bootable volume by completing a form or by editing a YAML configuration file. |
Filter field | Filter bootable volumes by operating system and resource type. |
Search field | Search for bootable volumes by name or by label. |
Manage columns icon | Select up to 9 columns to display in the table. The Namespace column is only displayed when All Projects is selected from the Projects list. |
Bootable volumes table | List of bootable volumes. Click the actions menu beside a bootable volume to select Edit, Remove from list, or Delete. |
Click a bootable volume to view the PersistentVolumeClaim details page.
3.3.7.1. PersistentVolumeClaim details page
You configure the persistent volume claim (PVC) of a bootable volume on the PersistentVolumeClaim details page.
Example 3.43. PersistentVolumeClaim details page
Element | Description |
---|---|
Details tab | Configure the PVC by editing a form. |
YAML tab | Configure the PVC by editing a YAML configuration file. |
Events tab | The Events tab displays a list of PVC events. |
VolumeSnapshots tab | The VolumeSnapshots tab displays a list of volume snapshots. |
Actions menu | Select Expand PVC, Create snapshot, Clone PVC, Edit labels, Edit annotations, Edit PersistentVolumeClaim or Delete PersistentVolumeClaim. |
3.3.7.1.1. Details tab
You configure the persistent volume claim (PVC) of the bootable volume by editing a form on the Details tab.
Example 3.44. Details tab
Element | Description |
---|---|
Name | PVC name. |
Namespace | PVC namespace. |
Labels | Click the edit icon to edit the labels. |
Annotations | Click the edit icon to edit the annotations. |
Created at | PVC creation date. |
Owner | PVC owner. |
Status | Status of the PVC, for example, Bound. |
Requested capacity | Requested capacity of the PVC. |
Capacity | Capacity of the PVC. |
Used | Used space of the PVC. |
Access modes | PVC access modes. |
Volume mode | PVC volume mode. |
StorageClasses | PVC storage class. |
PersistentVolumes | Persistent volume associated with the PVC. |
Conditions table | Displays the status of the PVC. |
3.3.7.1.2. YAML tab
You configure the persistent volume claim of the bootable volume by editing the YAML file on the YAML tab.
Example 3.45. YAML tab
Element | Description |
---|---|
Save button | Save changes to the YAML file. |
Reload button | Discard your changes and reload the YAML file. |
Cancel button | Exit the YAML tab. |
Download button | Download the YAML file to your local machine. |
3.3.8. MigrationPolicies page
You manage migration policies for workloads on the MigrationPolicies page.
Example 3.46. MigrationPolicies page
Element | Description |
---|---|
Create MigrationPolicy | Create a migration policy by entering configurations and labels in a form or by editing a YAML file. |
Search field | Search for a migration policy by name or by label. |
Manage columns icon | Select up to 9 columns to display in the table. The Namespace column is only displayed when All Projects is selected from the Projects list. |
MigrationPolicies table | List of migration policies. Click the actions menu beside a migration policy to select Edit or Delete. |
Click a migration policy to view the MigrationPolicy details page.
3.3.8.1. MigrationPolicy details page
You configure a migration policy on the MigrationPolicy details page.
Example 3.47. MigrationPolicy details page
Element | Description |
---|---|
Details tab | Configure a migration policy by editing a form. |
YAML tab | Configure a migration policy by editing a YAML configuration file. |
Actions menu | Select Edit or Delete. |
3.3.8.1.1. Details tab
You configure a custom template on the Details tab.
Example 3.48. Details tab
Element | Description |
---|---|
Name | Migration policy name. |
Description | Migration policy description. |
Configurations | Click the edit icon to update the migration policy configurations. |
Bandwidth per migration |
Bandwidth request per migration. For unlimited bandwidth, set the value to |
Auto converge | When auto converge is enabled, the performance and availability of the virtual machines might be reduced to ensure that migration is successful. |
Post-copy | Post-copy policy. |
Completion timeout | Completion timeout value in seconds. |
Project labels | Click Edit to edit the project labels. |
VirtualMachine labels | Click Edit to edit the virtual machine labels. |
3.3.8.1.2. YAML tab
You configure the migration polic by editing the YAML file on the YAML tab.
Example 3.49. YAML tab
Element | Description |
---|---|
Save button | Save changes to the YAML file. |
Reload button | Discard your changes and reload the YAML file. |
Cancel button | Exit the YAML tab. |
Download button | Download the YAML file to your local machine. |