Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Container ¶ added in v1.1.0
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 ¶ added in v1.4.0
type ContainerID string
ContainerID is a hash string representing a container instance
func (ContainerID) ShortID ¶ added in v1.4.0
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 ¶ added in v1.4.0
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 ¶ added in v1.2.0
ConvertibleNotifier is a notifier capable of creating a shoutrrr URL
type DelayNotifier ¶ added in v1.4.0
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 ¶ added in v1.4.0
type ImageID string
ImageID is a hash string representing a container image
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 ¶ added in v1.1.0
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 ¶ added in v1.4.0
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 ¶ added in v1.1.0
type TokenResponse struct {
Token string `json:"token"`
}
TokenResponse is returned by the registry on successful authentication
type UpdateParams ¶ added in v0.3.11
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
Source Files