Documentation
¶
Index ¶
- type ByCreated
- type Client
- type Container
- func (c Container) Deps() []string
- func (c Container) ID() string
- func (c Container) ImageID() string
- func (c Container) ImageName() string
- func (c Container) IsDepensOn(container Container) bool
- func (c Container) IsWatchtower() bool
- func (c Container) Links() []string
- func (c Container) Name() string
- func (c Container) StopSignal() string
- type Filter
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ByCreated ¶
type ByCreated []Container
ByCreated allows a list of Container structs to be sorted by the container's created date.
type Client ¶
type Client interface {
ListContainers(Filter) ([]Container, error)
StopContainer(Container, time.Duration) error
StartContainer(Container) error
RenameContainer(Container, string) error
IsContainerStale(Container) (bool, error)
RemoveImage(Container) error
ClearIds()
}
A Client is the interface through which watchtower interacts with the Docker API.
func NewClient ¶
func NewClient(dockerHost string, tlsConfig *tls.Config, pullImages bool, auth *dockerclient.AuthConfig) Client
NewClient returns a new Client instance which can be used to interact with the Docker API.
type Container ¶
type Container struct {
Stale bool
// contains filtered or unexported fields
}
Container represents a running Docker container.
func NewContainer ¶
func NewContainer(containerInfo *dockerclient.ContainerInfo, imageInfo *dockerclient.ImageInfo) *Container
NewContainer returns a new Container instance instantiated with the specified ContainerInfo and ImageInfo structs.
func SortByDependencies ¶
SortByDependencies will sort the list of containers taking into account any links between containers. Container with no outgoing links will be sorted to the front of the list while containers with links will be sorted after all of their dependencies. This sort order ensures that linked containers can be started in the correct order.
func (Container) ImageID ¶
ImageID returns the ID of the Docker image that was used to start the container.
func (Container) ImageName ¶
ImageName returns the name of the Docker image that was used to start the container. If the original image was specified without a particular tag, the "latest" tag is assumed.
func (Container) IsDepensOn ¶
func (Container) IsWatchtower ¶
IsWatchtower returns a boolean flag indicating whether or not the current container is the watchtower container itself. The watchtower container is identified by the presence of the "com.centurylinklabs.watchtower" label in the container metadata.
func (Container) Links ¶
Links returns a list containing the names of all the containers to which this container is linked.
func (Container) StopSignal ¶
StopSignal returns the custom stop signal (if any) that is encoded in the container's metadata. If the container has not specified a custom stop signal, the empty string "" is returned.
Source Files
Directories