keel/readme.md

[![CircleCI](https://circleci.com/gh/rusenask/keel/tree/master.svg?style=shield&circle-token=0239846a42cfa188de531058b9a2116a4b8600d8)](https://circleci.com/gh/rusenask/keel/tree/master)

# Keel - automated Kubernetes deployments for the rest of us

* Website [https://keel.sh](https://keel.sh)
* Slack - [kubernetes.slack.com](https://kubernetes.slack.com) look for @karolis

Keel is a tool for automating [Kubernetes](https://kubernetes.io/) deployment updates. Keel is stateless, robust and lightweight.

Keel provides several key features:

* __Semver policies__ - specify update policy for each deployment individually.

* __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.

* __[DockerHub Webhooks](https://docs.docker.com/docker-hub/webhooks/) support__ - Keel accepts dockerhub style webhooks on `/v1/webhooks/dockerhub` endpoint. Impacted deployments will be identified and updated.

*  __[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`).

* __Notifications__ - out of the box Keel has Slack and standard webhook notifications, more info [here](https://keel.sh/user-guide/#notifications)

<img src="https://keel.sh/images/keel-overview.png">

### Quick Start

A step-by-step guide to install Keel on your Kubernetes cluster is viewable on the Keel website:

[https://keel.sh/install](https://keel.sh/install)

### Documentation

Documentation is viewable on the Keel Website:

[https://keel.sh/user-guide/](https://keel.sh/user-guide/)


### Contributing

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.

### Developing Keel

If you wish to work on Keel itself, you will need Go 1.8+ installed. Make sure you put Keel into correct Gopath and get remaining dependencies (some dependencies are already locked through glide). 

### Roadmap

Project [roadmap available here](https://github.com/rusenask/keel/wiki/Roadmap).
added circleci status badge 2017-07-16 20:45:26 +00:00			`[![CircleCI](https://circleci.com/gh/rusenask/keel/tree/master.svg?style=shield&circle-token=0239846a42cfa188de531058b9a2116a4b8600d8)](https://circleci.com/gh/rusenask/keel/tree/master)`

readme 2017-06-11 23:03:56 +00:00			`# Keel - automated Kubernetes deployments for the rest of us`
readme 2017-06-11 10:29:33 +00:00
readme updated, sample updated 2017-07-09 20:33:52 +00:00			`* Website [https://keel.sh](https://keel.sh)`
updated link to slack 2017-07-14 09:48:21 +00:00			`* Slack - [kubernetes.slack.com](https://kubernetes.slack.com) look for @karolis`
readme 2017-06-11 10:29:33 +00:00
readme updated, sample updated 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.`
readme 2017-06-11 10:29:33 +00:00
readme updated, sample updated 2017-07-09 20:33:52 +00:00			`Keel provides several key features:`
readme updated 2017-07-04 15:42:25 +00:00
readme updated, sample updated 2017-07-09 20:33:52 +00:00			`* __Semver policies__ - specify update policy for each deployment individually.`
roadmap link 2017-07-04 16:53:21 +00:00
readme updated, sample updated 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.`
readme updates 2017-06-14 17:50:41 +00:00
readme updated, sample updated 2017-07-09 20:33:52 +00:00			* __[DockerHub Webhooks](https://docs.docker.com/docker-hub/webhooks/) support__ - Keel accepts dockerhub style webhooks on `/v1/webhooks/dockerhub` endpoint. Impacted deployments will be identified and updated.
readme 2017-06-11 23:03:56 +00:00
readme updated 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`).
added notifications to feature list 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)`
readme updated 2017-07-04 15:42:25 +00:00
updated link 2017-07-09 20:39:12 +00:00			`<img src="https://keel.sh/images/keel-overview.png">`
readme 2017-06-11 10:29:33 +00:00
readme updated, sample updated 2017-07-09 20:33:52 +00:00			`### Quick Start`
updated readme 2017-06-16 14:30:09 +00:00
readme updated, sample updated 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:`
readme 2017-07-01 12:56:33 +00:00
readme updated, sample updated 2017-07-09 20:33:52 +00:00			`[https://keel.sh/install](https://keel.sh/install)`
readme 2017-07-08 17:52:33 +00:00
readme updated, sample updated 2017-07-09 20:33:52 +00:00			`### Documentation`
readme 2017-07-08 17:52:33 +00:00
readme updated, sample updated 2017-07-09 20:33:52 +00:00			`Documentation is viewable on the Keel Website:`
readme 2017-07-08 17:52:33 +00:00
readme updated, sample updated 2017-07-09 20:33:52 +00:00			`[https://keel.sh/user-guide/](https://keel.sh/user-guide/)`
readme 2017-07-08 17:52:33 +00:00

readme updated, sample updated 2017-07-09 20:33:52 +00:00			`### Contributing`
readme 2017-07-08 17:52:33 +00:00
readme updated, sample updated 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.`
readme 2017-07-08 17:52:33 +00:00
readme updated, sample updated 2017-07-09 20:33:52 +00:00			`### Developing Keel`
readme 2017-07-08 17:52:33 +00:00
readme updated, sample updated 2017-07-09 20:33:52 +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 get remaining dependencies (some dependencies are already locked through glide).`
readme 2017-07-08 17:52:33 +00:00
readme updated, sample updated 2017-07-09 20:33:52 +00:00			`### Roadmap`
readme 2017-07-08 17:52:33 +00:00
updated link 2017-07-09 20:39:12 +00:00			`Project [roadmap available here](https://github.com/rusenask/keel/wiki/Roadmap).`