common: document "cluster" variable usage

Fixes: https://bugzilla.redhat.com/show_bug.cgi?id=1408848
Signed-off-by: Sébastien Han <seb@redhat.com>

diff --git a/group_vars/all.yml.sample b/group_vars/all.yml.sample
index c46a20a0aa54f70b3b8e1b475c908cea09f84ee0..31c0b7c7382a479442570421d80c6cca86f4723e 100644 (file)
--- a/group_vars/all.yml.sample
+++ b/group_vars/all.yml.sample
@@ -14,7 +14,17 @@ dummy:
 ###########
 
 #fetch_directory: fetch/
-#cluster: ceph # cluster name
+
+# The 'cluster' variable determines the name of the cluster.
+# Changing the default value to something else means that you will
+# need to change all the command line calls as well, for example if
+# your cluster name is 'foo':
+# "ceph health" will become "ceph --cluster foo health"
+#
+# An easier way to handle this is to use the environment variable CEPH_ARGS
+# So run: "export CEPH_ARGS="--cluster foo"
+# With that you will be able to run "ceph health" normally
+#cluster: ceph
 
 ###########
 # INSTALL #

diff --git a/roles/ceph-common/defaults/main.yml b/roles/ceph-common/defaults/main.yml
index b9970b8c66c91d6ed1cbca7d3743868da135c621..13ad0b39c59c0d1d2b5b8474c8fa820a3bf6566e 100644 (file)
--- a/roles/ceph-common/defaults/main.yml
+++ b/roles/ceph-common/defaults/main.yml
@@ -6,7 +6,17 @@
 ###########
 
 fetch_directory: fetch/
-cluster: ceph # cluster name
+
+# The 'cluster' variable determines the name of the cluster.
+# Changing the default value to something else means that you will
+# need to change all the command line calls as well, for example if
+# your cluster name is 'foo':
+# "ceph health" will become "ceph --cluster foo health"
+#
+# An easier way to handle this is to use the environment variable CEPH_ARGS
+# So run: "export CEPH_ARGS="--cluster foo"
+# With that you will be able to run "ceph health" normally
+cluster: ceph
 
 ###########
 # INSTALL #