https://raw.githubusercontent.com/numberly/kubemen/master/artwork/logo.png

https://img.shields.io/github/v/tag/numberly/kubemen https://img.shields.io/github/license/numberly/kubemen.svg https://img.shields.io/docker/cloud/build/numberly/kubemen https://img.shields.io/travis/numberly/kubemen/master?label=travis%20build https://img.shields.io/coveralls/numberly/kubemen.svg https://readthedocs.org/projects/kubemen/badge

They watch on your Kubernetes cluster…

Kubemen is a Kubernetes validating admission webhook that sends notifications when a resource changes on your cluster, heavily influenced by the Watchmen (2009) movie.

Currently supported channels:

Documentation: https://kubemen.readthedocs.io

Installation

Kubernetes

Requirements:

  • ValidatingAdmissionWebhooks being enabled on your cluster
  • you being an administrator of the cluster

If these requirements are fulfilled, installing Kubemen on your cluster is pretty straightforward:

  • create TLS certificates for the service and sign them through the CSR API:
$ sh deploy/create-cert.sh
  • deploy Kubemen:
$ cat deploy/kubemen.yaml | sh deploy/patch-ca-bundle.sh | kubectl apply -f -

Locally

If you want to hack on Kubemen:

$ virtualenv -ppython3 .venv
$ .venv/bin/activate
  • install the application requirements with pip:
(.venv) $ pip install -r requirements.txt
  • run it with:
(.venv) $ python run.py

Tests

To run Kubemen tests:

  • install Kubemen locally (see above);
  • install developers requirements with pip install -r dev-requirements.txt;
  • run pytest.

License

MIT