container

Documentation

Index

• func GetDockerClient(ctx context.Context) (*client.Client, error)
• func ImageExistsLocally(ctx context.Context, imageName string) (bool, error)
• func NewDockerBuildExecutor(input NewDockerBuildExecutorInput) common.Executor
• func NewDockerPullExecutor(input NewDockerPullExecutorInput) common.Executor
• func NewDockerVolumeRemoveExecutor(volume string, force bool) common.Executor
• type Container
  • func NewContainer(input *NewContainerInput) Container
• type FileEntry
• type NewContainerInput
• type NewDockerBuildExecutorInput
• type NewDockerPullExecutorInput

Functions

func GetDockerClient

func GetDockerClient(ctx context.Context) (*client.Client, error)

func ImageExistsLocally

func ImageExistsLocally(ctx context.Context, imageName string) (bool, error)

ImageExistsLocally returns a boolean indicating if an image with the requested name (and tag) exist in the local docker image store

func NewDockerBuildExecutor

func NewDockerBuildExecutor(input NewDockerBuildExecutorInput) common.Executor

NewDockerBuildExecutor function to create a run executor for the container

func NewDockerPullExecutor

func NewDockerPullExecutor(input NewDockerPullExecutorInput) common.Executor

NewDockerPullExecutor function to create a run executor for the container

func NewDockerVolumeRemoveExecutor

func NewDockerVolumeRemoveExecutor(volume string, force bool) common.Executor

Types

type Container

type Container interface {
	Create() common.Executor
	Copy(destPath string, files ...*FileEntry) common.Executor
	CopyDir(destPath string, srcPath string) common.Executor
	Pull(forcePull bool) common.Executor
	Start(attach bool) common.Executor
	Exec(command []string, env map[string]string) common.Executor
	Remove() common.Executor
}

Container for managing docker run containers

func NewContainer

func NewContainer(input *NewContainerInput) Container

NewContainer creates a reference to a container

type FileEntry

type FileEntry struct {
	Name string
	Mode int64
	Body string
}

FileEntry is a file to copy to a container

type NewContainerInput

type NewContainerInput struct {
	Image       string
	Entrypoint  []string
	Cmd         []string
	WorkingDir  string
	Env         []string
	Binds       []string
	Mounts      map[string]string
	Name        string
	Stdout      io.Writer
	Stderr      io.Writer
	NetworkMode string
}

NewContainerInput the input for the New function

type NewDockerBuildExecutorInput

type NewDockerBuildExecutorInput struct {
	ContextDir string
	ImageTag   string
}

NewDockerBuildExecutorInput the input for the NewDockerBuildExecutor function

type NewDockerPullExecutorInput

type NewDockerPullExecutorInput struct {
	Image     string
	ForcePull bool
}

NewDockerPullExecutorInput the input for the NewDockerPullExecutor function