docker

Documentation

Index

• func Client() (*docker.Client, error)
• type Build
  • func (c *Build) BuildImage(source string, image string, dockerfile string, buildargs []dockerlib.BuildArg) error
• type Image
  • func NewImageFromParsed(parsed *dockerparser.Reference) Image
  • func ParseImage(fullImageName string, targetRegistry string) (Image, error)
• type Push
  • func (c *Push) PushImage(image Image) error
• type Tag
  • func (c *Tag) TagImage(image Image) error

Functions

func Client

func Client() (*docker.Client, error)

Client connects to Docker client on host

Types

type Build

type Build struct {
	Client dockerlib.Client
}

Build will provide methods for interaction with API regarding building images

func (*Build) BuildImage

func (c *Build) BuildImage(source string, image string, dockerfile string, buildargs []dockerlib.BuildArg) error

BuildImage builds a Docker image via the Docker API or Docker CLI. Takes the source directory and image name and then builds the appropriate image. Tarball is utilized in order to make building easier.

if the DOCKER_BUILDKIT is '1', then we will use the docker CLI to build the image

type Image

type Image struct {
	Name       string // the image's name (ie: debian[:8.2])
	ShortName  string // the image's name (ie: debian)
	Tag        string // the image's tag (or digest)
	Registry   string // the image's registry. (ie: host[:port])
	Repository string // the image's repository. (ie: registry/name)
	Remote     string // the image's remote identifier. (ie: registry/name[:tag])
}

Image contains the basic information parsed from full image name see github.com/novln/docker-parser Reference

func NewImageFromParsed

func NewImageFromParsed(parsed *dockerparser.Reference) Image

NewImageFromParsed method returns the docker image from the docker parser reference

func ParseImage

func ParseImage(fullImageName string, targetRegistry string) (Image, error)

ParseImage Using https://github.com/novln/docker-parser in order to parse the appropriate name and registry. 1. Return default registry when the registry is not specified from image 2. Return target registry when the registry is specified from command line

type Push

type Push struct {
	Client dockerlib.Client
}

Push will provide methods for interaction with API regarding pushing images

func (*Push) PushImage

func (c *Push) PushImage(image Image) error

PushImage pushes a Docker image via the Docker API. Takes the image name, parses the URL details and then push based on environment authentication credentials.

type Tag

type Tag struct {
	Client dockerlib.Client
}

Tag will provide methods for interaction with API regarding tagging images

func (*Tag) TagImage

func (c *Tag) TagImage(image Image) error

TagImage function is responsible for tagging the docker image