From a3262591701d8be1b6a3704f2b919e874af208d7 Mon Sep 17 00:00:00 2001
From: Dharini Chandrasekar <dharini.chandrasekar@intel.com>
Date: Fri, 5 Aug 2016 16:22:08 +0000
Subject: [PATCH] Improving help text for Glance store Swift  opts.

Change-Id: I70aa0432d4fc625c3f79eabe1f94cf78e704cd25
Partial-Bug: #1570946
---
 glance_store/_drivers/swift/utils.py | 68 ++++++++++++++++++++++------
 1 file changed, 54 insertions(+), 14 deletions(-)

diff --git a/glance_store/_drivers/swift/utils.py b/glance_store/_drivers/swift/utils.py
index 97a36124..d1462749 100644
--- a/glance_store/_drivers/swift/utils.py
+++ b/glance_store/_drivers/swift/utils.py
@@ -25,37 +25,77 @@ from glance_store.i18n import _, _LE
 swift_opts = [
     cfg.StrOpt('default_swift_reference',
                default="ref1",
-               help=_('The reference to the default swift account/backing'
-                      ' store parameters to use for adding new images.')),
+               help=_("""
+Reference to default Swift account/backing store parameters.
+
+Provide a string value representing a reference to the default set
+of parameters required for using swift account/backing store for
+image storage. The default reference value for this configuration
+option is 'ref1'. This configuration option dereferences the
+parameters and facilitates image storage in Swift storage backend
+every time a new image is added.
+
+Possible values:
+    * A valid string value
+
+Related options:
+    * None
+
+""")),
     cfg.StrOpt('swift_store_auth_version', default='2',
                help=_('Version of the authentication service to use. '
                       'Valid versions are 2 and 3 for keystone and 1 '
                       '(deprecated) for swauth and rackspace.'),
                deprecated_for_removal=True,
-               deprecated_reason=_('Use "auth_version" in '
-                                   'swift_store_config_file.')),
+               deprecated_reason=_("""
+The option 'auth_version' in the Swift back-end configuration file is
+used instead.
+""")),
     cfg.StrOpt('swift_store_auth_address',
                help=_('The address where the Swift authentication '
                       'service is listening.'),
                deprecated_for_removal=True,
-               deprecated_reason=_('Use "auth_address" in '
-                                   'swift_store_config_file')),
+               deprecated_reason=_("""
+The option 'auth_address' in the Swift back-end configuration file is
+used instead.
+""")),
     cfg.StrOpt('swift_store_user', secret=True,
                help=_('The user to authenticate against the Swift '
                       'authentication service.'),
                deprecated_for_removal=True,
-               deprecated_reason=_('Use "user" in '
-                                   'swift_store_config_file.')),
+               deprecated_reason=_("""
+The option 'user' in the Swift back-end configuration file is set instead.
+""")),
     cfg.StrOpt('swift_store_key', secret=True,
                help=_('Auth key for the user authenticating against the '
                       'Swift authentication service.'),
                deprecated_for_removal=True,
-               deprecated_reason=_('Use "key" in '
-                                   'swift_store_config_file.')
-               ),
-    cfg.StrOpt('swift_store_config_file', secret=True,
-               help=_('The config file that has the swift account(s)'
-                      'configs.')),
+               deprecated_reason=_("""
+The option 'key' in the Swift back-end configuration file is used
+to set the authentication key instead.
+""")),
+    cfg.StrOpt('swift_store_config_file',
+               secret=True,
+               help=_("""
+Absolute path to the file containing the swift account(s)
+configurations.
+
+Include a string value representing the path to a configuration
+file that has references for each of the configured Swift
+account(s)/backing stores. By default, no file path is specified
+and customized Swift referencing is disabled. Configuring this
+option is highly recommended while using Swift storage backend for
+image storage as it avoids storage of credentials in the database.
+
+Possible values:
+    * None
+    * String value representing an absolute path on the glance-api
+      node
+
+Related options:
+    * None
+
+""")),
 ]
 
 _config_defaults = {'user_domain_id': 'default',