Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Qovery/pleco
Automatically removes Cloud managed services and Kubernetes resources based on tags with TTL
https://github.com/Qovery/pleco
Last synced: 2 months ago
JSON representation
Automatically removes Cloud managed services and Kubernetes resources based on tags with TTL
- Host: GitHub
- URL: https://github.com/Qovery/pleco
- Owner: Qovery
- License: apache-2.0
- Created: 2020-10-23T09:19:04.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-07T11:20:33.000Z (2 months ago)
- Last Synced: 2024-11-07T12:26:42.583Z (2 months ago)
- Language: Go
- Homepage:
- Size: 22 MB
- Stars: 222
- Watchers: 7
- Forks: 18
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-repositories - Qovery/pleco - Automatically removes Cloud managed services and Kubernetes resources based on tags with TTL (Go)
README
# Pleco
[](https://hub.docker.com/repository/docker/qoveryrd/pleco)
[](https://artifacthub.io/packages/search?repo=pleco)
[](https://www.qovery.com)
Automatically remove cloud and kubernetes resources based on a time to leave tag, **ttl**.
Protect resources from deletion with a protection tag, **do_not_delete**.
NOTE: this project is used in Qovery's production environment
---
Check out our Blog announcement of Pleco: https://www.qovery.com/blog/announcement-of-pleco-the-open-source-kubernetes-and-cloud-services-garbage-collector
---
## Supported resources
- [X] Kubernetes
- [X] Namespaces
- [X] AWS
- [X] Document DB databases
- [X] Document DB subnet groups
- [X] Elasticache databases
- [X] Elasticache subnet groups
- [X] RDS databases
- [X] RDS subnet groups
- [X] RDS parameter groups
- [X] RDS snapshots
- [X] EBS volumes
- [X] ELB load balancers
- [X] EC2 Key pairs
- [X] ECR repositories
- [X] EKS clusters
- [X] IAM groups
- [X] IAM users
- [X] IAM policies
- [X] IAM roles
- [X] IAM OpenId Connect provider
- [X] Cloudwatch logs
- [X] KMS keys
- [X] VPC vpcs
- [X] VPC internet gateways
- [X] VPC nat gateways
- [X] VPC Elastic IP
- [X] VPC route tables
- [X] VPC subnets
- [X] VPC security groups
- [X] S3 buckets
- [X] Lambda Functions
- [X] SQS Queues
- [X] Step Functions
- [X] EC2 instances
- [X] SCALEWAY
- [X] Kubernetes clusters
- [X] Database instances
- [X] Load balancers
- [X] Detached volumes
- [X] S3 Buckets
- [X] Unused Security Groups
- [X] Orphan IPs
- [X] VPCs
- [X] Private networks
- [X] DIGITAL OCEAN
- [X] Kubernetes clusters
- [X] Database instances
- [X] Load balancers
- [X] Detached volumes
- [X] S3 Buckets
- [X] Droplet firewalls
- [X] Unused VPCs
- [X] GCP
- [X] Cloud Storage Buckets
- [X] Artifact Registry Repositories
- [X] Kubernetes clusters
- [X] Cloud run jobs
- [X] Networks // via JSON tags in resource description because resource has no support for tags
- [X] Routers // via JSON tags in resource description because resource has no support for tags
- [X] Service accounts // via JSON tags in resource description because resource has no support for tags
- [ ] AZURE
---
## Installation
You can find a helm chart [here](https://artifacthub.io/packages/helm/pleco/pleco), a docker image [here](https://hub.docker.com/r/qoveryrd/pleco) and all binaries are on [github](https://github.com/Qovery/pleco/releases).
---
## Requirements
In order to make pleco check and clean expired resources you need to set the following environment variables:
#### For AWS
```bash
$ export AWS_ACCESS_KEY_ID=
$ export AWS_SECRET_ACCESS_KEY=
```
#### For Scaleway
```bash
$ export SCW_ACCESS_KEY=
$ export SCW_SECRET_KEY=
$ export SCW_VOLUME_TIMEOUT= # default is 2 hours
```
#### For Digital Ocean
```bash
$ export DO_API_TOKEN=
$ export DO_SPACES_KEY=
$ export DO_SPACES_SECRET=
$ export DO_VOLUME_TIMEOUT= # default is 2 hours
```
#### For GCP
```bash
$ export GOOGLE_APPLICATION_CREDENTIALS=
```
---
## Basic command
A pleco command has the following structure:
```bash
pleco start [options]
```
### General options
#### Connection Mode
You can set the connection mode with:
```bash
--kube-conn, -k
```
Default is "in"
#### Debug Level
You can set the debug level with:
```bash
--level
```
Default is "info"
#### Check's interval
You can set the interval between two pleco's check with:
```bash
--check-interval, -i
#### Dry Run
If you disable dry run, pleco will delete expired resources.
If not it will only tells you how many resources are expired.
You can disable dry-run with:
```bash
--disable-dry-run, -y
```
Default is "false"
### AWS options
#### Region selector
When pleco's look for expired resources, it will do it by aws region.
You can set region(s) with:
```bash
--aws-regions, -a
```
For example:
```bash
-a eu-west-3,us-east-2
```
#### Resources Selector
When pleco is running you have to specify which resources expiration will be checked.
Here are some of the resources you can check:
```bash
--enable-eks, -e # Enable EKS watch
--enable-iam, -u # Enable IAM watch (groups, policies, roles, users)
```
#### Example
```bash
pleco start aws --level debug -i 240 -a eu-west-3 -e -r -m -c -l -b -p -s -w -n -u -z -o -f -x -q -y
```
### Scaleway options
#### Region selector
When pleco's look for expired resources, it will do it by [scaleway zone](https://registry.terraform.io/providers/scaleway/scaleway/latest/docs/guides/regions_and_zones).
You can set zone(s) with:
```bash
--scw-zones, -a
```
For example:
```bash
-a fr-par-1
```
#### Resources Selector
When pleco is running you have to specify which resources expiration will be checked.
Here are some of the resources you can check:
```bash
--enable-cluster, -e # Enable cluster watch
```
#### Example
```bash
pleco start scaleway --level debug -i 240 -a fr-par-1 -e -r -o -l -b -s -p -y
```
### Digital Ocean options
#### Region selector
When pleco's look for expired resources, it will do it by [digital ocean region](https://docs.digitalocean.com/products/platform/availability-matrix/).
You can set zone(s) with:
```bash
--do-regions, -a
```
For example:
```bash
-a nyc3
```
#### Resources Selector
When pleco is running you have to specify which resources expiration will be checked.
Here are some of the resources you can check:
```bash
--enable-cluster, -e # Enable cluster watch
```
#### Example
```bash
pleco start do --level debug -i 240 -a nyc3 -e -r -s -l -b -f -v -y
```
### GCP options
#### Region selector
When pleco's look for expired resources, it will do it by [gcp_regions](https://cloud.google.com/compute/docs/regions-zones?hl=en).
You can set zone(s) with:
```bash
--gcp-regions, -a
```
For example:
```bash
-a europe-west9
```
#### Resources Selector
When pleco is running you have to specify which resources expiration will be checked.
Here are some of the resources you can check:
```bash
--enable-cluster # Enable cluster watch
--enable-object-storage # Enable object storage watch
--enable-artifact-registry # Enable artifact registry watch
--enable-network # Enable network watch
--enable-router # Enable router watch
--enable-iam # Enable IAM watch (service accounts)
```
#### Example
```bash
pleco start
gcp
--level
debug
-i
240
--enable-object-storage
--enable-artifact-registry
--enable-cluster
--enable-network
--enable-router
--enable-iam
--enable-job
--gcp-regions
europe-west9
--disable-dry-run
```