boreas-scheduler

Overview

Deploy Boreas scheduler

You can deploy the Boreas scheduler on your master node by either pulling it from the Github Container Registry (recommended), or by building it yourself and deploying it to a local container registry. The later is mostly useful for development of the Boreas scheduler itself.

You can see the scheduler's pod by listing pods in the system namespace:

• $ kubectl get pods --namespace=kube-system

Pod description and logs are also available:

• $ kubectl describe pod boreas-scheduler --namespace=kube-system
• $ kubectl logs boreas-scheduler-<pod-identifier> boreas-scheduler --namespace=kube-system

Deploy from the Github Container Registry

• $ kubectl create -f deployments/scheduler.yaml

Deploy from local container registry

Install Buildah to work with images locally (requires Ubuntu 20.10 or newer):

• $ sudo apt-get install buildah make

Start a local image registry as a background process:

• $ make start-registry

Then run the deployment script:

• $ make deploy-locally

which deploys the scheduler locally in three steps:

(1) Build a container image:

• $ buildah bud -t boreas-scheduler:local .

(2) Push the image to the local registry:

• $ buildah push --tls-verify=false boreas-scheduler docker://localhost:5000/boreas-scheduler:local

(3) Deploy the sheduler to Kubernetes:

• $ kubectl create -f deployments/scheduler-local.yaml

Remove Boreas scheduler

• $ make remove

which removes the scheduler by running the following:

• $ kubectl delete deployment --namespace=kube-system boreas-scheduler
• $ kubectl delete clusterrolebinding --namespace=kube-system boreas-scheduler-as-kube-scheduler
• $ kubectl delete serviceaccount --namespace=kube-system boreas-scheduler

Advanced optimizer settings

Boreas can be configured to include options with the optimizing requests sent to Zephyrus2 through the BOREAS_OPTIMIZER_OPTIONS environment variable.

Details on the available options can be found in Zephyrus2's documentation, but options include:

• disabling Zephyrus2's symmetry breaking constraint: --no-simmetry-breaking
• using the OR-Tools solver: --solver, lex-or-tools
• using the Gecode solver: --solver, gecode
• using the Z3 SMT solver: --solver, smt

For instance, the following will instruct Zephyrus2 to use OR-Tools as its solver:

• BOREAS_OPTIMIZER_OPTIONS='--solver, lex-or-tools'

Credits

• Jacopo Mauro: Zephyrus2
• Nick Joyce: «Building Minimal Docker Containers for Python Applications» (Dockerfile design)

Citation

If you use this software in your work, please cite it as described in the CITATION file.

License

See the LICENSE file for license rights and limitations (MIT).