nvidia-container-toolkit/cmd/nvidia-cdi-hook
Carlos Eduardo Arango Gutierrez 55a8d1e1e5
Some checks failed
CI Pipeline / code-scanning (push) Has been cancelled
CI Pipeline / variables (push) Has been cancelled
CI Pipeline / golang (push) Has been cancelled
CI Pipeline / image (push) Has been cancelled
CI Pipeline / e2e-test (push) Has been cancelled
Load settings from config.toml file during CDI generation
Signed-off-by: Carlos Eduardo Arango Gutierrez <eduardoa@nvidia.com>
2025-06-26 13:14:27 +02:00
..
chmod [no-relnote] Migrate to urfave v3 2025-06-25 15:46:27 +02:00
commands [no-relnote] Migrate to urfave v3 2025-06-25 15:46:27 +02:00
create-soname-symlinks [no-relnote] Migrate to urfave v3 2025-06-25 15:46:27 +02:00
create-symlinks [no-relnote] Migrate to urfave v3 2025-06-25 15:46:27 +02:00
cudacompat [no-relnote] Migrate to urfave v3 2025-06-25 15:46:27 +02:00
disable-device-node-modification [no-relnote] Migrate to urfave v3 2025-06-25 15:46:27 +02:00
update-ldcache [no-relnote] Migrate to urfave v3 2025-06-25 15:46:27 +02:00
main.go Load settings from config.toml file during CDI generation 2025-06-26 13:14:27 +02:00
README.md Move nvidia-ctk hook command into own binary 2024-05-21 12:19:44 +02:00

NVIDIA CDI Hook

The CLI nvidia-cdi-hook provides container device runtime hook capabilities when called by a container runtime, as specific in a Container Device Interface file.

Generating a CDI

The CDI itself is created for an NVIDIA-capable device using the nvidia-ctk cdi generate command.

When nvidia-ctk cdi generate is run, the CDI specification is generated as a yaml file. The CDI specification provides instructions for a container runtime to set up devices, files and other resources for the container prior to starting it. Those instructions may include executing command-line tools to prepare the filesystem. The execution of such command-line tools is called a hook.

nvidia-cdi-hook is the CLI tool that is expected to be called by the container runtime, when specified by the CDI file.

See the nvidia-ctk documentation for more information on generating a CDI file.

Functionality

The nvidia-cdi-hook CLI provides the following functionality:

  • chmod - Change the permissions of a file or directory inside the directory path to be mounted into a container.
  • create-symlinks - Create symlinks inside the directory path to be mounted into a container.
  • update-ldcache - Update the dynamic linker cache inside the directory path to be mounted into a container.