Merge pull request #54286 from ousleyp/CNV-20942

CNV-20942: virtio-scsi for hot-plugged disks

Author: apinnick

_topic_maps/_topic_map.yml

@@ -3517,7 +3517,7 @@ Topics:
       File: virt-cloning-a-datavolume-using-smart-cloning
     - Name: Creating and using boot sources
       File: virt-creating-and-using-boot-sources
-    - Name: Hot-plugging virtual disks
+    - 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

modules/virt-about-hot-plugging-virtual-disks.adoc

@@ -0,0 +1,15 @@
+// Module included in the following assemblies:
+//
+// * virt/virtual_machines/virtual_disks/virt-hot-plugging-virtual-disks.adoc
+
+:_content-type: CONCEPT
+[id="virt-about-hot-plugging-virtual-disks_{context}"]
+= About hot plugging virtual disks
+
+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.
+
+After you hot plug a virtual disk, it remains attached until you detach it, even if you restart the virtual machine.

modules/virt-about-virtio-scsi.adoc

@@ -0,0 +1,11 @@
+// Module included in the following assemblies:
+//
+// * virt/virtual_machines/virtual_disks/virt-hot-plugging-virtual-disks.adoc
+
+:_content-type: CONCEPT
+[id="virt-about-virtio-scsi_{context}"]
+= About virtio-scsi
+
+In {VirtProductName}, each virtual machine (VM) has a `virtio-scsi` controller so that hot plugged disks can use a `scsi` bus. The `virtio-scsi` controller overcomes the limitations of `virtio` while retaining its performance advantages. It is highly scalable and supports hot plugging over 4 million disks.
+
+Regular `virtio` is not available for hot plugged disks because it is not scalable: each `virtio` disk uses one of the limited PCI Express (PCIe) slots in the VM. PCIe slots are also used by other devices and must be reserved in advance, therefore slots might not be available on demand.

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

@@ -4,23 +4,23 @@
 
 :_content-type: PROCEDURE
 [id="virt-hot-plugging-a-virtual-disk-using-the-cli_{context}"]
-= Hot-plugging a virtual disk using the CLI
+= 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.
+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.
+* 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:
+* 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 instances.
-** 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.
+** 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 instances.
+** 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-plugging-a-virtual-disk-using-the-web-console.adoc

@@ -4,23 +4,23 @@
 
 :_content-type: PROCEDURE
 [id="virt-hot-plugging-a-virtual-disk-using-the-web-console{context}"]
-= Hot-plugging a virtual disk using the web console
+= Hot plugging a virtual disk using the web console
 
-Hot-plug virtual disks that you want to attach to a virtual machine instance (VMI) while a virtual machine is running. When you hot-plug a virtual disk, it remains attached to the VMI until you hot-unplug it.
+Hot plug virtual disks that you want to attach to a virtual machine instance (VMI) while a virtual machine is running. When you hot plug a virtual disk, it remains attached to the VMI until you unplug it.
 
 .Prerequisites
-* You must have a running virtual machine to hot-plug a virtual disk.
+* You must have a running virtual machine to hot plug a virtual disk.
 
 .Procedure
 
 . Click *Virtualization* -> *VirtualMachines* from the side menu.
 
-. Select the running virtual machine to which you want to hot-plug a virtual disk.
+. Select the running virtual machine to which you want to hot plug a virtual disk.
 
 . On the *VirtualMachine details* page, click the *Disks* tab.
 
 . Click *Add disk*.
 
-. In the *Add disk (hot plugged)* window, fill in the information for the virtual disk that you want to hot-plug.
+. In the *Add disk (hot plugged)* window, fill in the information for the virtual disk that you want to hot plug.
 
 . Click *Save*.

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

@@ -4,17 +4,17 @@
 
 :_content-type: PROCEDURE
 [id="virt-hot-unplugging-a-virtual-disk-using-the-cli_{context}"]
-= Hot-unplugging a virtual disk using the CLI
+= 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.
+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.
+* 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:
+* Hot unplug a virtual disk by running the following command:
 +
 [source,terminal]
 ----

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

@@ -4,19 +4,19 @@
 
 :_content-type: PROCEDURE
 [id="virt-hot-unplugging-a-virtual-disk-using-the-web-console{context}"]
-= Hot-unplugging a virtual disk using the web console
+= Hot unplugging a virtual disk using the web console
 
-Hot-unplug virtual disks that you want to detach from a virtual machine instance (VMI) while a virtual machine is running.
+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 with a hot-plugged disk attached.
+* Your virtual machine must be running with a hot plugged disk attached.
 
 .Procedure
 
 . Click *Virtualization* -> *VirtualMachines* from the side menu.
 
-. Select the running virtual machine with the disk you want to hot-unplug to open the *VirtualMachine details* page.
+. Select the running virtual machine with the disk you want to hot unplug to open the *VirtualMachine details* page.
 
-. On the *Disks* tab, click the Options menu {kebab} of the virtual disk that you want to hot-unplug.
+. On the *Disks* tab, click the Options menu {kebab} of the virtual disk that you want to hot unplug.
 
 . Click *Detach*.

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

@@ -1,22 +1,21 @@
 :_content-type: ASSEMBLY
 [id="virt-hot-plugging-virtual-disks"]
-= Hot-plugging virtual disks
+= Hot plugging virtual disks
 include::_attributes/common-attributes.adoc[]
 :context: virt-hot-plugging-virtual-disks
 
 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.
+You can add or remove virtual disks without stopping your virtual machine (VM) or virtual machine instance (VMI).
 
-When you _hot-plug_ a virtual disk, you attach a virtual disk to a virtual machine instance while the virtual machine is running.
+include::modules/virt-about-hot-plugging-virtual-disks.adoc[leveloffset=+1]
 
-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.
-
-After you hot-plug a virtual disk, it remains hot-plugged until you detach (unplug) it, even if you restart the virtual machine.
+include::modules/virt-about-virtio-scsi.adoc[leveloffset=+1]
 
 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]
+
 include::modules/virt-hot-plugging-a-virtual-disk-using-the-web-console.adoc[leveloffset=+1]
+
 include::modules/virt-hot-unplugging-a-virtual-disk-using-the-web-console.adoc[leveloffset=+1]