dockerclient

Documentation

Index

• Variables
• type APIContainers
• type APIImages
• type APIMount
• type APIPort
• type Client
  • func NewClient() (*Client, error)
  • func NewTLSClient(endpoint string, dockerCertPath string) (*Client, error)
  • func (c *Client) ListContainers() ([]APIContainers, error)
  • func (c *Client) ListImages() ([]APIImages, error)
  • func (c *Client) ListServices() ([]swarm.Service, error)
  • func (c *Client) RemoveImage(name string) error
• type ContainerNetwork
• type Dialer
• type Error
  • func (e *Error) Error() string
• type NetworkList

Variables

var (
	// ErrInvalidEndpoint is returned when the endpoint is not a valid URL.
	ErrInvalidEndpoint = errors.New("invalid endpoint")
	// ErrConnectionRefused is returned when the client cannot connect to the given endpoint.
	ErrConnectionRefused = errors.New("cannot connect to Docker endpoint")
)

var ErrNoSuchImage = errors.New("no such image")

ErrNoSuchImage is error returned when the image does not exist.

Types

type APIContainers

type APIContainers struct {
	ID         string            `json:"Id"`
	Image      string            `json:"Image,omitempty"`
	State      string            `json:"State,omitempty"`
	Status     string            `json:"Status,omitempty"`
	Command    string            `json:"Command,omitempty"`
	SizeRw     int64             `json:"SizeRw,omitempty"`
	SizeRootFs int64             `json:"SizeRootFs,omitempty"`
	Names      []string          `json:"Names,omitempty"`
	Ports      []APIPort         `json:"Ports,omitempty"`
	Mounts     []APIMount        `json:"Mounts,omitempty"`
	Labels     map[string]string `json:"Labels,omitempty"`
	Networks   NetworkList       `json:"NetworkSettings,omitempty"`
}

APIContainers Docker API ListContainers 响应体切片中的容器实体

type APIImages

type APIImages struct {
	ID          string            `json:"Id"`
	RepoTags    []string          `json:"RepoTags,omitempty"`
	Created     int64             `json:"Created,omitempty"`
	Size        int64             `json:"Size,omitempty"`
	VirtualSize int64             `json:"VirtualSize,omitempty"`
	ParentID    string            `json:"ParentId,omitempty"`
	RepoDigests []string          `json:"RepoDigests,omitempty"`
	Labels      map[string]string `json:"Labels,omitempty"`
}

APIImages represent an image returned to the ListImages call.

type APIMount

type APIMount struct {
	Name        string `json:"Name,omitempty"`
	Mode        string `json:"Mode,omitempty"`
	Source      string `json:"Source,omitempty"`
	Driver      string `json:"Driver,omitempty"`
	Destination string `json:"Destination,omitempty"`
	Propagation string `json:"Propagation,omitempty"`
}

APIMount 容器的挂载点

type APIPort

type APIPort struct {
	Type        string `json:"Type,omitempty"`
	PublicPort  int64  `json:"publicPort,omitempty"`
	PrivatePort int64  `json:"privatePort,omitempty"`
}

APIPort Docker API 返回的端口映射类型

type Client

type Client struct {
	Dialer     Dialer
	TLSConfig  *tls.Config
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

func NewClient

func NewClient() (*Client, error)

NewClient returns a Client

func NewTLSClient

func NewTLSClient(endpoint string, dockerCertPath string) (*Client, error)

NewTLSClient returns a Client instance ready for TLS communications with the givens server endpoint, key and certificates, using a specific remote API version. TODO: 🚧 Under construction...

func (*Client) ListContainers

func (c *Client) ListContainers() ([]APIContainers, error)

ListContainers 返回容器切片

More: https://docs.docker.com/engine/api/v1.41/#tag/Container

func (*Client) ListImages

func (c *Client) ListImages() ([]APIImages, error)

ListImages returns the list of available images in the server.

More: https://docs.docker.com/engine/api/v1.23/#list-images

func (*Client) ListServices

func (c *Client) ListServices() ([]swarm.Service, error)

ListServices returns a slices of services

More: https://docs.docker.com/engine/api/v1.41/#tag/Service/operation/ServiceList

func (*Client) RemoveImage

func (c *Client) RemoveImage(name string) error

RemoveImage remove an image by its name or ID.

More: https://docs.docker.com/engine/api/v1.41/#tag/Image/operation/ImageDelete.

type ContainerNetwork

type ContainerNetwork struct {
	Aliases             []string `json:"Aliases,omitempty"`
	IPPrefixLen         int      `json:"IPPrefixLen,omitempty"`
	GlobalIPv6PrefixLen int      `json:"GlobalIPv6PrefixLen,omitempty"`
	Gateway             string   `json:"Gateway,omitempty"`
	NetworkID           string   `json:"NetworkID,omitempty"`
	IPAddress           string   `json:"IPAddress,omitempty"`
	EndpointID          string   `json:"EndpointID,omitempty"`
	MacAddress          string   `json:"MacAddress,omitempty"`
	IPv6Gateway         string   `json:"IPv6Gateway,omitempty"`
	GlobalIPv6Address   string   `json:"GlobalIPv6Address,omitempty"`
}

ContainerNetwork 容器的网络

type Dialer

type Dialer interface {
	Dial(network, address string) (net.Conn, error)
}

type Error

type Error struct {
	Status  int
	Message string
}

Error represents failures in the API.

func (*Error) Error

func (e *Error) Error() string

type NetworkList

type NetworkList struct {
	Networks map[string]ContainerNetwork `json:"Networks,omitempty"`
}

NetworkList 容器的网络映射