Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stakater/Jamadar
A kubernetes controller which cleans up cluster left-overs – [✩Star] if you're using it!
https://github.com/stakater/Jamadar
k8s kubecleaner kubernetes openshift
Last synced: 3 months ago
JSON representation
A kubernetes controller which cleans up cluster left-overs – [✩Star] if you're using it!
- Host: GitHub
- URL: https://github.com/stakater/Jamadar
- Owner: stakater
- License: apache-2.0
- Created: 2018-05-02T21:20:06.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T17:43:01.000Z (6 months ago)
- Last Synced: 2024-01-18T11:33:19.021Z (5 months ago)
- Topics: k8s, kubecleaner, kubernetes, openshift
- Language: Go
- Homepage:
- Size: 17.8 MB
- Stars: 44
- Watchers: 6
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-controllers - stakater/Jamadar
- awesome-cloud-native - Jamadar - A kubernetes controller which cleans up cluster left-overs. (OPS)
README
#  Jamadar
[](https://goreportcard.com/report/github.com/stakater/jamadar)
[](http://godoc.org/github.com/stakater/jamadar)
[](https://github.com/stakater/jamadar/releases/latest)
[](https://github.com/stakater/jamadar/releases/latest)
[](https://hub.docker.com/r/stakater/jamadar/)
[](https://hub.docker.com/r/stakater/jamadar/)
[](https://microbadger.com/images/stakater/jamadar)
[](https://microbadger.com/images/stakater/jamadar)
[](LICENSE)
[](http://stakater.com/?utm_source=Jamadar&utm_medium=github)
## WHY NAME JAMADAR?
Jamadar, an Urdu word, is used for Sweepers/Cleaners in Pakistan. This Jamadar will keep your cluster clean and sweep away the left overs of your cluster and will act as you want it to.
## Problem
Dangling/Redundant resources take a lot of space and memory in a cluster. So we want to delete these unneeded resources depending upon the age and pre-defined annotations. e.g. I would like to delete namespaces that were without a specific annotation and are almost a month old and would like to take action whenever that happens.
## Solution
Jamadar is a Kubernetes controller that can poll at configured time intervals and watch for dangling resources that are an 'X' time period old and don't have a specific annotation, and will delete them and take corresponding actions.
## Configuring
First of all you need to modify `configs/config.yaml` file. Following are the available options that you can use to customize Jamadar:
| Key |Description |
|-----------------------|-------------------------------------------------------------------------------|
| pollTimeInterval | The time interval after which the controller will poll and look for dangling resources, The value can be in "ms", "s", "m", "h" or even combined like 2h45m |
| age | The time period that a dangling resource has been created e.g. delete only resources that are 7 days old, The value can be in "d", "w", "m", "y", Combined format is not supported |
| resources | The resources that you want to be taken care of by Jamadar, e.g. namespaces, pods, etc |
| actions | The Array of actions that you want to take, e.g. send message to Slack, etc |
| restrictedNamespaces | The Array of string which contains the namespaces names to ignore |
### Supported Resources
Currently we are supporting the following dangling resources,
- namespaces
We will be adding support for other Resources as well in the future
### Supported Actions
Currently we are supporting following Actions with their Parameters,
- Default: No parameters needed, it will just log to console the details.
- Slack: you need to provide `token` and `Channel Name` as Parameters in the yaml file
We will be adding support for other Actions as well in the future
## Deploying to Kubernetes
You have to first clone or download the repository contents. The kubernetes deployment and files are provided inside `deployments/kubernetes/manifests` folder.
### Deploying through kubectl
You can deploy Jamadar by running the following kubectl commands:
```bash
kubectl apply -f configmap.yaml -n
kubectl apply -f rbac.yaml -n
kubectl apply -f deployment.yaml -n
```
### Helm Charts
Or alternatively if you configured `helm` on your cluster, you can deploy Jamadar via helm chart located under `deployments/kubernetes/chart/Jamadar` folder.
## Help
**Got a question?**
File a GitHub [issue](https://github.com/stakater/Jamadar/issues), or send us an [email](mailto:[email protected]).
### Talk to us on Slack
Join and talk to us on the #tools-imc channel for discussing Jamadar
[](https://slack.stakater.com/)
[](https://stakater-community.slack.com/messages/CAPTSU1EX)
## Contributing
### Bug Reports & Feature Requests
Please use the [issue tracker](https://github.com/stakater/Jamadar/issues) to report any bugs or file feature requests.
### Developing
PRs are welcome. In general, we follow the "fork-and-pull" Git workflow.
1. **Fork** the repo on GitHub
2. **Clone** the project to your own machine
3. **Commit** changes to your own branch
4. **Push** your work back up to your fork
5. Submit a **Pull request** so that we can review your changes
NOTE: Be sure to merge the latest from "upstream" before making a pull request!
## Changelog
View our closed [Pull Requests](https://github.com/stakater/Jamadar/pulls?q=is%3Apr+is%3Aclosed).
## License
Apache2 © [Stakater](http://stakater.com)
## About
`Jamadar` is maintained by [Stakater][website]. Like it? Please let us know at
See [our other projects][community]
or contact us in case of professional services and queries on
[website]: http://stakater.com/
[community]: https://github.com/stakater/