mirror of
https://github.com/NVIDIA/nvidia-container-toolkit
synced 2024-11-22 16:29:18 +00:00
f6c252cbde
This change adds crun as a configured low-level runtime. Note that runc still preferred and will be used if present on the system. Signed-off-by: Evan Lezar <elezar@nvidia.com>
338 lines
11 KiB
Go
338 lines
11 KiB
Go
/**
|
|
# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
**/
|
|
|
|
package config
|
|
|
|
import (
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func TestGetConfigWithCustomConfig(t *testing.T) {
|
|
testDir := t.TempDir()
|
|
t.Setenv(configOverride, testDir)
|
|
|
|
filename := filepath.Join(testDir, configFilePath)
|
|
|
|
// By default debug is disabled
|
|
contents := []byte("[nvidia-container-runtime]\ndebug = \"/nvidia-container-toolkit.log\"")
|
|
|
|
require.NoError(t, os.MkdirAll(filepath.Dir(filename), 0766))
|
|
require.NoError(t, os.WriteFile(filename, contents, 0600))
|
|
|
|
cfg, err := GetConfig()
|
|
require.NoError(t, err)
|
|
require.Equal(t, "/nvidia-container-toolkit.log", cfg.NVIDIAContainerRuntimeConfig.DebugFilePath)
|
|
}
|
|
|
|
func TestGetConfig(t *testing.T) {
|
|
testCases := []struct {
|
|
description string
|
|
contents []string
|
|
expectedError error
|
|
inspectLdconfig bool
|
|
distIdsLike []string
|
|
expectedConfig *Config
|
|
}{
|
|
{
|
|
description: "empty config is default",
|
|
inspectLdconfig: true,
|
|
expectedConfig: &Config{
|
|
AcceptEnvvarUnprivileged: true,
|
|
SupportedDriverCapabilities: "compat32,compute,display,graphics,ngx,utility,video",
|
|
NVIDIAContainerCLIConfig: ContainerCLIConfig{
|
|
Root: "",
|
|
LoadKmods: true,
|
|
Ldconfig: "WAS_CHECKED",
|
|
},
|
|
NVIDIAContainerRuntimeConfig: RuntimeConfig{
|
|
DebugFilePath: "/dev/null",
|
|
LogLevel: "info",
|
|
Runtimes: []string{"docker-runc", "runc", "crun"},
|
|
Mode: "auto",
|
|
Modes: modesConfig{
|
|
CSV: csvModeConfig{
|
|
MountSpecPath: "/etc/nvidia-container-runtime/host-files-for-container.d",
|
|
},
|
|
CDI: cdiModeConfig{
|
|
DefaultKind: "nvidia.com/gpu",
|
|
AnnotationPrefixes: []string{"cdi.k8s.io/"},
|
|
SpecDirs: []string{"/etc/cdi", "/var/run/cdi"},
|
|
},
|
|
},
|
|
},
|
|
NVIDIAContainerRuntimeHookConfig: RuntimeHookConfig{
|
|
Path: "nvidia-container-runtime-hook",
|
|
},
|
|
NVIDIACTKConfig: CTKConfig{
|
|
Path: "nvidia-ctk",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
description: "config options set inline",
|
|
contents: []string{
|
|
"accept-nvidia-visible-devices-envvar-when-unprivileged = false",
|
|
"supported-driver-capabilities = \"compute,utility\"",
|
|
"nvidia-container-cli.root = \"/bar/baz\"",
|
|
"nvidia-container-cli.load-kmods = false",
|
|
"nvidia-container-cli.ldconfig = \"/foo/bar/ldconfig\"",
|
|
"nvidia-container-cli.user = \"foo:bar\"",
|
|
"nvidia-container-runtime.debug = \"/foo/bar\"",
|
|
"nvidia-container-runtime.discover-mode = \"not-legacy\"",
|
|
"nvidia-container-runtime.log-level = \"debug\"",
|
|
"nvidia-container-runtime.runtimes = [\"/some/runtime\",]",
|
|
"nvidia-container-runtime.mode = \"not-auto\"",
|
|
"nvidia-container-runtime.modes.cdi.default-kind = \"example.vendor.com/device\"",
|
|
"nvidia-container-runtime.modes.cdi.annotation-prefixes = [\"cdi.k8s.io/\", \"example.vendor.com/\",]",
|
|
"nvidia-container-runtime.modes.cdi.spec-dirs = [\"/except/etc/cdi\", \"/not/var/run/cdi\",]",
|
|
"nvidia-container-runtime.modes.csv.mount-spec-path = \"/not/etc/nvidia-container-runtime/host-files-for-container.d\"",
|
|
"nvidia-container-runtime-hook.path = \"/foo/bar/nvidia-container-runtime-hook\"",
|
|
"nvidia-ctk.path = \"/foo/bar/nvidia-ctk\"",
|
|
},
|
|
expectedConfig: &Config{
|
|
AcceptEnvvarUnprivileged: false,
|
|
SupportedDriverCapabilities: "compute,utility",
|
|
NVIDIAContainerCLIConfig: ContainerCLIConfig{
|
|
Root: "/bar/baz",
|
|
LoadKmods: false,
|
|
Ldconfig: "/foo/bar/ldconfig",
|
|
User: "foo:bar",
|
|
},
|
|
NVIDIAContainerRuntimeConfig: RuntimeConfig{
|
|
DebugFilePath: "/foo/bar",
|
|
LogLevel: "debug",
|
|
Runtimes: []string{"/some/runtime"},
|
|
Mode: "not-auto",
|
|
Modes: modesConfig{
|
|
CSV: csvModeConfig{
|
|
MountSpecPath: "/not/etc/nvidia-container-runtime/host-files-for-container.d",
|
|
},
|
|
CDI: cdiModeConfig{
|
|
DefaultKind: "example.vendor.com/device",
|
|
AnnotationPrefixes: []string{
|
|
"cdi.k8s.io/",
|
|
"example.vendor.com/",
|
|
},
|
|
SpecDirs: []string{
|
|
"/except/etc/cdi",
|
|
"/not/var/run/cdi",
|
|
},
|
|
},
|
|
},
|
|
},
|
|
NVIDIAContainerRuntimeHookConfig: RuntimeHookConfig{
|
|
Path: "/foo/bar/nvidia-container-runtime-hook",
|
|
},
|
|
NVIDIACTKConfig: CTKConfig{
|
|
Path: "/foo/bar/nvidia-ctk",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
description: "config options set in section",
|
|
contents: []string{
|
|
"accept-nvidia-visible-devices-envvar-when-unprivileged = false",
|
|
"supported-driver-capabilities = \"compute,utility\"",
|
|
"[nvidia-container-cli]",
|
|
"root = \"/bar/baz\"",
|
|
"load-kmods = false",
|
|
"ldconfig = \"/foo/bar/ldconfig\"",
|
|
"user = \"foo:bar\"",
|
|
"[nvidia-container-runtime]",
|
|
"debug = \"/foo/bar\"",
|
|
"discover-mode = \"not-legacy\"",
|
|
"log-level = \"debug\"",
|
|
"runtimes = [\"/some/runtime\",]",
|
|
"mode = \"not-auto\"",
|
|
"[nvidia-container-runtime.modes.cdi]",
|
|
"default-kind = \"example.vendor.com/device\"",
|
|
"annotation-prefixes = [\"cdi.k8s.io/\", \"example.vendor.com/\",]",
|
|
"spec-dirs = [\"/except/etc/cdi\", \"/not/var/run/cdi\",]",
|
|
"[nvidia-container-runtime.modes.csv]",
|
|
"mount-spec-path = \"/not/etc/nvidia-container-runtime/host-files-for-container.d\"",
|
|
"[nvidia-container-runtime-hook]",
|
|
"path = \"/foo/bar/nvidia-container-runtime-hook\"",
|
|
"[nvidia-ctk]",
|
|
"path = \"/foo/bar/nvidia-ctk\"",
|
|
},
|
|
expectedConfig: &Config{
|
|
AcceptEnvvarUnprivileged: false,
|
|
SupportedDriverCapabilities: "compute,utility",
|
|
NVIDIAContainerCLIConfig: ContainerCLIConfig{
|
|
Root: "/bar/baz",
|
|
LoadKmods: false,
|
|
Ldconfig: "/foo/bar/ldconfig",
|
|
User: "foo:bar",
|
|
},
|
|
NVIDIAContainerRuntimeConfig: RuntimeConfig{
|
|
DebugFilePath: "/foo/bar",
|
|
LogLevel: "debug",
|
|
Runtimes: []string{"/some/runtime"},
|
|
Mode: "not-auto",
|
|
Modes: modesConfig{
|
|
CSV: csvModeConfig{
|
|
MountSpecPath: "/not/etc/nvidia-container-runtime/host-files-for-container.d",
|
|
},
|
|
CDI: cdiModeConfig{
|
|
DefaultKind: "example.vendor.com/device",
|
|
AnnotationPrefixes: []string{
|
|
"cdi.k8s.io/",
|
|
"example.vendor.com/",
|
|
},
|
|
SpecDirs: []string{
|
|
"/except/etc/cdi",
|
|
"/not/var/run/cdi",
|
|
},
|
|
},
|
|
},
|
|
},
|
|
NVIDIAContainerRuntimeHookConfig: RuntimeHookConfig{
|
|
Path: "/foo/bar/nvidia-container-runtime-hook",
|
|
},
|
|
NVIDIACTKConfig: CTKConfig{
|
|
Path: "/foo/bar/nvidia-ctk",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
description: "suse config",
|
|
distIdsLike: []string{"suse", "opensuse"},
|
|
inspectLdconfig: true,
|
|
expectedConfig: &Config{
|
|
AcceptEnvvarUnprivileged: true,
|
|
SupportedDriverCapabilities: "compat32,compute,display,graphics,ngx,utility,video",
|
|
NVIDIAContainerCLIConfig: ContainerCLIConfig{
|
|
Root: "",
|
|
LoadKmods: true,
|
|
Ldconfig: "WAS_CHECKED",
|
|
User: "root:video",
|
|
},
|
|
NVIDIAContainerRuntimeConfig: RuntimeConfig{
|
|
DebugFilePath: "/dev/null",
|
|
LogLevel: "info",
|
|
Runtimes: []string{"docker-runc", "runc", "crun"},
|
|
Mode: "auto",
|
|
Modes: modesConfig{
|
|
CSV: csvModeConfig{
|
|
MountSpecPath: "/etc/nvidia-container-runtime/host-files-for-container.d",
|
|
},
|
|
CDI: cdiModeConfig{
|
|
DefaultKind: "nvidia.com/gpu",
|
|
AnnotationPrefixes: []string{"cdi.k8s.io/"},
|
|
SpecDirs: []string{"/etc/cdi", "/var/run/cdi"},
|
|
},
|
|
},
|
|
},
|
|
NVIDIAContainerRuntimeHookConfig: RuntimeHookConfig{
|
|
Path: "nvidia-container-runtime-hook",
|
|
},
|
|
NVIDIACTKConfig: CTKConfig{
|
|
Path: "nvidia-ctk",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
description: "suse config overrides user",
|
|
distIdsLike: []string{"suse", "opensuse"},
|
|
inspectLdconfig: true,
|
|
contents: []string{
|
|
"nvidia-container-cli.user = \"foo:bar\"",
|
|
},
|
|
expectedConfig: &Config{
|
|
AcceptEnvvarUnprivileged: true,
|
|
SupportedDriverCapabilities: "compat32,compute,display,graphics,ngx,utility,video",
|
|
NVIDIAContainerCLIConfig: ContainerCLIConfig{
|
|
Root: "",
|
|
LoadKmods: true,
|
|
Ldconfig: "WAS_CHECKED",
|
|
User: "foo:bar",
|
|
},
|
|
NVIDIAContainerRuntimeConfig: RuntimeConfig{
|
|
DebugFilePath: "/dev/null",
|
|
LogLevel: "info",
|
|
Runtimes: []string{"docker-runc", "runc", "crun"},
|
|
Mode: "auto",
|
|
Modes: modesConfig{
|
|
CSV: csvModeConfig{
|
|
MountSpecPath: "/etc/nvidia-container-runtime/host-files-for-container.d",
|
|
},
|
|
CDI: cdiModeConfig{
|
|
DefaultKind: "nvidia.com/gpu",
|
|
AnnotationPrefixes: []string{"cdi.k8s.io/"},
|
|
SpecDirs: []string{"/etc/cdi", "/var/run/cdi"},
|
|
},
|
|
},
|
|
},
|
|
NVIDIAContainerRuntimeHookConfig: RuntimeHookConfig{
|
|
Path: "nvidia-container-runtime-hook",
|
|
},
|
|
NVIDIACTKConfig: CTKConfig{
|
|
Path: "nvidia-ctk",
|
|
},
|
|
},
|
|
},
|
|
}
|
|
|
|
for _, tc := range testCases {
|
|
t.Run(tc.description, func(t *testing.T) {
|
|
defer setGetDistIDLikeForTest(tc.distIdsLike)()
|
|
reader := strings.NewReader(strings.Join(tc.contents, "\n"))
|
|
|
|
tomlCfg, err := loadConfigTomlFrom(reader)
|
|
if tc.expectedError != nil {
|
|
require.Error(t, err)
|
|
} else {
|
|
require.NoError(t, err)
|
|
}
|
|
cfg, err := tomlCfg.Config()
|
|
require.NoError(t, err)
|
|
|
|
// We first handle the ldconfig path since this is currently system-dependent.
|
|
if tc.inspectLdconfig {
|
|
ldconfig := cfg.NVIDIAContainerCLIConfig.Ldconfig
|
|
require.True(t, strings.HasPrefix(ldconfig, "@/sbin/ldconfig"))
|
|
remaining := strings.TrimPrefix(ldconfig, "@/sbin/ldconfig")
|
|
require.True(t, remaining == ".real" || remaining == "")
|
|
|
|
cfg.NVIDIAContainerCLIConfig.Ldconfig = "WAS_CHECKED"
|
|
}
|
|
|
|
require.EqualValues(t, tc.expectedConfig, cfg)
|
|
})
|
|
}
|
|
}
|
|
|
|
// setGetDistIDsLikeForTest overrides the distribution IDs that would normally be read from the /etc/os-release file.
|
|
func setGetDistIDLikeForTest(ids []string) func() {
|
|
if ids == nil {
|
|
return func() {}
|
|
}
|
|
original := getDistIDLike
|
|
|
|
getDistIDLike = func() []string {
|
|
return ids
|
|
}
|
|
|
|
return func() {
|
|
getDistIDLike = original
|
|
}
|
|
}
|