actions

func ApplyLocalUpdates ¶

func ApplyLocalUpdates(
	ctx context.Context,
	filter types.Filter,
	cleanup bool,
	monitorOnly bool,
	runUpdates func(context.Context, types.Filter, types.UpdateParams) *metrics.Metric,
) *metrics.Metric

ApplyLocalUpdates runs the standard Watchtower update procedure using already-downloaded images only. Explicitly sets NoPull to true to prevent any image pulls, and RunOnce to true to ensure the update process runs only once.

func CheckForUpdates ¶

func CheckForUpdates(
	ctx context.Context,
	client container.Client,
	filter types.Filter,
) (*checkAPI.Result, error)

CheckForUpdates inspects filtered containers and returns only those with newer upstream images.

func DownloadImages ¶

func DownloadImages(
	ctx context.Context,
	client container.Client,
	filter types.Filter,
	images []string,
) (*downloadAPI.Result, error)

DownloadImages pulls unique image references either from the request directly or from the filtered set of monitored containers when no explicit images are provided.

func RemoveExcessWatchtowerInstances ¶

func RemoveExcessWatchtowerInstances(
	ctx context.Context,
	client container.Client,
	cleanupImages bool,
	scope string,
	removeImageInfos *[]types.RemovedImageInfo,
	currentContainer types.Container,
) (int, error)

RemoveExcessWatchtowerInstances ensures a single Watchtower instance within the same scope.

It identifies multiple Watchtower containers within the same scope, stops all but the current, and collects removed images for deferred removal if enabled, preventing conflicts from concurrent instances. Chain identification uses the current container's labels to determine old containers to remove. Scoped instances only remove other instances in the same scope, allowing coexistence with different scopes. Removal operations respect scope boundaries to prevent cross-scope interference.

Parameters:

• ctx: Context for cancellation and timeouts.
• client: Container client for Docker operations.
• cleanupImages: Remove images if true.
• watchtowerScope: Scope to filter Watchtower instances.
• removeImageInfos: Pointer to slice of images to remove after stopping excess instances.
• currentContainer: The current running Watchtower container.

Returns:

• int: Number of removed Watchtower instances.
• error: Non-nil if removal fails, nil if single instance or successful removal.

func RemoveImages ¶

func RemoveImages(
	ctx context.Context,
	client container.Client,
	images []types.RemovedImageInfo,
) ([]types.RemovedImageInfo, error)

RemoveImages removes specified images and returns successfully removed ones.

It iterates through the provided images, attempting to remove each from the Docker environment, logging successes or failures for debugging and monitoring. Tracks successfully removed image info. If no images are provided, it returns an empty slice and no error.

Parameters:

• ctx: Context for cancellation and timeouts.
• client: Container client for Docker operations.
• images: Slice of images to remove.

Returns:

• []RemovedImageInfo: Slice of successfully removed image info.
• error: Non-nil if any image removal failed, nil otherwise.

func RunUpdatesWithNotifications ¶

func RunUpdatesWithNotifications(
	ctx context.Context,
	params RunUpdatesWithNotificationsParams,
) *metrics.Metric

RunUpdatesWithNotifications performs container updates and sends notifications about the results.

It executes the update action with configured parameters, batches notifications, and returns a metric summarizing the session for monitoring purposes, ensuring users are informed of update outcomes.

Parameters:

• ctx: Context for cancellation and timeouts.
• params: The RunUpdatesWithNotificationsParams struct containing all configuration parameters.

Returns:

• *metrics.Metric: A pointer to a metric object summarizing the update session (scanned, updated, failed counts).

func StreamLogs ¶

func StreamLogs(ctx context.Context, target types.ServiceTarget, window LogWindow, out chan<- LogLine) error

StreamLogs streams log lines for all containers matching target to out. It always closes out before returning, whether due to completion or error.

func Update ¶

func Update(
	ctx context.Context,
	client container.Client,
	config types.UpdateParams,
) (types.Report, []types.RemovedImageInfo, error)

Update scans and updates containers based on parameters.

It checks container staleness, sorts by dependencies, and updates or restarts containers as needed, collecting cleaned image info for cleanup. Non-stale linked containers are restarted but not marked as updated. Containers with pinned images (referenced by digest) are skipped to preserve immutability.

Parameters:

• ctx: Context for cancellation and timeouts.
• client: Container client for interacting with Docker API.
• config: UpdateParams specifying behavior like cleanup, restart, and filtering.

Returns:

• types.Report: Session report summarizing scanned, updated, and failed containers.
• []types.RemovedImageInfo: Slice of cleaned image info to clean up after updates.
• error: Non-nil if listing or sorting fails, nil on success.

func UpdateImplicitRestart ¶

func UpdateImplicitRestart(allContainers, containers []types.Container)

UpdateImplicitRestart marks containers linked to restarting ones.

It uses a multi-pass algorithm to ensure transitive propagation through the dependency chain, continuing until no more containers are marked for restart.

Parameters:

• allContainers: List of all containers.
• containers: List of containers to update.

func ValidateRollingRestartDependencies ¶

func ValidateRollingRestartDependencies(ctx context.Context, client container.Client, filter types.Filter) error

ValidateRollingRestartDependencies validates the environment for rolling restart updates.

It iterates through the filtered containers and returns an error if any container has a linked dependency, which is incompatible with the use of a rolling restart update policy.

Parameters:

• ctx: Context for cancellation and timeouts.
• client: Container client for Docker operations.
• filter: Container filter to select relevant containers.

Returns:

• error: Non-nil if dependencies conflict with rolling restarts, nil otherwise.