Add a README describing briefly how to use the jail role

Unsure whether this should go in the docs or the directory of the role. I opted for the latter thinking if someone wanted to learn how to use the role, they would be more likely to look in the role's directory.
buildbot · Dec 5, 2014 · 2f453df · 2f453df
1 parent 9f5cfcf
commit 2f453df
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 11 deletions.
diff --git a/jail.yml b/jail.yml
diff --git a/roles/jail/README.rst b/roles/jail/README.rst
@@ -0,0 +1,32 @@
+Jail Role
+=========
+
+The jail role requires four arguments to be used.
+
+``name``
+    The name to use for the jail. This is often the same as the hostname.
+
+``hostname``
+    The hostname of the jail.
+
+``jid``
+    The jail ID. This must be unique on the host.
+
+``ip_address``
+    A list of interface and IP address pairs. Each address in the list should be of the form `interface|ip`.
+
+
+Example playbook
+----------------
+
+::
+
+    ---
+    - name: Jail test
+      hosts: servicehosts
+      roles:
+        - role: jail
+          name: jailtest.buildbot.net
+          jid: 1
+          hostname: jailtest.buildbot.net
+          ip_address: ['vtnet0|192.168.8.49']