docker

Documentation

Index

• Variables
• func CheckManifest(ctx context.Context, imageRef string, token string) (*dockerparser.Reference, error)
• func RegistryAuth(token string) types.AuthConfig
• func ResolveDockerfile(cwd string) string
• type DeployOperation
  • func NewDeployOperation(ctx context.Context, cmdContext *cmdctx.CmdContext) (*DeployOperation, error)
  • func (op *DeployOperation) AppName() string
  • func (op *DeployOperation) BuildWithDocker(commandContext *cmdctx.CmdContext, dockerfilePath string, ...) (*Image, error)
  • func (op *DeployOperation) BuildWithPack(commandContext *cmdctx.CmdContext, buildArgs map[string]string) (*Image, error)
  • func (op *DeployOperation) CleanDeploymentTags()
  • func (op *DeployOperation) Deploy(image Image, strategy DeploymentStrategy) (*api.Release, error)
  • func (op *DeployOperation) DockerAvailable() bool
  • func (op *DeployOperation) OptimizeImage(image Image) error
  • func (op *DeployOperation) PushImage(image Image) error
  • func (op *DeployOperation) ResolveImage(ctx context.Context, commandContext *cmdctx.CmdContext, imageRef string) (*Image, error)
  • func (op *DeployOperation) StartRemoteBuild(cwd string, appConfig *flyctl.AppConfig, dockerfilePath string, ...) (*api.Build, 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) 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 or specify a builder")

ErrNoDockerfile - No dockerfile or builder specified error

Functions

func CheckManifest

func CheckManifest(ctx context.Context, imageRef string, token string) (*dockerparser.Reference, error)

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 DeployOperation

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

func NewDeployOperation

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

func (*DeployOperation) AppName

func (op *DeployOperation) AppName() string

func (*DeployOperation) BuildWithDocker

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

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

func (*DeployOperation) BuildWithPack

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

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

func (*DeployOperation) CleanDeploymentTags

func (op *DeployOperation) CleanDeploymentTags()

func (*DeployOperation) Deploy

func (op *DeployOperation) Deploy(image Image, strategy DeploymentStrategy) (*api.Release, error)

func (*DeployOperation) DockerAvailable

func (op *DeployOperation) DockerAvailable() bool

func (*DeployOperation) OptimizeImage

func (op *DeployOperation) OptimizeImage(image Image) error

OptimizeImage - Optimize the Image for deployment

func (*DeployOperation) PushImage

func (op *DeployOperation) PushImage(image Image) error

PushImage - Push the Image (where?)

func (*DeployOperation) ResolveImage

func (op *DeployOperation) ResolveImage(ctx context.Context, commandContext *cmdctx.CmdContext, imageRef string) (*Image, error)

func (*DeployOperation) StartRemoteBuild

func (op *DeployOperation) StartRemoteBuild(cwd string, appConfig *flyctl.AppConfig, dockerfilePath string, buildArgs map[string]string) (*api.Build, error)

StartRemoteBuild - Start a remote build and track its progress

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) 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