This document is intended to be the canonical source of truth for things like supported toolchain versions for building Voyager. If you find a requirement that this doc does not capture, please submit an issue on github.
This document is intended to be relative to the branch in which it is found. It is guaranteed that requirements will change over time for the development branch, but release branches of Voyager should not change.
Some of the Voyager development helper scripts rely on a fairly up-to-date GNU tools environment, so most recent Linux distros should work just fine out-of-the-box.
Voyager is written in the go programming language. The release is built and tested on go 1.7.5. If you haven't set up a Go development environment, please follow these instructions to install the go tools.
Voyager build and test scripts use glide to manage dependencies.
To install glide follow these instructions.
Currently the project includes all its required dependencies inside vendor to make things easier.
To build Voyager using your local Go development environment (generate linux binaries):
$ ./hack/make.py build VoyagerRead full Build instructions.
Voyager works by implementing third party resource data watcher for kubernetes. It connects with k8s apiserver for specific events as ADD, UPDATE and DELETE. and perform required operations.
Ingress watcher generates the configuration for HAProxy and stores it as a ConfigMaps and creates a RC with specified HAProxy - that is configured with auto reload while any changes happens to ConfigMap data. This is handled via kloader. Voyager keeps the ingress resource and the configuration in sync by performing processing on the resources.
Certificate watcher watch and process certificates third party data and obtain a ACME certificates.