keel-hq
/
keel
mirror of https://github.com/keel-hq/keel/tree/master/chart/keel
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
keel/readme.md

2.0 KiB
Raw Blame History

Keel - automated Kubernetes deployments for the rest of us

Keel is a tool for automating Kubernetes 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 configuration - Keel automatically sets up topic and subscriptions for your deployment images by periodically scanning your environment.

  • DockerHub Webhooks support - Keel accepts dockerhub style webhooks on /v1/webhooks/dockerhub endpoint. Impacted deployments will be identified and updated.

  • Polling - when webhooks and pubsub aren't available - Keel can still be useful by checking Docker Registry for changed SHA digest.

  • Notifications - out of the box Keel has Slack and standard webhook notifications, more info here

Quick Start

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

https://keel.sh/install

Documentation

Documentation is viewable on the Keel Website:

https://keel.sh/user-guide/

Contributing

Before starting to work on some big or medium features - raise an issue here 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.