Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 2.61 KB

README.md

File metadata and controls

54 lines (36 loc) · 2.61 KB
Raw

Build Status

codecov

clean_registry

Docker Registry cleanup and image removal tool.

Docker image for linux/amd64 available at ghcr.io/ricardobranco777/clean_registry:latest

By default it performs a cleanup of untagged images with the help of the Docker Registry garbage collector or remove the specified repositories or tagged images.

Usage

docker run --rm -v REGISTRY_DIRECTORY:/var/lib/registry ghcr.io/ricardobranco777/clean_registry [OPTIONS] [REPOSITORY[:TAG]] ...

Options

  --dry-run      Don't remove anything
  -l {debug,info,warning,error,critical}, --log {debug,info,warning,error,critical}
                 Log level (default is info)
  -V, --version  Show version and exit

BUGS / LIMITATIONS

  • The --delete-untagged option added to Docker Registry does NOT work with multi-arch images as noted in this bug. The only workaround is to avoid multi-arch images completely and append the architecture name to the tag instead.
  • Do NOT use it with sigstore/cosign as they hijack the Registry API in the most obnoxious way by storing signatures as tags, also breaking in the process every registry listing tool.
  • It should work with --volumes-from REGISTRY_CONTAINER if the volume is mounted in /var/lib/registry. Beware that this option may be buggy in Podman < 4.7.0.

Examples

# Test cleanup with --dry-run
docker run --rm -v /path/to/registry:/var/lib/registry ghcr.io/ricardobranco777/clean_registry --dry-run

# Cleanup of untagged images
docker run --rm -v /path/to/registry:/var/lib/registry ghcr.io/ricardobranco777/clean_registry

# Test remove tagged image with --dry-run
docker run --rm -v /path/to/registry:/var/lib/registry ghcr.io/ricardobranco777/clean_registry --dry-run old_image:latest

# Remove tagged image
docker run --rm -v /path/to/registry:/var/lib/registry ghcr.io/ricardobranco777/clean_registry old_image:latest

# Test remove whole repo (all tags) with --dry-run
docker run --rm -v /path/to/registry:/var/lib/registry ghcr.io/ricardobranco777/clean_registry --dry-run old_image

# Remove whole repo (all tags)
docker run --rm -v /path/to/registry:/var/lib/registry ghcr.io/ricardobranco777/clean_registry old_image