ECR Image Cleanup Tool
Project description
ECR Image Cleanup Tool
Table of Contents
Overview
The ECR Image Cleanup Tool addresses limitations in Amazon ECR's built-in lifecycle policies, particularly for multi-architecture images. It helps prevent repositories from hitting the 10,000 image hard limit imposed by ECR by providing more flexible and architecture-aware cleanup options.
Features
- Supports multi-architecture image cleanup
- Allows fine-grained control over image retention
- Can keep a specified number of recent images for each tag
- Manages untagged images separately
- Provides a dry-run option to preview actions before execution
Installation
pip install ecr-cleaner
Usage
Support following CLI argument
usage: ecr_cleaner [-h] [--config-file CONFIG_FILE] [--repositories REPOSITORIES [REPOSITORIES ...]] [--region REGION] [--batch-size BATCH_SIZE] [--dry-run] [--debug]
ECR Cleaner CLI
options:
-h, --help show this help message and exit
--config-file CONFIG_FILE
Path to configuration file in YAML format. See example in README.md
--repositories REPOSITORIES [REPOSITORIES ...]
List of repository names and policies(keep-most-recent). (e.g. my-repo:latest=3,tag-prefix=2,untagged=10)
--region REGION ECR region
--batch-size BATCH_SIZE
Max number of images that can be deleted in one call
--dry-run Check result without deleting images
--debug Enable debug logging
Clean-up will keep most recent number of images based on inputs and it will delete remaining matching tagPrefix
Helm chart
Prerequisites
AWS IAM role permission to manage ECR repositories
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "ecr-cleaner",
"Effect": "Allow",
"Action": [
"ecr:BatchDeleteImage",
"ecr:BatchGetImage",
"ecr:DescribeImages",
"ecr:ListImages",
"ecr:DescribeRepositories"
]
}
]
}
Installation
Service account annotation
If you are using IRSA then you can use following in helm values
serviceAccount:
create: true
name: ecr-cleaner
annotations:
eks.amazonaws.com/role-arn: arn:aws:iam::111122223333:role/my-role
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
ecr_cleaner-0.1.6.tar.gz
(18.8 kB
view hashes)
Built Distribution
Close
Hashes for ecr_cleaner-0.1.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6a08161fd3ea80e5877c8d38dcd72fced3851ccfcd99f9eb448bbf9ac2830790 |
|
MD5 | 434cd828116c3b47760a7e00d398b7ca |
|
BLAKE2b-256 | f99c8c895c6e62d7db455e68baf5eb8b2922256d63afe5f7052eeb7a1c0c9146 |