docker

Documentation

Overview

Package docker implements a compiler for turning Blubber configuration into a valid single- or multi-stage Dockerfile.

Index

• func Compile(cfg *config.Config, variant string) (*bytes.Buffer, error)
• type Copy
  • func (di Copy) Arguments() []string
  • func (dc Copy) Compile() string
• type CopyFrom
  • func (di CopyFrom) Arguments() []string
  • func (dcf CopyFrom) Compile() string
• type Env
  • func (di Env) Arguments() []string
  • func (de Env) Compile() string
• type Instruction
  • func NewInstruction(instruction build.Instruction) (Instruction, error)
• type Label
  • func (di Label) Arguments() []string
  • func (dl Label) Compile() string
• type Run
  • func (di Run) Arguments() []string
  • func (dr Run) Compile() string
• type Volume
  • func (di Volume) Arguments() []string
  • func (dv Volume) Compile() string

Functions

func Compile

func Compile(cfg *config.Config, variant string) (*bytes.Buffer, error)

Compile takes a parsed config.Config and a configured variant name and returns the bytes of a resulting Dockerfile. In the case where artifacts are defined or the shorthand "copies" configured is set, a multi-stage Dockerfile will be returned.

Types

type Copy

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

Copy compiles into a COPY instruction.

func (Copy) Arguments

func (di Copy) Arguments() []string

func (Copy) Compile

func (dc Copy) Compile() string

Compile compiles COPY instructions.

type CopyFrom

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

CopyFrom compiles into a COPY --from instruction.

func (CopyFrom) Arguments

func (di CopyFrom) Arguments() []string

func (CopyFrom) Compile

func (dcf CopyFrom) Compile() string

Compile compiles COPY --from instructions.

type Env

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

Env compiles into a ENV instruction.

func (Env) Arguments

func (di Env) Arguments() []string

func (Env) Compile

func (de Env) Compile() string

Compile compiles ENV instructions.

type Instruction

type Instruction interface {
	Compile() string
	Arguments() []string
}

Instruction defines an interface for instruction compilation.

func NewInstruction

func NewInstruction(instruction build.Instruction) (Instruction, error)

NewInstruction takes a general internal build.Instruction and returns a corresponding compilable Docker specific instruction. The given internal instruction is partially compiled at this point by calling Compile() which applies its own logic for escaping arguments, etc.

type Label

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

Label compiles into a LABEL instruction.

func (Label) Arguments

func (di Label) Arguments() []string

func (Label) Compile

func (dl Label) Compile() string

Compile returns multiple key="value" arguments as a single LABEL instruction.

type Run

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

Run compiles into a RUN instruction.

func (Run) Arguments

func (di Run) Arguments() []string

func (Run) Compile

func (dr Run) Compile() string

Compile compiles RUN instructions.

type Volume

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

Volume compiles into a VOLUME instruction.

func (Volume) Arguments

func (di Volume) Arguments() []string

func (Volume) Compile

func (dv Volume) Compile() string

Compile compiles VOLUME instructions.