summaryrefslogtreecommitdiffstats
path: root/roles/openshift_storage_glusterfs/README.md
diff options
context:
space:
mode:
authorJose A. Rivera <jarrpa@redhat.com>2017-04-20 18:08:19 -0500
committerJose A. Rivera <jarrpa@redhat.com>2017-05-04 11:32:00 +0200
commit023e7d00b26b870b26c514a7893a9511fa9770d7 (patch)
treee7eee1ebf94289847c7763f6a6dfec6e24065052 /roles/openshift_storage_glusterfs/README.md
parentf958058cec4671bf463f25bbf13d3e74e11bb9e7 (diff)
downloadopenshift-023e7d00b26b870b26c514a7893a9511fa9770d7.tar.gz
openshift-023e7d00b26b870b26c514a7893a9511fa9770d7.tar.bz2
openshift-023e7d00b26b870b26c514a7893a9511fa9770d7.tar.xz
openshift-023e7d00b26b870b26c514a7893a9511fa9770d7.zip
GlusterFS: Improve role documentation
Signed-off-by: Jose A. Rivera <jarrpa@redhat.com>
Diffstat (limited to 'roles/openshift_storage_glusterfs/README.md')
-rw-r--r--roles/openshift_storage_glusterfs/README.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/roles/openshift_storage_glusterfs/README.md b/roles/openshift_storage_glusterfs/README.md
index cf0fb94c9..d60be0849 100644
--- a/roles/openshift_storage_glusterfs/README.md
+++ b/roles/openshift_storage_glusterfs/README.md
@@ -8,10 +8,18 @@ Requirements
* Ansible 2.2
+Host Groups
+-----------
+
+The following group is expected to be populated for this role to run:
+
+* `[glusterfs]`
+
Role Variables
--------------
-From this role:
+This role has the following variables that control the integration of a
+GlusterFS cluster into a new or existing OpenShift cluster:
| Name | Default value | |
|--------------------------------------------------|-------------------------|-----------------------------------------|
@@ -47,6 +55,7 @@ Example Playbook
hosts: oo_first_master
roles:
- role: openshift_storage_glusterfs
+ when: groups.oo_glusterfs_to_config | default([]) | count > 0
```
License