packages: add a README file

Signed-off-by: Andrew Schoen <aschoen@redhat.com>

diff --git a/roles/packages/README.rst b/roles/packages/README.rst
new file mode 100644 (file)
index 0000000..dd7ea60
--- /dev/null
+++ b/roles/packages/README.rst
@@ -0,0 +1,34 @@
+Packages
+========
+
+This role is used to install and remove packages.
+
+Usage
++++++
+
+To install packages, use --extra-vars and pass in lists of packages you
+wish to install for both yum and apt based systems.
+
+For example::
+
+    ansible-playbook packages.yml --extra-vars='{"yum_packages": "foo", "apt_packages": ["foo", "bar"]}'
+
+To remove packages, use --extra-vars and pass in the list of packages you wish
+to remove while also including the ``cleanup`` variable.
+
+For example::
+
+    ansible-playbook packages.yml --extra-vars='{"yum_packages": "foo", "cleanup": true}'
+
+The following is an example of how you might accomplish this in a teuthology job::
+
+    tasks:
+    - ansible:
+        repo: https://github.com/ceph/ceph-cm-ansible.git
+        playbook: packages.yml
+        cleanup: true
+        vars:
+            yum_packages: "foo" 
+            apt_packages:
+                - "foo"
+                - "bar"