docker

Documentation

Index

• func ContainerImageNameTagFromImage(fullImage string) (string, error)
• func ContainerRegistryFromImage(fullImage string) (string, error)
• func ContainerRegistryFromURL(registryURL string) (string, error)
• func CreateDockerConfigJSON(registryURL, username, password, targetPath, configPath string, ...) (string, error)
• type AuthEntry
• 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

Functions

func ContainerImageNameTagFromImage

func ContainerImageNameTagFromImage(fullImage string) (string, error)

ContainerImageNameTagFromImage provides the name & tag part of a full image name

func ContainerRegistryFromImage

func ContainerRegistryFromImage(fullImage string) (string, error)

ContainerRegistryFromImage provides the registry part of a full image name

func ContainerRegistryFromURL

func ContainerRegistryFromURL(registryURL string) (string, error)

ContainerRegistryFromURL provides the registry part of a complete registry url including the port

func CreateDockerConfigJSON

func CreateDockerConfigJSON(registryURL, username, password, targetPath, configPath string, utils piperutils.FileUtils) (string, error)

CreateDockerConfigJSON creates / updates a Docker config.json with registry credentials

Types

type AuthEntry

type AuthEntry struct {
	Auth string `json:"auth,omitempty"`
}

AuthEntry defines base64 encoded username:password required inside a Docker config.json

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