Add warning for CRIU config usage

ruiwen-zhao · ruiwen-zhao · commit f8447466ccd8 · 2023-12-14T18:06:54.000Z
Signed-off-by: ruiwen-zhao <ruiwen@google.com> (cherry picked from commit 1fdefdd) Signed-off-by: ruiwen-zhao <ruiwen@google.com>
diff --git a/pkg/cri/config/config.go b/pkg/cri/config/config.go
@@ -396,6 +396,11 @@ func ValidatePluginConfig(ctx context.Context, c *PluginConfig) ([]deprecation.W
 			}
 			log.G(ctx).Warning("`runtime_root` is deprecated, please use runtime `options` instead")
 		}
+
+		if p, ok := r.Options["CriuPath"].(string); ok && p != "" {
+			log.G(ctx).Warning("`CriuPath` is deprecated, please use a criu binary in $PATH instead.")
+			warnings = append(warnings, deprecation.CRICRIUPath)
+		}
 	}
 
 	useConfigPath := c.Registry.ConfigPath != ""
diff --git a/pkg/cri/config/config_test.go b/pkg/cri/config/config_test.go
@@ -430,6 +430,33 @@ func TestValidateConfig(t *testing.T) {
 			},
 			warnings: []deprecation.Warning{deprecation.CRIRegistryConfigs},
 		},
+		"deprecated CRIU path": {
+			config: &PluginConfig{
+				ContainerdConfig: ContainerdConfig{
+					DefaultRuntimeName: RuntimeDefault,
+					Runtimes: map[string]Runtime{
+						RuntimeDefault: {
+							Options: map[string]interface{}{
+								"CriuPath": "/path/to/criu-binary",
+							},
+						},
+					},
+				},
+			},
+			expected: &PluginConfig{
+				ContainerdConfig: ContainerdConfig{
+					DefaultRuntimeName: RuntimeDefault,
+					Runtimes: map[string]Runtime{
+						RuntimeDefault: {
+							Options: map[string]interface{}{
+								"CriuPath": "/path/to/criu-binary",
+							},
+						},
+					},
+				},
+			},
+			warnings: []deprecation.Warning{deprecation.CRICRIUPath},
+		},
 	} {
 		t.Run(desc, func(t *testing.T) {
 			w, err := ValidatePluginConfig(context.Background(), test.config)
diff --git a/pkg/deprecation/deprecation.go b/pkg/deprecation/deprecation.go
@@ -39,6 +39,8 @@ const (
 	RuntimeV1 Warning = Prefix + "runtime-v1"
 	// RuntimeRuncV1 is a warning for the io.containerd.runc.v1 runtime
 	RuntimeRuncV1 Warning = Prefix + "runtime-runc-v1"
+	// CRICRIUPath is a warning for the use of the `CriuPath` property
+	CRICRIUPath Warning = Prefix + "cri-criu-path"
 )
 
 var messages = map[Warning]string{
@@ -55,6 +57,8 @@ var messages = map[Warning]string{
 	AUFSSnapshotter: "The aufs snapshotter is deprecated since containerd v1.5 and removed in containerd v2.0. Use the overlay snapshotter instead.",
 	RuntimeV1:       "The `io.containerd.runtime.v1.linux` runtime is deprecated since containerd v1.4 and removed in containerd v2.0. Use the `io.containerd.runc.v2` runtime instead.",
 	RuntimeRuncV1:   "The `io.containerd.runc.v1` runtime is deprecated since containerd v1.4 and removed in containerd v2.0. Use the `io.containerd.runc.v2` runtime instead.",
+	CRICRIUPath: "The `CriuPath` property of `[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.*.options]` is deprecated since containerd v1.7 and will be removed in containerd v2.0. " +
+		"Use a criu binary in $PATH instead.",
 }
 
 // Valid checks whether a given Warning is valid

Original file line number	Diff line number	Diff line change
`@@ -396,6 +396,11 @@ func ValidatePluginConfig(ctx context.Context, c *PluginConfig) ([]deprecation.W`
`396`	`396`	`}`
`397`	`397`	log.G(ctx).Warning("`runtime_root` is deprecated, please use runtime `options` instead")
`398`	`398`	`}`
	`399`	`+`
	`400`	`+ if p, ok := r.Options["CriuPath"].(string); ok && p != "" {`
	`401`	+ log.G(ctx).Warning("`CriuPath` is deprecated, please use a criu binary in $PATH instead.")
	`402`	`+ warnings = append(warnings, deprecation.CRICRIUPath)`
	`403`	`+ }`
`399`	`404`	`}`
`400`	`405`
`401`	`406`	`useConfigPath := c.Registry.ConfigPath != ""`