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

Development

Docker

To use the docker containter to develop:

1. Fork the [repo](http://github.com/att-comdev/armada)
2. After making changes push to repo and build from forked repo

export repo="https://github.com/<forked-repo>/armada.git"
export branch="<branch>"
docker build . -p 8000:8000 -v ${HOME}/.kube/config:/root/.kube/config -t quay.io/attcomdev/armada:latest --build-arg REPO=$repo --build-arg VERSION=$branch

Note

The first build will take a little while. Afterwards the it will much faster

3. EZPZ :)

Virtualenv

To use VirtualEnv we will need to add some extra steps

1. virtualenv venv
2. source ./venv/bin/activate
3. export LIBGIT2=$VIRTUAL_ENV
4. run modified bash below

#!/bin/sh

# Ubuntu 16.04 Install only

sudo apt install git cmake make -y
sudo apt-get install -y python-dev libffi-dev libssl-dev libxml2-dev libxslt1-dev libssh2-1 libgit2-dev python-pip libgit2-24
sudo apt-get install -y pkg-config libssh2-1-dev libhttp-parser-dev libssl-dev libz-dev

LIBGIT_VERSION='0.25.0'

wget https://github.com/libgit2/libgit2/archive/v${LIBGIT_VERSION}.tar.gz
tar xzf v${LIBGIT_VERSION}.tar.gz
cd libgit2-${LIBGIT_VERSION}/
cmake . -DCMAKE_INSTALL_PREFIX=$LIBGIT2
make
sudo make install
export LDFLAGS="-Wl,-rpath='$LIBGIT2/lib',--enable-new-dtags $LDFLAGS"
sudo pip install pygit2==${LIBGIT_VERSION}
sudo ldconfig

Test that it worked with:

python -c 'import pygit2'

git clone https://github.com/att-comdev/armada.git
cd armada
pip install -r requirements.txt
pip install -r test-requirements.txt

Your env is now ready to go! :)

Note

this will install latest libgit2 library so you have to make sure you install the same version library with pip ( current version: 0.25.0 )

Kubernetes

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

Minikube

Halcyon

Note

When using Halcyon it will not generate a config file. Run the following commands to create one: get_k8s_creds.sh