NVIDIA / NVIDIA/cloud-native-docs
install-gpu-operator-vgpu: say the driver-container build is for non-NVIDIA AI Enterprise customers; NVAIE customers can pull the prebuilt image from NGC
Nobody has claimed this yet.
- Dominant language
- PowerShell
- Stars
- 43
- Forks
- 53
- Avg merge
- 3d 4h
- Merged PRs (30d)
- 19
Description
Summary
gpu-operator/install-gpu-operator-vgpu.rst presents building the vGPU guest driver container from the licensing-portal ZIP as the only way to get a driver image, and never says who that workflow is for. NVIDIA AI Enterprise customers have a prebuilt vGPU guest driver image on NGC (nvcr.io/nvaie/vgpu-guest-driver), and the page should say that so they do not build an image they could have pulled.
This request has come up more than once recently, including from a customer who read the page as mandatory.
Current text
The prerequisites make Git, Docker, and a private registry unconditional:
* You have access to a private registry such as NVIDIA NGC Private Registry and can push container images to the registry.
* Git and Docker are required to build the vGPU driver image from source repository and push to the private registry.
"Build the Driver Container" opens with no scoping statement, and nothing on the page mentions NVIDIA AI Enterprise, NGC entitlement, or the prebuilt image.
Elsewhere the docs already show the prebuilt image being used, so the two pages disagree on whether building is required:
- https://github.com/NVIDIA/cloud-native-docs/blob/db636fa/openshift/nvaie-with-ocp.rst#L242-L249 (
vgpu-guest-driverimages fromnvcr.io/nvaie) - https://github.com/NVIDIA/cloud-native-docs/blob/db636fa/gpu-operator/gpu-operator-rdma.rst#L177-L183 (
nvcr.io/nvaie/vgpu-guest-driver:...in sample output)
Suggested change
- At the top of "Build the Driver Container" (or in the prerequisites), state that building the driver container is for customers who have a vGPU entitlement but not NVIDIA AI Enterprise, and that NVIDIA AI Enterprise customers can instead pull the prebuilt
vgpu-guest-driverimage from thenvaieNGC org and skip the build and download steps. - Cross-reference :ref:
nvaie-ocp(and the equivalent guidance for non-OpenShift clusters) for how to setdriver.repository/driver.image/driver.versionand the NGC pull secret when using the prebuilt image. - Make the Git/Docker/private-registry prerequisites conditional on the build path.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in gpu-operator/install-gpu-operator-vgpu.rst, especially the prerequisites and “Build the Driver Container” section, then compare openshift/nvaie-with-ocp.rst and gpu-operator/gpu-operator-rdma.rst. Clarify the build versus NGC prebuilt paths, make build prerequisites conditional, and cross-reference the configuration and pull-secret guidance; done when NVAIE readers can skip the build and download steps without ambiguity.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, git, kubernetes
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 84/100