Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stakater/Chowkidar
A kubernetes controller that watches/observes events & then takes configured actions – [✩Star] if you're using it!
https://github.com/stakater/Chowkidar
kube-alert kubernetes kubernetes-controller kubewatch openshift
Last synced: about 1 month ago
JSON representation
A kubernetes controller that watches/observes events & then takes configured actions – [✩Star] if you're using it!
- Host: GitHub
- URL: https://github.com/stakater/Chowkidar
- Owner: stakater
- License: apache-2.0
- Created: 2018-04-25T18:22:15.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T17:58:11.000Z (9 months ago)
- Last Synced: 2024-07-20T03:18:56.390Z (about 2 months ago)
- Topics: kube-alert, kubernetes, kubernetes-controller, kubewatch, openshift
- Language: Go
- Homepage: https://stakater.com/opensource
- Size: 12.7 MB
- Stars: 55
- Watchers: 4
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
#  Chowkidar
[](https://goreportcard.com/report/github.com/stakater/chowkidar)
[](http://godoc.org/github.com/stakater/chowkidar)
[](https://github.com/stakater/chowkidar/releases/latest)
[](https://github.com/stakater/chowkidar/releases/latest)
[](https://hub.docker.com/r/stakater/chowkidar/)
[](https://hub.docker.com/r/stakater/chowkidar/)
[](https://microbadger.com/images/stakater/chowkidar)
[](https://microbadger.com/images/stakater/chowkidar)
[](LICENSE)
[](http://stakater.com/?utm_source=Chowkidar&utm_medium=github)
## WHY NAME CHOWKIDAR?
Chowkidar, an Urdu word, is used for Watchman in Pakistan. This Chowkidar will watch over your cluster, looking for any anomaly in the cluster and will act as you want it to.
## Problem
We would like to watch for relevant events happening inside kubernetes and then perform actions depending upon the criteria.
e.g. I would like to get a slack notification when a pod is submitted without requests & limits.
## Solution
Chowkidar allows you to have multiple controllers that will continuously watch types in all the namespaces and automatically perform any actions given in the yaml file. With this, you can easily check for any criteria on your Pods/other types and take corresponding actions.
## Deploying to Kubernetes
### Vanilla Manifests
You have to first clone or download the repository contents. The kubernetes deployment and files are provided inside `deployments/kubernetes/manifests` folder.
### Configuring
First of all you need to modify `configs/config.yaml` file. Following are the available options that you can use to customize the controllers:
| Key |Description |
|-----------------------|-------------------------------------------------------------------------------|
| type | The type of Resource you want to monitor, like Pods, Deployments, etc |
| watchcriterion | The criterion for which you want to take actions for the controller e.g. ResourceExists,etc |
| actions | The Array of actions that you want to take, e.g. send message to Slack, etc |
### Supported Types
Currently we are supporting,
- Pods
We will be adding support for other Types as well in the future
### Supported Criterion
Currently we are supporting following Criterion
- resourceExists: It will make sure Pods should have Resources and if not found, it will take action
We will be adding support for other Criterion as well in the future
### Supported Actions
Currently we are supporting following Actions with their Parameters,
- 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
You can deploy Chowkidar 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 Chowkidar via helm chart located under `deployments/kubernetes/chart/Chowkidar` folder.
## Help
**Got a question?**
File a GitHub [issue](https://github.com/stakater/Chowkidar/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 Chowkidar
[](https://slack.stakater.com/)
[](https://stakater-community.slack.com/messages/CAN960CTG)
## Contributing
### Bug Reports & Feature Requests
Please use the [issue tracker](https://github.com/stakater/Chowkidar/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/Chowkidar/pulls?q=is%3Apr+is%3Aclosed).
## License
Apache2 © [Stakater](http://stakater.com)
## About
`Chowkidar` 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/