docker

Documentation

Index

• type Client
  • func New(opts Options) (*Client, error)
  • func (c *Client) Close()
  • func (c *Client) ContainerInspect(containerID string) (types.ContainerJSON, error)
  • func (c *Client) ContainerList(filterArgs filters.Args) ([]types.Container, error)
  • func (c *Client) ImageInspectWithRaw(imageID string) (types.ImageInspect, error)
  • func (c *Client) IsDanglingImage(image types.ImageInspect) bool
  • func (c *Client) IsDigest(imageID string) bool
  • func (c *Client) IsLocalImage(image types.ImageInspect) bool
  • func (c *Client) ServiceList(filterArgs filters.Args) ([]swarm.Service, error)
• type Options

Types

type Client

type Client struct {
	API *client.Client
	// contains filtered or unexported fields
}

Client represents an active docker object

func New

func New(opts Options) (*Client, error)

New initializes a new Docker API client with default values

func (*Client) Close

func (c *Client) Close()

Close closes docker client

func (*Client) ContainerInspect

func (c *Client) ContainerInspect(containerID string) (types.ContainerJSON, error)

ContainerInspect returns the container information.

func (*Client) ContainerList

func (c *Client) ContainerList(filterArgs filters.Args) ([]types.Container, error)

ContainerList returns Docker containers

func (*Client) ImageInspectWithRaw

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

ImageInspectWithRaw returns the image information and its raw representation.

func (*Client) IsDanglingImage

func (c *Client) IsDanglingImage(image types.ImageInspect) bool

IsDanglingImage returns whether the given image is "dangling" which means that there are no repository references to the given image and it has no child images

func (*Client) IsDigest

func (c *Client) IsDigest(imageID string) bool

IsDigest determines image it looks like a digest based image reference.

func (*Client) IsLocalImage

func (c *Client) IsLocalImage(image types.ImageInspect) bool

IsLocalImage checks if the image has been built locally

func (*Client) ServiceList

func (c *Client) ServiceList(filterArgs filters.Args) ([]swarm.Service, error)

ServiceList returns Swarm services

type Options

type Options struct {
	Endpoint    string
	APIVersion  string
	TLSCertPath string
	TLSVerify   bool
}

Options holds docker client object options