interface.go

/*
Copyright 2021 The Everoute 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 client

import (
	"context"
	"io"

	"github.com/containerd/containerd"
	"github.com/containerd/containerd/containers"
	"github.com/containerd/containerd/images"
	"github.com/containerd/containerd/platforms"

	"github.com/everoute/container/model"
)

const (
	ENVRuntimeContainerName      = "RUNTIME_CONTAINER_NAME"
	ENVRuntimeContainerNamespace = "RUNTIME_CONTAINER_NAMESPACE"
	ENVRuntimeContainerImage     = "RUNTIME_CONTAINER_IMAGE"
)

type Runtime interface {
	ImageManager
	ContainerManager
	io.Closer

	// Platform supported by the runtime
	Platform() platforms.MatchComparer
	// Namespace of the current runtime in
	Namespace() string
	// NodeExecute execute commands on the runtime node
	NodeExecute(ctx context.Context, name string, commands ...string) error
	// ConfigRuntime config container runtime
	ConfigRuntime(ctx context.Context) error
	// RemoveNamespace delete runtime namespace
	RemoveNamespace(ctx context.Context) error
}

type ContainerdClientProvider interface {
	ContainerdClient() *containerd.Client
}

// ImageManager contains methods to manipulate images. The methods are thread-safe.
type ImageManager interface {
	// ImportImages imports specify images to containerd
	ImportImages(ctx context.Context, refs ...string) error

	// ListImages list all images in containerd
	ListImages(ctx context.Context) ([]images.Image, error)

	// RemoveImage remove an image from containerd
	RemoveImage(ctx context.Context, ref string) error

	// GetImage return image details
	GetImage(ctx context.Context, ref string) (*images.Image, bool, error)
}

type ContainerStatus struct {
	containerd.Status
	containerd.Task
	containers.Container
}

type ContainerUpdateOptions struct {
	UpdateSnapshot bool
}

// ContainerManager contains methods to manipulate containers managed by a
// container runtime. The methods are thread-safe.
type ContainerManager interface {
	// RecommendedRuntimeInfo of the container.
	RecommendedRuntimeInfo(ctx context.Context, container *model.Container) *containers.RuntimeInfo

	// CreateContainer creates a new container.
	CreateContainer(ctx context.Context, container *model.Container, follow bool) error

	// UpdateContainer update the container.
	UpdateContainer(ctx context.Context, container *model.Container, opts *ContainerUpdateOptions) error

	// RemoveContainer removes the container.
	RemoveContainer(ctx context.Context, containerID string) error

	// GetContainer return container by containerID
	GetContainer(ctx context.Context, containerID string) (*model.Container, error)

	// ListContainers list containers in the namespace
	ListContainers(ctx context.Context) ([]*model.Container, error)

	// GetContainerStatus return the container status
	GetContainerStatus(ctx context.Context, containerID string) (ContainerStatus, error)

	// ExecCommand exec giving commands and return result
	ExecCommand(ctx context.Context, containerID string, commands []string) (*containerd.ExitStatus, error)
}