docker_api

Documentation

Overview

Package docker_api

Index

• type Client
  • func New(hostURL, version string) (*Client, error)
  • func (c *Client) CreateImageTag(toAbsRefStr, fromAbsRefStr string) (io.ReadCloser, error)
  • func (c *Client) Do(cfn ...ClientFunc) error
  • func (c *Client) ExportContainer(containerID string) (io.ReadCloser, error)
  • func (c *Client) ExportImage(absRefStr string) (imagePullResp, imageSaveResp io.ReadCloser, err error)
  • func (c *Client) GC(gcFn ...util.Func)
  • func (c *Client) HostImageStorageGC(gcFunc ...HostImageGCFunc)
  • func (c *Client) ImportContainer(destRefStr string) (io.ReadCloser, error)
  • func (c *Client) ImportImage(absRefStr string, input io.Reader) (io.ReadCloser, error)
  • func (c *Client) InspectImage(imageID string) (types.ImageInspect, error)
  • func (c *Client) ListContainerFullIds() ([]string, error)
  • func (c *Client) ListContainerIds() ([]string, error)
  • func (c *Client) ListContainerNames() ([]string, error)
  • func (c *Client) ListContainers() ([]types.Container, error)
  • func (c *Client) RegistryAuth(config *registry.AuthConfig) (string, error)
  • func (c *Client) WithContext(ctx context.Context) *Client
  • func (c *Client) WithPage(page *util.Page) *Client
  • func (c *Client) WithRegistryAuth(registryAuthConfig *registry.AuthConfig) *Client
• type ClientFunc
• type HostImageGCFunc

Types

type Client

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

func New

func New(hostURL, version string) (*Client, error)

func (*Client) CreateImageTag

func (c *Client) CreateImageTag(toAbsRefStr, fromAbsRefStr string) (io.ReadCloser, error)

func (*Client) Do

func (c *Client) Do(cfn ...ClientFunc) error

func (*Client) ExportContainer

func (c *Client) ExportContainer(containerID string) (io.ReadCloser, error)

func (*Client) ExportImage

func (c *Client) ExportImage(absRefStr string) (imagePullResp, imageSaveResp io.ReadCloser, err error)

ExportImage +param absRefStr (1). absolutely reference string for registry/project/repository/artifact/name:tag +desc

(1).if image do not exist in docker host local, pull image to local

(2).get image id by absRefStr

(3).save image to docker host local get io.ReadCloser fd

func (*Client) GC

func (c *Client) GC(gcFn ...util.Func)

func (*Client) HostImageStorageGC

func (c *Client) HostImageStorageGC(gcFunc ...HostImageGCFunc)

HostImageGC cli: docker rmi IMAGE_ID maybe quota by:

1. image CREATED: since, before 2. image SIZE: bytes(B) 3. cache algorithm policy: lru, lfu 4. host disk: bytes(B)

func (*Client) ImportContainer

func (c *Client) ImportContainer(destRefStr string) (io.ReadCloser, error)

func (*Client) ImportImage

func (c *Client) ImportImage(absRefStr string, input io.Reader) (io.ReadCloser, error)

ImportImage +param input

(1). make sure the input file(.tar.gz) metadata attribute image name format is: registry/project/image_name:image_tag

(1.1). or will create new image tag to local

(2). push image to registry

func (*Client) InspectImage

func (c *Client) InspectImage(imageID string) (types.ImageInspect, error)

InspectImage +param imageID or imageName

func (*Client) ListContainerFullIds

func (c *Client) ListContainerFullIds() ([]string, error)

func (*Client) ListContainerIds

func (c *Client) ListContainerIds() ([]string, error)

func (*Client) ListContainerNames

func (c *Client) ListContainerNames() ([]string, error)

func (*Client) ListContainers

func (c *Client) ListContainers() ([]types.Container, error)

func (*Client) RegistryAuth

func (c *Client) RegistryAuth(config *registry.AuthConfig) (string, error)

func (*Client) WithContext

func (c *Client) WithContext(ctx context.Context) *Client

func (*Client) WithPage

func (c *Client) WithPage(page *util.Page) *Client

func (*Client) WithRegistryAuth

func (c *Client) WithRegistryAuth(registryAuthConfig *registry.AuthConfig) *Client

type ClientFunc

type ClientFunc func(client *dockercli.Client) error

type HostImageGCFunc

type HostImageGCFunc util.Func