Skip to content

Latest commit

 

History

History
74 lines (55 loc) · 3.01 KB

README.md

File metadata and controls

74 lines (55 loc) · 3.01 KB
Raw

GCR Retention policy

This simple golang CLI tool is handling retention policy of images in Google Container Registry (and Google Artifact Registry for Docker) in a similar manner as Elastic Container Registry does (original blogpost talking about the details here)

It scans all the Docker registry images (it supports paths like eu.gcr.io/my-project/foo/bar/my-service:123) and fetches their tags using Docker v2 API. Then it deletes some of them based on parametrized filters and input GKE clusters.

Retention policy configuration

Using --cluster path/to/kubeconfig it queries all pods and replicasets in the GKE cluster and prevents these image tags before deleting.

$ gcr cleanup --help
Usage:
  gcr cleanup [flags]

Flags:
      --dry-run         dry-run for images cleaning (default true)
  -h, --help            help for cleanup
      --keep-tags int   number of tags to keep per image (default 10)
      --retention int   number of days of retention to keep images (default 365)

Global Flags:
      --cluster string      kubeconfig path (default "/Users/marek/.kube/config")
      --creds string        credential file (default "./creds/serviceaccount.json")
      --log-level string    log level (default "ERROR")
      --registry string     GCR url to use (default "eu.gcr.io")
      --repos stringArray   list of repos you want to work with
      --sort-by string      field to sort images by (default "timeCreatedMs")

TIP: For Google Artifact Registry use --sort-by="timeUploadedMs"

WARNING: This is an alpha version! Be very careful using this in production.

How to build it

make dep
make build

How to run it

Provision GCP IAM service account

serviceaccount.json is a json key of IAM service account called gcr-retention-policy that has these roles

Kubernetes Engine Cluster Viewer
Kubernetes Engine Developer
Kubernetes Engine Service Agent
Storage Object Admin
Artifact Registry Repository Administrator

Run it

make build && ./bin/gcr --help

gcr cleanup without kubeconfig

If you want to nuke old images without checking if they're currently used in a cluster you can do so by setting --cluster="". When using this "dummy mode" your IAM service account doesn't need any Kubernetes Engine roles listed above.

TODO:

  • release binary to Github Release
  • release docker image to Docker Hub
  • try to make use of https://github.com/google/go-containerregistry/tree/master
  • support Cloud Run in --cluster (not it supports only GKE)
  • prepare example deployment for Cloud Scheduler + Cloud Run (or Cloud Functions)
  • make the horrible code a bit less horrible and more reusable

deprecation info

this tool used bash/jq before and the code is still kept here. I will not continue maintaining the bash/jq version but focus purely in the new one in Go.