Add a docker-shim package

pkg/kubelet/container/kuberuntime.go

@@ -0,0 +1,71 @@
+/*
+Copyright 2016 The Kubernetes 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 container
+
+import (
+	"io"
+
+	runtimeApi "k8s.io/kubernetes/pkg/kubelet/api/v1alpha1/runtime"
+)
+
+// RuntimeService interface should be implemented by a container runtime.
+// The methods should be thread-safe.
+type RuntimeService interface {
+	// Version returns the runtime name, runtime version and runtime API version
+	Version(apiVersion string) (*runtimeApi.VersionResponse, error)
+	// CreatePodSandbox creates a pod-level sandbox.
+	// The definition of PodSandbox is at https://github.com/kubernetes/kubernetes/pull/25899
+	CreatePodSandbox(config *runtimeApi.PodSandboxConfig) (string, error)
+	// StopPodSandbox stops the sandbox. If there are any running containers in the
+	// sandbox, they should be force terminated.
+	StopPodSandbox(podSandboxID string) error
+	// DeletePodSandbox deletes the sandbox. If there are running containers in the
+	// sandbox, they should be forcibly deleted.
+	DeletePodSandbox(podSandboxID string) error
+	// PodSandboxStatus returns the Status of the PodSandbox.
+	PodSandboxStatus(podSandboxID string) (*runtimeApi.PodSandboxStatus, error)
+	// ListPodSandbox returns a list of Sandbox.
+	ListPodSandbox(filter *runtimeApi.PodSandboxFilter) ([]*runtimeApi.PodSandbox, error)
+	// CreateContainer creates a new container in specified PodSandbox.
+	CreateContainer(podSandboxID string, config *runtimeApi.ContainerConfig, sandboxConfig *runtimeApi.PodSandboxConfig) (string, error)
+	// StartContainer starts the container.
+	StartContainer(rawContainerID string) error
+	// StopContainer stops a running container with a grace period (i.e., timeout).
+	StopContainer(rawContainerID string, timeout int64) error
+	// RemoveContainer removes the container.
+	RemoveContainer(rawContainerID string) error
+	// ListContainers lists all containers by filters.
+	ListContainers(filter *runtimeApi.ContainerFilter) ([]*runtimeApi.Container, error)
+	// ContainerStatus returns the status of the container.
+	ContainerStatus(rawContainerID string) (*runtimeApi.ContainerStatus, error)
+	// Exec executes a command in the container.
+	Exec(rawContainerID string, cmd []string, tty bool, stdin io.Reader, stdout, stderr io.WriteCloser) error
+}
+
+// ImageManagerService interface should be implemented by a container image
+// manager.
+// The methods should be thread-safe.
+type ImageManagerService interface {
+	// ListImages lists the existing images.
+	ListImages(filter *runtimeApi.ImageFilter) ([]*runtimeApi.Image, error)
+	// ImageStatus returns the status of the image.
+	ImageStatus(image *runtimeApi.ImageSpec) (*runtimeApi.Image, error)
+	// PullImage pulls an image with the authentication config.
+	PullImage(image *runtimeApi.ImageSpec, auth *runtimeApi.AuthConfig) error
+	// RemoveImage removes the image.
+	RemoveImage(image *runtimeApi.ImageSpec) error
+}

pkg/kubelet/dockershim/convert.go

@@ -0,0 +1,91 @@
+/*
+Copyright 2016 The Kubernetes 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 dockershim
+
+import (
+	"fmt"
+	"strings"
+
+	dockertypes "github.com/docker/engine-api/types"
+	runtimeApi "k8s.io/kubernetes/pkg/kubelet/api/v1alpha1/runtime"
+)
+
+// This file contains helper functions to convert docker API types to runtime
+// API types, or vice versa.
+
+const (
+	// Status of a container returned by docker ListContainers
+	statusRunningPrefix = "Up"
+	statusCreatedPrefix = "Created"
+	statusExitedPrefix  = "Exited"
+)
+
+func toRuntimeAPIImage(image *dockertypes.Image) (*runtimeApi.Image, error) {
+	if image == nil {
+		return nil, fmt.Errorf("unable to convert a nil pointer to a runtime API image")
+	}
+
+	size := uint64(image.VirtualSize)
+	return &runtimeApi.Image{
+		Id:          &image.ID,
+		RepoTags:    image.RepoTags,
+		RepoDigests: image.RepoDigests,
+		Size_:       &size,
+	}, nil
+}
+
+func toRuntimeAPIContainer(c *dockertypes.Container) *runtimeApi.Container {
+	state := toRuntimeAPIContainerState(c.Status)
+	return &runtimeApi.Container{
+		Id:       &c.ID,
+		Name:     &c.Names[0],
+		Image:    &runtimeApi.ImageSpec{Image: &c.Image},
+		ImageRef: &c.ImageID,
+		State:    &state,
+		Labels:   c.Labels,
+	}
+}
+
+func toDockerContainerStatus(state runtimeApi.ContainerState) string {
+	switch state {
+	case runtimeApi.ContainerState_CREATED:
+		return "created"
+	case runtimeApi.ContainerState_RUNNING:
+		return "running"
+	case runtimeApi.ContainerState_EXITED:
+		return "exited"
+	case runtimeApi.ContainerState_UNKNOWN:
+		fallthrough
+	default:
+		return "unknown"
+	}
+}
+
+func toRuntimeAPIContainerState(state string) runtimeApi.ContainerState {
+	// Parse the state string in dockertypes.Container. This could break when
+	// we upgrade docker.
+	switch {
+	case strings.HasPrefix(state, statusRunningPrefix):
+		return runtimeApi.ContainerState_RUNNING
+	case strings.HasPrefix(state, statusExitedPrefix):
+		return runtimeApi.ContainerState_EXITED
+	case strings.HasPrefix(state, statusCreatedPrefix):
+		return runtimeApi.ContainerState_CREATED
+	default:
+		return runtimeApi.ContainerState_UNKNOWN
+	}
+}

pkg/kubelet/dockershim/convert_test.go

@@ -0,0 +1,41 @@
+/*
+Copyright 2016 The Kubernetes 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 dockershim
+
+import (
+	"testing"
+
+	runtimeApi "k8s.io/kubernetes/pkg/kubelet/api/v1alpha1/runtime"
+)
+
+func TestConvertDockerStatusToRuntimeAPIState(t *testing.T) {
+	testCases := []struct {
+		input    string
+		expected runtimeApi.ContainerState
+	}{
+		{input: "Up 5 hours", expected: runtimeApi.ContainerState_RUNNING},
+		{input: "Exited (0) 2 hours ago", expected: runtimeApi.ContainerState_EXITED},
+		{input: "Created", expected: runtimeApi.ContainerState_CREATED},
+		{input: "Random string", expected: runtimeApi.ContainerState_UNKNOWN},
+	}
+
+	for i, test := range testCases {
+		if actual := toRuntimeAPIContainerState(test.input); actual != test.expected {
+			t.Errorf("Test[%d]: expected %q, got %q", i, test.expected, actual)
+		}
+	}
+}

pkg/kubelet/dockershim/doc.go

@@ -0,0 +1,18 @@
+/*
+Copyright 2016 The Kubernetes 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.
+*/
+
+// Docker integration using pkg/kubelet/api/v1alpha1/runtime/api.pb.go.
+package dockershim