Config Option consistency for crypto.py

Fixed option descriptions by removing "Possible values" sections that
only duplicate the information in the option definition, as well as
"Related options" sections that do not contain any info.

Made minor fixes for the option description indentation.

Option registration consistency has been implemented prior to this
commit, so no further changes needed.

blueprint centralize-config-options-newton

Change-Id: Ie3546f8f3540f37bdce7e2d0a8d6b0f9c412a50e
This commit is contained in:
stewie925
2016-07-19 17:54:09 -07:00
committed by Michael Still
parent d8d7c9914a
commit 6f72b75ee6

View File

@@ -1,8 +1,5 @@
# needs:fix_opt_description
# needs:check_deprecation_status
# needs:check_opt_group_and_type
# needs:fix_opt_description_indentation
# needs:fix_opt_registration_consistency
# All Rights Reserved.
@@ -25,18 +22,16 @@ from oslo_config import cfg
from nova.conf import paths
crypto_opts_group = cfg.OptGroup(
"crypto",
title="Crypto Options")
crypto_opts_group = cfg.OptGroup("crypto",
title="Crypto Options")
crypto_opts = [
cfg.StrOpt(
"ca_file",
cfg.StrOpt("ca_file",
default="cacert.pem",
deprecated_group="DEFAULT",
help="""
Filename of root CA (Certificate Authority). This is a container format
and includes root certificates.
and includes root certificates.
* Possible values:
@@ -46,23 +41,17 @@ Filename of root CA (Certificate Authority). This is a container format
ca_path
"""),
cfg.StrOpt(
"key_file",
cfg.StrOpt("key_file",
default=os.path.join("private", "cakey.pem"),
deprecated_group="DEFAULT",
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",
cfg.StrOpt("crl_file",
default="crl.pem",
deprecated_group="DEFAULT",
help="""
@@ -70,61 +59,38 @@ 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",
cfg.StrOpt("keys_path",
default=paths.state_path_def("keys"),
deprecated_group="DEFAULT",
help="""
Directory path where keys are located.
* Possible values:
$state_path/keys is default.
* Related options:
key_file
"""),
cfg.StrOpt(
"ca_path",
cfg.StrOpt("ca_path",
default=paths.state_path_def("CA"),
deprecated_group="DEFAULT",
help="""
Directory path where root CA is located.
* Possible values:
$state_path/CA is default
* Related options:
ca_file
"""),
cfg.BoolOpt(
"use_project_ca",
cfg.BoolOpt("use_project_ca",
default=False,
deprecated_group="DEFAULT",
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",
cfg.StrOpt("user_cert_subject",
default="/C=US/ST=California/O=OpenStack/"
"OU=NovaDev/CN=%.16s-%.16s-%s",
deprecated_group="DEFAULT",
@@ -132,16 +98,8 @@ Option to enable/disable use of CA for each project.
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",
cfg.StrOpt("project_cert_subject",
default="/C=US/ST=California/O=OpenStack/"
"OU=NovaDev/CN=project-ca-%.16s-%s",
deprecated_group="DEFAULT",
@@ -149,13 +107,6 @@ project, user, timestamp
Subject for certificate for projects, %s for
project, timestamp
* Possible values:
Any subject for projects certificate.
* Related options:
None
"""),
]