This project packages a small Python REST endpoint you can include to any Kubernetes pod. It relies on Etcd for synchronization, leader election and persistence and will allow you to run code whenever a change occurs within the a set of monitored pods. Communications are performed using ZeroRPC over TCP at port 8000 by default.
The image will right now leverage the AWS metadata API to gather node level information (this will be extended to include other providers down the road).
It also offers the automaton command-line tool to run a finite state machine that is controlled via a local unix socket. This machine can be used to script the lifecycle of whatever process is managed by kontrol.
Pick one of the supported distros and build from the top-level directory. For instance:
$ docker build --no-cache -f alpine-3.5/Dockerfile .
Please note the two packages can be installed directly from github via pip (especially if you wish to include them in your own images or on your local dev box). For instance:
$ sudo pip install git+https://github.com/UnityTech/ads-infra-kontrol.git
Once installed you will have two local packages: kontrol and automaton. The image entrypoint is supervisord which is started from the /home/kontrol directory. By default Kontrol is not started and you have to explicitely add it to the supervisor jobs. Anything with extension conf found under /home/kontrol/supervisor will be included as a supervisor configuration file.
This image includes telegraf 1.2.1. Its core configuration is automatically generated at boot time based on the pod & node labels. Please note you do need to define the kontrol.unity3d.com/opentsdb annotation and set it to a valid host for the configuration to be generated.
Please look at the URL attached to this repository. It will take you to its latest github page. The Sphinx materials can be found under docs/. Just go in there and build for your favorite target, for instance:
$ cd docs
$ make html
The docs will be written to _docs/build/html. This is all Sphinx based and you have many options and knobs to tweak should you want to customize the output.
Contact olivierp@unity3d.com for more information about this project.