Repository navigation
docs(gpu-operator): State that the DRA Driver is opt-in - #535
Open
mikemckiernan wants to merge 1 commit into
Open
mikemckiernan wants to merge 1 commit into
mikemckiernan wants to merge 1 commit into
Conversation
Lead the DRA Driver page with the default behavior and the opt-in and opt-out Helm values. Explain each --set flag in the Install section and separate the NVIDIA GPU driver from the DRA Driver. Rewrite the clusterPolicy.deployCR, gpuCluster.deployCR, and driver.nvidiaDriverCRD.enabled chart option rows in reader terms and link to the install procedure anchor. Signed-off-by: Mike McKiernan <mmckiernan@nvidia.com> Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Contributor
|
I'll fix CI failures and address comments from users with write access. I'll skip comments containing "(aside)".
|
Documentation preview |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The DRA Driver page never said whether the GPU Operator installs the DRA Driver by default, or which value turns it on or off. Readers also had to work out what the
gpuCluster.deployCR,clusterPolicy.deployCR, anddriver.nvidiaDriverCRD.enabledvalues do from the Helm commands alone. The "DRA driver operands" wording was jargon, and a link sent readers back to the page they were already on.dra-intro-install.rstgpuCluster.deployCR=trueandclusterPolicy.deployCR=false. If the Operator also installs the GPU driver, setdriver.nvidiaDriverCRD.enabled=truetoo.gpuCluster.deployCRor set it tofalse.gpuCluster.deployCR=falsedoesn't remove the DRA Driver.--setvalue does. It also says thatdriver.nvidiaDriverCRD.enabledcontrols the NVIDIA GPU driver, not the DRA Driver.dra-driver-installanddra-driver-uninstallanchors for the new cross-references.getting-started.rst: rewrites theclusterPolicy.deployCR,gpuCluster.deployCR, anddriver.nvidiaDriverCRD.enabledchart option rows in reader terms, and links them to the install anchor instead of the page.I checked each behavior claim against the GPU Operator
v26.7.2chart:values.yaml):clusterPolicy.deployCR: trueandgpuCluster.deployCR: false.templates/validations.yaml): the chart fails when bothdeployCRvalues aretrue. It also fails whengpuCluster.deployCR=true,driver.enabled=true, anddriver.nvidiaDriverCRD.enabled=false.templates/gpucluster.yaml): theGPUClusterresource hashelm.sh/resource-policy: keep, and a pre-delete cleanup hook deletes it when you uninstall.Review notes
clusterPolicy.deployCR=falsewording. The Install list says this value "disables the NVIDIA Kubernetes Device Plugin". The value actually skips the wholeClusterPolicyresource. Should the wording say that instead?kubectl delete gpucluster gpu-clustera supported way to remove the DRA Driver and keep the GPU Operator? The page doesn't mention it.gpuCluster.deployCR=true" now repeats the new opening answer. Keep it or cut it?dra-intro-install.rst. A test merge of the two branches had no conflicts.Validation
./repo docs -p gpu-operatoringhcr.io/nvidia/cloud-native-docs:0.5.1gives the same 41 warnings and errors before and after this change. They include the existing tab-set errors and unreachable external inventories.I drafted this change with Devin, an AI assistant.
Link to Devin session: https://nvidia-cloud.devinenterprise.com/sessions/c60207a0e98342e98cefb31c56508ff6
Open in Devin Desktop: https://nvidia-cloud.devinenterprise.com/desktop/session/c60207a0e98342e98cefb31c56508ff6?variant=devin
Requested by: @mikemckiernan