libcontainerd

package

v0.0.0-...-b8d3825 Latest Latest Go to latest Published: Jul 22, 2019 License: Apache-2.0 Imports: 34 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/zhouyu0/docker-note

Links

Open Source Insights

Documentation ¶

Rendered for

Index ¶

Constants
type Backend
type Checkpoints
type Client
- func NewClient(ctx context.Context, cli *containerd.Client, stateDir, ns string, b Backend) (Client, error)
type EventInfo
type EventType
type Resources
type Stats
type Status
type StdioCallback
type Summary

Constants ¶

View Source

const InitProcessName = "init"

InitProcessName is the name given to the first process of a container

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Backend ¶

type Backend interface {
	ProcessEvent(containerID string, event EventType, ei EventInfo) error
}

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

type Checkpoints ¶

type Checkpoints struct{}

Checkpoints contains the details of a checkpoint

type Client ¶

type Client interface {
	Version(ctx context.Context) (containerd.Version, error)

	Restore(ctx context.Context, containerID string, attachStdio StdioCallback) (alive bool, pid int, err error)

	Create(ctx context.Context, containerID string, spec *specs.Spec, runtimeOptions interface{}) error
	Start(ctx context.Context, containerID, checkpointDir string, withStdin bool, attachStdio StdioCallback) (pid int, err error)
	SignalProcess(ctx context.Context, containerID, processID string, signal int) error
	Exec(ctx context.Context, containerID, processID string, spec *specs.Process, withStdin bool, attachStdio StdioCallback) (int, error)
	ResizeTerminal(ctx context.Context, containerID, processID string, width, height int) error
	CloseStdin(ctx context.Context, containerID, processID string) error
	Pause(ctx context.Context, containerID string) error
	Resume(ctx context.Context, containerID string) error
	Stats(ctx context.Context, containerID string) (*Stats, error)
	ListPids(ctx context.Context, containerID string) ([]uint32, error)
	Summary(ctx context.Context, containerID string) ([]Summary, error)
	DeleteTask(ctx context.Context, containerID string) (uint32, time.Time, error)
	Delete(ctx context.Context, containerID string) error
	Status(ctx context.Context, containerID string) (Status, error)

	UpdateResources(ctx context.Context, containerID string, resources *Resources) error
	CreateCheckpoint(ctx context.Context, containerID, checkpointDir string, exit bool) error
}

Client provides access to containerd features.

func NewClient ¶

func NewClient(ctx context.Context, cli *containerd.Client, stateDir, ns string, b Backend) (Client, error)

NewClient creates a new libcontainerd client from a containerd client

type EventInfo ¶

type EventInfo struct {
	ContainerID string
	ProcessID   string
	Pid         uint32
	ExitCode    uint32
	ExitedAt    time.Time
	OOMKilled   bool
	Error       error
}

EventInfo contains the event info

type EventType ¶

type EventType string

EventType represents a possible event from libcontainerd

const (
	EventUnknown     EventType = "unknown"
	EventExit        EventType = "exit"
	EventOOM         EventType = "oom"
	EventCreate      EventType = "create"
	EventStart       EventType = "start"
	EventExecAdded   EventType = "exec-added"
	EventExecStarted EventType = "exec-started"
	EventPaused      EventType = "paused"
	EventResumed     EventType = "resumed"
)

Event constants used when reporting events

type Resources ¶

type Resources specs.LinuxResources

Resources defines updatable container resource values. TODO: it must match containerd upcoming API

type Stats ¶

type Stats struct {
	Read    time.Time
	Metrics *cgroups.Metrics
}

Stats holds metrics properties as returned by containerd

type Status ¶

type Status string

Status represents the current status of a container

const (
	// Running indicates the process is currently executing
	StatusRunning Status = "running"
	// Created indicates the process has been created within containerd but the
	// user's defined process has not started
	StatusCreated Status = "created"
	// Stopped indicates that the process has ran and exited
	StatusStopped Status = "stopped"
	// Paused indicates that the process is currently paused
	StatusPaused Status = "paused"
	// Pausing indicates that the process is currently switching from a
	// running state into a paused state
	StatusPausing Status = "pausing"
	// Unknown indicates that we could not determine the status from the runtime
	StatusUnknown Status = "unknown"
)

Possible container statuses

type StdioCallback ¶

type StdioCallback func(io *cio.DirectIO) (cio.IO, error)

StdioCallback is called to connect a container or process stdio.

type Summary ¶

type Summary struct{}

Summary is not used on linux

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
supervisor

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL