Expand the description of extra_capabilities

The existing description of extra_capabilities was a bit terse,
meaning deployers couldn't easily gauge the power of this option.
This patch expands the textual description using information from
the blueprint and original commit message, so it can be picked
up automatically by the documentation.

Change-Id: Iac2b6d8a3ce4875a8c1d9874dd7f0e4cf7c435c0
Closes-Bug: 1288044
This commit is contained in:
Tom Fifield 2014-12-24 23:38:32 +09:00
parent c89875d1dc
commit a2a1123247
1 changed files with 7 additions and 1 deletions

View File

@ -91,7 +91,13 @@ volume_manager_opts = [
cfg.StrOpt('extra_capabilities', cfg.StrOpt('extra_capabilities',
default='{}', default='{}',
help='User defined capabilities, a JSON formatted string ' help='User defined capabilities, a JSON formatted string '
'specifying key/value pairs.'), 'specifying key/value pairs. The key/value pairs can '
'be used by the CapabilitiesFilter to select between '
'backends when requests specify volume types. For '
'example, specifying a service level or the geographical '
'location of a backend, then creating a volume type to '
'allow the user to select by these different '
'properties.'),
] ]
CONF = cfg.CONF CONF = cfg.CONF