container

Oct 30, 2026

Changes in this version

+ const DefaultDetachKeys

+ var ErrDetached = errors.New("detached")

+ var ErrNoStdin = errors.New("container has no stdin (create it with OpenStdin, run -i)")

+ var ErrNoTerminal = errors.New("container has no terminal (create it with Tty, run -t)")

+ func ParseDetachKeys(s string) ([]byte, error)

type Config

+ ConsoleSize [2]uint16

+ OpenStdin bool

+ StdinOnce bool

+ Tty bool

type Container

+ func (c *Container) AttachStdin(ctx context.Context, in io.Reader, detachKeys []byte) error

+ func (c *Container) Resize(h, w uint16) error

Oct 29, 2026

Changes in this version

+ const DefaultHealthInterval

+ const DefaultHealthRetries

+ const DefaultHealthStartInterval

+ const DefaultHealthTimeout

+ const HealthHealthy

+ const HealthLogSize

+ const HealthNone

+ const HealthOutputBytes

+ const HealthStarting

+ const HealthUnhealthy

+ const MaxHealthRetries

+ const MinHealthInterval

type Config

+ Healthcheck *HealthConfig

+ type Health struct

+ FailingStreak int

+ Log []HealthResult

+ Status string

+ type HealthConfig struct

+ Interval time.Duration

+ Retries int

+ StartInterval time.Duration

+ StartPeriod time.Duration

+ Test []string

+ Timeout time.Duration

+ func (h *HealthConfig) Enabled() bool

+ type HealthResult struct

+ End time.Time

+ ExitCode int

+ Output string

+ Start time.Time

type Snapshot

+ Health *Health

Oct 29, 2026

Changes in this version

+ const MaxRetryCount

+ const RestartFirstDelay

+ const RestartMaxDelay

+ const RestartReset

type Config

+ Restart RestartPolicy

type Manager

+ func (m *Manager) AutoStart(ctx context.Context) []error

+ type RestartPolicy struct

+ MaximumRetryCount int

+ Name string

+ func ParseRestartPolicy(s string) (RestartPolicy, error)

+ func (p RestartPolicy) None() bool

type Snapshot

+ RestartCount int

type State

+ const Restarting

Oct 29, 2026

Changes in this version

+ var ErrNoPublish = errors.New("this engine cannot publish ports")

type Config

+ Ports portmap.Map

+ PublishAll bool

type Options

+ PortLimits portmap.Limits

+ Ports portmap.Host

type Snapshot

+ Ports portmap.Map

Oct 28, 2026

Changes in this version

+ const MaxExecs

+ const MaxLine

+ var ErrExecNotRunning = errors.New("exec instance is not running")

+ var ErrExecStarted = errors.New("exec instance already started")

+ var ErrNoSuchExec = errors.New("no such exec instance")

+ type Exec struct

+ Config ExecConfig

+ ContainerID string

+ ID string

+ func (x *Exec) Done() <-chan struct{}

+ func (x *Exec) Info() ExecInfo

+ func (x *Exec) Kill()

+ func (x *Exec) Resize(h, w uint16) error

+ type ExecConfig struct

+ AttachStderr bool

+ AttachStdin bool

+ AttachStdout bool

+ Cmd []string

+ ConsoleSize [2]uint16

+ Env []string

+ Tty bool

+ User string

+ WorkingDir string

+ type ExecIO struct

+ Stderr io.Writer

+ Stdin io.Reader

+ Stdout io.Writer

+ type ExecInfo struct

+ Config ExecConfig

+ ContainerID string

+ Ended bool

+ ExitCode int

+ ID string

+ Pid uint32

+ Running bool

+ Started bool

type Manager

+ func (m *Manager) CreateExec(ref string, cfg ExecConfig) (*Exec, error)

+ func (m *Manager) GetExec(id string) (*Exec, error)

+ func (m *Manager) StartExec(ctx context.Context, x *Exec, sio ExecIO) error

Oct 28, 2026

Changes in this version

+ const MaxAttachments

+ const NoNetwork

+ type Attachment struct

+ Aliases []string

+ Network string

type Config

+ Networks []Attachment

+ func (cfg Config) PrimaryNetwork() string

type Manager

+ func (m *Manager) Connect(ctx context.Context, ref string, a Attachment) error

+ func (m *Manager) Disconnect(ref, network string) error

+ type NetworkInfo struct

+ Aliases []string

+ IPAddress netip.Addr

+ Network string

type Snapshot

+ Networks []NetworkInfo

Oct 28, 2026

Changes in this version

type Config

+ Caps []string

Oct 28, 2026

Changes in this version

type Manager

+ func (m *Manager) Touched(c *Container)

Oct 26, 2026

Changes in this version

+ func DNSName(name, id string) string

+ func ValidNetworkName(s string) bool

