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

git clone http://github.com/att-comdev/armada.git && cd armada

pip install tox

tox -e genconfig
tox -e genpolicy

docker build . -t armada/latest

docker run -d --name armada -v ~/.kube/:/armada/.kube/ -v $(pwd)/etc:/etc armada:local

Note

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

Virtualenv

How to set up armada in your local using virtualenv:

Note

Suggest that you use a Ubuntu 16.04 VM

From the directory of the forked repository:

git clone http://github.com/att-comdev/armada.git && cd armada

virtualenv -p python3 venv

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

pip install .

# Testing your armada code
# The tox command will execute lint, bandit, cover
pip install tox
tox

# For targeted test
tox -e pep8
tox -e bandit
tox -e cover

# policy and config are used in order to use and configure Armada API
tox -e genconfig
tox -e genpolicy

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