armada/docs/source/development/getting-started.rst

Development

Docker

To use the docker containter to develop:

1. Fork the Repository
2. Clone the forked repo
3. Change to the directory of the cloned repo

docker build . -t armada/latest

docker run -d --name armada -v ~/.kube/config:/root/.kube/config -v $(pwd)/examples/:/examples armada/latest

Note

The first build will take a little while. Afterwords, it will build much faster.

Virtualenv

To use VirtualEnv:

1. virtualenv venv
2. source ./venv/bin/activate

From the directory of the forked repository:

pip install -r requirements.txt
pip install -r test-requirements.txt
pip install -e .

Note

If building from source, Armada requires that git be installed on the system.

Kubernetes

To test your armada fixes/features you will need to set-up a Kubernetes cluster.

We recommend:

Kubeadm

Kubeadm-AIO