2.1 KiB
2.1 KiB
Development
Docker
To use the docker containter to develop:
- Fork the Repository
- Clone the forked repo
- 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
make images
# Run Docker Image
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
make bootstrap # install only requirements lib
make bootstrap-all # install all requirements and tests lib
pip install .
make build
pip install tox
tox
make test-all
# Linting
tox -e pep8
make test-pep8
make lint
# Bandit
tox -e bandit
make test-bandit
# Coverage
tox -e coverage
make test-coverage
# build charts
make charts
# 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: