CNV#67095-2: Docs on setup vGPU reach a dead end on step 3 of mdev creation #100376

Vaishali-gif-rh · 2025-10-13T07:26:22Z

Version(s):
4.20+

Issue:
https://issues.redhat.com/browse/CNV-67095

Link to docs preview:

QE review:

QE has approved this change.

Additional information:
This is a duplicate PR of #99158. The QA review for that issue has already been completed.

openshift-ci-robot · 2025-10-13T07:26:25Z

@Vaishali-gif-rh: No Jira issue with key 67095-2 exists in the tracker at https://issues.redhat.com/.
Once a valid jira issue is referenced in the title of this pull request, request a refresh with /jira refresh.

In response to this:

Version(s):
4.20+

Issue:
https://issues.redhat.com/browse/CNV-67095

Link to docs preview:

QE review:

QE has approved this change.

Additional information:
This is a duplicate PR of #99158. The QA review for that issue has already been completed.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

openshift-ci-robot · 2025-10-13T07:26:31Z

@Vaishali-gif-rh: No Jira issue with key 67095-2 exists in the tracker at https://issues.redhat.com/.
Once a valid jira issue is referenced in the title of this pull request, request a refresh with /jira refresh.

In response to this:

Version(s):
4.20+

Issue:
https://issues.redhat.com/browse/CNV-67095

Link to docs preview:

QE review:

QE has approved this change.

Additional information:
This is a duplicate PR of #99158. The QA review for that issue has already been completed.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

ocpdocs-previewbot · 2025-10-13T07:34:27Z

🤖 Tue Oct 14 14:05:24 - Prow CI generated the docs preview:

https://100376--ocpdocs-pr.netlify.app/openshift-enterprise/latest/virt/managing_vms/advanced_vm_management/virt-configuring-virtual-gpus.html

sjhala-ccs

I went through the content and did an initial review. Please ping the peer review channel again after you have made the updates. Thanks!

modules/virt-creating-and-exposing-mediated-devices.adoc

sjhala-ccs · 2025-10-13T18:16:35Z

modules/virt-creating-and-exposing-mediated-devices.adoc

 +
-.Example configuration file with mediated devices configured
+.Example configuration
 [%collapsible]


Remove this line and the next ==== because the code snippet is now smaller and the collapsible content does not render properly on docs.redhat

The [%collapsible] line still needs to be removed

modules/virt-creating-and-exposing-mediated-devices.adoc

openshift-ci · 2025-10-14T14:06:33Z

@Vaishali-gif-rh: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

ousleyp

Hey Vaishali, there are some things to resolve before we can move this forward. Please feel free to reach out if you have questions. Thanks!

ousleyp · 2025-10-15T18:54:45Z

modules/virt-creating-and-exposing-mediated-devices.adoc

+* You have enabled the Input-Output Memory Management Unit (IOMMU) driver.
+* If your hardware vendor provides drivers, you have installed them on the nodes where you want to create mediated devices.
+** If you use NVIDIA cards, you have link:https://docs.nvidia.com/datacenter/cloud-native/openshift/latest/openshift-virtualization.html[installed the NVIDIA GRID driver].


It looks like you changed the simple past tense verbs (like "You enabled") to use "have" (like "You have enabled"), which is not consistent with our style guidelines. The ISG has a short section on tense, indicating that we use simple present tense for most things, and simple past or future tense when present tense doesn't make sense.

ousleyp · 2025-10-15T19:05:23Z

modules/virt-creating-and-exposing-mediated-devices.adoc


 :_mod-docs-content-type: PROCEDURE
 [id="virt-creating-exposing-mediated-devices_{context}"]
 = Creating and exposing mediated devices

-As an administrator, you can create mediated devices and expose them to the cluster by editing the `HyperConverged` custom resource (CR).
+As an administrator, you can create mediated devices and expose them to the cluster by editing the `HyperConverged` custom resource (CR). The mediated device values that you supply can vary depending on the particular Graphics Processing Units (GPUs) you are using.


This additional sentence doesn't seem to add much for the reader. For conciseness, consider removing it, or you could shorten it to something like: "The values you add to the CR depend on your GPU model and vendor."

ousleyp · 2025-10-15T19:07:19Z

modules/virt-creating-and-exposing-mediated-devices.adoc

