openstack/deb-heat
Code Issues Proposed changes

Improve help strings

Browse Source 
Follow oslo.config style guide for help strings better to create
consistent help strings:
* Capitalize first word of each help string
* Finish help strings with "."
* Improve wording
* Add missing space between strings

Change-Id: Ia86734d44fdf4eb3711fef800fe6bdfd1a1b59d4
This commit is contained in:
Andreas Jaeger 2014-02-08 13:00:26 +01:00
parent 7091633f74
commit fb538071f6
9 changed files with 133 additions and 120 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
contrib/rackspace/clients.py
View File

@ -42,7 +42,7 @@ except ImportError:
cloud_opts = [
cfg.StrOpt('region_name',
default=None,
help=_('Region for connecting to services'))
help=_('Region for connecting to services.'))
]
cfg.CONF.register_opts(cloud_opts)

164
etc/heat/heat.conf.sample
View File

@ -14,23 +14,25 @@
# Options defined in heat.common.config
#
# The default user for new instances (string value)
# The default user for new instances. (string value)
#instance_user=ec2-user
# Driver to use for controlling instances (string value)
# Driver to use for controlling instances. (string value)
#instance_driver=heat.engine.nova
# List of directories to search for Plugins (list value)
# List of directories to search for plug-ins. (list value)
#plugin_dirs=/usr/lib64/heat,/usr/lib/heat
# The directory to search for environment files (string value)
# The directory to search for environment files. (string
# value)
#environment_dir=/etc/heat/environment.d
# Select deferred auth method, stored password or trusts
# Select deferred auth method, stored password or trusts.
# (string value)
#deferred_auth_method=password
# Subset of trustor roles to be delegated to heat (list value)
# Subset of trustor roles to be delegated to heat. (list
# value)
#trusts_delegated_roles=heat_stack_owner
# Maximum resources allowed per top-level stack. (integer
@ -56,35 +58,36 @@
# stack locking. (integer value)
#engine_life_check_timeout=2
# Name of the engine node. This can be an opaque identifier.It
# is not necessarily a hostname, FQDN, or IP address. (string
# value)
# Name of the engine node. This can be an opaque identifier.
# It is not necessarily a hostname, FQDN, or IP address.
# (string value)
#host=heat
# seconds between running periodic tasks (integer value)
# Seconds between running periodic tasks. (integer value)
#periodic_interval=60
# URL of the Heat metadata server (string value)
# URL of the Heat metadata server. (string value)
#heat_metadata_server_url=
# URL of the Heat waitcondition server (string value)
# URL of the Heat waitcondition server. (string value)
#heat_waitcondition_server_url=
# URL of the Heat cloudwatch server (string value)
# URL of the Heat CloudWatch server. (string value)
#heat_watch_server_url=
# Instance connection to cfn/cw API via https (string value)
# Instance connection to CFN/CW API via https. (string value)
#instance_connection_is_secure=0
# Instance connection to cfn/cw API validate certs if ssl
# (string value)
# Instance connection to CFN/CW API validate certs if SSL is
# used. (string value)
#instance_connection_https_validate_certificates=1
# Default region name used to get services endpoints (string
# Default region name used to get services endpoints. (string
# value)
#region_name_for_services=<None>
# Keystone role for heat template-defined users (string value)
# Keystone role for heat template-defined users. (string
# value)
#heat_stack_user_role=heat_stack_user
# Keystone domain which contains heat template-defined users.
@ -103,7 +106,7 @@
# Options defined in heat.common.crypt
#
# Encryption key used for authentication info in database
# Encryption key used for authentication info in database.
# (string value)
#auth_encryption_key=notgood but just long enough i think
@ -121,7 +124,7 @@
# Options defined in heat.db.api
#
# The backend to use for db (string value)
# The backend to use for db. (string value)
#db_backend=sqlalchemy
@ -138,7 +141,7 @@
# Options defined in heat.engine.resources.loadbalancer
#
# Custom template for the built-in loadbalancer nested stack
# Custom template for the built-in loadbalancer nested stack.
# (string value)
#loadbalancer_template=<None>
@ -506,7 +509,7 @@
# Options defined in heat.common.config
#
# Allow orchestration of multiple clouds (boolean value)
# Allow orchestration of multiple clouds. (boolean value)
#multi_cloud=false
# Allowed keystone endpoints for auth_uri when multi_cloud is
@ -525,18 +528,19 @@
# communication with the OpenStack service. (string value)
#endpoint_type=publicURL
# Optional CA cert file to use in SSL connections (string
# Optional CA cert file to use in SSL connections. (string
# value)
#ca_file=<None>
# Optional PEM-formatted certificate chain file (string value)
# Optional PEM-formatted certificate chain file. (string
# value)
#cert_file=<None>
# Optional PEM-formatted file that contains the private key
# Optional PEM-formatted file that contains the private key.
# (string value)
#key_file=<None>
# If set then the server's certificate will not be verified
# If set, then the server's certificate will not be verified.
# (boolean value)
#insecure=false
@ -551,18 +555,19 @@
# communication with the OpenStack service. (string value)
#endpoint_type=publicURL
# Optional CA cert file to use in SSL connections (string
# Optional CA cert file to use in SSL connections. (string
# value)
#ca_file=<None>
# Optional PEM-formatted certificate chain file (string value)
# Optional PEM-formatted certificate chain file. (string
# value)
#cert_file=<None>
# Optional PEM-formatted file that contains the private key
# Optional PEM-formatted file that contains the private key.
# (string value)
#key_file=<None>
# If set then the server's certificate will not be verified
# If set, then the server's certificate will not be verified.
# (boolean value)
#insecure=false
@ -577,18 +582,19 @@
# communication with the OpenStack service. (string value)
#endpoint_type=publicURL
# Optional CA cert file to use in SSL connections (string
# Optional CA cert file to use in SSL connections. (string
# value)
#ca_file=<None>
# Optional PEM-formatted certificate chain file (string value)
# Optional PEM-formatted certificate chain file. (string
# value)
#cert_file=<None>
# Optional PEM-formatted file that contains the private key
# Optional PEM-formatted file that contains the private key.
# (string value)
#key_file=<None>
# If set then the server's certificate will not be verified
# If set, then the server's certificate will not be verified.
# (boolean value)
#insecure=false
@ -603,18 +609,19 @@
# communication with the OpenStack service. (string value)
#endpoint_type=publicURL
# Optional CA cert file to use in SSL connections (string
# Optional CA cert file to use in SSL connections. (string
# value)
#ca_file=<None>
# Optional PEM-formatted certificate chain file (string value)
# Optional PEM-formatted certificate chain file. (string
# value)
#cert_file=<None>
# Optional PEM-formatted file that contains the private key
# Optional PEM-formatted file that contains the private key.
# (string value)
#key_file=<None>
# If set then the server's certificate will not be verified
# If set, then the server's certificate will not be verified.
# (boolean value)
#insecure=false
@ -633,18 +640,19 @@
# communication with the OpenStack service. (string value)
#endpoint_type=publicURL
# Optional CA cert file to use in SSL connections (string
# Optional CA cert file to use in SSL connections. (string
# value)
#ca_file=<None>
# Optional PEM-formatted certificate chain file (string value)
# Optional PEM-formatted certificate chain file. (string
# value)
#cert_file=<None>
# Optional PEM-formatted file that contains the private key
# Optional PEM-formatted file that contains the private key.
# (string value)
#key_file=<None>
# If set then the server's certificate will not be verified
# If set, then the server's certificate will not be verified.
# (boolean value)
#insecure=false
@ -659,18 +667,19 @@
# communication with the OpenStack service. (string value)
#endpoint_type=publicURL
# Optional CA cert file to use in SSL connections (string
# Optional CA cert file to use in SSL connections. (string
# value)
#ca_file=<None>
# Optional PEM-formatted certificate chain file (string value)
# Optional PEM-formatted certificate chain file. (string
# value)
#cert_file=<None>
# Optional PEM-formatted file that contains the private key
# Optional PEM-formatted file that contains the private key.
# (string value)
#key_file=<None>
# If set then the server's certificate will not be verified
# If set, then the server's certificate will not be verified.
# (boolean value)
#insecure=false
@ -685,18 +694,19 @@
# communication with the OpenStack service. (string value)
#endpoint_type=publicURL
# Optional CA cert file to use in SSL connections (string
# Optional CA cert file to use in SSL connections. (string
# value)
#ca_file=<None>
# Optional PEM-formatted certificate chain file (string value)
# Optional PEM-formatted certificate chain file. (string
# value)
#cert_file=<None>
# Optional PEM-formatted file that contains the private key
# Optional PEM-formatted file that contains the private key.
# (string value)
#key_file=<None>
# If set then the server's certificate will not be verified
# If set, then the server's certificate will not be verified.
# (boolean value)
#insecure=false
@ -711,18 +721,19 @@
# communication with the OpenStack service. (string value)
#endpoint_type=publicURL
# Optional CA cert file to use in SSL connections (string
# Optional CA cert file to use in SSL connections. (string
# value)
#ca_file=<None>
# Optional PEM-formatted certificate chain file (string value)
# Optional PEM-formatted certificate chain file. (string
# value)
#cert_file=<None>
# Optional PEM-formatted file that contains the private key
# Optional PEM-formatted file that contains the private key.
# (string value)
#key_file=<None>
# If set then the server's certificate will not be verified
# If set, then the server's certificate will not be verified.
# (boolean value)
#insecure=false
@ -737,18 +748,19 @@
# communication with the OpenStack service. (string value)
#endpoint_type=publicURL
# Optional CA cert file to use in SSL connections (string
# Optional CA cert file to use in SSL connections. (string
# value)
#ca_file=<None>
# Optional PEM-formatted certificate chain file (string value)
# Optional PEM-formatted certificate chain file. (string
# value)
#cert_file=<None>
# Optional PEM-formatted file that contains the private key
# Optional PEM-formatted file that contains the private key.
# (string value)
#key_file=<None>
# If set then the server's certificate will not be verified
# If set, then the server's certificate will not be verified.
# (boolean value)
#insecure=false
@ -838,10 +850,10 @@
# Options defined in heat.api.aws.ec2token
#
# Authentication Endpoint URI (string value)
# Authentication Endpoint URI. (string value)
#auth_uri=<None>
# Allow orchestration of multiple clouds (boolean value)
# Allow orchestration of multiple clouds. (boolean value)
#multi_cloud=false
# Allowed keystone endpoints for auth_uri when multi_cloud is
@ -863,19 +875,19 @@
# The port on which the server will listen. (integer value)
#bind_port=8004
# Number of backlog requests to configure the socket with
# Number of backlog requests to configure the socket with.
# (integer value)
#backlog=4096
# Location of the SSL Certificate File to use for SSL mode
# Location of the SSL Certificate File to use for SSL mode.
# (string value)
#cert_file=<None>
# Location of the SSL Key File to use for enabling SSL mode
# Location of the SSL Key File to use for enabling SSL mode.
# (string value)
#key_file=<None>
# Number of workers for Heat service (integer value)
# Number of workers for Heat service. (integer value)
#workers=0
@ -892,19 +904,19 @@
# The port on which the server will listen. (integer value)
#bind_port=8000
# Number of backlog requests to configure the socket with
# Number of backlog requests to configure the socket with.
# (integer value)
#backlog=4096
# Location of the SSL Certificate File to use for SSL mode
# Location of the SSL Certificate File to use for SSL mode.
# (string value)
#cert_file=<None>
# Location of the SSL Key File to use for enabling SSL mode
# Location of the SSL Key File to use for enabling SSL mode.
# (string value)
#key_file=<None>
# Number of workers for Heat service (integer value)
# Number of workers for Heat service. (integer value)
#workers=0
@ -921,19 +933,19 @@
# The port on which the server will listen. (integer value)
#bind_port=8003
# Number of backlog requests to configure the socket with
# Number of backlog requests to configure the socket with.
# (integer value)
#backlog=4096
# Location of the SSL Certificate File to use for SSL mode
# Location of the SSL Certificate File to use for SSL mode.
# (string value)
#cert_file=<None>
# Location of the SSL Key File to use for enabling SSL mode
# Location of the SSL Key File to use for enabling SSL mode.
# (string value)
#key_file=<None>
# Number of workers for Heat service (integer value)
# Number of workers for Heat service. (integer value)
#workers=0
@ -1101,10 +1113,10 @@
# Options defined in heat.common.config
#
# The flavor to use (string value)
# The flavor to use. (string value)
#flavor=<None>
# The API paste config file to use (string value)
# The API paste config file to use. (string value)
#api_paste_config=api-paste.ini
@ -1115,8 +1127,8 @@
#
# Heat build revision. If you would prefer to manage your
# build revision separately you can move this section to a
# different file and add it as another config option (string
# build revision separately, you can move this section to a
# different file and add it as another config option. (string
# value)
#heat_revision=unknown

