config

Documentation

Index

• Variables
• func GetDefaultConfigToml() (*toml.Tree, error)
• func ResolveNVIDIACTKPath(logger logger.Interface, nvidiaCTKPath string) string
• func ResolveNVIDIAContainerRuntimeHookPath(logger logger.Interface, nvidiaContainerRuntimeHookPath string) string
• type CTKConfig
• type Config
  • func GetConfig() (*Config, error)
• type ContainerCLIConfig
• type RuntimeConfig
  • func GetDefaultRuntimeConfig() (*RuntimeConfig, error)
• type RuntimeHookConfig
  • func GetDefaultRuntimeHookConfig() (*RuntimeHookConfig, error)

Variables

var (
	// DefaultExecutableDir specifies the default path to use for executables if they cannot be located in the path.
	DefaultExecutableDir = "/usr/bin"

	// NVIDIAContainerRuntimeHookExecutable is the executable name for the NVIDIA Container Runtime Hook
	NVIDIAContainerRuntimeHookExecutable = "nvidia-container-runtime-hook"
	// NVIDIAContainerToolkitExecutable is the executable name for the NVIDIA Container Toolkit (an alias for the NVIDIA Container Runtime Hook)
	NVIDIAContainerToolkitExecutable = "nvidia-container-toolkit"
)

Functions

func GetDefaultConfigToml

func GetDefaultConfigToml() (*toml.Tree, error)

GetDefaultConfigToml returns the default config as a toml Tree.

func ResolveNVIDIACTKPath

func ResolveNVIDIACTKPath(logger logger.Interface, nvidiaCTKPath string) string

ResolveNVIDIACTKPath resolves the path to the nvidia-ctk binary. This executable is used in hooks and needs to be an absolute path. If the path is specified as an absolute path, it is used directly without checking for existence of an executable at that path.

func ResolveNVIDIAContainerRuntimeHookPath

func ResolveNVIDIAContainerRuntimeHookPath(logger logger.Interface, nvidiaContainerRuntimeHookPath string) string

ResolveNVIDIAContainerRuntimeHookPath resolves the path the nvidia-container-runtime-hook binary.

Types

type CTKConfig

type CTKConfig struct {
	Path string `toml:"path"`
}

CTKConfig stores the config options for the NVIDIA Container Toolkit CLI (nvidia-ctk)

type Config

type Config struct {
	AcceptEnvvarUnprivileged bool `toml:"accept-nvidia-visible-devices-envvar-when-unprivileged"`

	NVIDIAContainerCLIConfig         ContainerCLIConfig `toml:"nvidia-container-cli"`
	NVIDIACTKConfig                  CTKConfig          `toml:"nvidia-ctk"`
	NVIDIAContainerRuntimeConfig     RuntimeConfig      `toml:"nvidia-container-runtime"`
	NVIDIAContainerRuntimeHookConfig RuntimeHookConfig  `toml:"nvidia-container-runtime-hook"`
}

Config represents the contents of the config.toml file for the NVIDIA Container Toolkit Note: This is currently duplicated by the HookConfig in cmd/nvidia-container-toolkit/hook_config.go

func GetConfig

func GetConfig() (*Config, error)

GetConfig sets up the config struct. Values are read from a toml file or set via the environment.

type ContainerCLIConfig

type ContainerCLIConfig struct {
	Root string `toml:"root"`
}

ContainerCLIConfig stores the options for the nvidia-container-cli

type RuntimeConfig

type RuntimeConfig struct {
	DebugFilePath string `toml:"debug"`
	// LogLevel defines the logging level for the application
	LogLevel string `toml:"log-level"`
	// Runtimes defines the candidates for the low-level runtime
	Runtimes []string    `toml:"runtimes"`
	Mode     string      `toml:"mode"`
	Modes    modesConfig `toml:"modes"`
}

RuntimeConfig stores the config options for the NVIDIA Container Runtime

func GetDefaultRuntimeConfig

func GetDefaultRuntimeConfig() (*RuntimeConfig, error)

GetDefaultRuntimeConfig defines the default values for the config

type RuntimeHookConfig

type RuntimeHookConfig struct {
	// Path specifies the path to the NVIDIA Container Runtime hook binary.
	// If an executable name is specified, this will be resolved in the path.
	Path string `toml:"path"`
	// SkipModeDetection disables the mode check for the runtime hook.
	SkipModeDetection bool `toml:"skip-mode-detection"`
}

RuntimeHookConfig stores the config options for the NVIDIA Container Runtime

func GetDefaultRuntimeHookConfig

func GetDefaultRuntimeHookConfig() (*RuntimeHookConfig, error)

GetDefaultRuntimeHookConfig defines the default values for the config