gitlab-registry-cleanup

A small utility for cleaning up Gitlab container registry image tags, inspired by the built in registry cleanup policies built into Gitlab.

Why?

When attempting to implement Cleanup Policies, we found configuration options to be limited, with only one policy per repository currently possible. This application implements the same functionality, however allows many policies to be specified. Another drawback to the builtin cleanup policies is the lack of methods for validating policies. This application addresses this problem with the ability of executing policies in dry-run mode.

Usage

A tool for cleaning up gitlab registries

Usage:
  gitlab-registry-cleanup [command]

Available Commands:
  execute     Executes cleanup
  help        Help about any command

Flags:
      --config string   config file (default "config.yml")
      --debug           specifies logging level should be set to debug
  -h, --help            help for gitlab-registry-cleanup

Commands

execute

Executes cleanup process

Flags

• --dry-run: Specifies execution should be ran in dry run mode. Tag deletions will not occur
• --policy: Specifies which policies should be ran. Defaults to all. Accepted comma-seperated list of policies. Can be repeated

Config

Application config is specified with a yaml configuration file, with an example below:

access_token: myaccesstoken
url: https://gitlab.privateinstance.com
debug: true
policies:
- name: nonsemverpolicy
  filter:
    include: .*
    exclude: ^v.+
    keep: 5
    age: 30
repositories:
- project: 123
  images: 
  - myproject/somerepository
  policies:
  - nonsemverpolicy

• access_token: Private access token with api read/write scope
• url: Gitlab instance URL
• debug: Trace-level logging should be enabled
• policies: array
  • name: Name of policy
  • filter: object
    • include: Regex specifying image tags to include - no tags will be matched if this isn't specified
    • exclude: (Optional) Regex specifying image tags to exclude
    • keep: (Optional) Specifies amount of tags to keep
    • age: (Optional) Specifies amount of days to keep tags
• repositories array
  • project: Project ID to target
  • group: Group/Namespace ID to target
  • recurse: Specifies groups should be recursed when specifying group
  • images: array
    • Image paths of repository/image
  • policies array
    • Name of policies

Environment variable can also be used, which are the uppercase equivelent of the yaml config directives, e.g. ACCESS_TOKEN

Targets are specified by supplying optional project, group and images, which are used for filtering

Docker

We recommend using Docker for executing this utility. Example usage can be found below:

docker run -v "${PWD}/config.yml:/config.yml" -e ACCESS_TOKEN=abcdef --rm -it ukfast/gitlab-registry-cleanup execute --config /config.yml