docker

Documentation

Overview

Package docker provides an interface to the system's Docker daemon.

Index

• type BuildArguments
• type Runner
  • func New() Runner
  • func (r Runner) Build(in *BuildArguments) error
  • func (r Runner) Login(uri, username, password string) error
  • func (r Runner) Push(uri, imageTag string, additionalTags ...string) error

Types

type BuildArguments

type BuildArguments struct {
	URI            string            // Required. Location of ECR Repo. Used to generate image name in conjunction with tag.
	ImageTag       string            // Required. Tag to pass to `docker build` via -t flag. Usually Git commit short ID.
	Dockerfile     string            // Required. Dockerfile to pass to `docker build` via --file flag.
	Context        string            // Optional. Build context directory to pass to `docker build`
	Args           map[string]string // Optional. Build args to pass via `--build-arg` flags. Equivalent to ARG directives in dockerfile.
	AdditionalTags []string          // Optional. Additional image tags to pass to docker.
}

BuildArguments holds the arguments we can pass in as flags from the manifest.

type Runner

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

Runner represents a command that can be run.

func New

func New() Runner

New returns a Runner.

func (Runner) Build

func (r Runner) Build(in *BuildArguments) error

Build will run a `docker build` command with the input uri, tag, and Dockerfile path.

func (Runner) Login

func (r Runner) Login(uri, username, password string) error

Login will run a `docker login` command against the Service repository URI with the input uri and auth data.

func (Runner) Push

func (r Runner) Push(uri, imageTag string, additionalTags ...string) error

Push will run `docker push` command against the repository URI with the input uri and image tags.