nvidia-container-toolkit

mirror of https://github.com/NVIDIA/nvidia-container-toolkit synced 2025-06-26 18:18:24 +00:00

History

Evan Lezar 9208159263 Add dev-root option to toolkit container This changes adds an option to the toolkit container to allow the dev root to be specified. This adds support for driver installations where the driver files are at one root and the dev nodes are created elsewhere -- most typically at /. This is the case, for example, for GKE driver installations. Signed-off-by: Evan Lezar <elezar@nvidia.com>		2024-06-03 20:40:30 +02:00
..
containerd	Add support for adding additional containerd configs	2024-05-17 12:58:08 +02:00
crio	run goimports -local against the entire codebase	2023-12-01 11:13:17 +01:00
docker	run goimports -local against the entire codebase	2023-12-01 11:13:17 +01:00
nvidia-toolkit	Add nolint for exec calls	2023-10-24 20:11:34 +02:00
operator	Remove NVIDIA experimental runtime from toolkit container	2023-07-10 11:44:55 +02:00
toolkit	Add dev-root option to toolkit container	2024-06-03 20:40:30 +02:00
container.go	Add support for adding additional containerd configs	2024-05-17 12:58:08 +02:00
README.md	Remove NVIDIA experimental runtime from toolkit container	2023-07-10 11:44:55 +02:00

README.md

Introduction

This repository contains tools that allow docker, containerd, or cri-o to be configured to use the NVIDIA Container Toolkit.

Note: These were copied from the container-config repository are being migrated to commands installed with the NVIDIA Container Toolkit.

These will be migrated into an upcoming nvidia-ctk CLI as required.

Docker

After building the docker binary, run:

docker setup \
    --runtime-name NAME \
        /run/nvidia/toolkit

Configure the nvidia-container-runtime as a docker runtime named NAME. If the --runtime-name flag is not specified, this runtime would be called nvidia.

Since --set-as-default is enabled by default, the specified runtime name will also be set as the default docker runtime. This can be disabled by explicityly specifying --set-as-default=false.

The following table describes the behaviour for different --runtime-name and --set-as-default flag combinations.

Flags	Installed Runtimes	Default Runtime
NONE SPECIFIED	`nvidia`	`nvidia`
`--runtime-name nvidia`	`nvidia`	`nvidia`
`--runtime-name NAME`	`NAME`	`NAME`
`--set-as-default`	`nvidia`	`nvidia`
`--set-as-default --runtime-name nvidia`	`nvidia`	`nvidia`
`--set-as-default --runtime-name NAME`	`NAME`	`NAME`
`--set-as-default=false`	`nvidia`	NOT SET
`--set-as-default=false --runtime-name NAME`	`NAME`	NOT SET
`--set-as-default=false --runtime-name nvidia`	`nvidia`	NOT SET

These combinations also hold for the environment variables that map to the command line flags: DOCKER_RUNTIME_NAME, DOCKER_SET_AS_DEFAULT.

Containerd

After running the containerd binary, run:

containerd setup \
    --runtime-class NAME \
        /run/nvidia/toolkit

Configure the nvidia-container-runtime as a runtime class named NAME. If the --runtime-class flag is not specified, this runtime would be called nvidia.

Adding the --set-as-default flag as follows:

containerd setup \
    --runtime-class NAME \
    --set-as-default \
        /run/nvidia/toolkit

will set the runtime class NAME (or nvidia if not specified) as the default runtime class.

The following table describes the behaviour for different --runtime-class and --set-as-default flag combinations.

Flags	Installed Runtime Classes	Default Runtime Class
NONE SPECIFIED	`nvidia`	NOT SET
`--runtime-class NAME`	`NAME`	NOT SET
`--runtime-class nvidia`	`nvidia`	NOT SET
`--set-as-default`	`nvidia`	`nvidia`
`--set-as-default --runtime-class NAME`	`NAME`	`NAME`
`--set-as-default --runtime-class nvidia`	`nvidia`	`nvidia`

These combinations also hold for the environment variables that map to the command line flags.