Skip to content

Add ability to opt-out of drop-in files #1331

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Add ability to opt-out of drop-in files #1331

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
107 changes: 107 additions & 0 deletions cmd/nvidia-ctk-installer/container/runtime/containerd/config_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1777,6 +1777,113 @@ version = 3

require.NoFileExists(t, co.DropInConfig)

return nil
},
},
{
description: "setting drop-in-config to empty modifies existing config",
containerOptions: container.Options{
TopLevelConfigPath: "{{ .testRoot }}/etc/containerd/config.toml",
DropInConfig: "",
RuntimeName: "nvidia",
RuntimeDir: "/usr/bin",
SetAsDefault: false,
RestartMode: "none",
ExecutablePath: "not-containerd",
},
options: Options{
runtimeType: "io.containerd.runc.v2",
},
prepareEnvironment: func(t *testing.T, co *container.Options, o *Options) error {
require.NoError(t, os.MkdirAll(filepath.Dir(co.TopLevelConfigPath), 0755))

initialConfig := `version = 2

[plugins]
[plugins."io.containerd.grpc.v1.cri"]
[plugins."io.containerd.grpc.v1.cri".containerd]
default_runtime_name = "runc"

[plugins."io.containerd.grpc.v1.cri".containerd.runtimes]
[plugins."io.containerd.grpc.v1.cri".containerd.runtimes.runc]
runtime_type = "io.containerd.runc.v2"

[plugins."io.containerd.grpc.v1.cri".containerd.runtimes.runc.options]
BinaryName = "/usr/bin/runc"
`
require.NoError(t, os.WriteFile(co.TopLevelConfigPath, []byte(initialConfig), 0600))
return nil
},
assertSetupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {
require.FileExists(t, co.TopLevelConfigPath)

actual, err := os.ReadFile(co.TopLevelConfigPath)
require.NoError(t, err)

expected := `version = 2

[plugins]

[plugins."io.containerd.grpc.v1.cri"]

[plugins."io.containerd.grpc.v1.cri".containerd]
default_runtime_name = "runc"

[plugins."io.containerd.grpc.v1.cri".containerd.runtimes]

[plugins."io.containerd.grpc.v1.cri".containerd.runtimes.nvidia]
runtime_type = "io.containerd.runc.v2"

[plugins."io.containerd.grpc.v1.cri".containerd.runtimes.nvidia.options]
BinaryName = "/usr/bin/nvidia-container-runtime"

[plugins."io.containerd.grpc.v1.cri".containerd.runtimes.nvidia-cdi]
runtime_type = "io.containerd.runc.v2"

[plugins."io.containerd.grpc.v1.cri".containerd.runtimes.nvidia-cdi.options]
BinaryName = "/usr/bin/nvidia-container-runtime.cdi"

[plugins."io.containerd.grpc.v1.cri".containerd.runtimes.nvidia-legacy]
runtime_type = "io.containerd.runc.v2"

[plugins."io.containerd.grpc.v1.cri".containerd.runtimes.nvidia-legacy.options]
BinaryName = "/usr/bin/nvidia-container-runtime.legacy"

[plugins."io.containerd.grpc.v1.cri".containerd.runtimes.runc]
runtime_type = "io.containerd.runc.v2"

[plugins."io.containerd.grpc.v1.cri".containerd.runtimes.runc.options]
BinaryName = "/usr/bin/runc"
`
require.Equal(t, expected, string(actual))

return nil
},
assertCleanupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {
require.FileExists(t, co.TopLevelConfigPath)

actual, err := os.ReadFile(co.TopLevelConfigPath)
require.NoError(t, err)

expected := `version = 2

[plugins]

[plugins."io.containerd.grpc.v1.cri"]

[plugins."io.containerd.grpc.v1.cri".containerd]
default_runtime_name = "runc"

[plugins."io.containerd.grpc.v1.cri".containerd.runtimes]

[plugins."io.containerd.grpc.v1.cri".containerd.runtimes.runc]
runtime_type = "io.containerd.runc.v2"

[plugins."io.containerd.grpc.v1.cri".containerd.runtimes.runc.options]
BinaryName = "/usr/bin/runc"
`
require.Equal(t, expected, string(actual))

return nil
},
},
Expand Down
1 change: 1 addition & 0 deletions cmd/nvidia-ctk-installer/container/runtime/containerd/containerd.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,7 @@ func getRuntimeConfig(o *container.Options, co *Options) (engine.Interface, erro
containerd.WithRuntimeType(co.runtimeType),
containerd.WithUseLegacyConfig(co.useLegacyConfig),
containerd.WithContainerAnnotations(co.containerAnnotationsFromCDIPrefixes()...),
containerd.WithDisableDropInConfig(o.DropInConfig == ""),
Copy link
Contributor

@tariq1890 tariq1890 Oct 2, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't quite understand the benefit of adding a new field here, if we can just directly evaluate this conditional internally when processing the runtime config

o.DropInConfig == ""

Copy link
Member

@elezar elezar Oct 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The DropInConfig path is not passed to the configs themselves.

}
if o.DropInConfigHostPath != "" && o.DropInConfig != "" {
options = append(options,
Expand Down
1 change: 1 addition & 0 deletions cmd/nvidia-ctk-installer/container/runtime/crio/crio.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,5 +222,6 @@ func getRuntimeConfig(o *container.Options) (engine.Interface, error) {
toml.FromFile(o.TopLevelConfigPath),
),
),
crio.WithDisableDropInConfig(o.DropInConfig == ""),
)
}
2 changes: 1 addition & 1 deletion cmd/nvidia-ctk-installer/container/runtime/runtime.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ func Flags(opts *Options) []cli.Flag {
},
&cli.StringFlag{
Name: "drop-in-config",
Usage: "Path to the NVIDIA-specific drop-in config file",
Usage: "Path to the NVIDIA-specific drop-in config file. If this is empty, the top-level config is modified directly.",
Value: runtimeSpecificDefault,
Destination: &opts.DropInConfig,
Sources: cli.EnvVars("RUNTIME_DROP_IN_CONFIG"),
Expand Down
2 changes: 2 additions & 0 deletions cmd/nvidia-ctk/runtime/configure/configure.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,12 +302,14 @@ func (m command) configureConfigFile(config *config) error {
containerd.WithLogger(m.logger),
containerd.WithTopLevelConfigPath(config.configFilePath),
containerd.WithConfigSource(configSource),
containerd.WithDisableDropInConfig(config.dropInConfigPath == ""),
)
case "crio":
cfg, err = crio.New(
crio.WithLogger(m.logger),
crio.WithTopLevelConfigPath(config.configFilePath),
crio.WithConfigSource(configSource),
crio.WithDisableDropInConfig(config.dropInConfigPath == ""),
)
case "docker":
cfg, err = docker.New(
Expand Down
5 changes: 5 additions & 0 deletions pkg/config/engine/containerd/containerd.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ type configOptions struct {
// for the CRI runtime service. The name of this plugin was changed in v3 of the
// containerd configuration file.
CRIRuntimePluginName string
DisableDropInConfig bool
}

var _ engine.Interface = (*Config)(nil)
Expand Down Expand Up @@ -122,6 +123,10 @@ func New(opts ...Option) (engine.Interface, error) {
// We return the sourceConfig as is.
return (*ConfigV1)(sourceConfig), nil
default:
if b.disableDropInConfig {
b.logger.Info("Drop-in config files are disabled. Modifying the source config directly.")
return sourceConfig, nil
}
// For other versions, we create a DropInConfig with a reference to the
// top-level config if present.
topLevelConfig := &Config{
Expand Down
9 changes: 9 additions & 0 deletions pkg/config/engine/containerd/option.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ type builder struct {
containerAnnotations []string

containerToHostPathMap map[string]string

disableDropInConfig bool
}

// Option defines a function that can be used to configure the config builder
Expand Down Expand Up @@ -97,3 +99,10 @@ func WithContainerAnnotations(containerAnnotations ...string) Option {
b.containerAnnotations = containerAnnotations
}
}

// WithDisableDropInConfig disables the use of drop-in config files
func WithDisableDropInConfig(disable bool) Option {
return func(b *builder) {
b.disableDropInConfig = disable
}
}
16 changes: 11 additions & 5 deletions pkg/config/engine/crio/crio.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,16 +62,22 @@ func New(opts ...Option) (engine.Interface, error) {
b.configSource = toml.FromFile(b.topLevelConfigPath)
}

sourceConfig, err := b.configSource.Load()
sourceConfigTree, err := b.configSource.Load()
if err != nil {
return nil, err
}

sourceConfig := &Config{
Tree: sourceConfigTree,
Logger: b.logger,
}

if b.disableDropInConfig {
return sourceConfig, nil
}

cfg := &engine.Config{
Source: &Config{
Tree: sourceConfig,
Logger: b.logger,
},
Source: sourceConfig,
Destination: &Config{
Tree: toml.NewEmpty(),
Logger: b.logger,
Expand Down
14 changes: 11 additions & 3 deletions pkg/config/engine/crio/option.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,22 @@ import (
)

type builder struct {
logger logger.Interface
configSource toml.Loader
topLevelConfigPath string
logger logger.Interface
configSource toml.Loader
topLevelConfigPath string
disableDropInConfig bool
}

// Option defines a function that can be used to configure the config builder
type Option func(*builder)

// WithDisableDropInConfig disables the use of drop-in config files
func WithDisableDropInConfig(disable bool) Option {
return func(b *builder) {
b.disableDropInConfig = disable
}
}

// WithLogger sets the logger for the config builder
func WithLogger(logger logger.Interface) Option {
return func(b *builder) {
Expand Down