docker

Documentation

Index

• Constants
• type Client
  • func NewClient(debugLogFn func(string, ...any)) (*Client, error)
  • func (c *Client) Exists(imageID string) (bool, error)
  • func (c *Client) SizeBytes(imageID string) (int64, error)
  • func (c *Client) Upload(image, registryAddr, repository, tag string) (string, error)

Constants

const (
	DefaultRegistry = "https://index.docker.io/v1/"
)

DefaultRegistry is the registry for that authentication data is used

Types

type Client

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

Client is a docker client

func NewClient

func NewClient(debugLogFn func(string, ...any)) (*Client, error)

NewClient initializes a new docker client. The following environment variables are respected: DOCKER_TLS_VERIFY DOCKER_CERT_PATH DOCKER_HOST to set the url to the docker server. DOCKER_API_VERSION to set the version of the API to reach, leave empty for latest. The Auth configuration is read from the user's config.json file for an Upload() operation. The following files are checked in the order listed: - $DOCKER_CONFIG/config.json if DOCKER_CONFIG set in the environment, - $HOME/.docker/config.json - $HOME/.dockercfg If reading auth data from the config fails, a message is logged via the debugLogFn function but no error is returned. An Upload() operation would be done without authentication.

func (*Client) Exists

func (c *Client) Exists(imageID string) (bool, error)

Exists return true if the image with the given ID exist, otherwise false.

func (*Client) SizeBytes

func (c *Client) SizeBytes(imageID string) (int64, error)

SizeBytes returns the size of an image in Bytes.

func (*Client) Upload

func (c *Client) Upload(image, registryAddr, repository, tag string) (string, error)

Upload tags and uploads an image to a docker registry repository. On success it returns the path to the uploaded docker image, in the format: [registry]:/repository/tag