From feaf7a41e193a104b65df19c3b6da6e2607bcf00 Mon Sep 17 00:00:00 2001 From: Dorian Pula Date: Thu, 26 Mar 2015 13:41:03 -0400 Subject: [PATCH] Update the general documentation for the role. --- README.md | 56 +++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 40 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 836c6e3..61378d9 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,21 @@ -Role Name -========= +Ansible Rookeries +================= -A brief description of the role goes here. +An Ansible role that acts as a companion to the Rookeries project. The goal of this role is to make deployment of +Rookeries simple. Ideally Rookeries even as a Python WSGI app with this role, should be easier to setup than Wordpress. Requirements ------------ -Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required. +- aptitude or python-apt (required by apt tasks) +- python > 2.5 (required by ini_file tasks) +- Ansible >= 1.8.0 -Role Variables --------------- +This role is designed to work against a modern Ubuntu system. (Tested on Ubuntu 13.10 and 14.04) It should +theoretically work on older versions of Ubuntu or Debian based systems. -A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well. - -Dependencies ------------- - -A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles. - -Example Playbook ----------------- +Example Playbook (WIP) +---------------------- Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too: @@ -27,6 +23,22 @@ Including an example of how to use your role (for instance, with variables passe roles: - { role: username.rolename, x: 42 } +Role Variables (WIP) +-------------------- + +A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well. + +This role depends on the nginx_uwsgi_supervisor role, and hence reuses the variables provided by that role. See the +[Ansible Galaxy role page] (https://galaxy.ansible.com/list#/roles/2637) for details. + +Dependencies +------------ + +- nginx_uwsgi_supervisor + - Setup common NGINX, UWSGI and Supervisor infrastructure. + - Repository: https://bitbucket.org/dorianpula/ansible-nginx-uwsgi-supervisor + - Ansible Galaxy: https://galaxy.ansible.com/list#/roles/2637 + License ------- @@ -35,4 +47,16 @@ AGPL v3 Author Information ------------------ -An optional section for the role authors to include contact information, or a website (HTML is not allowed). +Dorian Pula + +- twitter: @dorianpula +- email: dorian.pula at amber-penguin.software.ca +- www: http://amber-penguin-software.ca + +This role is a spin-off of the technology developed for the [Rookeries project] (http://rookeries.org/) + + +Repositories +------------ + +- Main: https://bitbucket.org/dorianpula/ansible-rookeries