Merge pull request containerd#2434 from crosbymichael/shimv2

Runtime v2 (shim API)

Author: dmcgowan

.travis.yml

@@ -27,7 +27,8 @@ addons:
       - socat
 
 env:
-  - TRAVIS_GOOS=linux TRAVIS_CGO_ENABLED=1
+  - TRAVIS_GOOS=linux TEST_RUNTIME=io.containerd.runc.v1 TRAVIS_CGO_ENABLED=1
+  - TRAVIS_GOOS=linux TEST_RUNTIME=io.containerd.runtime.v1.linux TRAVIS_CGO_ENABLED=1
   - TRAVIS_GOOS=darwin TRAVIS_CGO_ENABLED=0
 
 before_install:

Makefile

@@ -172,6 +172,10 @@ bin/containerd-shim: cmd/containerd-shim FORCE # set !cgo and omit pie for a sta
 	@echo "$(WHALE) bin/containerd-shim"
 	@CGO_ENABLED=0 go build ${GO_BUILD_FLAGS} -o bin/containerd-shim ${SHIM_GO_LDFLAGS} ${GO_TAGS} ./cmd/containerd-shim
 
+bin/containerd-shim-runc-v1: cmd/containerd-shim-runc-v1 FORCE # set !cgo and omit pie for a static shim build: https://github.com/golang/go/issues/17789#issuecomment-258542220
+	@echo "$(WHALE) bin/containerd-shim-runc-v1"
+	@CGO_ENABLED=0 go build ${GO_BUILD_FLAGS} -o bin/containerd-shim-runc-v1 ${SHIM_GO_LDFLAGS} ${GO_TAGS} ./cmd/containerd-shim-runc-v1
+
 binaries: $(BINARIES) ## build binaries
 	@echo "$(WHALE) $@"
 

Makefile.linux

@@ -14,7 +14,7 @@
 
 
 #linux specific settings
-COMMANDS += containerd-shim
+COMMANDS += containerd-shim containerd-shim-runc-v1
 
 # check GOOS for cross compile builds
 ifeq ($(GOOS),linux)

Protobuild.toml

@@ -37,7 +37,7 @@ plugins = ["fieldpath"] # disable grpc for this package
 
 [[overrides]]
 # enable ttrpc and disable fieldpath and grpc for the shim
-prefixes = ["github.com/containerd/containerd/runtime/shim/v1"]
+prefixes = ["github.com/containerd/containerd/runtime/v1/shim/v1", "github.com/containerd/containerd/runtime/v2/task"]
 plugins = ["ttrpc"]
 
 # Aggregrate the API descriptors to lock down API changes.

client.go

@@ -79,8 +79,12 @@ func New(address string, opts ...ClientOpt) (*Client, error) {
 			return nil, err
 		}
 	}
+	rt := fmt.Sprintf("%s.%s", plugin.RuntimePlugin, runtime.GOOS)
+	if copts.defaultRuntime != "" {
+		rt = copts.defaultRuntime
+	}
 	c := &Client{
-		runtime: fmt.Sprintf("%s.%s", plugin.RuntimePlugin, runtime.GOOS),
+		runtime: rt,
 	}
 	if copts.services != nil {
 		c.services = *copts.services

client_opts.go

@@ -23,9 +23,10 @@ import (
 )
 
 type clientOpts struct {
-	defaultns   string
-	services    *services
-	dialOptions []grpc.DialOption
+	defaultns      string
+	defaultRuntime string
+	services       *services
+	dialOptions    []grpc.DialOption
 }
 
 // ClientOpt allows callers to set options on the containerd client
@@ -42,6 +43,14 @@ func WithDefaultNamespace(ns string) ClientOpt {
 	}
 }
 
+// WithDefaultRuntime sets the default runtime on the client
+func WithDefaultRuntime(rt string) ClientOpt {
+	return func(c *clientOpts) error {
+		c.defaultRuntime = rt
+		return nil
+	}
+}
+
 // WithDialOpts allows grpc.DialOptions to be set on the connection
 func WithDialOpts(opts []grpc.DialOption) ClientOpt {
 	return func(c *clientOpts) error {

client_test.go

@@ -153,6 +153,9 @@ func newClient(t testing.TB, address string, opts ...ClientOpt) (*Client, error)
 	if testing.Short() {
 		t.Skip()
 	}
+	if rt := os.Getenv("TEST_RUNTIME"); rt != "" {
+		opts = append(opts, WithDefaultRuntime(rt))
+	}
 	// testutil.RequiresRoot(t) is not needed here (already called in TestMain)
 	return New(address, opts...)
 }

cmd/containerd-shim-runc-v1/main.go

@@ -0,0 +1,36 @@
+// +build linux
+
+/*
+   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 main
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/containerd/containerd/runtime/v2/runc"
+	"github.com/containerd/containerd/runtime/v2/shim"
+	"github.com/sirupsen/logrus"
+)
+
+func main() {
+	if err := shim.Run(runc.New); err != nil {
+		logrus.WithError(err).Error("shim run")
+		fmt.Fprintf(os.Stderr, "containerd-shim-run-v1: %s\n", err)
+		os.Exit(1)
+	}
+}

cmd/containerd-shim/main_unix.go

@@ -36,9 +36,9 @@ import (
 
 	"github.com/containerd/containerd/events"
 	"github.com/containerd/containerd/namespaces"
-	"github.com/containerd/containerd/runtime/linux/proc"
-	"github.com/containerd/containerd/runtime/shim"
-	shimapi "github.com/containerd/containerd/runtime/shim/v1"
+	"github.com/containerd/containerd/runtime/v1/linux/proc"
+	"github.com/containerd/containerd/runtime/v1/shim"
+	shimapi "github.com/containerd/containerd/runtime/v1/shim/v1"
 	"github.com/containerd/ttrpc"
 	"github.com/containerd/typeurl"
 	ptypes "github.com/gogo/protobuf/types"
@@ -134,7 +134,7 @@ func executeShim() error {
 	shimapi.RegisterShimService(server, sv)
 
 	socket := socketFlag
-	if err := serve(server, socket); err != nil {
+	if err := serve(context.Background(), server, socket); err != nil {
 		return err
 	}
 	logger := logrus.WithFields(logrus.Fields{
@@ -152,7 +152,7 @@ func executeShim() error {
 
 // serve serves the ttrpc API over a unix socket at the provided path
 // this function does not block
-func serve(server *ttrpc.Server, path string) error {
+func serve(ctx context.Context, server *ttrpc.Server, path string) error {
 	var (
 		l   net.Listener
 		err error
@@ -172,7 +172,7 @@ func serve(server *ttrpc.Server, path string) error {
 	logrus.WithField("socket", path).Debug("serving api on unix socket")
 	go func() {
 		defer l.Close()
-		if err := server.Serve(context.Background(), l); err != nil &&
+		if err := server.Serve(ctx, l); err != nil &&
 			!strings.Contains(err.Error(), "use of closed network connection") {
 			logrus.WithError(err).Fatal("containerd-shim: ttrpc server failure")
 		}

cmd/containerd-shim/shim_darwin.go

@@ -22,7 +22,7 @@ import (
 	"os"
 	"os/signal"
 
-	"github.com/containerd/containerd/runtime/shim"
+	"github.com/containerd/containerd/runtime/v1/shim"
 	runc "github.com/containerd/go-runc"
 	"github.com/containerd/ttrpc"
 )