4
heat/api/aws/ec2token.py
View File

@ -38,10 +38,10 @@ logger = logging.getLogger(__name__)
opts = [
cfg.StrOpt('auth_uri',
default=None,
help=_("Authentication Endpoint URI")),
help=_("Authentication Endpoint URI.")),
cfg.BoolOpt('multi_cloud',
default=False,
help=_('Allow orchestration of multiple clouds')),
help=_('Allow orchestration of multiple clouds.')),
cfg.ListOpt('allowed_auth_uris',
default=[],
help=_('Allowed keystone endpoints for auth_uri when '

2
heat/cmd/manage.py
View File

@ -71,7 +71,7 @@ def add_command_parsers(subparsers):
command_opt = cfg.SubCommandOpt('command',
title='Commands',
help='Available commands',
help='Show available commands.',
handler=add_command_parsers)

51
heat/common/config.py
View File

@ -34,36 +34,37 @@ DEFAULT_PORT = 8000
paste_deploy_group = cfg.OptGroup('paste_deploy')
paste_deploy_opts = [
cfg.StrOpt('flavor',
help=_("The flavor to use")),
help=_("The flavor to use.")),
cfg.StrOpt('api_paste_config', default="api-paste.ini",
help=_("The API paste config file to use"))]
help=_("The API paste config file to use."))]
service_opts = [
cfg.IntOpt('periodic_interval',
default=60,
help='seconds between running periodic tasks'),
help='Seconds between running periodic tasks.'),
cfg.StrOpt('heat_metadata_server_url',
default="",
help='URL of the Heat metadata server'),
help='URL of the Heat metadata server.'),
cfg.StrOpt('heat_waitcondition_server_url',
default="",
help='URL of the Heat waitcondition server'),
help='URL of the Heat waitcondition server.'),
cfg.StrOpt('heat_watch_server_url',
default="",
help='URL of the Heat cloudwatch server'),
help='URL of the Heat CloudWatch server.'),
cfg.StrOpt('instance_connection_is_secure',
default="0",
help='Instance connection to cfn/cw API via https'),
help='Instance connection to CFN/CW API via https.'),
cfg.StrOpt('instance_connection_https_validate_certificates',
default="1",
help='Instance connection to cfn/cw API validate certs if ssl'),
help='Instance connection to CFN/CW API validate certs if SSL '
'is used.'),
cfg.StrOpt('region_name_for_services',
default=None,
help='Default region name used to get services endpoints'),
help='Default region name used to get services endpoints.'),
cfg.StrOpt('heat_stack_user_role',
default="heat_stack_user",
help='Keystone role for heat template-defined users'),
help='Keystone role for heat template-defined users.'),
cfg.StrOpt('stack_user_domain',
default='heat',
help='Keystone domain which contains heat template-defined '
@ -78,24 +79,24 @@ service_opts = [
engine_opts = [
cfg.StrOpt('instance_user',
default='ec2-user',
help='The default user for new instances'),
help='The default user for new instances.'),
cfg.StrOpt('instance_driver',
default='heat.engine.nova',
help='Driver to use for controlling instances'),
help='Driver to use for controlling instances.'),
cfg.ListOpt('plugin_dirs',
default=['/usr/lib64/heat', '/usr/lib/heat'],
help='List of directories to search for Plugins'),
help='List of directories to search for plug-ins.'),
cfg.StrOpt('environment_dir',
default='/etc/heat/environment.d',
help='The directory to search for environment files'),
help='The directory to search for environment files.'),
cfg.StrOpt('deferred_auth_method',
choices=['password', 'trusts'],
default='password',
help=_('Select deferred auth method, '
'stored password or trusts')),
'stored password or trusts.')),
cfg.ListOpt('trusts_delegated_roles',
default=['heat_stack_owner'],
help=_('Subset of trustor roles to be delegated to heat')),
help=_('Subset of trustor roles to be delegated to heat.')),
cfg.IntOpt('max_resources_per_stack',
default=1000,
help='Maximum resources allowed per top-level stack.'),
@ -123,14 +124,14 @@ rpc_opts = [
cfg.StrOpt('host',
default=socket.gethostname(),
help='Name of the engine node. '
'This can be an opaque identifier.'
'This can be an opaque identifier. '
'It is not necessarily a hostname, FQDN, or IP address.')]
auth_password_group = cfg.OptGroup('auth_password')
auth_password_opts = [
cfg.BoolOpt('multi_cloud',
default=False,
help=_('Allow orchestration of multiple clouds')),
help=_('Allow orchestration of multiple clouds.')),
cfg.ListOpt('allowed_auth_uris',
default=[],
help=_('Allowed keystone endpoints for auth_uri when '
@ -143,16 +144,16 @@ clients_opts = [
'Type of endpoint in Identity service catalog to use '
'for communication with the OpenStack service.')),
cfg.StrOpt('ca_file',
help=_('Optional CA cert file to use in SSL connections')),
help=_('Optional CA cert file to use in SSL connections.')),
cfg.StrOpt('cert_file',
help=_('Optional PEM-formatted certificate chain file')),
help=_('Optional PEM-formatted certificate chain file.')),
cfg.StrOpt('key_file',
help=_('Optional PEM-formatted file that contains the '
'private key')),
'private key.')),
cfg.BoolOpt('insecure',
default=False,
help=_("If set then the server's certificate will not "
"be verified"))]
help=_("If set, then the server's certificate will not "
"be verified."))]
def register_clients_opts():
@ -178,8 +179,8 @@ revision_opts = [
default='unknown',
help=_('Heat build revision. '
'If you would prefer to manage your build revision '
'separately you can move this section to a different '
'file and add it as another config option'))]
'separately, you can move this section to a different '
'file and add it as another config option.'))]
cfg.CONF.register_opts(engine_opts)
cfg.CONF.register_opts(service_opts)

