docker

Documentation

Index

• Variables
• func RegistryAuth(token string) types.AuthConfig
• func ResolveDockerfile(cwd string) string
• type BuildOperation
  • func NewBuildOperation(ctx context.Context, cmdCtx *cmdctx.CmdContext) (*BuildOperation, error)
  • func (op *BuildOperation) BuildWithDocker(cmdCtx *cmdctx.CmdContext, dockerfilePath string, buildArgs map[string]string) (*Image, error)
  • func (op *BuildOperation) BuildWithPack(cmdCtx *cmdctx.CmdContext, buildArgs map[string]string) (*Image, error)
  • func (op *BuildOperation) CleanDeploymentTags(cmdCtx *cmdctx.CmdContext)
  • func (op *BuildOperation) LocalDockerAvailable() bool
  • func (op *BuildOperation) LocalOnly() bool
  • func (op *BuildOperation) PushImage(cmdCtx *cmdctx.CmdContext, image Image) error
  • func (op *BuildOperation) RemoteOnly() bool
  • func (op *BuildOperation) ResolveImageLocally(ctx context.Context, cmdCtx *cmdctx.CmdContext, imageRef string) (*Image, error)
• type DeployOperation
  • func NewDeployOperation(ctx context.Context, cmdCtx *cmdctx.CmdContext) (*DeployOperation, error)
  • func (op *DeployOperation) AppName() string
  • func (op *DeployOperation) Deploy(imageRef string, strategy DeploymentStrategy) (*api.Release, error)
  • func (op *DeployOperation) ValidateConfig() (*api.AppConfig, error)
• type DeploymentStrategy
  • func ParseDeploymentStrategy(val string) (DeploymentStrategy, error)
• type DockerClient
  • func NewDockerClient() (*DockerClient, error)
  • func (c *DockerClient) BuildImage(ctx context.Context, tar io.Reader, tag string, buildArgs map[string]*string, ...) (*types.ImageSummary, error)
  • func (c *DockerClient) Check(ctx context.Context) error
  • func (c *DockerClient) Client() *client.Client
  • func (c *DockerClient) DeleteDeploymentImages(ctx context.Context, tag string) error
  • func (c *DockerClient) Info(ctx context.Context) (types.Info, error)
  • func (c *DockerClient) PullImage(ctx context.Context, imageName string, out io.Writer) error
  • func (c *DockerClient) PushImage(ctx context.Context, imageName string, out io.Writer) error
  • func (c *DockerClient) ResolveImage(ctx context.Context, imageName string) (*types.ImageSummary, error)
  • func (c *DockerClient) TagImage(ctx context.Context, sourceRef, tag string) error
• type Image

Variables

var ErrDockerDaemon = errors.New("Docker daemon must be running to perform this action")

ErrDockerDaemon - Docker daemon needs to be running error

var ErrNoBuildpackBuilder = errors.New("No buildpack builder")

ErrNoBuildpackBuilder - Unable to find Buildpack builder

var ErrNoDockerfile = errors.New("Project does not contain a Dockerfile and has not set a CNB builder, builtin builder or selected an image")

ErrNoDockerfile - No dockerfile or builder or builtin or image specified error

Functions

func RegistryAuth

func RegistryAuth(token string) types.AuthConfig

func ResolveDockerfile

func ResolveDockerfile(cwd string) string

ResolveDockerfile - Resolve the location of the dockerfile, allowing for upper and lowercase naming

Types

type BuildOperation

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

func NewBuildOperation

func NewBuildOperation(ctx context.Context, cmdCtx *cmdctx.CmdContext) (*BuildOperation, error)

func (*BuildOperation) BuildWithDocker

func (op *BuildOperation) BuildWithDocker(cmdCtx *cmdctx.CmdContext, dockerfilePath string, buildArgs map[string]string) (*Image, error)

BuildWithDocker - Run a Docker Build operation reporting back via the command context

func (*BuildOperation) BuildWithPack

func (op *BuildOperation) BuildWithPack(cmdCtx *cmdctx.CmdContext, buildArgs map[string]string) (*Image, error)

BuildWithPack - Perform a Docker build using a Buildpack (buildpack.io)

func (*BuildOperation) CleanDeploymentTags

func (op *BuildOperation) CleanDeploymentTags(cmdCtx *cmdctx.CmdContext)

func (*BuildOperation) LocalDockerAvailable

func (op *BuildOperation) LocalDockerAvailable() bool

func (*BuildOperation) LocalOnly

func (op *BuildOperation) LocalOnly() bool

func (*BuildOperation) PushImage

func (op *BuildOperation) PushImage(cmdCtx *cmdctx.CmdContext, image Image) error

PushImage - Push the Image (where?)

func (*BuildOperation) RemoteOnly

func (op *BuildOperation) RemoteOnly() bool

func (*BuildOperation) ResolveImageLocally

func (op *BuildOperation) ResolveImageLocally(ctx context.Context, cmdCtx *cmdctx.CmdContext, imageRef string) (*Image, error)

type DeployOperation

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

func NewDeployOperation

func NewDeployOperation(ctx context.Context, cmdCtx *cmdctx.CmdContext) (*DeployOperation, error)

func (*DeployOperation) AppName

func (op *DeployOperation) AppName() string

func (*DeployOperation) Deploy

func (op *DeployOperation) Deploy(imageRef string, strategy DeploymentStrategy) (*api.Release, error)

func (*DeployOperation) ValidateConfig

func (op *DeployOperation) ValidateConfig() (*api.AppConfig, error)

type DeploymentStrategy

type DeploymentStrategy string

const (
	CanaryDeploymentStrategy    DeploymentStrategy = "canary"
	RollingDeploymentStrategy   DeploymentStrategy = "rolling"
	ImmediateDeploymentStrategy DeploymentStrategy = "immediate"
	DefaultDeploymentStrategy   DeploymentStrategy = ""
)

func ParseDeploymentStrategy

func ParseDeploymentStrategy(val string) (DeploymentStrategy, error)

type DockerClient

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

func NewDockerClient

func NewDockerClient() (*DockerClient, error)

func (*DockerClient) BuildImage

func (c *DockerClient) BuildImage(ctx context.Context, tar io.Reader, tag string, buildArgs map[string]*string, out io.Writer) (*types.ImageSummary, error)

func (*DockerClient) Check

func (c *DockerClient) Check(ctx context.Context) error

func (*DockerClient) Client

func (c *DockerClient) Client() *client.Client

func (*DockerClient) DeleteDeploymentImages

func (c *DockerClient) DeleteDeploymentImages(ctx context.Context, tag string) error

func (*DockerClient) Info

func (c *DockerClient) Info(ctx context.Context) (types.Info, error)

func (*DockerClient) PullImage

func (c *DockerClient) PullImage(ctx context.Context, imageName string, out io.Writer) error

func (*DockerClient) PushImage

func (c *DockerClient) PushImage(ctx context.Context, imageName string, out io.Writer) error

func (*DockerClient) ResolveImage

func (c *DockerClient) ResolveImage(ctx context.Context, imageName string) (*types.ImageSummary, error)

func (*DockerClient) TagImage

func (c *DockerClient) TagImage(ctx context.Context, sourceRef, tag string) error

type Image

type Image struct {
	ID   string
	Tag  string
	Size int64
}

Image - A type to hold information about a Docker image, including ID, Tag and Size