Merge pull request #41967 from bgaydosrh/CNV-2896

CNV-2896: Configuring vGPU passthrough in the UI

Author: mburke5678

_topic_maps/_topic_map.yml

@@ -3069,6 +3069,8 @@ Topics:
       File: virt-schedule-vms
     - Name: Configuring PCI passthrough
       File: virt-configuring-pci-passthrough
+    - Name: Configuring vGPU passthrough
+      File: virt-configuring-vgpu-passthrough
     - Name: Configuring a watchdog device
       File: virt-configuring-a-watchdog
 # Importing virtual machines

modules/virt-assign-vgpu-passthrough-to-vm.adoc

@@ -0,0 +1,35 @@
+// Module included in the following assemblies:
+//
+// * virt/virtual_machines/advanced_vm_management/virt-configuring-vgpu-passthrough.adoc
+
+[id="virt-assign-vgpu-passthrough-to-vm_{context}"]
+= Assigning vGPU passthrough to virtual machines
+
+Use the {product-title} web console to assign vGPU devices to your virtual machines.
+
+.Prerequisites
+
+* Ensure your cluster and virtual machines are deployed in a bare metal environment. At this time, no other environments are supported.
+
+.Procedure
+
+. Assign a virtual GPU device to your virtual machine:
+.. In the {product-title} web console, click *Virtualization -> Virtual Machines* from the side menu.
+.. Select the virtual machine to which you want to assign the device.
+.. Click the *Details* tab:
+* The *Hardware Devices* field includes links to add or remove *GPU devices* and *Host devices*.
+* Assigning a vGPU using *GPU devices* enables VNC console access for the attached virtual GPU. Assigning a vGPU using *Host Devices* does not enable VNC console access.
+* Use the minus icon to remove an existing hardware device.
+* You can only add or remove devices from your virtual machine when it is stopped.
+.. Click the pencil icon and use the pop-up windows to add or remove devices, selecting the appropriate hardware resource names.
+.. Click *Save*.
+. Click the *YAML* tab to verify that the new devices have been added to your cluster configuration in the `hostDevices` section.
+
+[NOTE]
+====
+You can add hardware devices to virtual machines using the {product-title} web console when you create a virtual machine or create a virtual machine using a  template that you customize. You cannot add devices to pre-supplied boot source templates for specific operating systems, such as Windows 10 or RHEL 7.
+
+To add or remove hardware devices to a custom template that you create, click the *Advanced* tab in the Create Virtual Machine wizard and click *Hardware devices*. Use the minus icon to remove an existing hardware device. You can only add or remove devices from your virtual machine when it is stopped.
+
+To display resources that are connected to your cluster, click *Compute -> Hardware Devices* from the side menu.
+====

virt/virtual_machines/advanced_vm_management/virt-configuring-vgpu-passthrough.adoc

@@ -0,0 +1,25 @@
+[id="virt-configuring-vgpu-passthrough"]
+= Configuring vGPU passthrough
+include::modules/virt-document-attributes.adoc[]
+:context: virt-configuring-vgpu-passthrough
+
+toc::[]
+
+Your virtual machines can access a virtual GPU (vGPU) hardware. Assigning a vGPU to your virtual machine allows you do the following:
+
+* Access a fraction of the underlying hardware's GPU to achieve high performance benefits in your virtual machine.
+
+* Streamline resource-intensive I/O operations.
+
+[IMPORTANT]
+====
+vGPU passthrough can only be assigned to devices that are connected to clusters running in a bare metal environment.
+====
+
+include::modules/virt-assign-vgpu-passthrough-to-vm.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+[id="additional-resources_virt-configuring-vgpu-passthrough"]
+== Additional resources
+* xref:../../../virt/virtual_machines/virt-create-vms.adoc#virt-create-vms[Creating virtual machines]
+* xref:../../../virt/vm_templates/virt-creating-vm-template.adoc#virt-creating-vm-template[Creating virtual machine templates]