This is a fork of the original Keel project. The original project can be found here. This fork is intended to provide a more up-2-date and possibly more feature rich version of Keel, since the original project seems to have been abandoned a long time ago. To be able to do that the scope of the project has been limited slightly by removing some features as described below.
Feel free to open issues and PRs to improve this fork, I will try to keep it up to date with the original project. Keep in mind though that I am not the original author of Keel and I am not affiliated with the original project in any way. I also do not have the resources to provide support for this fork like a full-blown company, so please do not contact me directly.
This README and maybe also other files in this Project still point to the original project, since it provides a lot of resources like the official documentation. While it might be feasible to migrate this at some point, most of these links still hold true and relevant information, so they will stay until there is a need to change something. If that is the case, please open an Issue to let me know, or better yet open a PR to address it.
Most if not all changes made to this project are intended to make it easier to maintain for a single person. Since the project is already quite feature rich, most of the updates to this repo will be focused on stability, security (through dependency updates) and maintainability.
- CI/CD
- This project now utilizes GitHub Actions to builds and publish the
ghcr.io/markusressel/keel:latestDocker container.
- This project now utilizes GitHub Actions to builds and publish the
- API
- The REST API of the original project is currently unchanged, but might be extended in the future.
- Since I do not intend to support a ton of external services like Slack or Discord, this API is the main way to interact with Keel and come up with your own service to provide bots and notifications. If you would like to create such a service, take a look at the keel-telegram-bot project.
- Bots
- All of the Bots have been removed from this project. The reason for this is that supporting them is out of scope for me and the REST API and webhooks makes it easy to provide them using third party containers. This makes it possible to share the maintenance burden with the community. Check out my own Telegram specific bot: keel-telegram-bot
- Notification Providers
- All of Notification Providers except the Webhook one have been removed from this project. The reason for this is that supporting them is out of scope for me and the webhook integration makes it easy to provide them using third party containers. Check out my Telegram specific one here: keel-telegram-bot
- Helm Provider
- While I have not yet removed the support for Helm, I am not using it myself and might remove support for it in the future.
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***ctlfor 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
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: 8090No 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:
- Fork this repository
- Create a branch on your local copy with a sensible name
- Push to your fork and open a pull request
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:
- Launch a Kubernetes cluster like Minikube or Docker for Mac with Kubernetes.
- Change config to use it:
kubectl config use-context docker-for-desktop - Build Keel from
cmd/keeldirectory. - Start Keel with:
keel --no-incluster. This will use Kubeconfig from your home.
sudo docker run -t --rm --name keel ghcr.io/markusressel/keel:latestGet a test parser (makes output nice):
go get github.com/mfridman/tparseTo run unit tests:
make testPrerequisites:
- configured kubectl + kubeconfig
- a running cluster (test suite will create testing namespaces and delete them after tests)
- Go environment (will compile Keel before running)
Once prerequisites are ready:
make e2e