runtime

Documentation

Index

• type Bind
  • func BindBoth(path string) *Bind
• type ContainerConfig
• type ContainerInspectResult
• type ImageInspectResult
• type Interface
• type Name
  • func ListRuntimes() []Name
  • func (n Name) String() string

Types

type Bind

type Bind struct {
	HostPath      string
	ContainerPath string
}

func BindBoth

func BindBoth(path string) *Bind

Convenience generator for Binds which have the same host and container path

type ContainerConfig

type ContainerConfig struct {
	Cmd          []string
	Hostname     string
	Labels       map[string]string
	EnvVars      []string
	Binds        []*Bind
	CapAdds      []string
	Devices      []*Bind
	StopTimeout  uint32
	AutoRemove   bool
	NetworkMode  string
	PortBindings meta.PortMappings
}

type ContainerInspectResult

type ContainerInspectResult struct {
	ID        string
	Image     string
	Status    string
	IPAddress net.IP
	PID       uint32
}

type ImageInspectResult

type ImageInspectResult struct {
	ID   *meta.OCIContentID
	Size int64
}

type Interface

type Interface interface {
	PullImage(image meta.OCIImageRef) error
	InspectImage(image meta.OCIImageRef) (*ImageInspectResult, error)
	ExportImage(image meta.OCIImageRef) (io.ReadCloser, func() error, error)

	InspectContainer(container string) (*ContainerInspectResult, error)
	AttachContainer(container string) error
	RunContainer(image meta.OCIImageRef, config *ContainerConfig, name, id string) (string, error)
	StopContainer(container string, timeout *time.Duration) error
	KillContainer(container, signal string) error
	RemoveContainer(container string) error
	ContainerLogs(container string) (io.ReadCloser, error)

	Name() Name
	RawClient() interface{}

	PreflightChecker() preflight.Checker
}

type Name

type Name string

Name defines a name for a runtime

const (
	// RuntimeDocker specifies the Docker runtime
	RuntimeDocker Name = "docker"
	// RuntimeContainerd specifies the containerd runtime
	RuntimeContainerd Name = "containerd"
)

func ListRuntimes

func ListRuntimes() []Name

ListRuntimes gets the list of available runtimes

func (Name) String

func (n Name) String() string