docker

Documentation

Index

• type Client
  • func (c *Client) DownloadImageToPath(imageSource, filePath string) (pkgutil.Image, error)
  • func (c *Client) GetImageSource() (string, error)
  • func (c *Client) SetOptions(options ClientOptions)
  • func (c *Client) TarImage(writer io.Writer, image pkgutil.Image) error
• type ClientOptions
• type Download

Types

type Client

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

Client defines an docker client object

func (*Client) DownloadImageToPath

func (c *Client) DownloadImageToPath(imageSource, filePath string) (pkgutil.Image, error)

DownloadImageToPath download the image to the specified path

func (*Client) GetImageSource

func (c *Client) GetImageSource() (string, error)

GetImageSource get the image source from client attributes (localPath, imageName, registryURL)

func (*Client) SetOptions

func (c *Client) SetOptions(options ClientOptions)

SetOptions sets options used for the docker client

func (*Client) TarImage

func (c *Client) TarImage(writer io.Writer, image pkgutil.Image) error

TarImage write a tar from the given image

type ClientOptions

type ClientOptions struct {
	ImageName     string
	RegistryURL   string
	LocalPath     string
	IncludeLayers bool
}

ClientOptions defines the options to be set on the client

type Download

type Download interface {
	GetImageSource() (string, error)
	DownloadImageToPath(imageSource, filePath string) (pkgutil.Image, error)
	TarImage(writer io.Writer, image pkgutil.Image) error
}

Download interface for download an image to a local path