docker_api

Documentation

Overview

Package docker_api

Index

• Variables
• type Client
  • func New(hostURL, version string) (*Client, error)
  • func (c *Client) CreateImageTag(toAbsRefStr, fromAbsRefStr string) (io.ReadCloser, error)
  • func (c *Client) CreateImageTagV2(toAbsRefStr, fromAbsRefStr string) (resp PushImageOfficialAPIResp, err error)
  • func (c *Client) CreateImageTagV3(toAbsRefStr, fromAbsRefStr string) (resp docker_client.EventResp, err error)
  • func (c *Client) Do(cfn ...ClientFunc) error
  • func (c *Client) ExportContainer(containerID string) (io.ReadCloser, error)
  • func (c *Client) ExportImage(absRefStr string) (resp ExportImageResp, err error)
  • func (c *Client) ExportImageV2(absRefStr string) (resp ExportImageRespV2, 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) (resp ImportImageResp, err error)
  • func (c *Client) ImportImageV2(absRefStr string, input io.Reader) (resp ImportImageResp, err error)
  • func (c *Client) ImportImageV3(absRefStr string, input io.Reader) (resp ImportImageRespV3, err error)
  • func (c *Client) InspectImage(image 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 ExportImageResp
• type ExportImageRespV2
• type HostImageGCFunc
• type ImportImageResp
• type ImportImageRespV3
• type PushImageOfficialAPIResp
  • func (r *PushImageOfficialAPIResp) GetDigest() string
  • func (r *PushImageOfficialAPIResp) GetSize() string
  • func (r *PushImageOfficialAPIResp) Parse(jsonStrSplitByLineFeed string)

Variables

var ErrNotFoundImageAnyWhere = errors.New("not found image refStr in anywhere")

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) CreateImageTagV2

func (c *Client) CreateImageTagV2(toAbsRefStr, fromAbsRefStr string) (resp PushImageOfficialAPIResp, err error)

func (*Client) CreateImageTagV3

func (c *Client) CreateImageTagV3(toAbsRefStr, fromAbsRefStr string) (resp docker_client.EventResp, err 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) (resp ExportImageResp, 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) ExportImageV2

func (c *Client) ExportImageV2(absRefStr string) (resp ExportImageRespV2, err error)

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) (resp ImportImageResp, err 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) ImportImageV2

func (c *Client) ImportImageV2(absRefStr string, input io.Reader) (resp ImportImageResp, err error)

func (*Client) ImportImageV3

func (c *Client) ImportImageV3(absRefStr string, input io.Reader) (resp ImportImageRespV3, err error)

func (*Client) InspectImage

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

InspectImage +param image: sha256ID or refStr

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 ExportImageResp

type ExportImageResp struct {
	RequestRefStr      string
	NotFoundInRegistry bool // absRefStr not found in provided registry.
	NotFoundInLocal    bool // absRefStr not found in docker-server local.
	// deprecated in Client.ExportImageV2
	ImagePulledInfo string        // image pulled information from provided registry.
	ImageFileReader io.ReadCloser `json:"-"` // compressed (.tar, .tar.gz) file reader, It's up to the caller to handle the io.ReadCloser and close it properly.
}

type ExportImageRespV2

type ExportImageRespV2 struct {
	ExportImageResp
	docker_client.ImagePullResp
}

type HostImageGCFunc

type HostImageGCFunc util.Func

type ImportImageResp

type ImportImageResp struct {
	RequestRefStr string
	LoadedRefStr  string
	// +disable in Client.ImportImageV2
	PushStatus string
	PushDigest string
	Inspect    types.ImageInspect
	PushResp   PushImageOfficialAPIResp
}

type ImportImageRespV3

type ImportImageRespV3 struct {
	RequestRefStr string
	LoadedRefStr  string
	Inspect       types.ImageInspect
	PushResp      docker_client.ImagePushResp
}

type PushImageOfficialAPIResp

type PushImageOfficialAPIResp struct {
	Messages []*jsonmessage.JSONMessage
	Aux      []*map[string]any //jsonmessage.JSONMessage .Aux -> []byte -> map[string]any
}

{"status":"The push refers to repository [10.112.121.243:8111/library/hello]"} {"status":"Preparing","progressDetail":{},"id":"ac28800ec8bb"} {"status":"Layer already exists","progressDetail":{},"id":"ac28800ec8bb"} {"status":"v3.0: digest: sha256:d37ada95d47ad12224c205a938129df7a3e52345828b4fa27b03a98825d1e2e7 size: 524"} {"progressDetail":{},"aux":{"Tag":"v3.0","Digest":"sha256:d37ada95d47ad12224c205a938129df7a3e52345828b4fa27b03a98825d1e2e7","Size":524}}

func (*PushImageOfficialAPIResp) GetDigest

func (r *PushImageOfficialAPIResp) GetDigest() string

func (*PushImageOfficialAPIResp) GetSize

func (r *PushImageOfficialAPIResp) GetSize() string

func (*PushImageOfficialAPIResp) Parse

func (r *PushImageOfficialAPIResp) Parse(jsonStrSplitByLineFeed string)