2017-08-07 15:56:53 +00:00
[](https://hub.docker.com/r/karolisr/keel/) [](https://goreportcard.com/report/github.com/rusenask/keel) [](https://img.shields.io/docker/pulls/karolisr/keel.svg)
2017-07-16 20:45:26 +00:00
2017-06-11 23:03:56 +00:00
# Keel - automated Kubernetes deployments for the rest of us
2017-06-11 10:29:33 +00:00
2017-07-09 20:33:52 +00:00
* Website [https://keel.sh ](https://keel.sh )
2017-08-04 17:45:22 +00:00
* Slack - [kubernetes.slack.com ](https://kubernetes.slack.com ) look for channel #keel
2017-06-11 10:29:33 +00:00
2017-07-09 20:33:52 +00:00
Keel is a tool for automating [Kubernetes ](https://kubernetes.io/ ) deployment updates. Keel is stateless, robust and lightweight.
2017-06-11 10:29:33 +00:00
2017-07-09 20:33:52 +00:00
Keel provides several key features:
2017-07-04 15:42:25 +00:00
2017-07-24 18:57:15 +00:00
* __[Kubernetes](https://kubernetes.io/) and [Helm ](https://helm.sh ) providers__ - Keel has direct integrations with Kubernetes and Helm.
* __No CLI/API__ - tired of `f***ctl` for everything? Keel doesn't have one. Gets job done through labels, annotations, charts.
* __Semver policies__ - specify update policy for each deployment/Helm release individually.
2017-07-04 16:53:21 +00:00
2017-07-09 20:33:52 +00:00
* __Automatic [Google Container Registry ](https://cloud.google.com/container-registry/ ) configuration__ - Keel automatically sets up topic and subscriptions for your deployment images by periodically scanning your environment.
2017-06-14 17:50:41 +00:00
2017-07-24 18:57:15 +00:00
* __[Native, DockerHub and Quay webhooks](https://keel.sh/user-guide/triggers/#webhooks) support__ - once webhook is received impacted deployments will be identified and updated.
2017-06-11 23:03:56 +00:00
2017-07-16 19:59:12 +00:00
* __ [Polling ](https://keel.sh/user-guide/#polling-deployment-example )__ - when webhooks and pubsub aren't available - Keel can still be useful by checking Docker Registry for new tags (if current tag is semver) or same tag SHA digest change (ie: `latest` ).
2017-07-09 20:41:42 +00:00
* __Notifications__ - out of the box Keel has Slack and standard webhook notifications, more info [here ](https://keel.sh/user-guide/#notifications )
2017-07-04 15:42:25 +00:00
2017-07-09 20:39:12 +00:00
< img src = "https://keel.sh/images/keel-overview.png" >
2017-06-11 10:29:33 +00:00
2017-07-09 20:33:52 +00:00
### Quick Start
2017-06-16 14:30:09 +00:00
2017-07-09 20:33:52 +00:00
A step-by-step guide to install Keel on your Kubernetes cluster is viewable on the Keel website:
2017-07-01 12:56:33 +00:00
2017-07-09 20:33:52 +00:00
[https://keel.sh/install ](https://keel.sh/install )
2017-07-08 17:52:33 +00:00
2017-07-09 20:33:52 +00:00
### Documentation
2017-07-08 17:52:33 +00:00
2017-07-09 20:33:52 +00:00
Documentation is viewable on the Keel Website:
2017-07-08 17:52:33 +00:00
2017-07-09 20:33:52 +00:00
[https://keel.sh/user-guide/ ](https://keel.sh/user-guide/ )
2017-07-08 17:52:33 +00:00
2017-07-09 20:33:52 +00:00
### Contributing
2017-07-08 17:52:33 +00:00
2017-07-09 20:33:52 +00:00
Before starting to work on some big or medium features - raise an issue [here ](https://github.com/rusenask/keel/issues ) so we can coordinate our efforts.
2017-07-08 17:52:33 +00:00
2017-07-09 20:33:52 +00:00
### Developing Keel
2017-07-08 17:52:33 +00:00
2017-07-24 18:57:15 +00:00
If you wish to work on Keel itself, you will need Go 1.8+ installed. Make sure you put Keel into correct Gopath and `go build` (dependency management is done through Glide).
2017-07-08 17:52:33 +00:00
2017-07-09 20:33:52 +00:00
### Roadmap
2017-07-08 17:52:33 +00:00
2017-07-09 20:39:12 +00:00
Project [roadmap available here ](https://github.com/rusenask/keel/wiki/Roadmap ).
