docs: add NVIDIA CDI configuration guide#613
Open
spencercjh wants to merge 2 commits into
Open
Conversation
✅ Deploy Preview for project-hami ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: spencercjh The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
📝 WalkthroughWalkthroughAdds CDI enablement documentation for HAMi, including Helm configuration, verification, troubleshooting, prerequisite links, Chinese translations, versioned pages, and installation sidebar entries. ChangesCDI documentation rollout
Estimated code review effort: 2 (Simple) | ~15 minutes Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
Author
|
/assign mesutoezdil |
Contributor
Author
|
Should we hold this PR until Project-HAMi/HAMi#2087 is merged and updated again after that? |
Contributor
Author
|
This is first-hand feedback from a client we serve. We’ve found that CDI is a rather complex issue that isn’t easy to resolve. |
spencercjh
changed the title
spencercjh
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In
`@i18n/zh/docusaurus-plugin-content-docs/version-v2.8.0/installation/how-to-use-hami-dra.md`:
- Line 15: Regenerate all affected versioned documentation through the
Docusaurus versioning workflow rather than editing snapshots directly:
i18n/zh/docusaurus-plugin-content-docs/version-v2.8.0/installation/how-to-use-hami-dra.md
lines 15-15,
i18n/zh/docusaurus-plugin-content-docs/version-v2.8.0/installation/prerequisites.md
lines 23-24,
i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/installation/how-to-use-hami-dra.md
lines 21-21,
i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/installation/prerequisites.md
lines 22-23, versioned_docs/version-v2.8.0/installation/how-to-use-hami-dra.md
lines 15-15, and versioned_docs/version-v2.8.0/installation/prerequisites.md
lines 22-23. Apply the documentation change to the current source pages first,
then run the established version-generation command so every listed snapshot is
updated consistently.
In `@versioned_docs/version-v2.8.0/installation/configure-cdi.md`:
- Around line 85-92: Pin the Helm chart version in the Install or upgrade HAMi
command: add --version 2.8.0 in
versioned_docs/version-v2.8.0/installation/configure-cdi.md:85-92 and its
Chinese counterpart
i18n/zh/docusaurus-plugin-content-docs/version-v2.8.0/installation/configure-cdi.md:86-93;
add --version 2.9.0 in
versioned_docs/version-v2.9.0/installation/configure-cdi.md:85-92 and its
Chinese counterpart
i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/installation/configure-cdi.md:86-93.
In `@versioned_docs/version-v2.9.0/installation/how-to-use-hami-dra.md`:
- Line 21: Update the corresponding source installation docs rather than the
immutable snapshots, then regenerate the v2.9.0 documentation using the
prescribed Docusaurus versioning command. This applies to
versioned_docs/version-v2.9.0/installation/how-to-use-hami-dra.md at lines 21-21
and versioned_docs/version-v2.9.0/installation/prerequisites.md at lines 22-22;
both sites should be corrected by regenerating the snapshot.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 34223542-59de-4690-8fd6-a11cf4854160
📒 Files selected for processing (21)
docs/installation/configure-cdi.mddocs/installation/how-to-use-hami-dra.mddocs/installation/prerequisites.mdi18n/zh/docusaurus-plugin-content-docs/current/installation/configure-cdi.mdi18n/zh/docusaurus-plugin-content-docs/current/installation/how-to-use-hami-dra.mdi18n/zh/docusaurus-plugin-content-docs/current/installation/prerequisites.mdi18n/zh/docusaurus-plugin-content-docs/version-v2.8.0/installation/configure-cdi.mdi18n/zh/docusaurus-plugin-content-docs/version-v2.8.0/installation/how-to-use-hami-dra.mdi18n/zh/docusaurus-plugin-content-docs/version-v2.8.0/installation/prerequisites.mdi18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/installation/configure-cdi.mdi18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/installation/how-to-use-hami-dra.mdi18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/installation/prerequisites.mdsidebars.jsversioned_docs/version-v2.8.0/installation/configure-cdi.mdversioned_docs/version-v2.8.0/installation/how-to-use-hami-dra.mdversioned_docs/version-v2.8.0/installation/prerequisites.mdversioned_docs/version-v2.9.0/installation/configure-cdi.mdversioned_docs/version-v2.9.0/installation/how-to-use-hami-dra.mdversioned_docs/version-v2.9.0/installation/prerequisites.mdversioned_sidebars/version-v2.8.0-sidebars.jsonversioned_sidebars/version-v2.9.0-sidebars.json
Document CDI concepts, chart values, verification, and troubleshooting in English and Chinese. Backport the guide and navigation to v2.8.0 and v2.9.0. Signed-off-by: spencercjh <spencercjh@gmail.com>
Signed-off-by: spencercjh <spencercjh@gmail.com>
spencercjh
changed the title
Contributor
|
/hold |
Contributor
yes |
Contributor
Author
|
cc @FouoF |
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
2 participants
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.
Most of this Pull Request was generated or revised with the assistance of AI tools (Codex with GPT-5.6 Sol High and kimi-code with K3). I have reviewed the resulting content and take full responsibility for its accuracy, security, licensing compliance, and inclusion in this project.
What changed
installation/configure-cdi.md) in English and Chinese, covering:k8s.device-plugin.nvidia.com/gpukind, specification written to/var/run/cdi)devicePlugin.deviceListStrategy: "cdi-annotations",nvidiaDriverRoot, andnvidiaHookPath, with host-installed and GPU Operator path presetsinstallation/prerequisites.mdin both localeshow-to-use-hami-dra.mdat the internal guide instead of the external CDI READMEWhy
CDI is a vendor-neutral specification, but HAMi currently implements CDI device injection only for NVIDIA GPUs. The DRA integration depends on CDI being enabled in the container runtime, yet the documentation did not explain how to configure and verify HAMi's NVIDIA CDI integration. Both v2.8.0 and v2.9.0 ship the required NVIDIA chart values and Device Plugin implementation, so the guide is included in both released versions as well as
next.This PR does not add or document CDI support for non-NVIDIA devices.
Important review notes
disable-device-node-modificationhook requires NVIDIA Container Toolkit >= 1.18.0nvidiaHookPathpointing atnvidia-ctkis valid with Toolkit >= 1.18.0 becausenvidia-ctk hookexposes the same hook subcommands asnvidia-cdi-hookk8s.device-plugin.nvidia.com/gpu) and generated specification path (/var/run/cdi/k8s.device-plugin.nvidia.com-gpu.json) match the HAMi NVIDIA Device Plugin sourceValidation
npm run lintpassesnpm run format:checkpassesnpm run buildsucceeds for both English and Chinese localesSummary by CodeRabbit