Skip to content

docs: fix nvidia-container-runtime usage example#1905

Merged
cdesiniotis merged 1 commit into
NVIDIA:mainfrom
iacker:docs/fix-runtime-usage-example
Jul 23, 2026
Merged

docs: fix nvidia-container-runtime usage example#1905
cdesiniotis merged 1 commit into
NVIDIA:mainfrom
iacker:docs/fix-runtime-usage-example

Conversation

@iacker

@iacker iacker commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

This updates the nvidia-container-runtime usage example so it follows the runtime path described earlier in the README: the NVIDIA runtime modifies the OCI spec when a create command is detected, then the container can be started.

The old example used run, which skips the modifier path and leaves the generated config.json unchanged, as reported in #781.

Fixes #781

Validation:

  • Confirmed the old nvidia-container-runtime run nvidia_smi example is no longer present.
  • Confirmed the replacement example uses create, start, and cleanup with delete.

AI assistance disclosure:

  • I used AI assistance to identify the stale example and prepare this small documentation update.

@copy-pr-bot

copy-pr-bot Bot commented Jul 4, 2026

Copy link
Copy Markdown

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.

@henry118 henry118 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

Signed-off-by: Billard <82095453+iacker@users.noreply.github.com>
Co-authored-by: Christopher Desiniotis <cdesiniotis@nvidia.com>
@cdesiniotis
cdesiniotis force-pushed the docs/fix-runtime-usage-example branch from fdeed4c to ebf6e57 Compare July 23, 2026 20:51
@cdesiniotis

Copy link
Copy Markdown
Contributor

I tried out the new procedure, and hit the below error:

$ sudo nvidia-container-runtime create nvidia_smi
ERRO[0000] runc create failed: cannot allocate tty if runc will detach without setting console socket

I have modified the commit in this PR so that the procedure is functional.

@henry118 ptal

@cdesiniotis
cdesiniotis requested a review from henry118 July 23, 2026 20:52
@cdesiniotis cdesiniotis self-assigned this Jul 23, 2026

@henry118 henry118 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM. Thanks for pointing out the TTY issue.

@cdesiniotis

Copy link
Copy Markdown
Contributor

Thank you @iacker for the contribution.

@cdesiniotis
cdesiniotis merged commit f7cb44c into NVIDIA:main Jul 23, 2026
6 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.

nvidia-container-runtime usage example is broken/incorrect

3 participants