Merge "Improve help text of crypto.py"

nova/conf/crypto.py

@@ -24,57 +24,140 @@ import os
 from oslo_config import cfg
 
 from nova.conf import paths
-from nova.i18n import _
 
 crypto_opts_group = cfg.OptGroup(
-    'crypto',
+    "crypto",
-    title='Crypto Options')
+    title="Crypto Options")
 
 crypto_opts = [
     cfg.StrOpt(
-        'ca_file',
+        "ca_file",
-        default='cacert.pem',
+        default="cacert.pem",
-        deprecated_group='DEFAULT',
+        deprecated_group="DEFAULT",
-        help=_('Filename of root CA')),
+        help="""
+Filename of root CA (Certificate Authority). This is a container format
+ and includes root certificates.
+
+* Possible values:
+
+    Any file name containing root CA, cacert.pem is default
+
+* Related options:
+
+    ca_path
+"""),
     cfg.StrOpt(
-        'key_file',
+        "key_file",
-        default=os.path.join('private', 'cakey.pem'),
+        default=os.path.join("private", "cakey.pem"),
-        deprecated_group='DEFAULT',
+        deprecated_group="DEFAULT",
-        help=_('Filename of private key')),
+        help="""
+Filename of a private key.
+
+* Possible values:
+
+    Private key file name, private/cakey.pem is default
+
+* Related options:
+
+    keys_path
+"""),
     cfg.StrOpt(
-        'crl_file',
+        "crl_file",
-        default='crl.pem',
+        default="crl.pem",
-        deprecated_group='DEFAULT',
+        deprecated_group="DEFAULT",
-        help=_('Filename of root Certificate Revocation List')),
+        help="""
+Filename of root Certificate Revocation List (CRL). This is a list of
+certificates that have been revoked, and therefore, entities presenting
+those (revoked) certificates should no longer be trusted.
+
+* Possible values:
+
+    crl.pem is default
+
+* Related options:
+
+    ca_path
+"""),
     cfg.StrOpt(
-        'keys_path',
+        "keys_path",
-        default=paths.state_path_def('keys'),
+        default=paths.state_path_def("keys"),
-        deprecated_group='DEFAULT',
+        deprecated_group="DEFAULT",
-        help=_('Where we keep our keys')),
+        help="""
+Directory path where keys are located.
+
+* Possible values:
+
+    $state_path/keys is default.
+
+* Related options:
+
+    key_file
+"""),
     cfg.StrOpt(
-        'ca_path',
+        "ca_path",
-        default=paths.state_path_def('CA'),
+        default=paths.state_path_def("CA"),
-        deprecated_group='DEFAULT',
+        deprecated_group="DEFAULT",
-        help=_('Where we keep our root CA')),
+        help="""
+Directory path where root CA is located.
+
+* Possible values:
+
+    $state_path/CA is default
+
+* Related options:
+
+    ca_file
+"""),
     cfg.BoolOpt(
-        'use_project_ca',
+        "use_project_ca",
         default=False,
-        deprecated_group='DEFAULT',
+        deprecated_group="DEFAULT",
-        help=_('Should we use a CA for each project?')),
+        help="""
+Option to enable/disable use of CA for each project.
+
+* Possible values:
+
+    True, False is default
+
+* Related options:
+
+    None
+"""),
     cfg.StrOpt(
-        'user_cert_subject',
+        "user_cert_subject",
-        default='/C=US/ST=California/O=OpenStack/'
+        default="/C=US/ST=California/O=OpenStack/"
-                'OU=NovaDev/CN=%.16s-%.16s-%s',
+                "OU=NovaDev/CN=%.16s-%.16s-%s",
-        deprecated_group='DEFAULT',
+        deprecated_group="DEFAULT",
-        help=_('Subject for certificate for users, %s for '
+        help="""
-               'project, user, timestamp')),
+Subject for certificate for users, %s for
+project, user, timestamp
+
+* Possible values:
+
+    Any subject for users certificate.
+
+* Related options:
+
+    None
+"""),
     cfg.StrOpt(
-        'project_cert_subject',
+        "project_cert_subject",
-        default='/C=US/ST=California/O=OpenStack/'
+        default="/C=US/ST=California/O=OpenStack/"
-                'OU=NovaDev/CN=project-ca-%.16s-%s',
+                "OU=NovaDev/CN=project-ca-%.16s-%s",
-        deprecated_group='DEFAULT',
+        deprecated_group="DEFAULT",
-        help=_('Subject for certificate for projects, %s for '
+        help="""
-               'project, timestamp'))]
+Subject for certificate for projects, %s for
+project, timestamp
+
+* Possible values:
+
+    Any subject for projects certificate.
+
+* Related options:
+
+    None
+"""),
+]
 
 
 def register_opts(conf):