docker

Documentation

Index

• func NewWatcherWithClient(client Client, cleanupTimeout time.Duration) (*watcher, error)
• type Client
• type Container
• type TLSConfig
• type Watcher
  • func NewWatcher(host string, tls *TLSConfig) (Watcher, error)
• type WatcherConstructor

Functions

func NewWatcherWithClient

func NewWatcherWithClient(client Client, cleanupTimeout time.Duration) (*watcher, error)

Types

type Client

type Client interface {
	ContainerList(ctx context.Context, options types.ContainerListOptions) ([]types.Container, error)
	Events(ctx context.Context, options types.EventsOptions) (<-chan events.Message, <-chan error)
}

Client for docker interface

type Container

type Container struct {
	ID          string
	Name        string
	Image       string
	Labels      map[string]string
	IPAddresses []string
	Ports       []types.Port
}

Container info retrieved by the watcher

type TLSConfig

type TLSConfig struct {
	CA          string `config:"certificate_authority"`
	Certificate string `config:"certificate"`
	Key         string `config:"key"`
}

TLSConfig for docker socket connection

type Watcher

type Watcher interface {
	// Start watching docker API for new containers
	Start() error

	// Stop watching docker API for new containers
	Stop()

	// Container returns the running container with the given ID or nil if unknown
	Container(ID string) *Container

	// Containers returns the list of known containers
	Containers() map[string]*Container

	// ListenStart returns a bus listener to receive container started events, with a `container` key holding it
	ListenStart() bus.Listener

	// ListenStop returns a bus listener to receive container stopped events, with a `container` key holding it
	ListenStop() bus.Listener
}

Watcher reads docker events and keeps a list of known containers

func NewWatcher

func NewWatcher(host string, tls *TLSConfig) (Watcher, error)

NewWatcher returns a watcher running for the given settings

type WatcherConstructor

type WatcherConstructor func(host string, tls *TLSConfig) (Watcher, error)