@@ -43,81 +48,85 @@ spec:
      - nvidia-233
      nodeSelector:
        kubernetes.io/hostname: node-11.redhat.com
-  permittedHostDevices:
-    mediatedDevices:
-    - mdevNameSelector: GRID T4-2Q
-      resourceName: nvidia.com/GRID_T4-2Q
-    - mdevNameSelector: GRID T4-8Q
-      resourceName: nvidia.com/GRID_T4-8Q
-# ...
+  # ...
 ----
-====

-. Create mediated devices by adding them to the `spec.mediatedDevicesConfiguration` stanza:
+ Identify the name selector and resource name values for the devices that you want to expose to the cluster, as shown in the following example. You can use the same value for both, replacing any spaces in the name with an underscore.
 +
-.Example YAML snippet
-[source,yaml]
+[source,terminal]


This section has some formatting issues that I've captured in a screenshot.

ousleyp · 2025-10-15T19:08:15Z

modules/virt-creating-and-exposing-mediated-devices.adoc

 +
-.Example configuration file with mediated devices configured
+.Example configuration
 [%collapsible]


The [%collapsible] line still needs to be removed

ousleyp · 2025-10-15T19:09:28Z

modules/virt-creating-and-exposing-mediated-devices.adoc

-[source,yaml,subs="attributes+"]
+
+[source,yaml]


This needs to be reverted to [source,yaml,subs="attributes+"] because the code block has an attribute in it ({CNVNamespace})

ousleyp · 2025-10-15T19:36:36Z

modules/virt-creating-and-exposing-mediated-devices.adoc

+
+<mdevNameSelector>:: Specifies the mediated devices that map to this value on the host.
+
+<resourceName>:: Specifies the matching resource name that is allocated on the node.


In this case, you don't need to use the < > characters because the example doesn't contain them. You just need to put the parameters in backticks.

Suggested change

<resourceName>:: Specifies the matching resource name that is allocated on the node.

`mediatedDeviceTypes`:: Specifies global settings for the cluster and is required.

`nodeMediatedDeviceTypes`:: Specifies global configuration overrides for a specific node or group of nodes and is optional. Must be used with the global `mediatedDeviceTypes` configuration.

`mediatedDeviceTypes`:: Specifies an override to the global `mediatedDeviceTypes` configuration for the specified nodes. Required if you use `nodeMediatedDeviceTypes`.

`nodeSelector`:: Specifies the node selector and must include a `key:value` pair. Required if you use `nodeMediatedDeviceTypes`.

`mdevNameSelector`:: Specifies the mediated devices that map to this value on the host.

`resourceName`:: Specifies the matching resource name that is allocated on the node.

ousleyp · 2025-10-15T19:41:15Z

modules/virt-creating-and-exposing-mediated-devices.adoc

+spec:
+ mediatedDevicesConfiguration:
+   mediatedDeviceTypes:
+   - nvidia-745
+   nodeMediatedDeviceTypes:
+   - mediatedDeviceTypes:
+     - nvidia-746
+     nodeSelector:
+       kubernetes.io/hostname: node-11.redhat.com
+ permittedHostDevices:
+   mediatedDevices:
+   - mdevNameSelector: GRID A2-2Q
+     resourceName: nvidia.com/GRID_A2-2Q
+   - mdevNameSelector: GRID A2-4Q
+     resourceName: nvidia.com/GRID_A2-4Q


Because this is a snippet, you need to put # ... before and after the code itself.

Suggested change

spec:

mediatedDevicesConfiguration:

mediatedDeviceTypes:

- nvidia-745

nodeMediatedDeviceTypes:

- mediatedDeviceTypes:

- nvidia-746

nodeSelector:

kubernetes.io/hostname: node-11.redhat.com

permittedHostDevices:

mediatedDevices:

- mdevNameSelector: GRID A2-2Q

resourceName: nvidia.com/GRID_A2-2Q

- mdevNameSelector: GRID A2-4Q

resourceName: nvidia.com/GRID_A2-4Q

# ...

spec:

mediatedDevicesConfiguration:

mediatedDeviceTypes:

- nvidia-745

nodeMediatedDeviceTypes:

- mediatedDeviceTypes:

- nvidia-746

nodeSelector:

kubernetes.io/hostname: node-11.redhat.com

permittedHostDevices:

mediatedDevices:

- mdevNameSelector: GRID A2-2Q

