cri: add deprecation warning for runtime_root

samuelkarp · ruiwen-zhao · commit de0cc92a793b · 2023-12-14T18:39:38.000Z
Signed-off-by: Samuel Karp <samuelkarp@google.com> (cherry picked from commit 51a604c) Signed-off-by: ruiwen-zhao <ruiwen@google.com>
diff --git a/pkg/cri/config/config.go b/pkg/cri/config/config.go
@@ -398,6 +398,7 @@ func ValidatePluginConfig(ctx context.Context, c *PluginConfig) ([]deprecation.W
 			if r.Type != plugin.RuntimeLinuxV1 {
 				return warnings, fmt.Errorf("`runtime_root` only works for runtime %s", plugin.RuntimeLinuxV1)
 			}
+			warnings = append(warnings, deprecation.CRIRuntimeRoot)
 			log.G(ctx).Warning("`runtime_root` is deprecated, please use runtime `options` instead")
 		}
 	}
diff --git a/pkg/cri/config/config_test.go b/pkg/cri/config/config_test.go
@@ -259,6 +259,7 @@ func TestValidateConfig(t *testing.T) {
 					},
 				},
 			},
+			warnings: []deprecation.Warning{deprecation.CRIRuntimeRoot},
 		},
 		"deprecated runtime_root for v2 runtime": {
 			config: &PluginConfig{
diff --git a/pkg/deprecation/deprecation.go b/pkg/deprecation/deprecation.go
@@ -33,6 +33,8 @@ const (
 	CRIDefaultRuntime Warning = Prefix + "cri-default-runtime"
 	// CRIRuntimeEngine is a warning for the `runtime_engine` property
 	CRIRuntimeEngine Warning = Prefix + "cri-runtime-engine"
+	// CRIRuntimeRoot is a warning for the `runtime_root` property
+	CRIRuntimeRoot Warning = Prefix + "cri-runtime-root"
 	// 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
@@ -61,6 +63,8 @@ var messages = map[Warning]string{
 		"Use `default_runtime_name` instead.",
 	CRIRuntimeEngine: "The `runtime_engine` property of [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.*] is deprecated since containerd v1.3 and will be removed in containerd v2.0. " +
 		"Use a v2 runtime and `options` instead.",
+	CRIRuntimeRoot: "The `runtime_root` property of [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.*] is deprecated since containerd v1.3 and will be removed in containerd v2.0. " +
+		"Use a v2 runtime and `options.Root` 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." +

Original file line number	Diff line number	Diff line change
`@@ -398,6 +398,7 @@ func ValidatePluginConfig(ctx context.Context, c *PluginConfig) ([]deprecation.W`
`398`	`398`	`if r.Type != plugin.RuntimeLinuxV1 {`
`399`	`399`	return warnings, fmt.Errorf("`runtime_root` only works for runtime %s", plugin.RuntimeLinuxV1)
`400`	`400`	`}`
	`401`	`+ warnings = append(warnings, deprecation.CRIRuntimeRoot)`
`401`	`402`	log.G(ctx).Warning("`runtime_root` is deprecated, please use runtime `options` instead")
`402`	`403`	`}`
`403`	`404`	`}`