2
heat/common/crypt.py
View File

@ -24,7 +24,7 @@ from heat.openstack.common import log as logging
auth_opts = [
cfg.StrOpt('auth_encryption_key',
default='notgood but just long enough i think',
help="Encryption key used for authentication info in database")
help="Encryption key used for authentication info in database.")
]
cfg.CONF.register_opts(auth_opts)

24
heat/common/wsgi.py
View File

@ -60,18 +60,18 @@ api_opts = [
deprecated_group='DEFAULT'),
cfg.IntOpt('backlog', default=4096,
help=_("Number of backlog requests "
"to configure the socket with"),
"to configure the socket with."),
deprecated_group='DEFAULT'),
cfg.StrOpt('cert_file', default=None,
help=_("Location of the SSL Certificate File "
"to use for SSL mode"),
"to use for SSL mode."),
deprecated_group='DEFAULT'),
cfg.StrOpt('key_file', default=None,
help=_("Location of the SSL Key File to use "
"for enabling SSL mode"),
"for enabling SSL mode."),
deprecated_group='DEFAULT'),
cfg.IntOpt('workers', default=0,
help=_("Number of workers for Heat service"),
help=_("Number of workers for Heat service."),
deprecated_group='DEFAULT'),
]
api_group = cfg.OptGroup('heat_api')
@ -89,18 +89,18 @@ api_cfn_opts = [
deprecated_group='DEFAULT'),
cfg.IntOpt('backlog', default=4096,
help=_("Number of backlog requests "
"to configure the socket with"),
"to configure the socket with."),
deprecated_group='DEFAULT'),
cfg.StrOpt('cert_file', default=None,
help=_("Location of the SSL Certificate File "
"to use for SSL mode"),
"to use for SSL mode."),
deprecated_group='DEFAULT'),
cfg.StrOpt('key_file', default=None,
help=_("Location of the SSL Key File to use "
"for enabling SSL mode"),
"for enabling SSL mode."),
deprecated_group='DEFAULT'),
cfg.IntOpt('workers', default=0,
help=_("Number of workers for Heat service"),
help=_("Number of workers for Heat service."),
deprecated_group='DEFAULT'),
]
api_cfn_group = cfg.OptGroup('heat_api_cfn')
@ -118,18 +118,18 @@ api_cw_opts = [
deprecated_group='DEFAULT'),
cfg.IntOpt('backlog', default=4096,
help=_("Number of backlog requests "
"to configure the socket with"),
"to configure the socket with."),
deprecated_group='DEFAULT'),
cfg.StrOpt('cert_file', default=None,
help=_("Location of the SSL Certificate File "
"to use for SSL mode"),
"to use for SSL mode."),
deprecated_group='DEFAULT'),
cfg.StrOpt('key_file', default=None,
help=_("Location of the SSL Key File to use "
"for enabling SSL mode"),
"for enabling SSL mode."),
deprecated_group='DEFAULT'),
cfg.IntOpt('workers', default=0,
help=_("Number of workers for Heat service"),
help=_("Number of workers for Heat service."),
deprecated_group='DEFAULT'),
]
api_cw_group = cfg.OptGroup('heat_api_cloudwatch')

2
heat/db/api.py
View File

@ -33,7 +33,7 @@ from heat.openstack.common.db import api as db_api
db_opts = [
cfg.StrOpt('db_backend',
default='sqlalchemy',
help='The backend to use for db')]
help='The backend to use for db.')]
CONF = cfg.CONF
CONF.register_opts(db_opts)

2
heat/engine/resources/loadbalancer.py
View File

@ -201,7 +201,7 @@ loadbalancer_opts = [
cfg.StrOpt('loadbalancer_template',
default=None,
help='Custom template for the built-in '
'loadbalancer nested stack')]
'loadbalancer nested stack.')]
cfg.CONF.register_opts(loadbalancer_opts)