Merge pull request #65985 from ousleyp/cnv-24223

CNV#24223: updating mediated devices assembly for NVIDIA operator

Author: ousleyp

_topic_maps/_topic_map.yml

@@ -3803,10 +3803,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 mediated devices
-      File: virt-configuring-mediated-devices
+    - Name: Configuring virtual GPUs
+      File: virt-configuring-virtual-gpus
     - Name: Enabling descheduler evictions on virtual machines
       File: virt-enabling-descheduler-evictions
     - Name: About high availability for virtual machines

modules/about-using-gpu-operator.adoc

@@ -1,21 +1,11 @@
 // Module included in the following assemblies:
 //
-// * virt/virtual_machines/advanced_vm_management/virt-configuring-mediated-devices.adoc
-
+// * virt/virtual_machines/advanced_vm_management/virt-configuring-virtual-gpus.adoc
 
 :_content-type: CONCEPT
 [id="about-using-nvidia-gpu_{context}"]
 = About using the NVIDIA GPU Operator
 
-The NVIDIA GPU Operator manages NVIDIA GPU resources in a {product-title} cluster and automates tasks related to bootstrapping GPU nodes. Because the GPU is a special resource in the cluster, you must install some components before you can deploy application workloads to the GPU. These components include the NVIDIA drivers that enable the compute unified device architecture (CUDA), Kubernetes device plugin, container runtime, and other features such as automatic node labeling, monitoring, and more.
-
-[NOTE]
-====
-The NVIDIA GPU Operator is supported only by NVIDIA. For more information about obtaining support from NVIDIA, see link:https://access.redhat.com/solutions/5174941[Obtaining Support from NVIDIA].
-====
-
-There are two ways to enable GPUs with {product-title} {VirtProductName}: the {product-title}-native way described here and by using the NVIDIA GPU Operator.
-
-The NVIDIA GPU Operator is a Kubernetes Operator that uses {product-title} {VirtProductName} to provision GPUs for virtualized workloads running on {product-title}. With the Operator, you can easily provision and manage GPU-enabled virtual machines to run complex artificial intelligence/machine learning (AI/ML) workloads on the same platform as their other workloads. The Operator also provides an easy way to scale the GPU capacity of their infrastructure, enabling rapid growth of GPU-based workloads.
+You can use the NVIDIA GPU Operator with {VirtProductName} to rapidly provision worker nodes for running GPU-enabled virtual machines (VMs). The NVIDIA GPU Operator manages NVIDIA GPU resources in an {product-title} cluster and automates tasks that are required when preparing nodes for GPU workloads.
 
-For more information about using the NVIDIA GPU Operator to provision worker nodes for running GPU-accelerated VMs, see link:https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/openshift/openshift-virtualization.html[NVIDIA GPU Operator with OpenShift Virtualization].
+Before you can deploy application workloads to a GPU resource, you must install components such as the NVIDIA drivers that enable the compute unified device architecture (CUDA), Kubernetes device plugin, container runtime, and other features, such as automatic node labeling and monitoring. By automating these tasks, you can quickly scale the GPU capacity of your infrastructure. The NVIDIA GPU Operator can especially facilitate provisioning complex artificial intelligence and machine learning (AI/ML) workloads.

modules/using-mediated-devices.adoc

@@ -1,23 +1,20 @@
 // Module included in the following assemblies:
 //
-// * virt/virtual_machines/advanced_vm_management/virt-configuring-mediated-devices.adoc
+// * virt/virtual_machines/advanced_vm_management/virt-configuring-virtual-gpus.adoc
 
 :_content-type: CONCEPT
-
 [id="about-changing-removing-mediated-devices_{context}"]
 = About changing and removing mediated devices
 
-The cluster's mediated device configuration can be updated with {VirtProductName} by:
+You can reconfigure or remove mediated devices in several ways:
 
-* Editing the `HyperConverged` CR and change the contents of the `mediatedDevicesTypes` stanza.
+* Edit the `HyperConverged` CR and change the contents of the `mediatedDeviceTypes` stanza.
 
-* Changing the node labels that match the `nodeMediatedDeviceTypes` node selector.
+* Change the node labels that match the `nodeMediatedDeviceTypes` node selector.
 
-* Removing the device information from the `spec.mediatedDevicesConfiguration` and `spec.permittedHostDevices` stanzas of the `HyperConverged` CR.
+* Remove the device information from the `spec.mediatedDevicesConfiguration` and `spec.permittedHostDevices` stanzas of the `HyperConverged` CR.
 +
 [NOTE]
 ====
 If you remove the device information from the `spec.permittedHostDevices` stanza without also removing it from the `spec.mediatedDevicesConfiguration` stanza, you cannot create a new mediated device type on the same node. To properly remove mediated devices, remove the device information from both stanzas.
