common: document "cluster" variable usage

Fixes: https://bugzilla.redhat.com/show_bug.cgi?id=1408848

Signed-off-by: Sébastien Han <seb@redhat.com>
pull/1212/head
Sébastien Han 2017-01-02 09:20:43 +01:00
parent 7016ab73b3
commit b76d0aceca
2 changed files with 22 additions and 2 deletions

View File

@ -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 #

View File

@ -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 #