Merge pull request containerd#9258 from samuelkarp/introspection-depr…

…ecation-warning

Expose usage of deprecated features

api/next.pb.txt

@@ -4344,6 +4344,7 @@ file {
   dependency: "github.com/containerd/containerd/api/types/platform.proto"
   dependency: "google/rpc/status.proto"
   dependency: "google/protobuf/empty.proto"
+  dependency: "google/protobuf/timestamp.proto"
   message_type {
     name: "Plugin"
     field {
@@ -4463,6 +4464,39 @@ file {
       type: TYPE_UINT64
       json_name: "pidns"
     }
+    field {
+      name: "deprecations"
+      number: 4
+      label: LABEL_REPEATED
+      type: TYPE_MESSAGE
+      type_name: ".containerd.services.introspection.v1.DeprecationWarning"
+      json_name: "deprecations"
+    }
+  }
+  message_type {
+    name: "DeprecationWarning"
+    field {
+      name: "id"
+      number: 1
+      label: LABEL_OPTIONAL
+      type: TYPE_STRING
+      json_name: "id"
+    }
+    field {
+      name: "message"
+      number: 2
+      label: LABEL_OPTIONAL
+      type: TYPE_STRING
+      json_name: "message"
+    }
+    field {
+      name: "last_occurrence"
+      number: 3
+      label: LABEL_OPTIONAL
+      type: TYPE_MESSAGE
+      type_name: ".google.protobuf.Timestamp"
+      json_name: "lastOccurrence"
+    }
   }
   service {
     name: "Introspection"

api/services/introspection/v1/introspection.proto

@@ -21,6 +21,7 @@ package containerd.services.introspection.v1;
 import "github.com/containerd/containerd/api/types/platform.proto";
 import "google/rpc/status.proto";
 import "google/protobuf/empty.proto";
+import "google/protobuf/timestamp.proto";
 
 option go_package = "github.com/containerd/containerd/api/services/introspection/v1;introspection";
 
@@ -102,4 +103,11 @@ message ServerResponse {
 	string uuid = 1;
 	uint64 pid = 2;
 	uint64 pidns = 3; // PID namespace, such as 4026531836
+	repeated DeprecationWarning deprecations = 4;
 }
+
+message DeprecationWarning {
+	string id = 1;
+	string message = 2;
+	google.protobuf.Timestamp last_occurrence = 3;
+}

cmd/containerd/builtins/builtins.go

@@ -46,4 +46,5 @@ import (
 	_ "github.com/containerd/containerd/services/tasks"
 	_ "github.com/containerd/containerd/services/transfer"
 	_ "github.com/containerd/containerd/services/version"
+	_ "github.com/containerd/containerd/services/warning"
 )

cmd/ctr/app/main.go

@@ -20,8 +20,13 @@ import (
 	"fmt"
 	"io"
 
+	"github.com/containerd/log"
+	"github.com/urfave/cli"
+	"google.golang.org/grpc/grpclog"
+
 	"github.com/containerd/containerd/cmd/ctr/commands/containers"
 	"github.com/containerd/containerd/cmd/ctr/commands/content"
+	"github.com/containerd/containerd/cmd/ctr/commands/deprecations"
 	"github.com/containerd/containerd/cmd/ctr/commands/events"
 	"github.com/containerd/containerd/cmd/ctr/commands/images"
 	"github.com/containerd/containerd/cmd/ctr/commands/info"
@@ -39,9 +44,6 @@ import (
 	"github.com/containerd/containerd/defaults"
 	"github.com/containerd/containerd/namespaces"
 	"github.com/containerd/containerd/version"
-	"github.com/containerd/log"
-	"github.com/urfave/cli"
-	"google.golang.org/grpc/grpclog"
 )
 
 var extraCmds = []cli.Command{}
@@ -118,6 +120,7 @@ containerd CLI
 		ociCmd.Command,
 		sandboxes.Command,
 		info.Command,
+		deprecations.Command,
 	}, extraCmds...)
 	app.Before = func(context *cli.Context) error {
 		if context.GlobalBool("debug") {

cmd/ctr/commands/deprecations/deprecations.go

@@ -0,0 +1,113 @@
+/*
+   Copyright The containerd Authors.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+
+package deprecations
+
+import (
+	"fmt"
+	"os"
+	"text/tabwriter"
+	"time"
+
+	"github.com/urfave/cli"
+
+	api "github.com/containerd/containerd/api/services/introspection/v1"
+	"github.com/containerd/containerd/cmd/ctr/commands"
+	"github.com/containerd/containerd/protobuf"
+	ptypes "github.com/containerd/containerd/protobuf/types"
+)
+
+// Command is the parent for all commands under "deprecations"
+var Command = cli.Command{
+	Name: "deprecations",
+	Subcommands: []cli.Command{
+		listCommand,
+	},
+}
+var listCommand = cli.Command{
+	Name:  "list",
+	Usage: "Print warnings for deprecations",
+	Flags: []cli.Flag{
+		cli.StringFlag{
+			Name:  "format",
+			Usage: "output format to use (Examples: 'default', 'json')",
+		},
+	},
+	Action: func(context *cli.Context) error {
+		client, ctx, cancel, err := commands.NewClient(context)
+		if err != nil {
+			return err
+		}
+		defer cancel()
+
+		resp, err := client.IntrospectionService().Server(ctx, &ptypes.Empty{})
+		if err != nil {
+			return err
+		}
+		wrn := warnings(resp)
+		if len(wrn) > 0 {
+			switch context.String("format") {
+			case "json":
+				commands.PrintAsJSON(warnings(resp))
+				return nil
+			default:
+				w := tabwriter.NewWriter(os.Stdout, 4, 8, 4, ' ', 0)
+				fmt.Fprintln(w, "ID\tLAST OCCURRENCE\tMESSAGE\t")
+				for _, dw := range wrn {
+					if _, err := fmt.Fprintf(w, "%s\t%s\t%s\n",
+						dw.ID,
+						dw.LastOccurrence.Format(time.RFC3339Nano),
+						dw.Message,
+					); err != nil {
+						return err
+					}
+				}
+				return w.Flush()
+			}
+
+		}
+		return nil
+	},
+}
+
+type deprecationWarning struct {
+	ID             string    `json:"id"`
+	Message        string    `json:"message"`
+	LastOccurrence time.Time `json:"lastOccurrence"`
+}
+
+func warnings(in *api.ServerResponse) []deprecationWarning {
+	var warnings []deprecationWarning
+	for _, dw := range in.Deprecations {
+		wrn := deprecationWarningFromPB(dw)
+		if wrn == nil {
+			continue
+		}
+		warnings = append(warnings, *wrn)
+	}
+	return warnings
+}
+func deprecationWarningFromPB(in *api.DeprecationWarning) *deprecationWarning {
+	if in == nil {
+		return nil
+	}
+	lo := protobuf.FromTimestamp(in.LastOccurrence)
+	return &deprecationWarning{
+		ID:             in.ID,
+		Message:        in.Message,
+		LastOccurrence: lo,
+	}
+}

images/labels.go

@@ -0,0 +1,21 @@
+/*
+   Copyright The containerd Authors.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+
+package images
+
+const (
+	ConvertedDockerSchema1LabelKey = "io.containerd.image/converted-docker-schema1"
+)

pkg/deprecation/deprecation.go

@@ -0,0 +1,46 @@
+/*
+   Copyright The containerd Authors.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+
+package deprecation
+
+type Warning string
+
+const (
+	// Prefix is a standard prefix for all Warnings, used for filtering plugin Exports
+	Prefix = "io.containerd.deprecation/"
+	// PullSchema1Image is a warning for the use of schema 1 images
+	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"
+)
+
+var messages = map[Warning]string{
+	PullSchema1Image: "Schema 1 images are deprecated since containerd v1.7 and removed in containerd v2.0. " +
+		`Since containerd v1.7.8, 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.",
+}
+
+// Valid checks whether a given Warning is valid
+func Valid(id Warning) bool {
+	_, ok := messages[id]
+	return ok
+}
+
+// Message returns the human-readable message for a given Warning
+func Message(id Warning) (string, bool) {
+	msg, ok := messages[id]
+	return msg, ok
+}

plugin/context.go

@@ -127,6 +127,19 @@ func (ps *Set) Get(t Type) (interface{}, error) {
 	return nil, fmt.Errorf("no plugins registered for %s: %w", t, ErrPluginNotFound)
 }
 
+// GetByID returns the plugin of the given type and ID
+func (ps *Set) GetByID(t Type, id string) (*Plugin, error) {
+	typSet, ok := ps.byTypeAndID[t]
+	if !ok || len(typSet) == 0 {
+		return nil, fmt.Errorf("no plugins registered for %s: %w", t, ErrPluginNotFound)
+	}
+	p, ok := typSet[id]
+	if !ok {
+		return nil, fmt.Errorf("no plugins registered for %s %q: %w", t, id, ErrPluginNotFound)
+	}
+	return p, nil
+}
+
 // GetAll returns all initialized plugins
 func (ps *Set) GetAll() []*Plugin {
 	return ps.ordered

plugin/dynamic/dynamic.go

@@ -23,7 +23,7 @@ import "fmt"
 // Load is currently only implemented on non-static, non-gccgo builds for amd64
 // and arm64, and plugins must be built with the exact same version of Go as
 // containerd itself.
-func Load(path string) (err error) {
+func Load(path string) (loaded int, err error) {
 	defer func() {
 		if v := recover(); v != nil {
 			rerr, ok := v.(error)

plugin/dynamic/dynamic_supported.go

@@ -25,12 +25,13 @@ import (
 	"runtime"
 )
 
-// loadPlugins loads all plugins for the OS and Arch
-// that containerd is built for inside the provided path
-func loadPlugins(path string) error {
+// loadPlugins loads all plugins for the OS and Arch that containerd is built
+// for inside the provided path and returns the count of successfully-loaded
+// plugins
+func loadPlugins(path string) (int, error) {
 	abs, err := filepath.Abs(path)
 	if err != nil {
-		return err
+		return 0, err
 	}
 	pattern := filepath.Join(abs, fmt.Sprintf(
 		"*-%s-%s.%s",
@@ -40,14 +41,16 @@ func loadPlugins(path string) error {
 	))
 	libs, err := filepath.Glob(pattern)
 	if err != nil {
-		return err
+		return 0, err
 	}
+	loaded := 0
 	for _, lib := range libs {
 		if _, err := plugin.Open(lib); err != nil {
-			return err
+			return loaded, err
 		}
+		loaded++
 	}
-	return nil
+	return loaded, nil
 }
 
 // getLibExt returns a platform specific lib extension for

plugin/dynamic/dynamic_unsupported.go

@@ -23,6 +23,6 @@ package dynamic
 // - with gccgo: gccgo has no plugin support golang/go#36403
 // - on static builds; https://github.com/containerd/containerd/commit/0d682e24a1ba8e93e5e54a73d64f7d256f87492f
 // - on architectures other than amd64 and arm64 (other architectures need to be tested)
-func loadPlugins(path string) error {
-	return nil
+func loadPlugins(path string) (int, error) {
+	return 0, nil
 }

plugins/types.go

@@ -65,11 +65,15 @@ const (
 	SandboxControllerPlugin plugin.Type = "io.containerd.sandbox.controller.v1"
 	// ImageVerifierPlugin implements an image verifier service
 	ImageVerifierPlugin plugin.Type = "io.containerd.image-verifier.v1"
+	// WarningPlugin implements a warning service
+	WarningPlugin plugin.Type = "io.containerd.warning.v1"
 )
 
 const (
 	// RuntimeRuncV2 is the runc runtime that supports multiple containers per shim
 	RuntimeRuncV2 = "io.containerd.runc.v2"
+
+	DeprecationsPlugin = "deprecations"
 )
 
 const (