-====
-
-Depending on the specific changes, these actions cause {VirtProductName} to reconfigure mediated devices or remove them from the cluster nodes.
+====

modules/virt-about-changing-removing-mediated-devices.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * virt/virtual_machines/advanced_vm_management/virt-configuring-mediated-devices.adoc
+// * virt/virtual_machines/advanced_vm_management/virt-configuring-virtual-gpus.adoc
 
 :_content-type: CONCEPT
 [id="virt-about-using-virtual-gpus_{context}"]

modules/virt-about-using-virtual-gpus.adoc

@@ -1,19 +1,22 @@
 // Module included in the following assemblies:
 //
 // * virt/virtual_machines/advanced_vm_management/configuring-pci-passthrough.adoc
+// * virt/virtual_machines/advanced_vm_management/virt-configuring-virtual-gpus.adoc
 
 :_content-type: PROCEDURE
 [id="virt-adding-kernel-arguments-enable-IOMMU_{context}"]
 = Adding kernel arguments to enable the IOMMU driver
 
-To enable the IOMMU (Input-Output Memory Management Unit)  driver in the kernel, create the `MachineConfig` object and add the kernel arguments.
+To enable the IOMMU driver in the kernel, create the `MachineConfig` object and add the kernel arguments.
 
 .Prerequisites
-* Administrative privilege to a working {product-title} cluster.
-* Intel or AMD CPU hardware.
-* Intel Virtualization Technology for Directed I/O extensions or AMD IOMMU in the BIOS (Basic Input/Output System) is enabled.
+
+* You have cluster administrator permissions.
+* Your CPU hardware is Intel or AMD.
+* You enabled Intel Virtualization Technology for Directed I/O extensions or AMD IOMMU in the BIOS.
 
 .Procedure
+
 . Create a `MachineConfig` object that identifies the kernel argument. The following example shows a kernel argument for an Intel CPU.
 
 +

modules/virt-add-remove-mediated-devices.adoc

@@ -1,16 +1,17 @@
 // Module included in the following assemblies:
 //
-// * virt/virtual_machines/advanced_vm_management/virt-configuring-mediated-devices.adoc
+// * virt/virtual_machines/advanced_vm_management/virt-configuring-virtual-gpus.adoc
 
 :_content-type: PROCEDURE
-[id="virt-assigning-mediated-device-virtual-machine_{context}"]
-= Assigning a mediated device to a virtual machine
+[id="virt-assigning-mdev-vm-cli_{context}"]
+= Assigning a vGPU to a VM by using the CLI
 
-Assign mediated devices such as virtual GPUs (vGPUs) to virtual machines.
+Assign mediated devices such as virtual GPUs (vGPUs) to virtual machines (VMs).
 
 .Prerequisites
 
 * The mediated device is configured in the `HyperConverged` custom resource.
+* The VM is stopped.
 
 .Procedure
 
@@ -27,7 +28,7 @@ spec:
       gpus:
       - deviceName: nvidia.com/TU104GL_Tesla_T4 <1>
         name: gpu1 <2>
-      - deviceName: nvidia.com/GRID_T4-1Q
+      - deviceName: nvidia.com/GRID_T4-2Q
         name: gpu2
 ----
 <1> The resource name associated with the mediated device.

modules/virt-adding-kernel-arguments-enable-iommu.adoc

@@ -0,0 +1,31 @@
+// Module included in the following assemblies:
+//
+// * virt/virtual_machines/advanced_vm_management/virt-configuring-virtual-gpus.adoc
+
+[id="virt-assigning-vgpu-vm-web_{context}"]
+= Assigning a vGPU to a VM by using the web console
+
+You can assign virtual GPUs to virtual machines by using the {product-title} web console.
+[NOTE]
+====
+You can add hardware devices to virtual machines created from customized templates or a YAML file. You cannot add devices to pre-supplied boot source templates for specific operating systems.
+====
+
+.Prerequisites
+
+* The vGPU is configured as a mediated device in your cluster.
+** To view the devices that are connected to your cluster, click *Compute* -> *Hardware Devices* from the side menu.
+* The VM is stopped.
+
+.Procedure
+
+. In the {product-title} web console, click *Virtualization* -> *VirtualMachines* from the side menu.
+. Select the VM that you want to assign the device to.
+. On the *Details* tab, click *GPU devices*.
+. Click *Add GPU device*.
+. Enter an identifying value in the *Name* field.
+. From the *Device name* list, select the device that you want to add to the VM.
+. Click *Save*.
+
+.Verification
+* To confirm that the devices were added to the VM, click the *YAML* tab and review the `VirtualMachine` configuration. Mediated devices are added to the `spec.domain.devices` stanza.