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.
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.
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.
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 |
Currently we are supporting the following dangling resources,
- namespaces
We will be adding support for other Resources as well in the future
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
tokenandChannel Nameas Parameters in the yaml file
We will be adding support for other Actions as well in the future
You have to first clone or download the repository contents. The kubernetes deployment and files are provided inside deployments/kubernetes/manifests folder.
You can deploy Jamadar by running the following kubectl commands:
kubectl apply -f configmap.yaml -n <namespace>
kubectl apply -f rbac.yaml -n <namespace>
kubectl apply -f deployment.yaml -n <namespace>Or alternatively if you configured helm on your cluster, you can deploy Jamadar via helm chart located under deployments/kubernetes/chart/Jamadar folder.
Got a question? File a GitHub issue, or send us an email.
Join and talk to us on the #tools-imc channel for discussing Jamadar
Please use the issue tracker to report any bugs or file feature requests.
PRs are welcome. In general, we follow the "fork-and-pull" Git workflow.
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- 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!
View our closed Pull Requests.
Apache2 © Stakater
Jamadar is maintained by Stakater. Like it? Please let us know at [email protected]
See our other projects or contact us in case of professional services and queries on [email protected]