OS Manuals

/usr/bin/nvidia-ctk-installer

From nvidia-container-toolkit-nvidia-ctk-installer 1.20.0-r3 (os), captured 2026-11-10 by running nvidia-ctk-installer --help (exit 0). permalink

time="2026-11-10T13:52:18Z" level=info msg="Starting nvidia-ctk-installer"
NAME:
   nvidia-ctk-installer - Install the NVIDIA Container Toolkit and configure the specified runtime to use the `nvidia` runtime.

USAGE:
   nvidia-ctk-installer [global options]

VERSION:
   1.20.0
commit: 5505e2f94d9aaa08561490db974ba3cd676af209

GLOBAL OPTIONS:
   --no-daemon, -n                                                                                                                      terminate immediately after setting up the runtime. Note that no cleanup will be performed [$NO_DAEMON]
   --no-runtime-config                                                                                                                  Disables the configuration of a container runtime. This is used in cases where the runtime has already been configured for use with the toolkit, and the installer is only used to deploy the components of the NVIDIA Container Toolkit. [$NO_RUNTIME_CONFIG]
   --enable-nri-plugin, -p                                                                                                              if set to true, the toolkit will stand up an NRI Plugin server used to inject CDI devices to containers. Note that this option will be ignored if --no-daemon is set. [$ENABLE_NRI_PLUGIN]
   --nri-plugin-index uint                                                                                                              Specify the plugin index to register to NRI (default: 10) [$NRI_PLUGIN_INDEX]
   --nri-socket string                                                                                                                  Specify the path to the NRI socket file to register the NRI plugin server (default: "/var/run/nri/nri.sock") [$NRI_SOCKET]
   --nri-namespace string                                                                                                               Specify the kubernetes namespace the toolkit's NRI plugin is running in. [$NRI_NAMESPACE]
   --nri-management-cdi-device-namespaces string [ --nri-management-cdi-device-namespaces string ]                                      Specify the list of kubernetes namespaces (in addition to the nri-namespace) that are allowed to receive management CDI devices through the NRI plugin [$NRI_MANAGEMENT_CDI_DEVICE_NAMESPACES]
   --runtime string, -r string                                                                                                          the runtime to setup on this node. One of {'docker', 'crio', 'containerd'}. This setting is ignored if --no-runtime-config is specified. (default: "docker") [$RUNTIME]
   --toolkit-install-dir ROOT, --root ROOT                                                                                              The directory where the NVIDIA Container Toolkit is to be installed. The components of the toolkit will be installed to ROOT/toolkit. Note that in the case of a containerized installer, this is the path in the container and it is recommended that this match the path on the host. (default: "/usr/local/nvidia") [$TOOLKIT_INSTALL_DIR, $ROOT]
   --toolkit-source-root string                                                                                                         The folder where the required toolkit artifacts can be found. If this is not specified, the path /artifacts/{{ .ToolkitPackageType }} is used where ToolkitPackageType is the resolved package type [$TOOLKIT_SOURCE_ROOT]
   --toolkit-package-type string                                                                                                        specify the package type to use for the toolkit. One of ['deb', 'rpm', 'auto', '']. If 'auto' or '' are used, the type is inferred automatically. (default: "auto") [$TOOLKIT_PACKAGE_TYPE]
   --pid-file string                                                                                                                    the path to a toolkit.pid file to ensure that only a single configuration instance is running (default: "/run/nvidia/toolkit/toolkit.pid") [$TOOLKIT_PID_FILE, $PID_FILE]
   --debug                                                                                                                              enable debug-level log in the toolkit installer [$TOOLKIT_DEBUG]
   --driver-root string, --nvidia-driver-root string                                                                                    (default: "/run/nvidia/driver") [$NVIDIA_DRIVER_ROOT, $DRIVER_ROOT]
   --driver-root-ctr-path string                                                                                                        (default: "/run/nvidia/driver") [$DRIVER_ROOT_CTR_PATH]
   --dev-root /dev                                                                                                                      Specify the root where /dev is located. If this is not specified, the driver-root is assumed. [$NVIDIA_DEV_ROOT, $DEV_ROOT]
   --dev-root-ctr-path /dev                                                                                                             Specify the root where /dev is located in the container. If this is not specified, the driver-root-ctr-path is assumed. [$DEV_ROOT_CTR_PATH]
   --nvidia-container-runtime.debug string, --nvidia-container-runtime-debug string                                                     Specify the location of the debug log file for the NVIDIA Container Runtime [$NVIDIA_CONTAINER_RUNTIME_DEBUG]
   --nvidia-container-runtime.log-level string, --nvidia-container-runtime-debug-log-level string                                        [$NVIDIA_CONTAINER_RUNTIME_LOG_LEVEL]
   --nvidia-container-runtime.mode string, --nvidia-container-runtime-mode string                                                        [$NVIDIA_CONTAINER_RUNTIME_MODE]
   --nvidia-container-runtime.modes.cdi.default-kind string                                                                              [$NVIDIA_CONTAINER_RUNTIME_MODES_CDI_DEFAULT_KIND]
   --nvidia-container-runtime.modes.cdi.annotation-prefixes string [ --nvidia-container-runtime.modes.cdi.annotation-prefixes string ]   [$NVIDIA_CONTAINER_RUNTIME_MODES_CDI_ANNOTATION_PREFIXES]
   --nvidia-container-runtime.runtimes string [ --nvidia-container-runtime.runtimes string ]                                             [$NVIDIA_CONTAINER_RUNTIME_RUNTIMES]
   --nvidia-container-runtime-hook.skip-mode-detection                                                                                   [$NVIDIA_CONTAINER_RUNTIME_HOOK_SKIP_MODE_DETECTION]
   --nvidia-container-cli.debug string, --nvidia-container-cli-debug string                                                             Specify the location of the debug log file for the NVIDIA Container CLI [$NVIDIA_CONTAINER_CLI_DEBUG]
   --accept-nvidia-visible-devices-envvar-when-unprivileged                                                                             Set the accept-nvidia-visible-devices-envvar-when-unprivileged config option [$ACCEPT_NVIDIA_VISIBLE_DEVICES_ENVVAR_WHEN_UNPRIVILEGED]
   --accept-nvidia-visible-devices-as-volume-mounts                                                                                     Set the accept-nvidia-visible-devices-as-volume-mounts config option [$ACCEPT_NVIDIA_VISIBLE_DEVICES_AS_VOLUME_MOUNTS]
   --cdi-enabled, --enable-cdi                                                                                                          enable the generation of a CDI specification [$CDI_ENABLED, $ENABLE_CDI]
   --cdi-output-dir string                                                                                                              the directory where the CDI output files are to be written. If this is set to '', no CDI specification is generated. (default: "/var/run/cdi") [$CDI_OUTPUT_DIR]
   --cdi-kind string                                                                                                                    the vendor string to use for the generated CDI specification (default: "management.nvidia.com/gpu") [$CDI_KIND]
   --create-device-nodes string [ --create-device-nodes string ]                                                                        (Only applicable with --cdi-enabled) specifies which device nodes should be created. If any one of the options is set to '' or 'none', no device nodes will be created. (default: "control") [$CREATE_DEVICE_NODES]
   --config string                                                                                                                      Path to the runtime config file (default: "RUNTIME_SPECIFIC_DEFAULT") [$RUNTIME_CONFIG, $CONTAINERD_CONFIG, $DOCKER_CONFIG]
   --drop-in-config string                                                                                                              Path to the NVIDIA-specific drop-in config file (default: "RUNTIME_SPECIFIC_DEFAULT") [$RUNTIME_DROP_IN_CONFIG]
   --drop-in-config-host-path string                                                                                                    When running in a container, this is the path to the drop-in config (--drop-in-config) on the host. This is required to correctly update the top-level config if required since paths there must be host-relative. [$RUNTIME_DROP_IN_CONFIG_HOST_PATH]
   --executable-path string                                                                                                             The path to the runtime executable. This is used to extract the current config [$RUNTIME_EXECUTABLE_PATH]
   --socket string                                                                                                                      Path to the runtime socket file (default: "RUNTIME_SPECIFIC_DEFAULT") [$RUNTIME_SOCKET, $CONTAINERD_SOCKET, $DOCKER_SOCKET]
   --restart-mode string                                                                                                                Specify how the runtime should be restarted; If 'none' is selected it will not be restarted [signal | systemd | none ] (default: "RUNTIME_SPECIFIC_DEFAULT") [$RUNTIME_RESTART_MODE]
   --enable-cdi-in-runtime                                                                                                              Enable CDI in the configured runt  ime [$RUNTIME_ENABLE_CDI]
   --host-root string                                                                                                                   Specify the path to the host root to be used when restarting the runtime using systemd (default: "/host") [$HOST_ROOT_MOUNT]
   --runtime-name nvidia, --nvidia-runtime-name nvidia, --runtime-class nvidia                                                          Specify the name of the nvidia runtime. If set-as-default is selected, the runtime is used as the default runtime. (default: "nvidia") [$NVIDIA_RUNTIME_NAME, $CONTAINERD_RUNTIME_CLASS, $DOCKER_RUNTIME_NAME]
   --config-source file, --config-sources file [ --config-source file, --config-sources file ]                                          Specify the config sources for the container runtime. Any combination of [command | file]. When file is specified, the absolute path to the file to be used as a config source can be specified as `file=/path/to/source/config.toml (default: "command", "file") [$RUNTIME_CONFIG_SOURCES, $RUNTIME_CONFIG_SOURCE]
   --use-legacy-config                                                                                                                  Specify whether a legacy (pre v1.3) config should be used. This ensures that a version 1 container config is created by default and that the containerd.runtimes.default_runtime config section is used to define the default runtime instead of container.default_runtime_name. [$CONTAINERD_USE_LEGACY_CONFIG]
   --runtime-type string                                                                                                                The runtime_type to use for the configured runtime classes (default: "io.containerd.runc.v2") [$CONTAINERD_RUNTIME_TYPE]
   --nvidia-container-runtime-modes.cdi.annotation-prefixes string [ --nvidia-container-runtime-modes.cdi.annotation-prefixes string ]   [$NVIDIA_CONTAINER_RUNTIME_MODES_CDI_ANNOTATION_PREFIXES]
   --runtime-config-override string                                                                                                     specify additional runtime options as a JSON string. The paths are relative to the runtime config. (default: "{}") [$RUNTIME_CONFIG_OVERRIDE, $CONTAINERD_RUNTIME_CONFIG_OVERRIDE]
   --hooks-dir string                                                                                                                   path to the cri-o hooks directory (default: /usr/share/containers/oci/hooks.d) [$CRIO_HOOKS_DIR]
   --hook-filename string                                                                                                               filename of the cri-o hook that will be created / removed in the hooks directory (default: oci-nvidia-hook.json) [$CRIO_HOOK_FILENAME]
   --config-mode string                                                                                                                 the configuration mode to use. One of [hook | config] (default: "config") [$CRIO_CONFIG_MODE]
   --help, -h                                                                                                                           show help
   --version, -v                                                                                                                        print the version
time="2026-11-10T13:52:18Z" level=info msg="Completed nvidia-ctk-installer"
Options (50)
OptionDescriptionSource
--no-daemon, -nterminate immediately after setting up the runtime.help
--no-runtime-configDisables the configuration of a container runtime.help
--enable-nri-plugin, -pif set to true, the toolkit will stand up an NRI Plugin server used to inject CDI devices to containers.help
--nri-plugin-index uintSpecify the plugin index to register to NRI (default: 10) [$NRI_PLUGIN_INDEX]help
--nri-socket stringSpecify the path to the NRI socket file to register the NRI plugin server (default: "/var/run/nri/nri.sock") [$NRI_SOCKET]help
--nri-namespace stringSpecify the kubernetes namespace the toolkit's NRI plugin is running in.help
--nri-management-cdi-device-namespaces stringSpecify the list of kubernetes namespaces (in addition to the nri-namespace) that are allowed to receive management CDI devices through the NRI plugin [$NRI_MANAGEMENT_CDI_DEVICE_NAMESPACES]help
--runtime, -r stringthe runtime to setup on this node.help
--toolkit-install-dir, --root ROOTThe directory where the NVIDIA Container Toolkit is to be installed.help
--toolkit-source-root stringThe folder where the required toolkit artifacts can be found.help
--toolkit-package-type stringspecify the package type to use for the toolkit.help
--pid-file stringthe path to a toolkit.pid file to ensure that only a single configuration instance is running (default: "/run/nvidia/toolkit/toolkit.pid") [$TOOLKIT_PID_FILE, $PID_FILE]help
--debugenable debug-level log in the toolkit installer [$TOOLKIT_DEBUG]help
--driver-root, --nvidia-driver-root string(default: "/run/nvidia/driver") [$NVIDIA_DRIVER_ROOT, $DRIVER_ROOT]help
--driver-root-ctr-path string(default: "/run/nvidia/driver") [$DRIVER_ROOT_CTR_PATH]help
--dev-root /devSpecify the root where /dev is located.help
--dev-root-ctr-path /devSpecify the root where /dev is located in the container.help
--nvidia-container-runtime.debug, --nvidia-container-runtime-debug stringSpecify the location of the debug log file for the NVIDIA Container Runtime [$NVIDIA_CONTAINER_RUNTIME_DEBUG]help
--nvidia-container-runtime.log-level, --nvidia-container-runtime-debug-log-level string[$NVIDIA_CONTAINER_RUNTIME_LOG_LEVEL]help
--nvidia-container-runtime.mode, --nvidia-container-runtime-mode string[$NVIDIA_CONTAINER_RUNTIME_MODE]help
--nvidia-container-runtime.modes.cdi.default-kind string[$NVIDIA_CONTAINER_RUNTIME_MODES_CDI_DEFAULT_KIND]help
--nvidia-container-runtime.modes.cdi.annotation-prefixes string[$NVIDIA_CONTAINER_RUNTIME_MODES_CDI_ANNOTATION_PREFIXES]help
--nvidia-container-runtime.runtimes string[$NVIDIA_CONTAINER_RUNTIME_RUNTIMES]help
--nvidia-container-runtime-hook.skip-mode-detection[$NVIDIA_CONTAINER_RUNTIME_HOOK_SKIP_MODE_DETECTION]help
--nvidia-container-cli.debug, --nvidia-container-cli-debug stringSpecify the location of the debug log file for the NVIDIA Container CLI [$NVIDIA_CONTAINER_CLI_DEBUG]help
--accept-nvidia-visible-devices-envvar-when-unprivilegedSet the accept-nvidia-visible-devices-envvar-when-unprivileged config option [$ACCEPT_NVIDIA_VISIBLE_DEVICES_ENVVAR_WHEN_UNPRIVILEGED]help
--accept-nvidia-visible-devices-as-volume-mountsSet the accept-nvidia-visible-devices-as-volume-mounts config option [$ACCEPT_NVIDIA_VISIBLE_DEVICES_AS_VOLUME_MOUNTS]help
--cdi-enabled, --enable-cdienable the generation of a CDI specification [$CDI_ENABLED, $ENABLE_CDI]help
--cdi-output-dir stringthe directory where the CDI output files are to be written.help
--cdi-kind stringthe vendor string to use for the generated CDI specification (default: "management.nvidia.com/gpu") [$CDI_KIND]help
--create-device-nodes string(Only applicable with --cdi-enabled) specifies which device nodes should be created.help
--config stringPath to the runtime config file (default: "RUNTIME_SPECIFIC_DEFAULT") [$RUNTIME_CONFIG, $CONTAINERD_CONFIG, $DOCKER_CONFIG]help
--drop-in-config stringPath to the NVIDIA-specific drop-in config file (default: "RUNTIME_SPECIFIC_DEFAULT") [$RUNTIME_DROP_IN_CONFIG]help
--drop-in-config-host-path stringWhen running in a container, this is the path to the drop-in config (--drop-in-config) on the host.help
--executable-path stringThe path to the runtime executable.help
--socket stringPath to the runtime socket file (default: "RUNTIME_SPECIFIC_DEFAULT") [$RUNTIME_SOCKET, $CONTAINERD_SOCKET, $DOCKER_SOCKET]help
--restart-mode stringSpecify how the runtime should be restarted;help
--enable-cdi-in-runtimeEnable CDI in the configured runt ime [$RUNTIME_ENABLE_CDI]help
--host-root stringSpecify the path to the host root to be used when restarting the runtime using systemd (default: "/host") [$HOST_ROOT_MOUNT]help
--runtime-name, --nvidia-runtime-name, --runtime-class nvidiaSpecify the name of the nvidia runtime.help
--config-source, --config-sources, --config-sources fileSpecify the config sources for the container runtime.help
--use-legacy-configSpecify whether a legacy (pre v1.3) config should be used.help
--runtime-type stringThe runtime_type to use for the configured runtime classes (default: "io.containerd.runc.v2") [$CONTAINERD_RUNTIME_TYPE]help
--nvidia-container-runtime-modes.cdi.annotation-prefixes string[$NVIDIA_CONTAINER_RUNTIME_MODES_CDI_ANNOTATION_PREFIXES]help
--runtime-config-override stringspecify additional runtime options as a JSON string.help
--hooks-dir stringpath to the cri-o hooks directory (default: /usr/share/containers/oci/hooks.d) [$CRIO_HOOKS_DIR]help
--hook-filename stringfilename of the cri-o hook that will be created / removed in the hooks directory (default: oci-nvidia-hook.json) [$CRIO_HOOK_FILENAME]help
--config-mode stringthe configuration mode to use.help
--help, -hshow helphelp
--version, -vprint the versionhelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.