ctrd

README

ctrd

ctrd is a package to interact with containerd using containerd's exposed API. Pouch will vendor package containerd in repo containerd/containerd and alibaba/containerd.

difference between containerds

First, we should said alibaba/containerd is definitely forked from upstream project containerd/containerd.

containerd/containerd definitely has the code base of the other one. Then what is the usage of alibaba/containerd. We say it is BACK PORTING.

Every time releasing Pouch to launch a new version, we vendor containerd/containerd. Since upstream containerd/containerd keeps its own way to evolve, when a serious bug is fixed in the upstream and Pouch needs this for backporting only, it is not proper to vendor the latest container/containerd which contains too many changes. As a result, we come up with a way to backport severe bugfix in alibaba/containerd. Then when backporting, we vendor alibaba/containerd, otherwise we still take advantages of upstream containerd/containerd.

To check if the package we use is containerd/containerd or alibaba/containerd, we can refer to vendor.json.

Documentation

Index

• func NewDefaultSpec(ctx context.Context, id string) (*specs.Spec, error)
• type Client
  • func NewClient(cfg Config) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) ContainerPID(ctx context.Context, id string) (int, error)
  • func (c *Client) ContainerPIDs(ctx context.Context, id string) ([]int, error)
  • func (c *Client) CreateContainer(ctx context.Context, container *Container) error
  • func (c *Client) CreateSnapshot(ctx context.Context, id, ref string) error
  • func (c *Client) DestroyContainer(ctx context.Context, id string, timeout int64) (*Message, error)
  • func (c *Client) ExecContainer(ctx context.Context, process *Process) error
  • func (c *Client) GetImageConfig(ctx context.Context, ref string) (v1.ImageConfig, error)
  • func (c *Client) GetSnapshot(ctx context.Context, id string) (snapshots.Info, error)
  • func (c *Client) ListImages(ctx context.Context, filter ...string) ([]types.ImageInfo, error)
  • func (c *Client) PauseContainer(ctx context.Context, id string) error
  • func (c *Client) ProbeContainer(ctx context.Context, id string, timeout time.Duration) *Message
  • func (c *Client) PullImage(ctx context.Context, ref string, stream *jsonstream.JSONStream) (containerd.Image, error)
  • func (c *Client) RecoverContainer(ctx context.Context, id string, io *containerio.IO) error
  • func (c *Client) RemoveImage(ctx context.Context, ref string) error
  • func (c *Client) RemoveSnapshot(ctx context.Context, id string) error
  • func (c *Client) SetExitHooks(hooks ...func(string, *Message) error)
  • func (c *Client) SetStopHooks(hooks ...func(string, *Message) error)
  • func (c *Client) UnpauseContainer(ctx context.Context, id string) error
  • func (c *Client) Version() (string, error)
• type Config
• type Container
• type Message
  • func (m *Message) ExitCode() uint32
  • func (m *Message) ExitTime() time.Time
  • func (m *Message) RawError() error
• type Process
• type ProgressInfo

Functions

func NewDefaultSpec

func NewDefaultSpec(ctx context.Context, id string) (*specs.Spec, error)

NewDefaultSpec new a template spec with default.

Types

type Client

type Client struct {
	Config
	// contains filtered or unexported fields
}

Client is the client side the daemon holds to communicate with containerd.

func NewClient

func NewClient(cfg Config) (*Client, error)

NewClient connect to containerd.

func (*Client) Close

func (c *Client) Close() error

Close closes the client.

func (*Client) ContainerPID

func (c *Client) ContainerPID(ctx context.Context, id string) (int, error)

ContainerPID returns the container's init process id.

func (*Client) ContainerPIDs

func (c *Client) ContainerPIDs(ctx context.Context, id string) ([]int, error)

ContainerPIDs returns the all processes's ids inside the container.

func (*Client) CreateContainer

func (c *Client) CreateContainer(ctx context.Context, container *Container) error

CreateContainer create container and start process.

func (*Client) CreateSnapshot

func (c *Client) CreateSnapshot(ctx context.Context, id, ref string) error

CreateSnapshot creates a active snapshot with image's name and id.

func (*Client) DestroyContainer

func (c *Client) DestroyContainer(ctx context.Context, id string, timeout int64) (*Message, error)

DestroyContainer kill container and delete it.

func (*Client) ExecContainer

func (c *Client) ExecContainer(ctx context.Context, process *Process) error

ExecContainer executes a process in container.

func (*Client) GetImageConfig

func (c *Client) GetImageConfig(ctx context.Context, ref string) (v1.ImageConfig, error)

GetImageConfig returns the image's configure.

func (*Client) GetSnapshot

func (c *Client) GetSnapshot(ctx context.Context, id string) (snapshots.Info, error)

GetSnapshot returns the snapshot's info by id.

func (*Client) ListImages

func (c *Client) ListImages(ctx context.Context, filter ...string) ([]types.ImageInfo, error)

ListImages lists all images.

func (*Client) PauseContainer

func (c *Client) PauseContainer(ctx context.Context, id string) error

PauseContainer pause container.

func (*Client) ProbeContainer

func (c *Client) ProbeContainer(ctx context.Context, id string, timeout time.Duration) *Message

ProbeContainer probe the container's status, if timeout <= 0, will block to receive message.

func (*Client) PullImage

func (c *Client) PullImage(ctx context.Context, ref string, stream *jsonstream.JSONStream) (containerd.Image, error)

PullImage downloads an image from the remote repository.

func (*Client) RecoverContainer

func (c *Client) RecoverContainer(ctx context.Context, id string, io *containerio.IO) error

RecoverContainer reload the container from metadata and watch it, if program be restarted.

func (*Client) RemoveImage

func (c *Client) RemoveImage(ctx context.Context, ref string) error

RemoveImage deletes an image.

func (*Client) RemoveSnapshot

func (c *Client) RemoveSnapshot(ctx context.Context, id string) error

RemoveSnapshot removes the snapshot by id.

func (*Client) SetExitHooks

func (c *Client) SetExitHooks(hooks ...func(string, *Message) error)

SetExitHooks specified the handlers of exec process exit.

func (*Client) SetStopHooks

func (c *Client) SetStopHooks(hooks ...func(string, *Message) error)

SetStopHooks specified the handlers of container exit.

func (*Client) UnpauseContainer

func (c *Client) UnpauseContainer(ctx context.Context, id string) error

UnpauseContainer unpauses a container.

func (*Client) Version

func (c *Client) Version() (string, error)

Version returns the version of containerd.

type Config

type Config struct {
	Address string
}

Config represents the config used to communicated with containerd.

type Container

type Container struct {
	ID      string
	Image   string
	Runtime string
	IO      *containerio.IO
	Spec    *specs.Spec
}

Container wraps container's info.

type Message

type Message struct {
	// contains filtered or unexported fields
}

Message is used to watch containerd.

func (*Message) ExitCode

func (m *Message) ExitCode() uint32

ExitCode returns the exit code in Message.

func (*Message) ExitTime

func (m *Message) ExitTime() time.Time

ExitTime returns the exit time in Message.

func (*Message) RawError

func (m *Message) RawError() error

RawError returns the error contained in Message.

type Process

type Process struct {
	ContainerID string
	ExecID      string
	IO          *containerio.IO
	P           *specs.Process
}

Process wraps exec process's info.

type ProgressInfo

type ProgressInfo struct {
	Ref       string
	Status    string
	Offset    int64
	Total     int64
	StartedAt time.Time
	UpdatedAt time.Time

	// For Error handling
	Code         int    // http response code
	ErrorMessage string // detail error information
}

ProgressInfo represents the status of downloading image.