Skip to content

Commit

Permalink
Merge pull request containerd#10907 from AkihiroSuda/fix-10905
Browse files Browse the repository at this point in the history
config: v1Migrate: support DisabledPlugins and RequiredPlugins
  • Loading branch information
samuelkarp authored Oct 31, 2024
2 parents 29ecab6 + 9ed6e05 commit b6f4358
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 23 deletions.
70 changes: 47 additions & 23 deletions cmd/containerd/server/config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,12 @@ func (c *Config) ValidateVersion() error {

// MigrateConfig will convert the config to the latest version before using
func (c *Config) MigrateConfig(ctx context.Context) error {
for c.Version < version.ConfigVersion {
return c.MigrateConfigTo(ctx, version.ConfigVersion)
}

// MigrateConfigTo will convert the config to the target version before using
func (c *Config) MigrateConfigTo(ctx context.Context, targetVersion int) error {
for c.Version < targetVersion {
if m := migrations[c.Version]; m != nil {
if err := m(ctx, c); err != nil {
return err
Expand All @@ -144,9 +149,7 @@ func (c *Config) MigrateConfig(ctx context.Context) error {
return nil
}

func v1Migrate(ctx context.Context, c *Config) error {
plugins := make(map[string]interface{}, len(c.Plugins))

func v1MigratePluginName(ctx context.Context, plugin string) string {
// corePlugins is the list of used plugins before v1 was deprecated
corePlugins := map[string]string{
"cri": "io.containerd.grpc.v1.cri",
Expand All @@ -166,28 +169,40 @@ func v1Migrate(ctx context.Context, c *Config) error {
"overlayfs": "io.containerd.snapshotter.v1.overlayfs",
"zfs": "io.containerd.snapshotter.v1.zfs",
}
for plugin, value := range c.Plugins {
if !strings.ContainsAny(plugin, ".") {
var ambiguous string
if full, ok := corePlugins[plugin]; ok {
plugin = full
} else if strings.HasSuffix(plugin, "-service") {
plugin = "io.containerd.service.v1." + plugin
} else if plugin == "windows" || plugin == "windows-lcow" {
// runtime, differ, and snapshotter plugins do not have configs for v1
ambiguous = plugin
plugin = "io.containerd.snapshotter.v1." + plugin
} else {
ambiguous = plugin
plugin = "io.containerd.grpc.v1." + plugin
}
if ambiguous != "" {
log.G(ctx).Warnf("Ambiguous %s plugin in v1 config, treating as %s", ambiguous, plugin)
}
if !strings.ContainsAny(plugin, ".") {
var ambiguous string
if full, ok := corePlugins[plugin]; ok {
plugin = full
} else if strings.HasSuffix(plugin, "-service") {
plugin = "io.containerd.service.v1." + plugin
} else if plugin == "windows" || plugin == "windows-lcow" {
// runtime, differ, and snapshotter plugins do not have configs for v1
ambiguous = plugin
plugin = "io.containerd.snapshotter.v1." + plugin
} else {
ambiguous = plugin
plugin = "io.containerd.grpc.v1." + plugin
}
plugins[plugin] = value
if ambiguous != "" {
log.G(ctx).Warnf("Ambiguous %s plugin in v1 config, treating as %s", ambiguous, plugin)
}
}
return plugin
}

func v1Migrate(ctx context.Context, c *Config) error {
plugins := make(map[string]interface{}, len(c.Plugins))
for plugin, value := range c.Plugins {
plugins[v1MigratePluginName(ctx, plugin)] = value
}
c.Plugins = plugins
for i, plugin := range c.DisabledPlugins {
c.DisabledPlugins[i] = v1MigratePluginName(ctx, plugin)
}
for i, plugin := range c.RequiredPlugins {
c.RequiredPlugins[i] = v1MigratePluginName(ctx, plugin)
}
// No change in c.ProxyPlugins
return nil
}

Expand Down Expand Up @@ -297,6 +312,15 @@ func LoadConfig(ctx context.Context, path string, out *Config) error {
return err
}

switch config.Version {
case 0, 1:
if err := config.MigrateConfigTo(ctx, out.Version); err != nil {
return err
}
default:
// NOP
}

if err := mergeConfig(out, config); err != nil {
return err
}
Expand Down
19 changes: 19 additions & 0 deletions cmd/containerd/server/config/config_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,25 @@ imports = ["data1.toml", "data2.toml"]
}, out.Imports)
}

// https://github.com/containerd/containerd/issues/10905
func TestLoadConfigWithDefaultConfigVersion(t *testing.T) {
data1 := `
disabled_plugins=["cri"]
`
tempDir := t.TempDir()

err := os.WriteFile(filepath.Join(tempDir, "data1.toml"), []byte(data1), 0o600)
assert.NoError(t, err)

var out Config
out.Version = version.ConfigVersion
err = LoadConfig(context.Background(), filepath.Join(tempDir, "data1.toml"), &out)
assert.NoError(t, err)

assert.Equal(t, version.ConfigVersion, out.Version)
assert.Equal(t, []string{"io.containerd.grpc.v1.cri"}, out.DisabledPlugins)
}

func TestDecodePlugin(t *testing.T) {
ctx := logtest.WithT(context.Background(), t)
data := `
Expand Down

0 comments on commit b6f4358

Please sign in to comment.