openstack/aodh
Code Issues Proposed changes

Improve consistency of help strings

Browse Source 
Fixes include rework of text, missing or extra spaces, wrong
capitalization and no sentence style capitalization.

Co-Authored-By: Diane Fleming <diane.fleming@rackspace.com>
Change-Id: I480a8f1816b0698a10165318fe25b4f58e8d2700
This commit is contained in:
Andreas Jaeger 2014-01-18 16:53:50 +01:00
parent 2d8e6d9264
commit 45ba5d2f61
6 changed files with 42 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
ceilometer/alarm/rpc.py
View File

@ -27,10 +27,11 @@ from ceilometer.storage import models
OPTS = [ OPTS = [
cfg.StrOpt('notifier_rpc_topic', cfg.StrOpt('notifier_rpc_topic',
default='alarm_notifier', default='alarm_notifier',
help='the topic ceilometer uses for alarm notifier messages'), help='The topic that ceilometer uses for alarm notifier '
'messages'),
cfg.StrOpt('partition_rpc_topic', cfg.StrOpt('partition_rpc_topic',
default='alarm_partition_coordination', default='alarm_partition_coordination',
help='the topic ceilometer uses for alarm partition ' help='The topic that ceilometer uses for alarm partition '
'coordination messages'), 'coordination messages'),
] ]

6
ceilometer/collector.py
View File

@ -31,11 +31,11 @@ from ceilometer import service
OPTS = [ OPTS = [
cfg.StrOpt('udp_address', cfg.StrOpt('udp_address',
default='0.0.0.0', default='0.0.0.0',
help='address to bind the UDP socket to' help='Address to which the UDP socket is bound. Set to '
'disabled if set to an empty string'), 'an empty string to disable.'),
cfg.IntOpt('udp_port', cfg.IntOpt('udp_port',
default=4952, default=4952,
help='port to bind the UDP socket to'), help='Port to which the UDP socket is bound'),
] ]
cfg.CONF.register_opts(OPTS, group="collector") cfg.CONF.register_opts(OPTS, group="collector")

4
ceilometer/compute/pollsters/util.py
View File

