This repository contains files, scripts, & documentation for the automated administration of Acorn's Linux servers(Slackware), workstations(Debian), & VM cluster(OpenStack).

You can read all the documentation at http://acorn-networking.rtfd.org.

The main applications we use are Ansible and Fabric.

The Ansible and Fabric dependencies may be installed via pip:

pip install ansible Fabric

You can build the documentation yourself by using Sphinx, also installed via pip:

# Create & Source A Python Virtual Environment
python -m venv Env
source Env/bin/activate
pip install -r requirements.txt
cd docs
make html
firefox build/html/index.html

You can run just make to see all the formats you can build. You might want make latexpdf to generate a PDF of the documentation.

If you are writing documentation, run make livehtml to open the docs in your browser, and automatically rebuild the documentation & refresh the page when a source file is modified.

The diagrams in the documentation are made with Pencil, the source file is located at docs/source/diagrams.epgz.

TODO: Add playbooks for VMs