cri: add deprecation warning for default_runtime

Signed-off-by: Samuel Karp <samuelkarp@google.com>
containerd · Dec 6, 2023 · 99adc40 · 99adc40
1 parent afef7ec
commit 99adc40
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
diff --git a/pkg/cri/config/config.go b/pkg/cri/config/config.go
@@ -439,6 +439,7 @@ func ValidatePluginConfig(ctx context.Context, c *PluginConfig) ([]deprecation.W
 
 	// Validation for deprecated default_runtime field.
 	if c.ContainerdConfig.DefaultRuntime.Type != "" {
+		warnings = append(warnings, deprecation.CRIDefaultRuntime)
 		log.G(ctx).Warning("`default_runtime` is deprecated, please use `default_runtime_name` to reference the default configuration you have defined in `runtimes`")
 		c.ContainerdConfig.DefaultRuntimeName = RuntimeDefault
 		c.ContainerdConfig.Runtimes[RuntimeDefault] = c.ContainerdConfig.DefaultRuntime

diff --git a/pkg/cri/config/config_test.go b/pkg/cri/config/config_test.go
@@ -110,6 +110,7 @@ func TestValidateConfig(t *testing.T) {
 					},
 				},
 			},
+			warnings: []deprecation.Warning{deprecation.CRIDefaultRuntime},
 		},
 		"no default_runtime_name": {
 			config:      &PluginConfig{},

diff --git a/pkg/deprecation/deprecation.go b/pkg/deprecation/deprecation.go
@@ -29,6 +29,8 @@ const (
 	CRISystemdCgroupV1 Warning = Prefix + "cri-systemd-cgroup-v1"
 	// CRIUntrustedWorkloadRuntime is a warning for the `untrusted_workload_runtime` property
 	CRIUntrustedWorkloadRuntime Warning = Prefix + "cri-untrusted-workload-runtime"
+	// CRIDefaultRuntime is a warning for the `default_runtime` property
+	CRIDefaultRuntime Warning = Prefix + "cri-default-runtime"
 	// CRIRegistryMirrors is a warning for the use of the `mirrors` property
 	CRIRegistryMirrors Warning = Prefix + "cri-registry-mirrors"
 	// CRIRegistryAuths is a warning for the use of the `auths` property
@@ -53,6 +55,8 @@ var messages = map[Warning]string{
 		"Use `SystemdCgroup` in [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc.options] options instead.",
 	CRIUntrustedWorkloadRuntime: "The `untrusted_workload_runtime` property of [plugins.\"io.containerd.grpc.v1.cri\".containerd] is deprecated since containerd v1.2 and will be removed in containerd v2.0. " +
 		"Create an `untrusted` runtime in `runtimes` instead.",
+	CRIDefaultRuntime: "The `default_runtime` property of [plugins.\"io.containerd.grpc.v1.cri\".containerd] is deprecated since containerd v1.3 and will be removed in containerd v2.0. " +
+		"Use `default_runtime_name` instead.",
 	CRIRegistryMirrors: "The `mirrors` property of `[plugins.\"io.containerd.grpc.v1.cri\".registry]` is deprecated since containerd v1.5 and will be removed in containerd v2.0." +
 		"Use `config_path` instead.",
 	CRIRegistryAuths: "The `auths` property of `[plugins.\"io.containerd.grpc.v1.cri\".registry]` is deprecated since containerd v1.3 and will be removed in containerd v2.0." +