docker

Documentation

Index

• Variables
• func CreateDockerTarContext(w io.Writer, dockerfilePath, context string) error
• func Digest(ctx context.Context, cli DockerAPIClient, ref string) (string, error)
• func GetDockerfileDependencies(workspace string, r io.Reader) ([]string, error)
• func PortsFromDockerfile(r io.Reader) ([]string, error)
• func RunBuild(ctx context.Context, cli DockerAPIClient, opts *BuildOptions) error
• func RunPush(ctx context.Context, cli DockerAPIClient, ref string, out io.Writer) error
• type AuthConfigHelper
• type BuildOptions
• type DockerAPIClient
  • func NewDockerAPIClient() (DockerAPIClient, error)

Variables

var RetrieveImage = retrieveImage

For testing.

Functions

func CreateDockerTarContext

func CreateDockerTarContext(w io.Writer, dockerfilePath, context string) error

func Digest

func Digest(ctx context.Context, cli DockerAPIClient, ref string) (string, error)

Digest returns the image digest for a corresponding reference. The digest is of the form sha256:<image_id>

func GetDockerfileDependencies

func GetDockerfileDependencies(workspace string, r io.Reader) ([]string, error)

GetDockerfileDependencies parses a dockerfile and returns the full paths of all the source files that the resulting docker image depends on.

func PortsFromDockerfile

func PortsFromDockerfile(r io.Reader) ([]string, error)

func RunBuild

func RunBuild(ctx context.Context, cli DockerAPIClient, opts *BuildOptions) error

RunBuild performs a docker build and returns nothing

func RunPush

func RunPush(ctx context.Context, cli DockerAPIClient, ref string, out io.Writer) error

Types

type AuthConfigHelper

type AuthConfigHelper interface {
	GetAuthConfig(registry string) (types.AuthConfig, error)
	GetAllAuthConfigs() (map[string]types.AuthConfig, error)
}

AuthConfigHelper exists for testing purposes since GetAuthConfig shells out to native store helpers. Ideally this shouldn't be public, but the LocalBuilder needs to use it.

var (
	// DefaultAuthHelper is exposed so that other packages can override it for testing
	DefaultAuthHelper AuthConfigHelper
)

type BuildOptions

type BuildOptions struct {
	ImageName   string
	Dockerfile  string
	ContextDir  string
	ProgressBuf io.Writer
	BuildBuf    io.Writer
	BuildArgs   map[string]*string
}

type DockerAPIClient

type DockerAPIClient interface {
	client.CommonAPIClient
	io.Closer
}

func NewDockerAPIClient

func NewDockerAPIClient() (DockerAPIClient, error)

NewDockerAPIClient guesses the docker client to use based on current kubernetes context.