runtime

package

Go to main page

Versions in this module

v0

v0.4.0

Jun 24, 2026

Changes in this version

+ var ErrCheckpointUnsupported = errors.New("runtime: checkpoint/restore not supported by this backend")

type Capabilities

+ Checkpoint bool

+ type CheckpointFailedError struct

+ Err error

+ ID string

+ Stderr string

+ func (e *CheckpointFailedError) Error() string

+ func (e *CheckpointFailedError) Unwrap() error

+ type CheckpointRef struct

+ ArchivePath string

+ Size int64

+ type CheckpointRuntime interface

+ Checkpoint func(ctx context.Context, id string, spec CheckpointSpec) (CheckpointRef, error)

+ Restore func(ctx context.Context, spec RestoreSpec) (*Container, error)

+ type CheckpointSpec struct

+ ArchivePath string

+ StopAfter bool

+ TCPEstablished bool

type ContainerDetails

+ CapAdd []string

+ Privileged bool

+ SecurityOpt []string

type ImageDetails

+ Entrypoint []string

+ type RestoreFailedError struct

+ ArchivePath string

+ Err error

+ Stderr string

+ func (e *RestoreFailedError) Error() string

+ func (e *RestoreFailedError) Unwrap() error

+ type RestoreSpec struct

+ ArchivePath string

+ IgnoreVolumes bool

+ Name string

+ TCPEstablished bool

v0.3.0

Jun 2, 2026

Changes in this version

type ExecOptions

+ InitialTtySize TtySize

+ ResizeCh <-chan TtySize

+ type TtySize struct

+ Height uint16

+ Width uint16

v0.2.0

May 18, 2026

Changes in this version

+ type BuilderUnavailableError struct

+ Err error

+ Hint string

+ func (e *BuilderUnavailableError) Error() string

+ func (e *BuilderUnavailableError) Unwrap() error

+ type Capabilities struct

+ ExitCodes bool

+ Healthchecks bool

+ NamespaceSharing bool

+ RestartPolicies bool

+ ServiceNameDNS bool

+ SharedVolumes bool

type ComposeUpSpec

+ NoRecreate bool

type Container

+ Labels map[string]string

type ContainerDetails

+ Health HealthStatus

+ type HealthCheckSpec struct

+ Disable bool

+ Interval time.Duration

+ Retries int

+ StartInterval time.Duration

+ StartPeriod time.Duration

+ Test []string

+ Timeout time.Duration

+ type HealthStatus string

+ const HealthHealthy

+ const HealthNone

+ const HealthStarting

+ const HealthUnhealthy

+ type LabelFilter struct

+ Match map[string]string

+ type NetworkSpec struct

+ Driver string

+ Labels map[string]string

+ Name string

+ Options map[string]string

+ type PortBinding struct

+ ContainerPort int

+ HostIP string

+ HostPort string

+ Protocol string

+ type RestartPolicy string

+ const RestartAlways

+ const RestartNo

+ const RestartOnFailure

+ const RestartUnlessStopped

type RunSpec

+ HealthCheck *HealthCheckSpec

+ MemoryBytes int64

+ NanoCPUs int64

+ Networks []string

+ Ports []PortBinding

+ RestartPolicy RestartPolicy

type Runtime

+ Capabilities func() Capabilities

+ CreateNetwork func(ctx context.Context, spec NetworkSpec) (string, error)

+ CreateVolume func(ctx context.Context, spec VolumeSpec) (string, error)

+ ListContainers func(ctx context.Context, filter LabelFilter) ([]Container, error)

+ ListImages func(ctx context.Context, filter LabelFilter) ([]ImageRef, error)

+ RemoveImage func(ctx context.Context, ref string) error

+ RemoveNetwork func(ctx context.Context, id string) error

+ RemoveVolume func(ctx context.Context, name string) error

+ type UnsupportedOptionError struct

+ Backend string

+ Option string

+ func (e *UnsupportedOptionError) Error() string

+ type VolumeSpec struct

+ Driver string

+ Labels map[string]string

+ Name string

+ Options map[string]string

v0.1.4

May 13, 2026

v0.1.3

May 13, 2026

v0.1.2

May 12, 2026

v0.1.1

May 11, 2026

Changes in this version

+ var ErrNotImplemented = errors.New("runtime: not implemented")

+ func CancellableCopy(ctx context.Context, dst io.Writer, src io.ReadCloser) error

+ type BuildEvent struct

+ Digest string

+ Kind BuildEventKind

+ LayerID string

+ Message string

+ type BuildEventKind string

+ const BuildEventCompleted

+ const BuildEventLayer

+ const BuildEventLog

+ const BuildEventPullProgress

+ type BuildSpec struct

+ Args map[string]string

