libcontainerd

Documentation

Index

• Constants
• type Backend
• type Client
• type CreateOption
  • func WithRestartManager(rm restartmanager.RestartManager) CreateOption
• type IOPipe
• type Process
• type Remote
  • func New(_ string, _ ...RemoteOption) (Remote, error)
• type RemoteOption
• type Resources
• type Spec
• type StateInfo
• type Stats
• type Summary
• type User

Constants

const (
	CoEClassstring     = syscall.Errno(0x800401F3) // Invalid class string
	ErrorNoNetwork     = syscall.Errno(1222)       // The network is not present or not started
	ErrorBadPathname   = syscall.Errno(161)        // The specified path is invalid
	ErrorInvalidObject = syscall.Errno(0x800710D8) // The object identifier does not represent a valid object
)

Win32 error codes that are used for various workarounds These really should be ALL_CAPS to match golangs syscall library and standard Win32 error conventions, but golint insists on CamelCase.

const (
	StateStart        = "start-container"
	StatePause        = "pause"
	StateResume       = "resume"
	StateExit         = "exit"
	StateRestart      = "restart"
	StateRestore      = "restore"
	StateStartProcess = "start-process"
	StateExitProcess  = "exit-process"
	StateOOM          = "oom" // fake state

)

State constants used in state change reporting.

const (
	// InitFriendlyName is the name given in the lookup map of processes
	// for the first process started in a container.
	InitFriendlyName = "init"
)

Types

type Backend

type Backend interface {
	StateChanged(containerID string, state StateInfo) error
	AttachStreams(processFriendlyName string, io IOPipe) error
}

Backend defines callbacks that the client of the library needs to implement.

type Client

type Client interface {
	Create(containerID string, spec Spec, options ...CreateOption) error
	Signal(containerID string, sig int) error
	AddProcess(containerID, processFriendlyName string, process Process) error
	Resize(containerID, processFriendlyName string, width, height int) error
	Pause(containerID string) error
	Resume(containerID string) error
	Restore(containerID string, options ...CreateOption) error
	Stats(containerID string) (*Stats, error)
	GetPidsForContainer(containerID string) ([]int, error)
	Summary(containerID string) ([]Summary, error)
	UpdateResources(containerID string, resources Resources) error
}

Client provides access to containerd features.

type CreateOption

type CreateOption interface {
	Apply(interface{}) error
}

CreateOption allows to configure parameters of container creation.

func WithRestartManager

func WithRestartManager(rm restartmanager.RestartManager) CreateOption

WithRestartManager sets the restartmanager to be used with the container.

type IOPipe

type IOPipe struct {
	Stdin    io.WriteCloser
	Stdout   io.Reader
	Stderr   io.Reader
	Terminal bool // Whether stderr is connected on Windows
}

IOPipe contains the stdio streams.

type Process

type Process windowsoci.Process

Process contains information to start a specific application inside the container.

type Remote

type Remote interface {
	// Client returns a new Client instance connected with given Backend.
	Client(Backend) (Client, error)
	// Cleanup stops containerd if it was started by libcontainerd.
	// Note this is not used on Windows as there is no remote containerd.
	Cleanup()
}

Remote on Linux defines the accesspoint to the containerd grpc API. Remote on Windows is largely an unimplemented interface as there is no remote containerd.

func New

func New(_ string, _ ...RemoteOption) (Remote, error)

New creates a fresh instance of libcontainerd remote. On Windows, this is not used as there is no remote containerd process.

type RemoteOption

type RemoteOption interface {
	Apply(Remote) error
}

RemoteOption allows to configure paramters of remotes. This is unused on Windows.

type Resources

type Resources struct{}

Resources defines updatable container resource values.

type Spec

type Spec windowsoci.WindowsSpec

Spec is the base configuration for the container.

type StateInfo

type StateInfo struct {
	State     string
	Pid       uint32
	ExitCode  uint32
	ProcessID string
	OOMKilled bool // TODO Windows containerd factor out
}

StateInfo contains description about the new state container has entered.

type Stats

type Stats struct{}

Stats contains a stats properties from containerd.

type Summary

type Summary struct {
	Pid     uint32
	Command string
}

Summary container a container summary from containerd

type User

type User windowsoci.User

User specifies user information for the containers main process.