resourceName: nvidia.com/GRID_A2-2Q

- mdevNameSelector: GRID A2-4Q

resourceName: nvidia.com/GRID_A2-4Q

# ...

ousleyp · 2025-10-15T19:43:28Z

modules/virt-creating-and-exposing-mediated-devices.adoc

-. Identify the name selector and resource name values for the devices that you want to expose to the cluster. You will add these values to the `HyperConverged` CR in the next step.
-.. Find the `resourceName` value by running the following command:
-+
+.Example output


Suggested change

.Example output

Example output:

+

ousleyp · 2025-10-15T19:44:45Z

modules/virt-creating-and-exposing-mediated-devices.adoc

@@ -24,10 +29,10 @@ As an administrator, you can create mediated devices and expose them to the clus
 $ oc edit hyperconverged kubevirt-hyperconverged -n {CNVNamespace}
 ----
 +
-.Example configuration file with mediated devices configured
+*Example configuration*


Suggested change

*Example configuration*

Example configuration file:

+

ousleyp · 2025-10-15T19:44:56Z

modules/virt-creating-and-exposing-mediated-devices.adoc

+[IMPORTANT]
+====
+Before {VirtProductName} 4.14, the `mediatedDeviceTypes` field was named `mediatedDevicesTypes`. Ensure that you use the correct field name when configuring mediated devices.
+====


I wonder if we still need this :)

ousleyp · 2025-10-15T21:20:07Z

Per @nunzy1, I am taking over this story in the interest of time; I'm closing this PR and will open a different one.

Audrey Spaulding added 2 commits October 1, 2025 11:34

CNV-67095

fe13493

additional input from QE

c1774a1

openshift-ci bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Oct 13, 2025

Vaishali-gif-rh force-pushed the CNV-67095-2 branch from 5c28270 to 2cc10e2 Compare October 13, 2025 07:49

sjhala-ccs reviewed Oct 13, 2025

View reviewed changes

added changes

60702dd

Vaishali-gif-rh force-pushed the CNV-67095-2 branch from 2cc10e2 to 60702dd Compare October 14, 2025 13:51

Vaishali-gif-rh mentioned this pull request Oct 14, 2025

CNV#67095: Docs on setup vGPU reach a dead end on step 3 of mdev creation #99158

Open

1 task

ousleyp reviewed Oct 15, 2025

View reviewed changes

ousleyp closed this Oct 15, 2025

ousleyp mentioned this pull request Oct 15, 2025

[WIP] CNV#67095: Docs on setup vGPU reach a dead end on step 3 of mdev creation #100595

Open

1 task


		<mdevNameSelector>:: Specifies the mediated devices that map to this value on the host.

		<resourceName>:: Specifies the matching resource name that is allocated on the node.

-<resourceName>:: Specifies the matching resource name that is allocated on the node.
+`mediatedDeviceTypes`:: Specifies global settings for the cluster and is required.
+`nodeMediatedDeviceTypes`:: Specifies global configuration overrides for a specific node or group of nodes and is optional. Must be used with the global `mediatedDeviceTypes` configuration.
+`mediatedDeviceTypes`:: Specifies an override to the global `mediatedDeviceTypes` configuration for the specified nodes. Required if you use `nodeMediatedDeviceTypes`.
+`nodeSelector`:: Specifies the node selector and must include a `key:value` pair. Required if you use `nodeMediatedDeviceTypes`.
+`mdevNameSelector`:: Specifies the mediated devices that map to this value on the host.
+`resourceName`:: Specifies the matching resource name that is allocated on the node.

		[source,yaml,subs="attributes+"]

		[source,yaml]

CNV#67095-2: Docs on setup vGPU reach a dead end on step 3 of mdev creation #100376

CNV#67095-2: Docs on setup vGPU reach a dead end on step 3 of mdev creation #100376

Conversation

Vaishali-gif-rh commented Oct 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-ci-robot commented Oct 13, 2025

Uh oh!

openshift-ci-robot commented Oct 13, 2025

Uh oh!

ocpdocs-previewbot commented Oct 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sjhala-ccs left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

openshift-ci bot commented Oct 14, 2025

Uh oh!

ousleyp left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ousleyp commented Oct 15, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Vaishali-gif-rh commented Oct 13, 2025 •

edited

Loading

ocpdocs-previewbot commented Oct 13, 2025 •

edited

Loading