moby

Documentation

Overview

Package moby provides a container Watcher for Docker/Moby engines.

Usage

import "github.com/thediveo/whalewatcher/watcher/moby"
watcher := moby.NewWatcher("")

The watcher constructor accepts options, with currently the only option being specifying a container engine's PID. The PID information then can be used downstream in tools like lxkns to translate container PIDs between different PID namespaces.

Index

• Constants
• func New(dockersock string, buggeroff backoff.BackOff, opts ...engineclient.NewOption) (watcher.Watcher, error)

Constants

const Type = engineclient.Type

Type ID of the container engine handled by this watcher.

Functions

func New

func New(dockersock string, buggeroff backoff.BackOff, opts ...engineclient.NewOption) (watcher.Watcher, error)

New returns a Watcher for keeping track of the currently alive containers, optionally with the composer projects they're associated with.

When the dockersock parameter is left empty then Docker's usual client defaults apply, such as trying to pick up the docker host from the environment or falling back to the local host's "unix:///var/run/docker.sock".

If the backoff is nil then the backoff defaults to backoff.StopBackOff, that is, any failed operation will never be retried.

Finally, Docker engine client-specific options can be passed in.