Skip to content

Add documentation for the systemd nvidia-container-toolkit.service #203

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 9, 2025

Conversation

ArangoGutierrez
Copy link
Collaborator

No description provided.

@ArangoGutierrez ArangoGutierrez self-assigned this Jun 27, 2025
Copilot

This comment was marked as outdated.

Copy link

Documentation preview

https://nvidia.github.io/cloud-native-docs/review/pr-203

Copilot

This comment was marked as outdated.

Copilot

This comment was marked as outdated.

@ArangoGutierrez
Copy link
Collaborator Author

@a-mccarthy / @elezar PTAL

Copy link
Collaborator

@chenopis chenopis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just address the last 2 comments from @elezar and @a-mccarthy. LGTM otherwise.

@ArangoGutierrez
Copy link
Collaborator Author

Just address the last 2 comments from @elezar and @a-mccarthy. LGTM otherwise.

Done, PTAL

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR enhances the NVIDIA Container Toolkit documentation by fixing minor typos, cleaning up formatting, and adding a detailed section on the new nvidia-cdi-refresh systemd service for automatic CDI spec generation.

  • Corrected spelling errors and formatting in sample-workload, release-notes, and install-guide.
  • Introduced “Automatic CDI Specification Generation” section detailing the nvidia-cdi-refresh service, its customization, and management.
  • Updated manual CDI generation paths and noted automatic handling in v1.18.0.

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
container-toolkit/sample-workload.md Fixed typo “configura” → “configure” in Podman sample workload instructions
container-toolkit/release-notes.md Corrected “conatiners” → “containers” in release notes
container-toolkit/install-guide.md Removed extraneous blank line before “Next Steps”
container-toolkit/cdi-support.md Added comprehensive docs for nvidia-cdi-refresh service and updated manual spec paths
Comments suppressed due to low confidence (3)

container-toolkit/cdi-support.md:1

  • [nitpick] The date metadata at the top appears outdated given the v1.18.0 additions; consider updating it to the current date or adding a 'Last Updated' field for clarity.
% Date: November 11 2022

container-toolkit/cdi-support.md:4

  • [nitpick] Consider consolidating multiple % Author lines into a single metadata entry (e.g., '% Author: elezar ([email protected]); ArangoGutierrez ([email protected])') to avoid duplicate keys.
% Author: ArangoGutierrez ([email protected])

container-toolkit/cdi-support.md:73

  • [nitpick] It may help readers to know where these systemd unit files are installed (e.g., /usr/lib/systemd/system/) or which package provides them.
- `nvidia-cdi-refresh.path` - Monitors for changes to driver files and triggers the service

Copy link
Collaborator

@chenopis chenopis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@chenopis chenopis merged commit 01f0197 into NVIDIA:main Jul 9, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants