mirror of https://github.com/NVIDIA/nvidia-container-toolkit synced 2024-11-25 13:35:00 +00:00

History

Evan Lezar 9ea214d0b3 Correct typo in info command Signed-off-by: Evan Lezar <elezar@nvidia.com>		2023-05-30 10:58:30 +02:00
..
cdi	Add csv mode to nvidia-ctk cdi generate command	2023-05-22 13:56:45 +02:00
config	Add nvidia-ctk config generate-default command	2023-05-03 16:11:05 +02:00
hook	Add symlinks package with Resolve function	2023-05-23 20:42:17 +02:00
info	Correct typo in info command	2023-05-30 10:58:30 +02:00
runtime	Export pkg config/engine	2023-04-25 07:16:59 +02:00
system	chore(cmd): Fixing minor spelling error.	2023-05-02 12:53:45 -05:00
main.go	Add nvidia-ctk config generate-default command	2023-05-03 16:11:05 +02:00
README.md	Add README for generating CDI specifications	2022-11-08 15:15:27 +01:00

README.md

NVIDIA Container Toolkit CLI

The NVIDIA Container Toolkit CLI nvidia-ctk provides a number of utilities that are useful for working with the NVIDIA Container Toolkit.

Functionality

Configure runtimes

The runtime command of the nvidia-ctk CLI provides a set of utilities to related to the configuration and management of supported container engines.

For example, running the following command:

nvidia-ctk runtime configure --set-as-default

will ensure that the NVIDIA Container Runtime is added as the default runtime to the default container engine.

Generate CDI specifications

The Container Device Interface (CDI) provides a vendor-agnostic mechanism to make arbitrary devices accessible in containerized environments. To allow NVIDIA devices to be used in these environments, the NVIDIA Container Toolkit CLI includes functionality to generate a CDI specification for the available NVIDIA GPUs in a system.

In order to generate the CDI specification for the available devices, run the following command:\

nvidia-ctk cdi generate

The default is to print the specification to STDOUT and a filename can be specified using the --output flag.

The specification will contain a device entries as follows (where applicable):

An nvidia.com/gpu=gpu{INDEX} device for each non-MIG-enabled full GPU in the system
An nvidia.com/gpu=mig{GPU_INDEX}:{MIG_INDEX} device for each MIG-device in the system
A special device called nvidia.com/gpu=all which represents all available devices.

For example, to generate the CDI specification in the default location where CDI-enabled tools such as podman, containerd, cri-o, or the NVIDIA Container Runtime can be configured to load it, the following command can be run:

sudo nvidia-ctk cdi generate --output=/etc/cdi/nvidia.yaml

(Note that sudo is used to ensure the correct permissions to write to the /etc/cdi folder)

With the specification generated, a GPU can be requested by specifying the fully-qualified CDI device name. With podman as an exmaple:

podman run --rm -ti --device=nvidia.com/gpu=gpu0 ubuntu nvidia-smi -L