diff --git a/ceilometer/alarm/rpc.py b/ceilometer/alarm/rpc.py index b64dd925d..47acf2805 100644 --- a/ceilometer/alarm/rpc.py +++ b/ceilometer/alarm/rpc.py @@ -27,10 +27,11 @@ from ceilometer.storage import models OPTS = [ cfg.StrOpt('notifier_rpc_topic', 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', default='alarm_partition_coordination', - help='the topic ceilometer uses for alarm partition ' + help='The topic that ceilometer uses for alarm partition ' 'coordination messages'), ] diff --git a/ceilometer/collector.py b/ceilometer/collector.py index ee129f65e..ce663dd07 100644 --- a/ceilometer/collector.py +++ b/ceilometer/collector.py @@ -31,11 +31,11 @@ from ceilometer import service OPTS = [ cfg.StrOpt('udp_address', default='0.0.0.0', - help='address to bind the UDP socket to' - 'disabled if set to an empty string'), + help='Address to which the UDP socket is bound. Set to ' + 'an empty string to disable.'), cfg.IntOpt('udp_port', 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") diff --git a/ceilometer/compute/pollsters/util.py b/ceilometer/compute/pollsters/util.py index aa5d07046..6fb76fc12 100644 --- a/ceilometer/compute/pollsters/util.py +++ b/ceilometer/compute/pollsters/util.py @@ -38,10 +38,10 @@ INSTANCE_PROPERTIES = [ OPTS = [ cfg.ListOpt('reserved_metadata_namespace', 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', default=256, - help='limit on length of reserved metadata values'), + help='Limit on length of reserved metadata values'), ] cfg.CONF.register_opts(OPTS) diff --git a/ceilometer/publisher/rpc.py b/ceilometer/publisher/rpc.py index c260c42ad..e38889069 100644 --- a/ceilometer/publisher/rpc.py +++ b/ceilometer/publisher/rpc.py @@ -37,7 +37,7 @@ LOG = log.getLogger(__name__) METER_PUBLISH_OPTS = [ cfg.StrOpt('metering_topic', default='metering', - help='the topic ceilometer uses for metering messages', + help='The topic that ceilometer uses for metering messages', deprecated_group="DEFAULT", ), ] diff --git a/ceilometer/service.py b/ceilometer/service.py index a94f381ed..c08f480b5 100644 --- a/ceilometer/service.py +++ b/ceilometer/service.py @@ -34,15 +34,13 @@ from ceilometer.openstack.common import rpc OPTS = [ cfg.StrOpt('host', default=socket.gethostname(), - help='Name of this node. This can be an opaque identifier. ' - 'It is not necessarily a hostname, FQDN, or IP address. ' - 'However, the node name must be valid within ' - 'an AMQP key, and if using ZeroMQ, a valid ' - 'hostname, FQDN, or IP address'), + help='Name of this node, which must be valid in an AMQP ' + 'key. Can be an opaque identifier. For ZeroMQ only, must ' + 'be a valid host name, FQDN, or IP address.'), cfg.MultiStrOpt('dispatcher', deprecated_group="collector", default=['database'], - help='dispatcher to process data'), + help='Dispatcher to process data'), ] cfg.CONF.register_opts(OPTS) @@ -50,20 +48,20 @@ CLI_OPTIONS = [ cfg.StrOpt('os-username', deprecated_group="DEFAULT", 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', deprecated_group="DEFAULT", secret=True, 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', deprecated_group="DEFAULT", 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', deprecated_group="DEFAULT", 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', default=os.environ.get('OS_CACERT', None), help='Certificate chain for SSL validation'), @@ -71,19 +69,19 @@ CLI_OPTIONS = [ deprecated_group="DEFAULT", default=os.environ.get('OS_AUTH_URL', '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', deprecated_group="DEFAULT", 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', default=os.environ.get('OS_ENDPOINT_TYPE', 'publicURL'), help='Type of endpoint in Identity service catalog to use for ' 'communication with OpenStack services.'), cfg.BoolOpt('insecure', default=False, - help='Does not perform X.509 certificate validation when' - 'establishing SSL connection with identity service.'), + help='Disables X.509 certificate validation when an ' + 'SSL connection to Identity Service is established.'), ] cfg.CONF.register_cli_opts(CLI_OPTIONS, group="service_credentials") diff --git a/etc/ceilometer/ceilometer.conf.sample b/etc/ceilometer/ceilometer.conf.sample index f59cd7601..a82ce7641 100644 --- a/etc/ceilometer/ceilometer.conf.sample +++ b/etc/ceilometer/ceilometer.conf.sample @@ -32,13 +32,12 @@ # Options defined in ceilometer.service # -# Name of this node. This can be an opaque identifier. It is -# not necessarily a hostname, FQDN, or IP address. However, -# the node name must be valid within an AMQP key, and if using -# ZeroMQ, a valid hostname, FQDN, or IP address (string value) +# Name of this node, which must be valid in an AMQP key. Can +# be an opaque identifier. For ZeroMQ only, must be a valid +# host name, FQDN, or IP address. (string value) #host=ceilometer -# dispatcher to process data (multi valued) +# Dispatcher to process data (multi valued) #dispatcher=database @@ -66,11 +65,11 @@ # 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) #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 @@ -539,12 +538,12 @@ # 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) #notifier_rpc_topic=alarm_notifier -# the topic ceilometer uses for alarm partition coordination -# messages (string value) +# The topic that ceilometer uses for alarm partition +# coordination messages (string value) #partition_rpc_topic=alarm_partition_coordination @@ -590,11 +589,11 @@ # Options defined in ceilometer.collector # -# address to bind the UDP socket todisabled if set to an empty -# string (string value) +# Address to which the UDP socket is bound. Set to an empty +# string to disable. (string value) #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 @@ -901,7 +900,7 @@ # Options defined in ceilometer.publisher.rpc # -# the topic ceilometer uses for metering messages (string +# The topic that ceilometer uses for metering messages (string # value) #metering_topic=metering @@ -922,26 +921,26 @@ # 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 -# Password to use for openstack service access (string value) +# Password to use for OpenStack service access (string value) #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= -# Tenant name to use for openstack service access (string +# Tenant name to use for OpenStack service access (string # value) #os_tenant_name=admin # Certificate chain for SSL validation (string value) #os_cacert= -# 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 -# Region name to use for openstack service endpoints (string +# Region name to use for OpenStack service endpoints (string # value) #os_region_name= @@ -949,9 +948,8 @@ # communication with OpenStack services. (string value) #os_endpoint_type=publicURL -# Does not perform X.509 certificate validation -# whenestablishing SSL connection with identity service. -# (boolean value) +# Disables X.509 certificate validation when an SSL connection +# to Identity Service is established. (boolean value) #insecure=false