docker

Documentation

Index

• Constants
• type Client
  • func NewClient(apiPath string) (*Client, error)
  • func NewVersionedClient(apiPath string, apiVersionString string) (*Client, error)
  • func NewVersionedClientFromEnv(apiVersionString string) (*Client, error)
  • func (c *Client) AddObserver(ob ContainerObserver) error
  • func (c *Client) AllContainerIDs() ([]string, error)
  • func (c *Client) DockerVersion() string
  • func (c *Client) EnsureNetwork(networkName, driver, subnet string, options map[string]interface{}) error
  • func (c *Client) GetContainerIP(nameOrID string) (string, error)
  • func (c *Client) Info() string
  • func (c *Client) IsContainerNotRunning(idStr string) bool
  • func (c *Client) RunningContainerIDs() ([]string, error)
• type ContainerObserver

Constants

const (
	InitialInterval = 1 * time.Second
	MaxInterval     = 20 * time.Second
)

Types

type Client

type Client struct {
	*docker.Client
}

func NewClient

func NewClient(apiPath string) (*Client, error)

NewClient creates a new Docker client and checks we can talk to Docker

func NewVersionedClient

func NewVersionedClient(apiPath string, apiVersionString string) (*Client, error)

func NewVersionedClientFromEnv

func NewVersionedClientFromEnv(apiVersionString string) (*Client, error)

func (*Client) AddObserver

func (c *Client) AddObserver(ob ContainerObserver) error

AddObserver adds an observer for docker events

func (*Client) AllContainerIDs

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

AllContainerIDs returns all the IDs of Docker containers, whether they are running or not.

func (*Client) DockerVersion

func (c *Client) DockerVersion() string

func (*Client) EnsureNetwork

func (c *Client) EnsureNetwork(networkName, driver, subnet string, options map[string]interface{}) error

func (*Client) GetContainerIP

func (c *Client) GetContainerIP(nameOrID string) (string, error)

This is intended to find an IP address that we can reach the container on; if it is on the Docker bridge network then that address; if on the host network then localhost

func (*Client) Info

func (c *Client) Info() string

func (*Client) IsContainerNotRunning

func (c *Client) IsContainerNotRunning(idStr string) bool

IsContainerNotRunning returns true if we have checked with Docker that the ID is not running

func (*Client) RunningContainerIDs

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

RunningContainerIDs returns all the IDs of the running Docker containers.

type ContainerObserver

type ContainerObserver interface {
	ContainerStarted(ident string)
	ContainerDied(ident string)
	ContainerDestroyed(ident string)
}

An observer for container events