@ -38,10 +38,10 @@ INSTANCE_PROPERTIES = [
OPTS = [ OPTS = [
cfg.ListOpt('reserved_metadata_namespace', cfg.ListOpt('reserved_metadata_namespace',
default=['metering.'], default=['metering.'],
help='list of metadata prefixes reserved for metering use'), help='List of metadata prefixes reserved for metering use'),
cfg.IntOpt('reserved_metadata_length', cfg.IntOpt('reserved_metadata_length',
default=256, default=256,
help='limit on length of reserved metadata values'), help='Limit on length of reserved metadata values'),
] ]
cfg.CONF.register_opts(OPTS) cfg.CONF.register_opts(OPTS)

2
ceilometer/publisher/rpc.py
View File

@ -37,7 +37,7 @@ LOG = log.getLogger(__name__)
METER_PUBLISH_OPTS = [ METER_PUBLISH_OPTS = [
cfg.StrOpt('metering_topic', cfg.StrOpt('metering_topic',
default='metering', default='metering',
help='the topic ceilometer uses for metering messages', help='The topic that ceilometer uses for metering messages',
deprecated_group="DEFAULT", deprecated_group="DEFAULT",
), ),
] ]

26
ceilometer/service.py
View File

@ -34,15 +34,13 @@ from ceilometer.openstack.common import rpc
OPTS = [ OPTS = [
cfg.StrOpt('host', cfg.StrOpt('host',
default=socket.gethostname(), default=socket.gethostname(),
help='Name of this node. This can be an opaque identifier. ' help='Name of this node, which must be valid in an AMQP '
'It is not necessarily a hostname, FQDN, or IP address. ' 'key. Can be an opaque identifier. For ZeroMQ only, must '
'However, the node name must be valid within ' 'be a valid host name, FQDN, or IP address.'),
'an AMQP key, and if using ZeroMQ, a valid '
'hostname, FQDN, or IP address'),
cfg.MultiStrOpt('dispatcher', cfg.MultiStrOpt('dispatcher',
deprecated_group="collector", deprecated_group="collector",
default=['database'], default=['database'],
help='dispatcher to process data'), help='Dispatcher to process data'),
] ]
cfg.CONF.register_opts(OPTS) cfg.CONF.register_opts(OPTS)
@ -50,20 +48,20 @@ CLI_OPTIONS = [
cfg.StrOpt('os-username', cfg.StrOpt('os-username',
deprecated_group="DEFAULT", deprecated_group="DEFAULT",
default=os.environ.get('OS_USERNAME', 'ceilometer'), default=os.environ.get('OS_USERNAME', 'ceilometer'),
help='Username to use for openstack service access'), help='User name to use for OpenStack service access'),
cfg.StrOpt('os-password', cfg.StrOpt('os-password',
deprecated_group="DEFAULT", deprecated_group="DEFAULT",
secret=True, secret=True,
default=os.environ.get('OS_PASSWORD', 'admin'), default=os.environ.get('OS_PASSWORD', 'admin'),
help='Password to use for openstack service access'), help='Password to use for OpenStack service access'),
cfg.StrOpt('os-tenant-id', cfg.StrOpt('os-tenant-id',
deprecated_group="DEFAULT", deprecated_group="DEFAULT",
default=os.environ.get('OS_TENANT_ID', ''), default=os.environ.get('OS_TENANT_ID', ''),
help='Tenant ID to use for openstack service access'), help='Tenant ID to use for OpenStack service access'),
cfg.StrOpt('os-tenant-name', cfg.StrOpt('os-tenant-name',
deprecated_group="DEFAULT", deprecated_group="DEFAULT",
default=os.environ.get('OS_TENANT_NAME', 'admin'), default=os.environ.get('OS_TENANT_NAME', 'admin'),
help='Tenant name to use for openstack service access'), help='Tenant name to use for OpenStack service access'),
cfg.StrOpt('os-cacert', cfg.StrOpt('os-cacert',
default=os.environ.get('OS_CACERT', None), default=os.environ.get('OS_CACERT', None),
help='Certificate chain for SSL validation'), help='Certificate chain for SSL validation'),
@ -71,19 +69,19 @@ CLI_OPTIONS = [
deprecated_group="DEFAULT", deprecated_group="DEFAULT",
default=os.environ.get('OS_AUTH_URL', default=os.environ.get('OS_AUTH_URL',
'http://localhost:5000/v2.0'), 'http://localhost:5000/v2.0'),
help='Auth URL to use for openstack service access'), help='Auth URL to use for OpenStack service access'),
cfg.StrOpt('os-region-name', cfg.StrOpt('os-region-name',
deprecated_group="DEFAULT", deprecated_group="DEFAULT",
default=os.environ.get('OS_REGION_NAME', None), default=os.environ.get('OS_REGION_NAME', None),
help='Region name to use for openstack service endpoints'), help='Region name to use for OpenStack service endpoints'),
cfg.StrOpt('os-endpoint-type', cfg.StrOpt('os-endpoint-type',
default=os.environ.get('OS_ENDPOINT_TYPE', 'publicURL'), default=os.environ.get('OS_ENDPOINT_TYPE', 'publicURL'),
help='Type of endpoint in Identity service catalog to use for ' help='Type of endpoint in Identity service catalog to use for '
'communication with OpenStack services.'), 'communication with OpenStack services.'),
cfg.BoolOpt('insecure', cfg.BoolOpt('insecure',
default=False, default=False,
help='Does not perform X.509 certificate validation when' help='Disables X.509 certificate validation when an '
'establishing SSL connection with identity service.'), 'SSL connection to Identity Service is established.'),
] ]
cfg.CONF.register_cli_opts(CLI_OPTIONS, group="service_credentials") cfg.CONF.register_cli_opts(CLI_OPTIONS, group="service_credentials")

44
etc/ceilometer/ceilometer.conf.sample
View File

