container

Documentation

Overview

Package container provides functionality to interact with containers.

Index

• type BuildOptions
• type Client
  • func NewDockerClient(dockerClient *docker.Client) Client
• type CreateOptions
• type KillOptions
• type LogsOptions
• type PullOptions
• type RemoveOptions
• type StartOptions
• type WaitOptions

Types

type BuildOptions

type BuildOptions struct {
	Dockerfile   string
	OutputStream io.Writer
}

BuildOptions represents container build options.

type Client

type Client interface {
	Build(imageName string, contextDir string, options BuildOptions) error
	Pull(imageName string, options PullOptions) error
	Create(imageName string, options CreateOptions) (string, error)
	Start(containerID string, options StartOptions) error
	Logs(containerID string, options LogsOptions) error
	Wait(containerID string, options WaitOptions) error
	Kill(containerID string, options KillOptions) error
	Remove(containerID string, options RemoveOptions) error
}

Client defines Pachyderm's interface to container-engines such as docker.

func NewDockerClient

func NewDockerClient(dockerClient *docker.Client) Client

NewDockerClient create a Client from given docker.Client.

type CreateOptions

type CreateOptions struct {
	Binds      []string
	HasCommand bool
	Shell      string
}

CreateOptions represents container create options.

type KillOptions

type KillOptions struct{}

KillOptions represents container kill options.

type LogsOptions

type LogsOptions struct {
	Stdout io.Writer
	Stderr io.Writer
}

LogsOptions represents container log options.

type PullOptions

type PullOptions struct {
	NoPullIfLocal bool
	OutputStream  io.Writer
}

PullOptions represents container pull options.

type RemoveOptions

type RemoveOptions struct{}

RemoveOptions represents container remove options.

type StartOptions

type StartOptions struct {
	Commands []string
}

StartOptions represents container start options.

type WaitOptions

type WaitOptions struct{}

WaitOptions represents container wait options.