From ee75bdafae6358f423f61eb5e3e24161bfa3ce1d Mon Sep 17 00:00:00 2001 From: Adar Nimrod <nimrod@shore.co.il> Date: Thu, 5 Nov 2015 09:48:23 +0200 Subject: [PATCH] Documentation. --- README.rst | 32 +++++++++++++++++++++++++------- 1 file changed, 25 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 48a27fe..3087e99 100644 --- a/README.rst +++ b/README.rst @@ -1,13 +1,31 @@ Ansible playbooks -================= +***************** -My repository of Ansible playbooks and surronding infrastrcture. The actual -roles are located in different repositories so they could be installed with -ansible-galaxy. +My homelab playground. A repository of infrastructure using Virtualbox, Vagrant, +Landrush and Ansible. The actual Ansible roles are each located in a repository +of its own (which is ansible-galaxy installable). -todo + +Requirements +------------ + +- `Virtualbox <https://www.virtualbox.org/>`_. +- `Vagrant <https://www.vagrantup.com/>`_. +- `Landrush <https://github.com/phinze/landrush>`_. +- `Ansible <http://www.ansible.com/>`_. + +Getting started +--------------- +:: + + git clone https://www.shore.co.il/cgit/ansible-playbooks + cd ansible-playbooks + ansible-galaxy install -r requirements.yml + vagrant up + + +TODO ---- -- Documentation? -- Testing, pre-commit hooks. +- Testing (maybe ansible-lint?). - Whatever automation not provided by Vagrant and Ansible. -- GitLab