README
¶
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.
Documentation
¶
Index ¶
- type Options
- func (o Options) Configure(cfg engine.Interface) error
- func (o Options) Flush(cfg engine.Interface) error
- func (o Options) GetConfigLoaders(commandSourceFunc func(string, string) toml.Loader) ([]toml.Loader, error)
- func (o Options) Restart(service string, withSignal func(string) error) error
- func (o Options) RevertConfig(cfg engine.Interface) error
- func (o Options) SystemdRestart(service string) error
- func (o Options) Unconfigure(cfg engine.Interface) error
- func (o Options) UpdateConfig(cfg engine.Interface) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Options ¶
type Options struct {
DropInConfig string
DropInConfigHostPath string
// TopLevelConfigPath stores the path to the top-level config for the runtime.
TopLevelConfigPath string
Socket string
// ExecutablePath specifies the path to the container runtime executable.
// This is used to extract the current config, for example.
// If a HostRootMount is specified, this path is relative to the host root
// mount.
ExecutablePath string
// EnabledCDI indicates whether CDI should be enabled.
EnableCDI bool
RuntimeName string
RuntimeDir string
SetAsDefault bool
RestartMode string
HostRootMount string
ConfigSources []string
}
Options defines the shared options for the CLIs to configure containers runtimes.
func (Options) GetConfigLoaders ¶
func (o Options) GetConfigLoaders(commandSourceFunc func(string, string) toml.Loader) ([]toml.Loader, error)
GetConfigLoaders returns the loaders for the requested config sources. Supported config sources can be specified as:
* 'file[=path/to/file]': The specified file or the top-level config path is used. * command: The runtime-specific function supplied as an argument is used.
func (Options) RevertConfig ¶
RevertConfig reverts the specified config to remove the nvidia runtimes
func (Options) SystemdRestart ¶
SystemdRestart restarts the specified service using systemd
func (Options) Unconfigure ¶
Unconfigure removes the options from the specified config
Source Files
Directories