docker

Documentation

Index

• Constants
• type BuildOptions
• type CLI
  • func NewCLI(executable Executable) CLI
  • func (c CLI) Build(options BuildOptions) (string, string, error)
  • func (c CLI) RemoveImage(image string, options RemoveImageOptions) (string, string, error)
  • func (c CLI) Run(image string, options RunOptions) (string, string, error)
• type Dockerfile
  • func BuildStagingDockerfile(logger lager.Logger, fixturePath, buildpackPath string, envs []string) Dockerfile
  • func NewDockerfile(baseImage string, instructions ...DockerfileInstruction) Dockerfile
• type DockerfileInstruction
  • func NewDockerfileADD(content string) DockerfileInstruction
  • func NewDockerfileENV(content string) DockerfileInstruction
  • func NewDockerfileFROM(content string) DockerfileInstruction
  • func NewDockerfileRUN(content string) DockerfileInstruction
  • func NewDockerfileUSER(content string) DockerfileInstruction
  • func (di DockerfileInstruction) String() string
• type DockerfileInstructionType
• type Executable
• type RemoveImageOptions
• type RunOptions

Constants

const ExecutableName = "docker"

Types

type BuildOptions

type BuildOptions struct {
	Remove  bool
	NoCache bool
	Tag     string
	File    string
	Context string
}

type CLI

type CLI struct {
	// contains filtered or unexported fields
}

func NewCLI

func NewCLI(executable Executable) CLI

func (CLI) Build

func (c CLI) Build(options BuildOptions) (string, string, error)

func (CLI) RemoveImage

func (c CLI) RemoveImage(image string, options RemoveImageOptions) (string, string, error)

func (CLI) Run

func (c CLI) Run(image string, options RunOptions) (string, string, error)

type Dockerfile

type Dockerfile struct {
	*bytes.Buffer
}

func BuildStagingDockerfile

func BuildStagingDockerfile(logger lager.Logger, fixturePath, buildpackPath string, envs []string) Dockerfile

func NewDockerfile

func NewDockerfile(baseImage string, instructions ...DockerfileInstruction) Dockerfile

type DockerfileInstruction

type DockerfileInstruction struct {
	Type    DockerfileInstructionType
	Content string
}

func NewDockerfileADD

func NewDockerfileADD(content string) DockerfileInstruction

func NewDockerfileENV

func NewDockerfileENV(content string) DockerfileInstruction

func NewDockerfileFROM

func NewDockerfileFROM(content string) DockerfileInstruction

func NewDockerfileRUN

func NewDockerfileRUN(content string) DockerfileInstruction

func NewDockerfileUSER

func NewDockerfileUSER(content string) DockerfileInstruction

func (DockerfileInstruction) String

func (di DockerfileInstruction) String() string

type DockerfileInstructionType

type DockerfileInstructionType string

const (
	DockerfileInstructionTypeFROM DockerfileInstructionType = "FROM"
	DockerfileInstructionTypeADD  DockerfileInstructionType = "ADD"
	DockerfileInstructionTypeRUN  DockerfileInstructionType = "RUN"
	DockerfileInstructionTypeENV  DockerfileInstructionType = "ENV"
	DockerfileInstructionTypeUSER DockerfileInstructionType = "USER"
)

type Executable

type Executable interface {
	Execute(pexec.Execution) error
}

type RemoveImageOptions

type RemoveImageOptions struct {
	Force bool
}

type RunOptions

type RunOptions struct {
	Network string
	Remove  bool
	TTY     bool
	Command string
}