https://github.com/prikhi/sysadmintools
Acorn's Server, Workstation, & VM Cluster Automation & Documentation
https://github.com/prikhi/sysadmintools
ansible debian fabric openstack restructuredtext slackware sphinx ubuntu
Last synced: 4 months ago
JSON representation
Acorn's Server, Workstation, & VM Cluster Automation & Documentation
- Host: GitHub
- URL: https://github.com/prikhi/sysadmintools
- Owner: prikhi
- License: gpl-3.0
- Created: 2014-08-12T20:58:44.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2020-05-30T12:28:28.000Z (about 5 years ago)
- Last Synced: 2025-02-02T01:02:10.774Z (4 months ago)
- Topics: ansible, debian, fabric, openstack, restructuredtext, slackware, sphinx, ubuntu
- Language: JavaScript
- Homepage: http://acorn-networking.rtfd.org
- Size: 62 MB
- Stars: 8
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE.txt
Awesome Lists containing this project
README
----------------------------------
Acorn System Administration Tools
----------------------------------
.. image:: https://readthedocs.org/projects/acorn-networking/badge/?version=latest
:target: http://acorn-networking.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
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
.. _Ansible: http://www.ansible.com/home
.. _Fabric: http://www.fabfile.org/
.. _Sphinx: http://www.sphinx-doc.org/
.. _Pencil: http://www.github.com/evolus/pencil