Google Container Registry Cleanup utility

If you use a CI system to push images to Google Container Registry you will eventually run into a situation where you're paying more than you would like for the storage there.

This tool helps you keep those costs reasonable, while allowing you to benefit from caches, keeping backups for rollbacks, etc.

Prerequisites and setup

• Python 3.9+
• Gcloud SDK with an authentication token that has admin access to the registry properly configured

pip install -U gcrc

Usage

Replace gcr.io/project-name with the specific GCR address to your repository, e.g. if your Google Cloud project is called foo-bar and it's in the EU zone this would likely be eu.gcr.io/foo-bar.

List all images

Figures out the different images we can access in the Container Registry.

gcrc list-images gcr.io/project-name

Show information on images

Analyzes current images and any need for cleanup based on current configuration without actually deleting anything. Use to check that configuration seems correct.

gcrc image-info gcr.io/project-name

Clean up images

Look up images with unneeded tags and delete them from Google Container Registry

gcrc cleanup gcr.io/project-name

Configuration

The following environment variables can be used to adjust the configuration:

KEEP_TAGS_MIN=10

Keeps at least this many tags for every image.

KEEP_TAGS_DAYS=14

Keep everything from within this many days.

KEEP_EXTRA='["^latest$", "^(master|main)-"]'

List of regex matches for important images that we want to keep an extra KEEP_TAGS_MIN items of. Formatted as a JSON list of strings.

The default is to keep latest and any tags starting with master- or main- for people who tag their images like <branch>-<timestamp or commit hash or uuid>.

You can also put these in a .env -file, but environment variables take priority over .env.

# .env
KEEP_TAGS_MIN=10
KEEP_TAGS_DAYS=14
KEEP_EXTRA='["^important-", "^latest$"]'

Financial support

This project has been made possible thanks to Cocreators and Lietu. You can help us continue our open source work by supporting us on Buy me a coffee.