type Config

+ Network string

type Manager

+ func (m *Manager) UsesNetwork(name string) bool

type Options

+ Network func(ctx context.Context, network, name string) (netdriver.Endpoint, error)

type Snapshot

+ IPAddress netip.Addr

Oct 26, 2026

Changes in this version

type Config

+ Mounts []Mount

type Manager

+ func (m *Manager) UsesVolume(name string) []string

+ type Mount struct

+ ReadOnly bool

+ Target string

+ Volume string

type Options

+ Volume func(name string) (*rootfs.FS, error)

Oct 26, 2026

Changes in this version

type Container

+ func (c *Container) Stats() Stats

type Manager

+ func (m *Manager) DefaultMemoryLimit() int64

+ type Stats struct

+ LogBytes int64

+ MemoryBytes int64

+ MemoryLimitBytes int64

+ Read time.Time

+ Running bool

+ SizeRw int64

+ WrittenBytes int64

Oct 26, 2026

Changes in this version

type Options

+ Events *events.Bus

Oct 26, 2026

Changes in this version

type Container

+ func (c *Container) Attach(ctx context.Context, logs bool, fn func(Record) error) error

type Manager

+ func (m *Manager) Restart(ctx context.Context, ref string) error

+ func (m *Manager) Stop(ctx context.Context, ref string) error

Oct 26, 2026

Changes in this version

+ func DecodeRecord(v []byte) (*record, error)

type Config

+ AutoRemove bool

type Manager

+ func (m *Manager) Flush(ctx context.Context) error

+ func (m *Manager) PersistError() error

+ func (m *Manager) Prune() ([]string, int64)

+ func (m *Manager) Restore(lower func(imageID string) (*rootfs.FS, error), lim rootfs.Limits) (RestoreReport, error)

type Options

+ CheckpointEvery time.Duration

+ Store state.Store

+ type RestoreReport struct

+ Removed []string

+ Repaired []string

+ Restored int

+ Stopped int

Oct 26, 2026

Changes in this version

+ const Stderr

+ const Stdout

+ var ErrAlreadyStarted = errors.New("container already started")

+ var ErrAmbiguous = errors.New("multiple containers match")

+ var ErrInvalid = errors.New("invalid container configuration")

+ var ErrNameConflict = errors.New("container name already in use")

+ var ErrNotFound = errors.New("no such container")

+ var ErrNotRunning = errors.New("container is not running")

+ var ErrRunning = errors.New("container is running")

+ var ErrTooMany = errors.New("too many containers")

+ type Config struct

+ Cmd []string

+ Entrypoint []string

+ Env []string

+ Image string

+ ImageID string

+ Labels map[string]string

+ MemoryLimitBytes int64

+ WorkingDir string

+ type Container struct

+ func (c *Container) FS() *rootfs.FS

+ func (c *Container) ID() string

+ func (c *Container) Logs(ctx context.Context, follow bool, fn func(Record) error) error

+ func (c *Container) Snapshot() Snapshot

+ func (c *Container) Wait(ctx context.Context, cond WaitCondition) (int, error)

+ type CreateOptions struct

+ Config Config

+ Lower *rootfs.FS

+ Name string

+ type Logs struct

+ type Manager struct

+ func NewManager(opt Options) *Manager

+ func (m *Manager) Create(o CreateOptions) (*Container, error)

+ func (m *Manager) Get(ref string) (*Container, error)

+ func (m *Manager) Kill(ref string) error

+ func (m *Manager) List(all bool) []Snapshot

+ func (m *Manager) Logs(ctx context.Context, ref string, follow bool, fn func(Record) error) error

+ func (m *Manager) Remove(ctx context.Context, ref string, force bool) error

+ func (m *Manager) Shutdown(ctx context.Context)

+ func (m *Manager) Start(ctx context.Context, ref string) error

+ func (m *Manager) UsesImage(imageID string) []string

+ func (m *Manager) Wait(ctx context.Context, ref string, cond WaitCondition) (int, error)

+ type Options struct

+ Executor runtime.Executor

+ MaxContainers int

+ MaxLogBytes int

+ MemoryLimitBytes int64

+ Quota rootfs.Quota

+ Timeout time.Duration

+ type Record struct

+ Data []byte

+ Stream byte

+ Time time.Time

+ type Snapshot struct

+ Config Config

+ Created time.Time

+ Error string

+ ExitCode int

+ FinishedAt time.Time

+ ID string

+ Name string

+ Path string

+ SizeRw int64

+ StartedAt time.Time

+ State State

+ TimedOut bool

+ func (s Snapshot) Command() []string

+ type State string

+ const Created

+ const Exited

+ const Running

+ type WaitCondition string

+ const WaitNextExit

+ const WaitNotRunning

+ const WaitRemoved