docker

Documentation

Index

• Variables
• func AddRemoteTag(src, target string, cfg Config) error
• func CreateDockerTarContext(ctx context.Context, w io.Writer, workspace string, a *latest.DockerArtifact, ...) error
• func GetDependencies(ctx context.Context, workspace string, dockerfilePath string, ...) ([]string, error)
• func IsInsecure(ref name.Reference, insecureRegistries map[string]bool) bool
• func NewDockerIgnorePredicate(workspace string, excludes []string) (walk.Predicate, error)
• func NormalizeDockerfilePath(context, dockerfile string) (string, error)
• func Push(tarPath, tag string, cfg Config) (string, error)
• func RetrieveConfigFile(tagged string, cfg Config) (*v1.ConfigFile, error)
• func RetrieveLabels(tagged string, cfg Config) (map[string]string, error)
• func RetrieveRemoteConfig(identifier string, cfg Config) (*v1.ConfigFile, error)
• func RetrieveWorkingDir(tagged string, cfg Config) (string, error)
• func SubstituteDefaultRepoIntoImage(defaultRepo string, image string) (string, error)
• func SyncMap(workspace string, dockerfilePath string, buildArgs map[string]*string, ...) (map[string][]string, error)
• func ToCLIBuildArgs(a *latest.DockerArtifact, evaluatedArgs map[string]*string) ([]string, error)
• func WalkWorkspace(workspace string, excludes, deps []string) (map[string]bool, error)
• type ArtifactConfig
  • func (c ArtifactConfig) ArtifactType() latest.ArtifactType
  • func (c ArtifactConfig) ConfiguredImage() string
  • func (c ArtifactConfig) Describe() string
  • func (c ArtifactConfig) Name() string
  • func (c ArtifactConfig) Path() string
• type AuthConfigHelper
• type BuildResult
• type Config
• type ContainerRun
• type ExitCoder
• type ImageReference
  • func ParseReference(image string) (*ImageReference, error)
• type Keychain
  • func (a *Keychain) Resolve(res authn.Resource) (authn.Authenticator, error)
• type LocalDaemon
  • func NewAPIClientImpl(cfg Config) (LocalDaemon, error)
  • func NewLocalDaemon(apiClient client.CommonAPIClient, extraEnv []string, forceRemove bool, ...) LocalDaemon
• type PushResult

Variables

var (
	EvalBuildArgs = evalBuildArgs // To override during testing

)

var Name = "Docker"

Name is the name of the Docker builder

var (
	NewAPIClient = NewAPIClientImpl
)

For testing

var (
	RemoteDigest = getRemoteDigest
)

for testing

var (
	// RetrieveImage is overridden for unit testing
	RetrieveImage = retrieveImage
)

var (
	Validate = validate
)

For testing

Functions

func AddRemoteTag

func AddRemoteTag(src, target string, cfg Config) error

func CreateDockerTarContext

func CreateDockerTarContext(ctx context.Context, w io.Writer, workspace string, a *latest.DockerArtifact, cfg Config) error

func GetDependencies

func GetDependencies(ctx context.Context, workspace string, dockerfilePath string, buildArgs map[string]*string, cfg Config) ([]string, error)

GetDependencies finds the sources dependencies for the given docker artifact. All paths are relative to the workspace.

func IsInsecure

func IsInsecure(ref name.Reference, insecureRegistries map[string]bool) bool

IsInsecure tests if an image is pulled from an insecure registry; default is false

func NewDockerIgnorePredicate

func NewDockerIgnorePredicate(workspace string, excludes []string) (walk.Predicate, error)

NewDockerIgnorePredicate creates a walk.Predicate that checks if directory entries should be ignored.

func NormalizeDockerfilePath

func NormalizeDockerfilePath(context, dockerfile string) (string, error)

NormalizeDockerfilePath returns the absolute path to the dockerfile.

func Push

func Push(tarPath, tag string, cfg Config) (string, error)

Push pushes the tarball image

func RetrieveConfigFile

func RetrieveConfigFile(tagged string, cfg Config) (*v1.ConfigFile, error)

func RetrieveLabels

func RetrieveLabels(tagged string, cfg Config) (map[string]string, error)

func RetrieveRemoteConfig

func RetrieveRemoteConfig(identifier string, cfg Config) (*v1.ConfigFile, error)

RetrieveRemoteConfig retrieves the remote config file for an image

func RetrieveWorkingDir

func RetrieveWorkingDir(tagged string, cfg Config) (string, error)

func SubstituteDefaultRepoIntoImage

func SubstituteDefaultRepoIntoImage(defaultRepo string, image string) (string, error)

