docker

Documentation

Overview

Package docker provides a wrapper around Docker Compose's functionality

Index

• func CompareDeletedImages(i, j dti.DeleteResponse) int
• func LoadAppDefinition(fsys core.PathedFS, name string, configPaths []string, env map[string]string) (*dct.Project, error)
• func NewOutStream(out io.Writer) *streams.Out
• type Client
  • func NewClient(opts ...ClientOption) (*Client, error)
  • func (c *Client) DeployApp(ctx context.Context, app *dct.Project, waitTimeout time.Duration) error
  • func (c *Client) InspectImage(ctx context.Context, imageHash string) (Image, error)
  • func (c *Client) ListApps(ctx context.Context) ([]api.Stack, error)
  • func (c *Client) ListContainers(ctx context.Context, appName string) ([]dt.Container, error)
  • func (c *Client) ListImages(ctx context.Context, matchName string) ([]Image, error)
  • func (c *Client) PruneUnusedImages(ctx context.Context) (dt.ImagesPruneReport, error)
  • func (c *Client) PullImage(ctx context.Context, taggedName string, outStream *streams.Out) (trust.ImageRefAndAuth, error)
  • func (c *Client) RemoveApps(ctx context.Context, names []string) error
• type ClientOption
  • func WithConcurrencySafeOutput() ClientOption
• type Image

Functions

func CompareDeletedImages

func CompareDeletedImages(i, j dti.DeleteResponse) int

func LoadAppDefinition

func LoadAppDefinition(
	fsys core.PathedFS, name string, configPaths []string, env map[string]string,
) (*dct.Project, error)

LoadAppDefinition parses the specified Docker Compose files from the provided fs as the current working directory, applies the provided environment variables, and returns a representation of the app as a Docker Compose project.

func NewOutStream

func NewOutStream(out io.Writer) *streams.Out

Types

type Client

type Client struct {
	Client  *dc.Client
	Compose api.Service
	// contains filtered or unexported fields
}

func NewClient

func NewClient(opts ...ClientOption) (*Client, error)

func (*Client) DeployApp

func (c *Client) DeployApp(
	ctx context.Context, app *dct.Project, waitTimeout time.Duration,
) error

func (*Client) InspectImage

func (c *Client) InspectImage(ctx context.Context, imageHash string) (Image, error)

func (*Client) ListApps

func (c *Client) ListApps(ctx context.Context) ([]api.Stack, error)

func (*Client) ListContainers

func (c *Client) ListContainers(ctx context.Context, appName string) ([]dt.Container, error)

func (*Client) ListImages

func (c *Client) ListImages(ctx context.Context, matchName string) ([]Image, error)

func (*Client) PruneUnusedImages

func (c *Client) PruneUnusedImages(ctx context.Context) (dt.ImagesPruneReport, error)

func (*Client) PullImage

func (c *Client) PullImage(
	ctx context.Context, taggedName string, outStream *streams.Out,
) (trust.ImageRefAndAuth, error)

func (*Client) RemoveApps

func (c *Client) RemoveApps(ctx context.Context, names []string) error

type ClientOption

type ClientOption func(clientOptions) clientOptions

func WithConcurrencySafeOutput

func WithConcurrencySafeOutput() ClientOption

type Image

type Image struct {
	Repository string
	Tag        string
	ID         string
	Inspect    dt.ImageInspect
}