cri: add deprecation warning for mirrors

samuelkarp · samuelkarp · commit 455edcad2cb5 · 2023-11-08T23:11:54.000-08:00
Signed-off-by: Samuel Karp <samuelkarp@google.com> (cherry picked from commit d7cb25d) Signed-off-by: Samuel Karp <samuelkarp@google.com>
diff --git a/pkg/cri/config/config.go b/pkg/cri/config/config.go
@@ -403,6 +403,7 @@ func ValidatePluginConfig(ctx context.Context, c *PluginConfig) ([]deprecation.W
 		if useConfigPath {
 			return warnings, errors.New("`mirrors` cannot be set when `config_path` is provided")
 		}
+		warnings = append(warnings, deprecation.CRIRegistryMirrors)
 		log.G(ctx).Warning("`mirrors` is deprecated, please use `config_path` instead")
 	}
 	var hasDeprecatedTLS bool
diff --git a/pkg/cri/config/config_test.go b/pkg/cri/config/config_test.go
@@ -363,6 +363,35 @@ func TestValidateConfig(t *testing.T) {
 			},
 			expectedErr: "`configs.tls` cannot be set when `config_path` is provided",
 		},
+		"deprecated mirrors": {
+			config: &PluginConfig{
+				ContainerdConfig: ContainerdConfig{
+					DefaultRuntimeName: RuntimeDefault,
+					Runtimes: map[string]Runtime{
+						RuntimeDefault: {},
+					},
+				},
+				Registry: Registry{
+					Mirrors: map[string]Mirror{
+						"example.com": {},
+					},
+				},
+			},
+			expected: &PluginConfig{
+				ContainerdConfig: ContainerdConfig{
+					DefaultRuntimeName: RuntimeDefault,
+					Runtimes: map[string]Runtime{
+						RuntimeDefault: {},
+					},
+				},
+				Registry: Registry{
+					Mirrors: map[string]Mirror{
+						"example.com": {},
+					},
+				},
+			},
+			warnings: []deprecation.Warning{deprecation.CRIRegistryMirrors},
+		},
 	} {
 		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
@@ -25,12 +25,16 @@ const (
 	PullSchema1Image Warning = Prefix + "pull-schema-1-image"
 	// GoPluginLibrary is a warning for the use of dynamic library Go plugins
 	GoPluginLibrary Warning = Prefix + "go-plugin-library"
+	// CRIRegistryMirrors is a warning for the use of the `mirrors` property
+	CRIRegistryMirrors Warning = Prefix + "cri-registry-mirrors"
 )
 
 var messages = map[Warning]string{
 	PullSchema1Image: "Schema 1 images will be deprecated in containerd v1.7 and removed in containerd v2.0. " +
 		`Since containerd v1.6.25, schema 1 images are identified by the "io.containerd.image/converted-docker-schema1" label.`,
 	GoPluginLibrary: "Dynamically-linked Go plugins as containerd runtimes are deprecated since containerd v2.0 and removed in containerd v2.1.",
+	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.",
 }
 
 // Valid checks whether a given Warning is valid

Original file line number	Diff line number	Diff line change
`@@ -403,6 +403,7 @@ func ValidatePluginConfig(ctx context.Context, c *PluginConfig) ([]deprecation.W`
`403`	`403`	`if useConfigPath {`
`404`	`404`	return warnings, errors.New("`mirrors` cannot be set when `config_path` is provided")
`405`	`405`	`}`
	`406`	`+ warnings = append(warnings, deprecation.CRIRegistryMirrors)`
`406`	`407`	log.G(ctx).Warning("`mirrors` is deprecated, please use `config_path` instead")
`407`	`408`	`}`
`408`	`409`	`var hasDeprecatedTLS bool`