func SyncMap

func SyncMap(workspace string, dockerfilePath string, buildArgs map[string]*string, cfg Config) (map[string][]string, error)

SyncMap creates a map of syncable files by looking at the COPY/ADD commands in the Dockerfile. All keys are relative to the Skaffold root, the destinations are absolute container paths. TODO(corneliusweig) destinations are not resolved across stages in multistage dockerfiles. Is there a use-case for that?

func ToCLIBuildArgs

func ToCLIBuildArgs(a *latest.DockerArtifact, evaluatedArgs map[string]*string) ([]string, error)

func WalkWorkspace

func WalkWorkspace(workspace string, excludes, deps []string) (map[string]bool, error)

WalkWorkspace walks the given host directories and records all files found. Note: if you change this function, you might also want to modify `walkWorkspaceWithDestinations`.

Types

type ArtifactConfig

type ArtifactConfig struct {
	File string `json:"path"`
}

ArtifactConfig holds information about a Docker build based project

func (ArtifactConfig) ArtifactType

func (c ArtifactConfig) ArtifactType() latest.ArtifactType

ArtifactType returns the type of the artifact to be built.

func (ArtifactConfig) ConfiguredImage

func (c ArtifactConfig) ConfiguredImage() string

ConfiguredImage returns the target image configured by the builder, or an empty string if no image is configured

func (ArtifactConfig) Describe

func (c ArtifactConfig) Describe() string

Describe returns the initBuilder's string representation, used when prompting the user to choose a builder.

func (ArtifactConfig) Name

func (c ArtifactConfig) Name() string

Name returns the name of the builder, "Docker"

func (ArtifactConfig) Path

func (c ArtifactConfig) Path() string

Path returns the path to the dockerfile

type AuthConfigHelper

type AuthConfigHelper interface {
	GetAuthConfig(registry string) (types.AuthConfig, error)
	GetAllAuthConfigs(ctx context.Context) (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 BuildResult

type BuildResult struct {
	ID string
}

BuildResult gives the information on an image that has been built.

type Config

type Config interface {
	Prune() bool
	GetKubeContext() string
	MinikubeProfile() string
	GetInsecureRegistries() map[string]bool
}

type ContainerRun

type ContainerRun struct {
	Image       string
	User        string
	Command     []string
	Mounts      []mount.Mount
	Env         []string
	BeforeStart func(context.Context, string) error
}

type ExitCoder

type ExitCoder interface {
	ExitCode() int
}

type ImageReference

type ImageReference struct {
	BaseName       string
	Domain         string
	Path           string
	Tag            string
	Digest         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.

type Keychain

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

Keychain stores an authenticator per registry.

func (*Keychain) Resolve

func (a *Keychain) Resolve(res authn.Resource) (authn.Authenticator, error)

Resolve retrieves the authenticator for a given resource.

type LocalDaemon

type LocalDaemon interface {
	Close() error
	ExtraEnv() []string
	ServerVersion(ctx context.Context) (types.Version, error)
	ConfigFile(ctx context.Context, image string) (*v1.ConfigFile, error)
	Build(ctx context.Context, out io.Writer, workspace string, a *latest.DockerArtifact, ref string, mode config.RunMode) (string, error)
	Push(ctx context.Context, out io.Writer, ref string) (string, error)
	Pull(ctx context.Context, out io.Writer, ref string) error
	Load(ctx context.Context, out io.Writer, input io.Reader, ref string) (string, error)
	Tag(ctx context.Context, image, ref string) error
	TagWithImageID(ctx context.Context, ref string, imageID string) (string, error)
	ImageID(ctx context.Context, ref string) (string, error)
	ImageInspectWithRaw(ctx context.Context, image string) (types.ImageInspect, []byte, error)
	ImageRemove(ctx context.Context, image string, opts types.ImageRemoveOptions) ([]types.ImageDeleteResponseItem, error)
	ImageExists(ctx context.Context, ref string) bool
	Prune(ctx context.Context, out io.Writer, images []string, pruneChildren bool) error
	RawClient() client.CommonAPIClient
}

LocalDaemon talks to a local Docker API.

func NewAPIClientImpl

func NewAPIClientImpl(cfg Config) (LocalDaemon, error)

NewAPIClientImpl guesses the docker client to use based on current Kubernetes context.

func NewLocalDaemon

func NewLocalDaemon(apiClient client.CommonAPIClient, extraEnv []string, forceRemove bool, cfg Config) LocalDaemon

NewLocalDaemon creates a new LocalDaemon.

type PushResult

type PushResult struct {
	Digest string
}

PushResult gives the information on an image that has been pushed.