engine

package

Go to main page

Versions in this module

v0

v0.4.0

Nov 9, 2026

Changes in this version

type Engine — darwin/amd64, js/wasm, windows/amd64

+ func (e *Engine) PruneContainers(context.Context) ([]string, error)

type Engine — linux/amd64

+ func (e *Engine) CleanTrash(olderThan time.Duration) (int, int64, error)

+ func (e *Engine) ListTrash() ([]TrashItem, error)

+ func (e *Engine) PruneContainers(ctx context.Context) ([]string, error)

+ type TrashItem struct

+ DiscardedAt time.Time

+ ItemType string

+ Name string

+ OriginalName string

+ Path string

+ Size int64

v0.3.0

Oct 31, 2026

Changes in this version

+ type BuildOptions struct

+ BuildArgs map[string]string

+ Context string

+ File string

+ Tag string

+ Target string

type Engine — darwin/amd64, js/wasm, windows/amd64

+ func (e *Engine) Build(context.Context, BuildOptions, IO) (*Image, error)

type Engine — linux/amd64

+ func (e *Engine) Build(ctx context.Context, opts BuildOptions, stdio IO) (_ *Image, retErr error)

type RunOptions

+ UserNS string

v0.2.0

Oct 31, 2026

Changes in this version

type Engine

+ func (e *Engine) ImportOCI(ctx context.Context, ref, path string) (*Image, error)

v0.1.0

Oct 30, 2026

Changes in this version

+ var ErrUnsupported = errors.New("spod container execution requires Linux user namespaces")

+ func DefaultRoot() (string, error)

+ func Init()

+ func ValidateName(name string) error

+ type Container struct

+ Created time.Time

+ Entrypoint []string

+ Image string

+ Name string

+ Options RunOptions

+ PID int

+ Status string

+ type Engine struct

+ Root string

+ func New(root string) (*Engine, error)

+ func (e *Engine) Discard(path string) error

+ func (e *Engine) Exec(context.Context, string, ExecOptions, IO) (int, error)

+ func (e *Engine) Exec(ctx context.Context, name string, opts ExecOptions, io IO) (int, error)

+ func (e *Engine) Export(ctx context.Context, name string, out io.Writer) error

+ func (e *Engine) Images() ([]Image, error)

+ func (e *Engine) Import(ctx context.Context, ref string, archive io.Reader) (*Image, error)

+ func (e *Engine) Inspect(context.Context, string) (*Container, error)

+ func (e *Engine) Inspect(ctx context.Context, name string) (*Container, error)

+ func (e *Engine) InspectImage(ref string) (*Image, error)

+ func (e *Engine) List(context.Context) ([]Container, error)

+ func (e *Engine) List(ctx context.Context) ([]Container, error)

+ func (e *Engine) PrepareRootfs(ctx context.Context, ref, dest string) (_ *Image, retErr error)

+ func (e *Engine) Pull(ctx context.Context, ref string) (*Image, error)

+ func (e *Engine) Remove(context.Context, string, bool) error

+ func (e *Engine) Remove(ctx context.Context, name string, force bool) error

+ func (e *Engine) RemoveImage(ref string) error

+ func (e *Engine) Rename(context.Context, string, string) error

+ func (e *Engine) Rename(ctx context.Context, oldName, newName string) error

+ func (e *Engine) Run(context.Context, RunOptions, IO) (int, error)

+ func (e *Engine) Run(ctx context.Context, opts RunOptions, io IO) (int, error)

+ func (e *Engine) Start(context.Context, string, IO) (int, error)

+ func (e *Engine) Start(ctx context.Context, name string, io IO) (int, error)

+ func (e *Engine) Stop(context.Context, string, time.Duration) error

+ func (e *Engine) Stop(ctx context.Context, name string, timeout time.Duration) error

+ type ExecOptions struct

+ Command []string

+ Env []string

+ TTY bool

+ User string

+ WorkDir string

+ type IO struct

+ Stderr io.Writer

+ Stdin io.Reader

+ Stdout io.Writer

+ type Image struct

+ Config v1.Config

+ Created time.Time

+ Digest string

+ Platform v1.Platform

+ Reference string

+ Rootfs string

+ type Lifecycle interface

+ Exec func(context.Context, string, ExecOptions, IO) (int, error)

+ Inspect func(context.Context, string) (*Container, error)

+ List func(context.Context) ([]Container, error)

+ Remove func(context.Context, string, bool) error

+ Run func(context.Context, RunOptions, IO) (int, error)

+ Start func(context.Context, string, IO) (int, error)

+ Stop func(context.Context, string, time.Duration) error

+ type Mount struct

+ ReadOnly bool

+ Source string

+ Target string

+ type RunOptions struct

+ Command []string

+ Entrypoint []string

+ Env []string

+ Hostname string

+ Image string

+ Interactive bool

+ Labels map[string]string

+ Mounts []Mount

+ Name string

+ Network string

+ Remove bool

+ TTY bool

+ User string

+ WorkDir string

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