engineclient

Documentation

Overview

Package engineclient provides container engine-specific EngineClient implementations in its sub-packages.

Index

• type ContainerEvent
• type EngineClient

Types

type ContainerEvent

type ContainerEvent struct {
	Born    bool   // true if new container, false if container has died.
	ID      string // ID (or name) of container.
	Project string // optional composer project name, or zero.
}

ContainerEvent is either a container lifecycle event of a container becoming alive or having died.

type EngineClient

type EngineClient interface {
	// List for the currently alive and kicking containers.
	List(ctx context.Context) ([]*whalewatcher.Container, error)
	// Query (only) those container details of interest to us, given the name or
	// ID of a container.
	Inspect(ctx context.Context, nameorid string) (*whalewatcher.Container, error)
	// Stream container lifecycle events, limited to those events in the
	// lifecycle of containers getting born (=alive, as opposed to, say,
	// "conceived") and die.
	LifecycleEvents(ctx context.Context) (<-chan ContainerEvent, <-chan error)

	// (More or less) unique engine identifier; the exact format is
	// engine-specific.
	ID(ctx context.Context) string

	// Clean up and release any engine client resources, if necessary.
	Close()
}

EngineClient defines the generic methods needed in order to watch the containers of a container engine, regardless of the specific type of engine.