Kubernetes Operator to automate Helm, DaemonSet, StatefulSet & Deployment updates
MPL-2.0 License
Keel is a tool for automating Kubernetes deployment updates. Keel is stateless, robust and lightweight.
Keel provides several key features:
Kubernetes and Helm 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.
Automatic Google Container Registry configuration - Keel automatically sets up topic and subscriptions for your deployment images by periodically scanning your environment.
Native, DockerHub, Quay and Azure container registry webhooks support - once webhook is received 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 new tags (if current tag is semver) or same tag SHA digest change (ie: latest
).
Notifications - out of the box Keel has Slack, Hipchat, Mattermost and standard webhook notifications, more info here
Support Keel's development by:
Prerequisites:
You need to add this Chart repo to Helm:
helm repo add keel https://charts.keel.sh
helm repo update
Install through Helm (with Helm provider enabled by default):
helm upgrade --install keel --namespace=kube-system keel/keel
If you work mostly with regular Kubernetes manifests, you can install Keel without Helm provider support:
helm upgrade --install keel --namespace=keel keel/keel --set helmProvider.enabled="false"
To install for Helm v3, set helmProvider.version="v3" (default is "v2"):
helm install keel keel/keel --set helmProvider.version="v3"
That's it, see Configuration section now.
A step-by-step guide to install Keel on your Kubernetes cluster is viewable on the Keel website:
https://keel.sh/examples/#example-1-push-to-deploy
Once Keel is deployed, you only need to specify update policy on your deployment file or Helm chart:
apiVersion: apps/v1
kind: Deployment
metadata:
name: wd
namespace: default
labels:
name: "wd"
annotations:
keel.sh/policy: minor # <-- policy name according to https://semver.org/
keel.sh/trigger: poll # <-- actively query registry, otherwise defaults to webhooks
spec:
template:
metadata:
name: wd
labels:
app: wd
spec:
containers:
- image: karolisr/webhook-demo:0.0.8
imagePullPolicy: Always
name: wd
command: ["/bin/webhook-demo"]
ports:
- containerPort: 8090
No additional configuration is required. Enabling continuous delivery for your workloads has never been this easy!
Documentation is viewable on the Keel Website:
https://keel.sh/docs/#introduction
Before starting to work on some big or medium features - raise an issue here so we can coordinate our efforts.
We use pull requests, so:
If you wish to work on Keel itself, you will need Go 1.12+ installed. Make sure you put Keel into correct Gopath and go build
(dependency management is done through dep).
To test Keel while developing:
kubectl config use-context docker-for-desktop
cmd/keel
directory.keel --no-incluster
. This will use Kubeconfig from your home.Get a test parser (makes output nice):
go get github.com/mfridman/tparse
To run unit tests:
make test
Prerequisites:
Once prerequisites are ready:
make e2e