diff options
author | Itisha Dewan <ishadewan07@gmail.com> | 2016-07-19 12:01:34 +0530 |
---|---|---|
committer | Itisha Dewan <ishadewan07@gmail.com> | 2016-08-12 16:32:25 +0000 |
commit | fe58b4b0495241d06e4fddac28e2d41cdf8e6097 (patch) | |
tree | 21bbeb4979414bcbc5cd0f5ca7cd02a21de2ff73 | |
parent | c1ba85406e4f59ec27854e1e8bc5b2f98ff358d1 (diff) | |
download | glance_store-fe58b4b0495241d06e4fddac28e2d41cdf8e6097.tar.gz |
Improve the help text for Swift driver opts
Change-Id: If2c21a465b228155b6cfa372994e6d78a6d755c8
Partial-Bug: #1570946
-rw-r--r-- | glance_store/_drivers/swift/store.py | 76 |
1 files changed, 65 insertions, 11 deletions
diff --git a/glance_store/_drivers/swift/store.py b/glance_store/_drivers/swift/store.py index 01cc404..e9577b2 100644 --- a/glance_store/_drivers/swift/store.py +++ b/glance_store/_drivers/swift/store.py @@ -58,11 +58,38 @@ ONE_MB = units.k * units.Ki # Here we used the mixed meaning of MB _SWIFT_OPTS = [ cfg.BoolOpt('swift_store_auth_insecure', default=False, - help=_('If True, swiftclient won\'t check for a valid SSL ' - 'certificate when authenticating.')), + help=_(""" +Set verification of the server certificate. + +This boolean determines whether or not to verify the server +certificate. If this option is set to True, swiftclient won't check +for a valid SSL certificate when authenticating. If the option is set +to False, then the default CA truststore is used for verification. + +Possible values: + * True + * False + +Related options: + * swift_store_cacert + +""")), cfg.StrOpt('swift_store_cacert', - help=_('A string giving the CA certificate file to use in ' - 'SSL connections for verifying certs.')), + sample_default='/etc/ssl/certs/ca-certificates.crt', + help=_(""" +Path to the CA bundle file. + +This configuration option enables the operator to specify the path to +a custom Certificate Authority file for SSL verification when +connecting to Swift. + +Possible values: + * A valid path to a CA file + +Related options: + * swift_store_auth_insecure + +""")), cfg.StrOpt('swift_store_region', help=_('The region of the swift endpoint to be used for ' 'single tenant. This setting is only necessary if the ' @@ -72,10 +99,25 @@ _SWIFT_OPTS = [ 'None, the storage url from the auth response will be ' 'used.')), cfg.StrOpt('swift_store_endpoint_type', default='publicURL', - help=_('A string giving the endpoint type of the swift ' - 'service to use (publicURL, adminURL or internalURL). ' - 'This setting is only used if swift_store_auth_version ' - 'is 2.')), + choices=('publicURL', 'adminURL', 'internalURL'), + help=_(""" +Endpoint Type of Swift service. + +This string value indicates the endpoint type to use to fetch the +Swift endpoint. The endpoint type determines the actions the user will +be allowed to perform, for instance, reading and writing to the Store. +This setting is only used if swift_store_auth_version is greater than +1. + +Possible values: + * publicURL + * adminURL + * internalURL + +Related options: + * swift_store_endpoint + +""")), cfg.StrOpt('swift_store_service_type', default='object-store', help=_('A string giving the service type of the swift service ' 'to use. This setting is only used if ' @@ -247,9 +289,21 @@ Related options: """)), cfg.ListOpt('swift_store_admin_tenants', default=[], - help=_('A list of tenants that will be granted read/write ' - 'access on all Swift containers created by Glance in ' - 'multi-tenant mode.')), + help=_(""" +List of tenants that will be granted admin access. + +This is a list of tenants that will be granted read/write access on +all Swift containers created by Glance in multi-tenant mode. The +default value is an empty list. + +Possible values: + * A comma separated list of strings representing UUIDs of Keystone + projects/tenants + +Related options: + * None + +""")), cfg.BoolOpt('swift_store_ssl_compression', default=True, help=_('If set to False, disables SSL layer compression of ' 'https swift requests. Setting to False may improve ' |