Skip to content

Update README.md #647

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 387 commits into from
Closed

Update README.md #647

wants to merge 387 commits into from

Conversation

Alokbpandey
Copy link

No description provided.

@ArangoGutierrez ArangoGutierrez added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label May 23, 2025
@ArangoGutierrez ArangoGutierrez self-assigned this Jul 10, 2025
@ArangoGutierrez ArangoGutierrez requested a review from Copilot July 10, 2025 10:11
Copilot
Copilot AI reviewed Jul 10, 2025
View reviewed changes
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 improves the README by tightening phrasing and adding a section directing users to the project’s changelog.

  • Hyphenates “GPU-accelerated” for consistency.
  • Introduces a “Releases and Updates” section with a link to the changelog.
Comments suppressed due to low confidence (1)

README.md:35

  • The changelog link points to libnvidia-container, but this repository is nvidia-container-toolkit. Please update the URL to reference the toolkit’s own CHANGELOG.
For the latest releases and updates, check the [CHANGELOG](https://github.com/NVIDIA/libnvidia-container/blob/main/CHANGELOG.md).

@ArangoGutierrez
Copy link
Collaborator

Hey @Alokbpandey, thanks for the PR Could you sign your commit so it passes the DCO check?

@copy-pr-bot copy-pr-bot
Copy link

copy-pr-bot bot commented Jul 11, 2025

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@ArangoGutierrez ArangoGutierrez mentioned this pull request Jul 14, 2025
Closed
elezar and others added 22 commits July 14, 2025 17:52
@elezar @Alokbpandey
Move nvidia-toolkit to nvidia-ctk-installer
682a673 
This change moves the containerized installer from nvidia-toolkit to
cmd/nvidia-ctk-installer to allow for its use in CI.

Signed-off-by: Evan Lezar <[email protected]>
@elezar @Alokbpandey
[no-relnote] Rename run.go to main.go
e796f60 
Signed-off-by: Evan Lezar <[email protected]>
@elezar @Alokbpandey
[no-relnote] Move tools/container to cmd/nvidia-ctk-installer
6399237 
Signed-off-by: Evan Lezar <[email protected]>
@elezar @Alokbpandey
Disable mounting of compat libs from container
a1b3783 
This change passes the --no-cntlibs argument to the nvidia-container-cli
from the nvidia-container-runtime-hook to disable overwriting host
drivers with the compat libs from a container being started.

Note that this may be a breaking change for some applications.

Signed-off-by: Evan Lezar <[email protected]>
@elezar @Alokbpandey
Add allow-cuda-compat-libs-from-container feature flag
8a28773 
This change adds an allow-cuda-compat-libs-from-container feature flag
to the NVIDIA Container Toolkit config. This allows a user to opt-in
to the previous default behaviour of overriding certain driver
libraries with CUDA compat libraries from the container.

Signed-off-by: Evan Lezar <[email protected]>
@elezar @Alokbpandey
Bump libnvidia-container to f23e5e55
c2fbbf5 
Signed-off-by: Evan Lezar <[email protected]>
@ArangoGutierrez @Alokbpandey
Rename test folder to tests
4c01499 
Signed-off-by: Carlos Eduardo Arango Gutierrez <[email protected]>
Signed-off-by: Evan Lezar <[email protected]>
@dependabot @Alokbpandey
Bump third_party/libnvidia-container from f23e5e5 to 95d3e86
8dd090e 
Bumps [third_party/libnvidia-container](https://github.com/NVIDIA/libnvidia-container) from `f23e5e5` to `95d3e86`.
- [Release notes](https://github.com/NVIDIA/libnvidia-container/releases)
- [Commits](NVIDIA/libnvidia-container@f23e5e5...95d3e86)

---
updated-dependencies:
- dependency-name: third_party/libnvidia-container
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <[email protected]>
@elezar @Alokbpandey
Add IMEX binaries to CDI discovery
1903f9c 
This change adds the nvidia-imex and nivdia-imex-ctl binaries to
the list of driver binaries that are searched when using CDI.

Signed-off-by: Evan Lezar <[email protected]>
@dependabot @Alokbpandey
Bump nvidia/cuda in /deployments/container
d4f03bb 
Bumps nvidia/cuda from 12.6.3-base-ubuntu20.04 to 12.8.0-base-ubuntu20.04.

---
updated-dependencies:
- dependency-name: nvidia/cuda
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
@tariq1890 @Alokbpandey
[no-relnote] switch to the newer qemu artifacts image
d3d9610 
Signed-off-by: Tariq Ibrahim <[email protected]>
@cdesiniotis @Alokbpandey
Add EnableCDI() method to engine.Interface
1b2d4c0 
This change adds an EnableCDI method to the container engine config files and
Updates the 'nvidia-ctk runtime configure' command to use this new method.

Signed-off-by: Christopher Desiniotis <[email protected]>
@elezar @Alokbpandey
Remove Set from engine config API
17579bc 
Signed-off-by: Evan Lezar <[email protected]>
@cdesiniotis @Alokbpandey
Add option in toolkit container to enable CDI in runtime
7fff56f 
Signed-off-by: Christopher Desiniotis <[email protected]>
@elezar @Alokbpandey
Fix overwriting docker feature flags
6e91713 
Signed-off-by: Evan Lezar <[email protected]>
@elezar @Alokbpandey
Enable CDI in runtime if CDI_ENABLED is set
5404151 
This change also enables CDI in the configured runtime when the toolkit
is installed with CDI enabled.

Signed-off-by: Evan Lezar <[email protected]>
@elezar @Alokbpandey
[no-relnote] Add unit test for installer command
a70353e 
This change adds a basic unit test for the nvidia-ckt-installer command.

Signed-off-by: Evan Lezar <[email protected]>
@elezar @Alokbpandey
[no-relnote] Add basic cdi-enabled tests
d5dc977 
Signed-off-by: Evan Lezar <[email protected]>
@ArangoGutierrez @Alokbpandey
Add remote-test option for E2E
8b3e0eb 
Signed-off-by: Carlos Eduardo Arango Gutierrez <[email protected]>
@elezar @Alokbpandey
[no-relnote] Enable pr-copy-bot
a2b9261 
Signed-off-by: Evan Lezar <[email protected]>
@elezar @Alokbpandey
[no-relnote] Use github.ref_name to detect PRs
d59795b 
Signed-off-by: Evan Lezar <[email protected]>
@elezar @Alokbpandey
[no-relnote] Remove unused LABEL_IMAGE_SOURCE
ec38837 
Signed-off-by: Evan Lezar <[email protected]>
elezar and others added 27 commits July 14, 2025 17:55
@elezar @Alokbpandey
Add SpecGenerator interface
5525876 
Signed-off-by: Evan Lezar <[email protected]>
@elezar @Alokbpandey
Simplify nvcdi interface
bd34738 
Signed-off-by: Evan Lezar <[email protected]>
@elezar @Alokbpandey
Refactor nvml CDI spec generation for consistency
53ef53d 
Signed-off-by: Evan Lezar <[email protected]>
@elezar @Alokbpandey
Use securejoin to resolve /proc
27f3d0e 
This change updates the proc mount when updating ldconfig to
use secure join to align with the other functions.

Signed-off-by: Evan Lezar <[email protected]>
@ArangoGutierrez @Alokbpandey
[no-relnote] Remove unused func ParseArgs
a8e1286 
Signed-off-by: Carlos Eduardo Arango Gutierrez <[email protected]>
@ArangoGutierrez @Alokbpandey
[no-relnote] Fix typo con nvidia-ctk/cdi cmd
edf6ca8 
Signed-off-by: Carlos Eduardo Arango Gutierrez <[email protected]>
@ArangoGutierrez @Alokbpandey
[no-relnote] Fix typo on nvidia-ctk-hook cmd
e5e21b5 
Signed-off-by: Carlos Eduardo Arango Gutierrez <[email protected]>
@elezar @Alokbpandey
[no-relnote] Migrate to urfave v3
49ee876 
Signed-off-by: Carlos Eduardo Arango Gutierrez <[email protected]>
Signed-off-by: Evan Lezar <[email protected]>
@elezar @Alokbpandey
[no-relnote] Set Before and Action in declaration
484ae78 
Signed-off-by: Evan Lezar <[email protected]>
@elezar @Alokbpandey
[no-relnote] Set Commands in declaration
3140c69 
Signed-off-by: Evan Lezar <[email protected]>
@elezar @Alokbpandey
[no-relnote] Set Flags in declaration
43e1620 
Signed-off-by: Evan Lezar <[email protected]>
@ArangoGutierrez @Alokbpandey
Load settings from config.toml file during CDI generation
70b0ac4 
Signed-off-by: Carlos Eduardo Arango Gutierrez <[email protected]>
@dependabot @Alokbpandey
Bump golang from 1.24.4 to 1.24.5 in /deployments/devel
a411823 
Bumps golang from 1.24.4 to 1.24.5.

---
updated-dependencies:
- dependency-name: golang
  dependency-version: 1.24.5
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
@elezar @Alokbpandey
[no-relnote] Move definitions from .common to .nvidia-ci
1045ebf 
Since we no longer maintain two pipeline definitions, it is
simpler to maintain a single CI definition file.

Signed-off-by: Evan Lezar <[email protected]>
@elezar @Alokbpandey
[no-relnote] Remove the signing of images
78e9695 
Signed-off-by: Evan Lezar <[email protected]>
@elezar @Alokbpandey
[no-relnote] Add CI job to trigger image publishing
6fbdfcc 
Signed-off-by: Evan Lezar <[email protected]>
@ArangoGutierrez @Alokbpandey
Bump version for v1.18.0-rc.2 release
3594486 
Signed-off-by: Carlos Eduardo Arango Gutierrez <[email protected]>
@ArangoGutierrez @Alokbpandey
[no-relnote] Avoid error in changelog script when submodule is unchanged
717c269 
Signed-off-by: Carlos Eduardo Arango Gutierrez <[email protected]>
@ArangoGutierrez @Alokbpandey
[no-relnote] Add v1.18.0-rc.2 changelog
5fd1ad8 
Signed-off-by: Carlos Eduardo Arango Gutierrez <[email protected]>
@dependabot @Alokbpandey
Bump slackapi/slack-github-action from 2.1.0 to 2.1.1
a3e3191 
Bumps [slackapi/slack-github-action](https://github.com/slackapi/slack-github-action) from 2.1.0 to 2.1.1.
- [Release notes](https://github.com/slackapi/slack-github-action/releases)
- [Commits](slackapi/slack-github-action@v2.1.0...v2.1.1)

---
updated-dependencies:
- dependency-name: slackapi/slack-github-action
  dependency-version: 2.1.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot @Alokbpandey
Bump golang.org/x/mod from 0.25.0 to 0.26.0
358f59f 
Bumps [golang.org/x/mod](https://github.com/golang/mod) from 0.25.0 to 0.26.0.
- [Commits](golang/mod@v0.25.0...v0.26.0)

---
updated-dependencies:
- dependency-name: golang.org/x/mod
  dependency-version: 0.26.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot @Alokbpandey
Bump golang.org/x/sys from 0.33.0 to 0.34.0
2c7d790 
Bumps [golang.org/x/sys](https://github.com/golang/sys) from 0.33.0 to 0.34.0.
- [Commits](golang/sys@v0.33.0...v0.34.0)

---
updated-dependencies:
- dependency-name: golang.org/x/sys
  dependency-version: 0.34.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
@jcpunk @Alokbpandey
[no-relnote] Setup envfile for systemd services
53de731 
Signed-off-by: Pat Riehecky <[email protected]>
Signed-off-by: Evan Lezar <[email protected]>
@elezar @Alokbpandey
[no-relnote] Fix rpm package definition
e77f489 
The change from c4a9bbe did not add
the envfile to the rpm sources.

Signed-off-by: Evan Lezar <[email protected]>
@elezar @Alokbpandey
[no-relnote] Allow coveralls upload to fail
172b705 
Signed-off-by: Evan Lezar <[email protected]>
@elezar @Alokbpandey
[no-relnote] Fix type in publish script
1df5661 
Signed-off-by: Evan Lezar <[email protected]>
@elezar @Alokbpandey
[no-relnote] Fix type in publish script
187a60a 
Signed-off-by: Evan Lezar <[email protected]>
@elezar
Copy link
Member

elezar commented Jul 23, 2025

@Alokbpandey thanks for the suggestions. I will make the hyphenation change locally. The other README additions are not something that make sense at this moment.

@elezar elezar closed this Jul 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

Copilot code review Copilot Copilot left review comments

Assignees

@ArangoGutierrez ArangoGutierrez

Labels
lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@Alokbpandey @ArangoGutierrez @elezar @tariq1890 @cdesiniotis @dschervov @JunAr7112 @jcpunk