types

Documentation

Index

• type Container
• type Filter
• type FilterableContainer
• type Notifier
• type RegistryCredentials
• type TokenResponse
• type UpdateParams

Types

type Container

type Container interface {
	ContainerInfo() *types.ContainerJSON
	ID() string
	IsRunning() bool
	Name() string
	ImageID() string
	ImageName() string
	Enabled() (bool, bool)
	IsMonitorOnly() bool
	Scope() (string, bool)
	Links() []string
	ToRestart() bool
	IsWatchtower() bool
	StopSignal() string
	HasImageInfo() bool
	ImageInfo() *types.ImageInspect
	GetLifecyclePreCheckCommand() string
	GetLifecyclePostCheckCommand() string
	GetLifecyclePreUpdateCommand() string
	GetLifecyclePostUpdateCommand() string
}

Container is a docker container running an image

type Filter

type Filter func(FilterableContainer) bool

A Filter is a prototype for a function that can be used to filter the results from a call to the ListContainers() method on the Client.

type FilterableContainer

type FilterableContainer interface {
	Name() string
	IsWatchtower() bool
	Enabled() (bool, bool)
	Scope() (string, bool)
}

A FilterableContainer is the interface which is used to filter containers.

type Notifier

type Notifier interface {
	StartNotification()
	SendNotification()
	Close()
}

Notifier is the interface that all notification services have in common

type RegistryCredentials

type RegistryCredentials struct {
	Username string
	Password string // usually a token rather than an actual password
}

RegistryCredentials is a credential pair used for basic auth

type TokenResponse

type TokenResponse struct {
	Token string `json:"token"`
}

TokenResponse is returned by the registry on successful authentication

type UpdateParams

type UpdateParams struct {
	Filter         Filter
	Cleanup        bool
	NoRestart      bool
	Timeout        time.Duration
	MonitorOnly    bool
	LifecycleHooks bool
	RollingRestart bool
}

UpdateParams contains all different options available to alter the behavior of the Update func