+ CacheFrom []string

+ ContextPath string

+ Dockerfile string

+ NoCache bool

+ Platform string

+ Tag string

+ Target string

+ type ComposeDownSpec struct

+ Files []string

+ ProjectName string

+ RemoveImages bool

+ RemoveVolumes bool

+ WorkingDir string

+ type ComposeFailedError struct

+ Args []string

+ ExitCode int

+ Stderr string

+ func (e *ComposeFailedError) Error() string

+ type ComposePsSpec struct

+ Files []string

+ ProjectName string

+ WorkingDir string

+ type ComposeRuntime interface

+ ComposeContainerID func(ctx context.Context, spec ComposePsSpec, service string) (string, error)

+ ComposeDown func(ctx context.Context, spec ComposeDownSpec) error

+ ComposeUp func(ctx context.Context, spec ComposeUpSpec, events chan<- BuildEvent) error

+ type ComposeUnavailableError struct

+ Err error

+ func (e *ComposeUnavailableError) Error() string

+ func (e *ComposeUnavailableError) Unwrap() error

+ type ComposeUpSpec struct

+ Files []string

+ ProjectName string

+ Services []string

+ WorkingDir string

+ type Container struct

+ ID string

+ Image string

+ Name string

+ State State

+ type ContainerDetails struct

+ Created time.Time

+ Env []string

+ ExitCode int

+ FinishedAt time.Time

+ Labels map[string]string

+ Mounts []MountInspect

+ StartedAt time.Time

+ User string

+ type ContainerNotFoundError struct

+ Err error

+ ID string

+ func (e *ContainerNotFoundError) Error() string

+ func (e *ContainerNotFoundError) Unwrap() error

+ type DaemonUnavailableError struct

+ Err error

+ func (e *DaemonUnavailableError) Error() string

+ func (e *DaemonUnavailableError) Unwrap() error

+ type ExecFailedError struct

+ ExitCode int

+ Stderr string

+ func (e *ExecFailedError) Error() string

+ type ExecOptions struct

+ Cmd []string

+ Env map[string]string

+ Stderr io.Writer

+ Stdin io.Reader

+ Stdout io.Writer

+ Tty bool

+ User string

+ WorkingDir string

+ type ExecResult struct

+ ExitCode int

+ Stderr string

+ Stdout string

+ type ImageDetails struct

+ Env []string

+ ID string

+ Labels map[string]string

+ Tags []string

+ User string

+ type ImageNotFoundError struct

+ Err error

+ Ref string

+ func (e *ImageNotFoundError) Error() string

+ func (e *ImageNotFoundError) Unwrap() error

+ type ImageRef struct

+ ID string

+ Tags []string

+ type MountInspect struct

+ ReadOnly bool

+ Source string

+ Target string

+ Type string

+ type MountSpec struct

+ Propagation string

+ ReadOnly bool

+ Source string

+ Target string

+ Type MountType

+ type MountType string

+ const MountBind

+ const MountTmpfs

+ const MountVolume

+ type RemoveOptions struct

+ Force bool

+ RemoveVolumes bool

+ type RunSpec struct

+ CapAdd []string

+ Cmd []string

+ Entrypoint []string

+ Env map[string]string

+ Image string

+ Init bool

+ Labels map[string]string

+ Mounts []MountSpec

+ Name string

+ OverrideCommand bool

+ Privileged bool

+ RunArgs []string

+ SecurityOpt []string

+ User string

+ WorkingDir string

+ type Runtime interface

+ BuildImage func(ctx context.Context, spec BuildSpec, events chan<- BuildEvent) (ImageRef, error)

+ ContainerLogs func(ctx context.Context, id string, w io.Writer, follow bool) error

+ ExecContainer func(ctx context.Context, id string, opts ExecOptions) (ExecResult, error)

+ FindContainerByLabel func(ctx context.Context, key, value string) (*Container, error)

+ InspectContainer func(ctx context.Context, id string) (*ContainerDetails, error)

+ InspectImage func(ctx context.Context, ref string) (*ImageDetails, error)

+ PullImage func(ctx context.Context, ref string, events chan<- BuildEvent) (ImageRef, error)

+ RemoveContainer func(ctx context.Context, id string, opts RemoveOptions) error

+ RunContainer func(ctx context.Context, spec RunSpec) (*Container, error)

+ StartContainer func(ctx context.Context, id string) error

+ StopContainer func(ctx context.Context, id string, opts StopOptions) error

+ type State string

+ const StateCreated

+ const StateDead

+ const StateExited

+ const StatePaused

+ const StateRemoving

+ const StateRestarting

+ const StateRunning

+ type StopOptions struct

+ Timeout time.Duration

v0.1.0

May 11, 2026

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