docker

Documentation

Index

• type CreateContainerOptions
• type ExecOptions
• type Iface
• type RunOptions

Types

type CreateContainerOptions

type CreateContainerOptions struct {
	Image string
	Binds []string
}

CreateContainerOptions represents the options to the CreateContainer method.

type ExecOptions

type ExecOptions struct {
	ID           string
	Cmd          []string
	OutputStream io.Writer
	ErrorStream  io.Writer
}

ExecOptions represents options to the Exec method.

type Iface

type Iface interface {
	Run(options *RunOptions) error
	EnsureImage(image string, outputStream io.Writer) error
	PullImage(image string, outputStream io.Writer) error
	GetImageRepoDigests(image string) ([]string, error)
	Exec(options *ExecOptions) error
	Stop(id string, timeout time.Duration) error
	CreateVolume() (string, error)
	RemoveVolume(id string) error
	CreateContainer(options *CreateContainerOptions) (string, error)
	RemoveContainer(id string) error
	CopyFromContainer(id, path string) (io.ReadCloser, error)
	CopyToContainer(id, path string, reader io.Reader) error
	SetDebugVolume(volume string)
}

Iface is an interface for interracting with docker.

type RunOptions

type RunOptions struct {
	Image         string
	WorkingDir    string
	Entrypoint    []string
	Cmd           []string
	Env           []string
	Binds         []string
	NamePrefix    string
	InputStream   io.ReadCloser
	OutputStream  io.Writer
	ErrorStream   io.Writer
	Started       chan string
	Init          bool
	SuccessStatus int
	BeforeRemove  func(id string) error
}

RunOptions represents the options to the Run method.