noaz / poseidon

Kubernetes integration for Firmament

Poseidon is Firmament's (http://www.firmament.io) integration with Kubernetes.

Note: this repo contains an initial prototype, it may break at any time! :)

Getting started

The easiest way to get Poseidon up and running is to use our Docker image:

$ docker pull camsas/poseidon:dev

Once the image has downloaded, you can start Poseidon as follows:

$ docker run camsas/poseidon:dev /usr/bin/poseidon \
    --logtostderr \
    --k8s_apiserver_host=<host> \
    --k8s_apiserver_port=<port> \
    --cs2_binary=/usr/bin/cs2.exe \
    --max_tasks_per_pu=<max pods per node>

Note that Poseidon will try to schedule for Kubernetes even if kube-scheduler is running -- to avoid conflicts, shut it down first.

You will also need to ensure that the API server is reachable from the Poseidon container's network (e.g., using --net=host if you're running a local development cluster).

Building from source

System requirements

• CMake 2.8+
• Docker 1.7+
• Kubernetes v1.1+
• Boost 1.54+
• libssl 1.0.0+

The build process will install local version of Poseidon's dependencies, which currently include:

• the Microsoft C++ REST SDK v2.7.0
• the Firmament scheduler (HEAD)

and their dependencies.

A known-good build environment is Ubuntu 16.04 with gcc 5.1.3.

Build process

First, generate the build infrastructure:

$ mkdir build
$ cd build
build$ cmake ..

Then, build Poseidon:

build$ make

To start up, run from the root directory:

$ build/poseidon --logtostderr \
                 --k8s_apiserver_host=<hostname> \
                 --k8s_apiserver_port=8080 \
                 --max_tasks_per_pu=<max pods per node> \
                 --cs2_binary=build/firmament/src/firmament-build/third_party/cs2/src/cs2/cs2.exe

Additional arguments (e.g. to choose a scheduling policy) follow those accepted by Firmament.

You will likely need to specify the --cs2_binary option, which should point to the local installation of the cs2 min-cost flow solver. Normally, the cs2 binary is located in build/firmament/src/firmament-build/third_party/cs2/src/cs2/cs2.exe.

Contributing

We always welcome contributions to Poseidon. We use GerritHub for our code reviews, and you can find the Poseidon review board there:

https://review.gerrithub.io/#/q/project:ms705/poseidon+is:open

In order to do code reviews, you will need an account on GerritHub (you can link your GitHub account).

The easiest way to submit changes for review is to check out Poseidon from GerritHub, or to add GerritHub as a remote. Alternatively, you can submit a pull request on GitHub and we will import it for review on GerritHub.