Merge pull request #32690 from bgaydosrh/CNV-6070

CNV-6070 Hot-plugging virtual disks

Author: sjhala-ccs

_topic_map.yml

@@ -2765,6 +2765,8 @@ Topics:
       File: virt-storage-defaults-for-datavolumes
     - Name: Creating and using boot sources
       File: virt-creating-and-using-boot-sources
+      Name: Hot-plugging virtual disks
+      File: virt-hot-plugging-virtual-disks
     - Name: Using container disks with virtual machines
       File: virt-using-container-disks-with-vms
     - Name: Preparing CDI scratch space

modules/virt-hot-plugging-a-virtual-disk-using-the-cli.adoc

@@ -0,0 +1,25 @@
+// Module included in the following assemblies:
+//
+// * virtual_machines/virtual_disks/virt-hot-plugging-virtual-disks.adoc
+
+[id="virt-hot-plugging-a-virtual-disk-using-the-cli_{context}"]
+= Hot-plugging a virtual disk using the CLI
+
+Hot-plug virtual disks that you want to attach to a virtual machine instance (VMI) while a virtual machine is running.
+
+.Prerequisites
+* You must have a running virtual machine to hot-plug a virtual disk.
+* You must have at least one data volume or persistent volume claim (PVC) available for hot-plugging.
+
+.Procedure
+
+* Hot-plug a virtual disk by running the following command:
++
+[source,terminal]
+----
+$ virtctl addvolume <virtual-machine|virtual-machine-instance> --volume-name=<datavolume|PVC> \
+[--persist] [--serial=<label-name>]
+----
++
+** Use the optional `--persist` flag to add the hot-plugged disk to the virtual machine specification as a permanently mounted virtual disk. Stop, restart, or reboot the virtual machine to permanently mount the virtual disk. After specifying the `--persist` flag, you can no longer hot-plug or hot-unplug the virtual disk. The `--persist` flag applies to virtual machines, not virtual machine interfaces.
+** The optional `--serial` flag allows you to add an alphanumeric string label of your choice. This helps you to identify the hot-plugged disk in a guest virtual machine. If you do not specify this option, the label defaults to the name of the hot-plugged data volume or PVC.

modules/virt-hot-unplugging-a-virtual-disk-using-the-cli.adoc

@@ -0,0 +1,21 @@
+// Module included in the following assemblies:
+//
+// * virtual_machines/virtual_disks/virt-hot-plugging-virtual-disks.adoc
+
+[id="virt-hot-unplugging-a-virtual-disk-using-the-cli_{context}"]
+= Hot-unplugging a virtual disk using the CLI
+
+Hot-unplug virtual disks that you want to detach from a virtual machine instance (VMI) while a virtual machine is running.
+
+.Prerequisites
+* Your virtual machine must be running.
+* You must have at least one data volume or persistent volume claim (PVC) available and hot-plugged.
+
+.Procedure
+
+* Hot-unplug a virtual disk by running the following command:
++
+[source,terminal]
+----
+$ virtctl removevolume <virtual-machine|virtual-machine-instance> --volume-name=<datavolume|PVC>
+----

virt/virtual_machines/virtual_disks/virt-hot-plugging-virtual-disks.adoc

@@ -0,0 +1,25 @@
+[id="virt-hot-plugging-virtual-disks"]
+= Hot-plugging virtual disks
+include::modules/virt-document-attributes.adoc[]
+:context: virt-hot-plugging-virtual-disks
+
+:FeatureName: Hot-plugging virtual disks
+include::modules/technology-preview.adoc[leveloffset=+1]
+
+toc::[]
+
+Hot-plug and hot-unplug virtual disks when you want to add or remove them  without stopping your virtual machine or virtual machine instance. This capability is helpful when you need to add storage to a running virtual machine without incurring down-time.
+
+When you _hot-plug_ a virtual disk, you attach a virtual disk to a virtual machine instance while the virtual machine is running.
+
+When you _hot-unplug_ a virtual disk, you detach a virtual disk from a virtual machine instance while the virtual machine is running.
+
+Only data volumes and persistent volume claims (PVCs) can be hot-plugged and hot-unplugged. You cannot hot-plug or hot-unplug container disks.
+
+[WARNING]
+====
+When you attach a hot-plugged virtual disk to a virtual machine, you cannot perform live migration on the virtual machine. If you attempt to perform live migration on a virtual machine with a hot-plugged disk attached, live migration fails.
+====
+
+include::modules/virt-hot-plugging-a-virtual-disk-using-the-cli.adoc[leveloffset=+1]
+include::modules/virt-hot-unplugging-a-virtual-disk-using-the-cli.adoc[leveloffset=+1]