@ -32,13 +32,12 @@
# Options defined in ceilometer.service # Options defined in ceilometer.service
# #
# Name of this node. This can be an opaque identifier. It is # Name of this node, which must be valid in an AMQP key. Can
# not necessarily a hostname, FQDN, or IP address. However, # be an opaque identifier. For ZeroMQ only, must be a valid
# the node name must be valid within an AMQP key, and if using # host name, FQDN, or IP address. (string value)
# ZeroMQ, a valid hostname, FQDN, or IP address (string value)
#host=ceilometer #host=ceilometer
# dispatcher to process data (multi valued) # Dispatcher to process data (multi valued)
#dispatcher=database #dispatcher=database
@ -66,11 +65,11 @@
# Options defined in ceilometer.compute.pollsters.util # Options defined in ceilometer.compute.pollsters.util
# #
# list of metadata prefixes reserved for metering use (list # List of metadata prefixes reserved for metering use (list
# value) # value)
#reserved_metadata_namespace=metering. #reserved_metadata_namespace=metering.
# limit on length of reserved metadata values (integer value) # Limit on length of reserved metadata values (integer value)
#reserved_metadata_length=256 #reserved_metadata_length=256
@ -539,12 +538,12 @@
# Options defined in ceilometer.alarm.rpc # Options defined in ceilometer.alarm.rpc
# #
# the topic ceilometer uses for alarm notifier messages # The topic that ceilometer uses for alarm notifier messages
# (string value) # (string value)
#notifier_rpc_topic=alarm_notifier #notifier_rpc_topic=alarm_notifier
# the topic ceilometer uses for alarm partition coordination # The topic that ceilometer uses for alarm partition
# messages (string value) # coordination messages (string value)
#partition_rpc_topic=alarm_partition_coordination #partition_rpc_topic=alarm_partition_coordination
@ -590,11 +589,11 @@
# Options defined in ceilometer.collector # Options defined in ceilometer.collector
# #
# address to bind the UDP socket todisabled if set to an empty # Address to which the UDP socket is bound. Set to an empty
# string (string value) # string to disable. (string value)
#udp_address=0.0.0.0 #udp_address=0.0.0.0
# port to bind the UDP socket to (integer value) # Port to which the UDP socket is bound (integer value)
#udp_port=4952 #udp_port=4952
@ -901,7 +900,7 @@
# Options defined in ceilometer.publisher.rpc # Options defined in ceilometer.publisher.rpc
# #
# the topic ceilometer uses for metering messages (string # The topic that ceilometer uses for metering messages (string
# value) # value)
#metering_topic=metering #metering_topic=metering
@ -922,26 +921,26 @@
# Options defined in ceilometer.service # Options defined in ceilometer.service
# #
# Username to use for openstack service access (string value) # User name to use for OpenStack service access (string value)
#os_username=ceilometer #os_username=ceilometer
# Password to use for openstack service access (string value) # Password to use for OpenStack service access (string value)
#os_password=admin #os_password=admin
# Tenant ID to use for openstack service access (string value) # Tenant ID to use for OpenStack service access (string value)
#os_tenant_id= #os_tenant_id=
# Tenant name to use for openstack service access (string # Tenant name to use for OpenStack service access (string
# value) # value)
#os_tenant_name=admin #os_tenant_name=admin
# Certificate chain for SSL validation (string value) # Certificate chain for SSL validation (string value)
#os_cacert=<None> #os_cacert=<None>
# Auth URL to use for openstack service access (string value) # Auth URL to use for OpenStack service access (string value)
#os_auth_url=http://localhost:5000/v2.0 #os_auth_url=http://localhost:5000/v2.0
# Region name to use for openstack service endpoints (string # Region name to use for OpenStack service endpoints (string
# value) # value)
#os_region_name=<None> #os_region_name=<None>
@ -949,9 +948,8 @@
# communication with OpenStack services. (string value) # communication with OpenStack services. (string value)
#os_endpoint_type=publicURL #os_endpoint_type=publicURL
# Does not perform X.509 certificate validation # Disables X.509 certificate validation when an SSL connection
# whenestablishing SSL connection with identity service. # to Identity Service is established. (boolean value)
# (boolean value)
#insecure=false #insecure=false