ceph-docker-common: adds a README file

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

diff --git a/roles/ceph-docker-common/README.md b/roles/ceph-docker-common/README.md
new file mode 100644 (file)
index 0000000..8283323
--- /dev/null
+++ b/roles/ceph-docker-common/README.md
@@ -0,0 +1,52 @@
+# Ansible role: Ceph Docker Common 
+
+This role contains variables and tasks common to
+all containerized deployments.
+
+# Requirements
+
+Nothing, it runs out of the box.
+
+# Role variables
+
+Have a look at: `defaults/main.yml`.
+
+## Mandatory variables
+
+None.
+
+# Dependencies
+
+None.
+
+# Example Playbook
+
+```
+- hosts: mons 
+  roles:
+     - { role: ceph.ceph-docker-common }
+```
+
+# Misc
+
+This role is a **mandatory** dependency for the following roles
+if you are doing a containerized deployment:
+
+* ceph-mon
+* ceph-osd
+* ceph-mds
+* ceph-rgw
+* ceph-restapi
+
+# Contribution
+
+**THIS REPOSITORY DOES NOT ACCEPT PULL REQUESTS**
+**PULL REQUESTS MUST GO THROUGH [CEPH-ANSIBLE](https://github.com/ceph/ceph-ansible)**
+
+# License
+
+Apache
+
+# Author Information
+
+This role was created by Andrew Schoen.