ContainerUpdater 1.0.1
dotnet tool install --global ContainerUpdater --version 1.0.1
dotnet new tool-manifest # if you are setting up this repo dotnet tool install --local ContainerUpdater --version 1.0.1
#tool dotnet:?package=ContainerUpdater&version=1.0.1
nuke :add-package ContainerUpdater --version 1.0.1
Container Updater
Automate updating Docker images and the containers that use them.
Updating Docker images in-place is a surprisingly complex task that requires multiple steps which are both time consuming and error prone if done manually. Container Updater completely automates this process in the simplest way possible (just run it).
Container Updater is available as a .NET Core Global Tool:
dotnet tool install --global ContainerUpdater
The latest version can also be downloaded directly from NuGet.org at: https://www.nuget.org/packages/ContainerUpdater
If you don't have .NET installed you can download the latest version for your operating system here: https://github.com/brutaldev/ContainerUpdater/releases/latest
Options
If you want to see if there are any updates and what will happen but don't want to make any changes you can use the --dry-run
option.
ContainerUpdater --dry-run
How It Works
- Get all the current image digests and tags to perform a manifest lookup.
- Lookup latest manifest and check if it matches the current image digest.
- If not the latest, get the containers that are using the old/existing image and stop them.
- Inspect and retain the information to re-install containers.
- Remove the containers using the old image.
- Remove the old image.
- Pull the new image.
- Re-create the containers from previous inspect data.
- Start the containers if they were previously running.
Alternatives
Watchtower (https://github.com/containrrr/watchtower) and Ouroboros (https://github.com/pyouroboros/ouroboros) are both alternatives that perform the same in-place update. Both these options run as docker containers themselves which actually creates unnecessary complexity. Container Update was created because these options just take too long to setup effectively as well as requiring their own maintenance.
Running an updater outside of Docker is incredibly simple and requires zero setup. Container Updater also provides the following:
- No installation or configuration, just double-click.
- Works on all operating systems regardless of Docker environment.
- Works with all repositories and manifest versions.
- Improved/reliable update checks using multiple digest lookups.
- Automatically use cached authentication on all operating systems including credential helpers.
- Full restore of containers including all labels and annotations.
TODO
- Automatically use available cached credentials (cross-platform)
- Handle automatic token generation for different registries
- Handle multiple digest checks using different content types
- Restore all attributes as well (compose groups)
- Support dry run just to check for and show updates
- Support adding image names to include/exclude in checks
- Support selection of images to update (interactive mode)
- Support updating a remote docker host
- Export container settings to recover from failures
- Add cross-platform UI to run in the system tray
- Deploy as a .NET global tool
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. |
This package has no dependencies.
Version | Downloads | Last updated |
---|---|---|
1.0.1 | 189 | 3/7/2025 |