https://github.com/magnetikonline/aws-ecs-task-definition-cleanup
Python CLI utility to help maintain legacy AWS ECS task definitions in bulk.
https://github.com/magnetikonline/aws-ecs-task-definition-cleanup
aws aws-ecs docker task-definition
Last synced: 23 days ago
JSON representation
Python CLI utility to help maintain legacy AWS ECS task definitions in bulk.
- Host: GitHub
- URL: https://github.com/magnetikonline/aws-ecs-task-definition-cleanup
- Owner: magnetikonline
- License: mit
- Created: 2023-05-19T04:40:34.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-26T01:15:16.000Z (6 months ago)
- Last Synced: 2025-04-06T20:25:03.214Z (about 2 months ago)
- Topics: aws, aws-ecs, docker, task-definition
- Language: Python
- Homepage:
- Size: 4.88 KB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AWS ECS task definition cleanup
Python CLI utility to help maintain legacy [AWS ECS task definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html).
The utility offers the following:
- Set task definitions `ACTIVE` -> `INACTIVE` that are not associated to ECS tasks.
- Mark currently `INACTIVE` task definitions for deletion by ECS.
## Requirements
- Python 3.10+
- [Boto3](https://boto3.amazonaws.com/v1/documentation/api/latest/index.html)
```sh
pip install boto3
```
## Usage
**Note:** adding a `--commit` argument will **apply changes** to ECS task definitions, otherwise all commands are executed in a safe "dry run" mode.
Locate task definitions unused by ECS tasks, set `INACTIVE`:
```sh
AWS_REGION="ap-southeast-2" \
./cleanup.py --set-inactive
```
By default `--set-inactive` _will not_ mark task definitions `INACTIVE` if _any version_ of said definition is in use.
For example:
- Task definition `arn:aws:ecs:REGION:ACCOUNT_ID:task-definition/my-task-definition:123` is currently in use by an ECS task.
- Utility locates unused task definition `arn:aws:ecs:REGION:ACCOUNT_ID:task-definition/my-task-definition:666`, but will not mark `INACTIVE` as there are other `my-task-definition:*` definition versions in use.
In order to set all unused task definition _versions_ `INACTIVE` - only leaving in use definition versions `ACTIVE`:
```sh
AWS_REGION="ap-southeast-2" \
./cleanup.py --set-inactive=aggressive
```
Mark currently `INACTIVE` task definitions for deletion by the ECS subsystem:
```sh
AWS_REGION="ap-southeast-2" \
./cleanup.py --delete-inactive
```
Finally, both operations can be executed together:
```sh
AWS_REGION="ap-southeast-2" \
./cleanup.py --set-inactive=aggressive --delete-inactive
```
## Reference
- https://aws.amazon.com/blogs/containers/announcing-amazon-ecs-task-definition-deletion/
- https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deregister-task-definition-v2.html
- https://docs.aws.amazon.com/AmazonECS/latest/developerguide/delete-task-definition-v2.html