types

Documentation

Index

• type Container
• type ContainerID
  • func (id ContainerID) ShortID() (short string)
• type ContainerReport
• type ConvertibleNotifier
• type DelayNotifier
• type Filter
• type FilterableContainer
• type ImageID
  • func (id ImageID) ShortID() (short string)
• type Notifier
• type RegistryCredentials
• type Report
• type TokenResponse
• type UpdateParams

Types

type Container

type Container interface {
	ContainerInfo() *types.ContainerJSON
	ID() ContainerID
	IsRunning() bool
	Name() string
	ImageID() ImageID
	SafeImageID() ImageID
	ImageName() string
	Enabled() (bool, bool)
	IsMonitorOnly(UpdateParams) 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
	VerifyConfiguration() error
	SetStale(bool)
	IsStale() bool
	IsNoPull(UpdateParams) bool
	SetLinkedToRestarting(bool)
	IsLinkedToRestarting() bool
	PreUpdateTimeout() int
	PostUpdateTimeout() int
	IsRestarting() bool
	GetCreateConfig() *dc.Config
	GetCreateHostConfig() *dc.HostConfig
}

Container is a docker container running an image

type ContainerID

type ContainerID string

ContainerID is a hash string representing a container instance

func (ContainerID) ShortID

func (id ContainerID) ShortID() (short string)

ShortID returns the 12-character (hex) short version of a container ID hash, removing any "sha256:" prefix if present

type ContainerReport

type ContainerReport interface {
	ID() ContainerID
	Name() string
	CurrentImageID() ImageID
	LatestImageID() ImageID
	ImageName() string
	Error() string
	State() string
}

ContainerReport represents a container that was included in watchtower session

type ConvertibleNotifier

type ConvertibleNotifier interface {
	GetURL(c *cobra.Command) (string, error)
}

ConvertibleNotifier is a notifier capable of creating a shoutrrr URL

type DelayNotifier

type DelayNotifier interface {
	GetDelay() time.Duration
}

DelayNotifier is a notifier that might need to be delayed before sending notifications

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)
	ImageName() string
}

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

type ImageID

type ImageID string

ImageID is a hash string representing a container image

func (ImageID) ShortID

func (id ImageID) ShortID() (short string)

ShortID returns the 12-character (hex) short version of an image ID hash, removing any "sha256:" prefix if present

type Notifier

type Notifier interface {
	StartNotification()
	SendNotification(Report)
	AddLogHook()
	GetNames() []string
	GetURLs() []string
	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 Report

type Report interface {
	Scanned() []ContainerReport
	Updated() []ContainerReport
	Failed() []ContainerReport
	Skipped() []ContainerReport
	Stale() []ContainerReport
	Fresh() []ContainerReport
	All() []ContainerReport
}

Report contains reports for all the containers processed during a session

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
	NoPull          bool
	LifecycleHooks  bool
	RollingRestart  bool
	LabelPrecedence bool
}

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