docker

Documentation

Index

• Variables
• func AddTag(src, target string) error
• func CreateDockerTarContext(w io.Writer, dockerfilePath, context string) error
• func CreateDockerTarGzContext(w io.Writer, dockerfilePath, context string) error
• func Digest(ctx context.Context, cli APIClient, ref string) (string, error)
• func GetDependencies(dockerfilePath, workspace string) ([]string, error)
• func RemoteDigest(identifier string) (string, error)
• func RunBuild(ctx context.Context, cli APIClient, opts *BuildOptions) error
• func RunPush(ctx context.Context, cli APIClient, ref string, out io.Writer) error
• func StreamDockerMessages(dst io.Writer, src io.Reader) error
• func UploadContextToGCS(ctx context.Context, dockerfilePath, dockerCtx, bucket, objectName string) error
• type APIClient
  • func NewAPIClient() (APIClient, error)
• type AuthConfigHelper
• type BuildOptions
• type ImageReference
  • func ParseReference(image string) (*ImageReference, error)

Variables

var RetrieveImage = retrieveImage

RetrieveImage is overriden for unit testing

Functions

func AddTag

func AddTag(src, target string) error

func CreateDockerTarContext

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

func CreateDockerTarGzContext

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

func Digest

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

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

func GetDependencies

func GetDependencies(dockerfilePath, workspace string) ([]string, error)

func RemoteDigest

func RemoteDigest(identifier string) (string, error)

func RunBuild

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

RunBuild performs a docker build and returns nothing

func RunPush

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

func StreamDockerMessages

func StreamDockerMessages(dst io.Writer, src io.Reader) error

StreamDockerMessages streams formatted json output from the docker daemon TODO(@r2d4): Make this output much better, this is the bare minimum

func UploadContextToGCS

func UploadContextToGCS(ctx context.Context, dockerfilePath, dockerCtx, bucket, objectName string) error

Types

type APIClient

type APIClient interface {
	client.CommonAPIClient
}

func NewAPIClient

func NewAPIClient() (APIClient, error)

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

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 ImageReference

type ImageReference struct {
	BaseName       string
	FullyQualified bool
}

ImageReference is a parsed image name.

func ParseReference

func ParseReference(image string) (*ImageReference, error)

ParseReference parses an image name to a reference.