This is a cache of https://docs.okd.io/latest/virt/virtual_machines/virt-edit-vms.html. It is a snapshot of the page at 2024-11-26T19:56:24.566+0000.
Editing virtual machines - Virtual machines | Virtualization | OKD 4
  1. Documentation
×

Editing virtual machines

You can update a virtual machine (VM) configuration by using the OKD web console. You can update the YAML file or the VirtualMachine details page.

You can also edit a VM by using the command line.

To edit a VM to configure disk sharing by using virtual disks or LUN, see Configuring shared volumes for virtual machines.

Hot plugging memory on a virtual machine

You can add or remove the amount of memory allocated to a virtual machine (VM) without having to restart the VM by using the OKD web console.

Procedure

  1. Navigate to Virtualization → VirtualMachines.

  2. Select the required VM to open the VirtualMachine details page.

  3. On the Configuration tab, click Edit CPU|Memory.

  4. Enter the desired amount of memory and click Save.

The system applies these changes immediately. If the VM is migratable, a live migration is triggered. If not, or if the changes cannot be live-updated, a RestartRequired condition is added to the VM.

Linux guests require a kernel version of 5.16 or later and Windows guests require the latest viomem drivers.

Hot plugging CPUs on a virtual machine

You can increase or decrease the number of CPU sockets allocated to a virtual machine (VM) without having to restart the VM by using the OKD web console.

Procedure

  1. Navigate to Virtualization → VirtualMachines.

  2. Select the required VM to open the VirtualMachine details page.

  3. On the Configuration tab, click Edit CPU|Memory.

  4. Select the vCPU radio button.

  5. Enter the desired number of vCPU sockets and click Save.

    If the VM is migratable, a live migration is triggered. If not, or if the changes cannot be live-updated, a RestartRequired condition is added to the VM.

Editing a virtual machine by using the command line

You can edit a virtual machine (VM) by using the command line.

Prerequisites

  • You installed the oc CLI.

Procedure

  1. Obtain the virtual machine configuration by running the following command:

    $ oc edit vm <vm_name>

  2. Edit the YAML configuration.

  3. If you edit a running virtual machine, you need to do one of the following:

    • Restart the virtual machine.

    • Run the following command for the new configuration to take effect:

      $ oc apply vm <vm_name> -n <namespace>

Adding a disk to a virtual machine

You can add a virtual disk to a virtual machine (VM) by using the OKD web console.

Procedure

  1. Navigate to Virtualization → VirtualMachines in the web console.

  2. Select a VM to open the VirtualMachine details page.

  3. On the Disks tab, click Add disk.

  4. Specify the Source, Name, Size, Type, Interface, and Storage Class.

    1. Optional: You can enable preallocation if you use a blank disk source and require maximum write performance when creating data volumes. To do so, select the Enable preallocation checkbox.

    2. Optional: You can clear Apply optimized StorageProfile settings to change the Volume Mode and Access Mode for the virtual disk. If you do not specify these parameters, the system uses the default values from the kubevirt-storage-class-defaults config map.

  5. Click Add.

If the VM is running, you must restart the VM to apply the change.

Storage fields

Field Description

Blank (creates PVC)

Create an empty disk.

Import via URL (creates PVC)

Import content via URL (HTTP or HTTPS endpoint).

Use an existing PVC

Use a PVC that is already available in the cluster.

Clone existing PVC (creates PVC)

Select an existing PVC available in the cluster and clone it.

Import via Registry (creates PVC)

Import content via container registry.

Container (ephemeral)

Upload content from a container located in a registry accessible from the cluster. The container disk should be used only for read-only filesystems such as CD-ROMs or temporary virtual machines.

Name

Name of the disk. The name can contain lowercase letters (a-z), numbers (0-9), hyphens (-), and periods (.), up to a maximum of 253 characters. The first and last characters must be alphanumeric. The name must not contain uppercase letters, spaces, or special characters.

Size

Size of the disk in GiB.

Type

Type of disk. Example: Disk or CD-ROM

Interface

Type of disk device. Supported interfaces are virtIO, SATA, and SCSI.

Storage Class

The storage class that is used to create the disk.

Advanced storage settings

The following advanced storage settings are optional and available for Blank, Import via URL, and Clone existing PVC disks.

If you do not specify these parameters, the system uses the default storage profile values.

Parameter Option Parameter description

Volume Mode

Filesystem

Stores the virtual disk on a file system-based volume.

Block

Stores the virtual disk directly on the block volume. Only use Block if the underlying storage supports it.

Access Mode

ReadWriteOnce (RWO)

Volume can be mounted as read-write by a single node.

ReadWriteMany (RWX)

Volume can be mounted as read-write by many nodes at one time.

This mode is required for live migration.

Mounting a Windows driver disk on a virtual machine

You can mount a Windows driver disk on a virtual machine (VM) by using the OKD web console.

Procedure

  1. Navigate to Virtualization → VirtualMachines.

  2. Select the required VM to open the VirtualMachine details page.

  3. On the Configuration tab, click Storage.

  4. Select the Mount Windows drivers disk checkbox.

    The Windows driver disk is displayed in the list of mounted disks.

Adding a secret, config map, or service account to a virtual machine

You add a secret, config map, or service account to a virtual machine by using the OKD web console.

These resources are added to the virtual machine as disks. You then mount the secret, config map, or service account as you would mount any other disk.

If the virtual machine is running, changes do not take effect until you restart the virtual machine. The newly added resources are marked as pending changes at the top of the page.

Prerequisites

  • The secret, config map, or service account that you want to add must exist in the same namespace as the target virtual machine.

Procedure

  1. Click Virtualization → VirtualMachines from the side menu.

  2. Select a virtual machine to open the VirtualMachine details page.

  3. Click Configuration → Environment.

  4. Click Add Config Map, secret or Service Account.

  5. Click Select a resource and select a resource from the list. A six character serial number is automatically generated for the selected resource.

  6. Optional: Click Reload to revert the environment to its last saved state.

  7. Click Save.

Verification

  1. On the VirtualMachine details page, click Configuration → Disks and verify that the resource is displayed in the list of disks.

  2. Restart the virtual machine by clicking Actions → Restart.

You can now mount the secret, config map, or service account as you would mount any other disk.

Additional resources for config maps, secrets, and service accounts