From 52a616e1da4df8795d84d22ea8f8320faa03a502 Mon Sep 17 00:00:00 2001 From: Atsushi SAKAI Date: Wed, 14 Oct 2015 14:44:16 +0900 Subject: [PATCH] Update Config Reference for ceilometer Changes in default parameter os_auth_url os_password os_tenant_id Parameter description updates mainly ceilometer-logging.xml And changes from importing modules like oslo_messaging etc. Change-Id: I3e39760d1a82163e2c2c4aa54ef57b2146f55f21 --- doc/common/tables/ceilometer-auth.xml | 8 ++--- doc/common/tables/ceilometer-logging.xml | 24 ++++++++------ doc/common/tables/ceilometer-redis.xml | 22 +++++++------ doc/common/tables/ceilometer-rpc.xml | 32 ++++++++++++++----- doc/common/tables/ceilometer-zeromq.xml | 18 ++++++++--- .../ceilometer.flagmappings | 16 +++++++--- 6 files changed, 80 insertions(+), 40 deletions(-) diff --git a/doc/common/tables/ceilometer-auth.xml b/doc/common/tables/ceilometer-auth.xml index fbd6fdbbdd..2fb0e1c736 100644 --- a/doc/common/tables/ceilometer-auth.xml +++ b/doc/common/tables/ceilometer-auth.xml @@ -22,7 +22,7 @@ (BoolOpt) Disables X.509 certificate validation when an SSL connection to Identity Service is established. - = http://localhost:5000/v2.0 + = http://localhost:35357/v2.0 (StrOpt) Auth URL to use for OpenStack service access. @@ -34,7 +34,7 @@ (StrOpt) Type of endpoint in Identity service catalog to use for communication with OpenStack services. - = admin + = stack (StrOpt) Password to use for OpenStack service access. @@ -42,7 +42,7 @@ (StrOpt) Region name to use for OpenStack service endpoints. - = + = admin (StrOpt) Tenant ID to use for OpenStack service access. @@ -50,7 +50,7 @@ (StrOpt) Tenant name to use for OpenStack service access. - = ceilometer + = admin (StrOpt) User name to use for OpenStack service access. diff --git a/doc/common/tables/ceilometer-logging.xml b/doc/common/tables/ceilometer-logging.xml index 3049d2c787..82a36ca254 100644 --- a/doc/common/tables/ceilometer-logging.xml +++ b/doc/common/tables/ceilometer-logging.xml @@ -23,7 +23,7 @@ = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN - (ListOpt) List of logger=LEVEL pairs. + (ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set. = False @@ -39,23 +39,23 @@ = None - (StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. + (StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log_format). = %Y-%m-%d %H:%M:%S - (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . + (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. = None - (StrOpt) (Optional) The base directory used for relative --log-file paths. + (StrOpt) (Optional) The base directory used for relative --log-file paths. This option is ignored if log_config_append is set. = None - (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. + (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. This option is ignored if log_config_append is set. = None - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. + (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. This option is ignored if log_config_append is set. = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s @@ -79,24 +79,28 @@ = LOG_USER - (StrOpt) Syslog facility to receive log lines. + (StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set. = True - (BoolOpt) Log output to standard error. + (BoolOpt) Log output to standard error. This option is ignored if log_config_append is set. = False - (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. + (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. = True - (BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option. + (BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option. This option is ignored if log_config_append is set. = True (BoolOpt) If set to false, will disable INFO logging level, making WARNING the default. + + = False + (BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. + diff --git a/doc/common/tables/ceilometer-redis.xml b/doc/common/tables/ceilometer-redis.xml index ce7343952a..dd7a36f161 100644 --- a/doc/common/tables/ceilometer-redis.xml +++ b/doc/common/tables/ceilometer-redis.xml @@ -15,14 +15,10 @@ - [matchmaker_redis] + [DEFAULT] - = 127.0.0.1 - (StrOpt) Host to locate redis. - - - = None + = (StrOpt) Password for Redis server (optional). @@ -30,11 +26,19 @@ (IntOpt) Use this port to connect to redis host. - [matchmaker_ring] + [matchmaker_redis] - = /etc/oslo/matchmaker_ring.json - (StrOpt) Matchmaker ring file (JSON). + = 127.0.0.1 + (StrOpt) Host to locate redis. + + + = + (StrOpt) Password for Redis server (optional). + + + = 6379 + (IntOpt) Use this port to connect to redis host. diff --git a/doc/common/tables/ceilometer-rpc.xml b/doc/common/tables/ceilometer-rpc.xml index 308bbb6c57..ac99e11cad 100644 --- a/doc/common/tables/ceilometer-rpc.xml +++ b/doc/common/tables/ceilometer-rpc.xml @@ -21,14 +21,6 @@ = ['database'] (MultiStrOpt) Dispatcher to process data. - - = 300 - (IntOpt) Heartbeat frequency. - - - = 600 - (IntOpt) Heartbeat time-to-live. - = rabbit (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. @@ -41,6 +33,10 @@ = 30 (IntOpt) Size of RPC connection pool. + + = 1 + (IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. + = 60 (IntOpt) Seconds to wait for a response from a call. @@ -86,6 +82,22 @@ = 0 (IntOpt) Timeout for inactive connections (in seconds) + + = + (StrOpt) Password for message broker authentication + + + = + (StrOpt) Path to directory that contains the SASL configuration + + + = + (StrOpt) Name of configuration file (without .conf suffix) + + + = + (StrOpt) Space separated list of acceptable SASL mechanisms + = exclusive (StrOpt) address prefix used when sending to a specific server @@ -110,6 +122,10 @@ = False (BoolOpt) Debug: dump AMQP frames to stdout + + = + (StrOpt) User name for message broker authentication + [publisher] diff --git a/doc/common/tables/ceilometer-zeromq.xml b/doc/common/tables/ceilometer-zeromq.xml index e715ceaa0b..f774685d51 100644 --- a/doc/common/tables/ceilometer-zeromq.xml +++ b/doc/common/tables/ceilometer-zeromq.xml @@ -17,10 +17,18 @@ [DEFAULT] + + = True + (BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. + = * (StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. + + = eventlet + (StrOpt) Type of concurrency used. Either "native" or "eventlet" + = 1 (IntOpt) Number of ZeroMQ contexts, defaults to 1. @@ -34,17 +42,17 @@ (StrOpt) Directory for holding IPC sockets. - = local + = redis (StrOpt) MatchMaker driver. - - = 9501 - (IntOpt) ZeroMQ receiver listening port. - = None (IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. + + = True + (BoolOpt) Shows whether zmq-messaging uses broker or not. + diff --git a/tools/autogenerate-config-flagmappings/ceilometer.flagmappings b/tools/autogenerate-config-flagmappings/ceilometer.flagmappings index b0d035e260..5e06dc4142 100644 --- a/tools/autogenerate-config-flagmappings/ceilometer.flagmappings +++ b/tools/autogenerate-config-flagmappings/ceilometer.flagmappings @@ -35,18 +35,18 @@ logging_default_format_string logging logging_exception_prefix logging magnetodb_control_exchange magnetodb magnum_control_exchange exchange -matchmaker_heartbeat_freq rpc -matchmaker_heartbeat_ttl rpc memcached_servers common neutron_control_exchange exchange notification_driver amqp notification_topics amqp nova_control_exchange exchange nova_http_log_debug debug +password redis pipeline_cfg_file api pipeline_polling_interval api polling_namespaces common pollster_list common +port redis publish_errors logging refresh_event_pipeline_cfg api refresh_pipeline_cfg api @@ -58,13 +58,15 @@ rootwrap_config common rpc_backend rpc rpc_cast_timeout rpc rpc_conn_pool_size rpc +rpc_poll_timeout rpc rpc_response_timeout rpc +rpc_zmq_all_req_rep zeromq rpc_zmq_bind_address zeromq +rpc_zmq_concurrency zeromq rpc_zmq_contexts zeromq rpc_zmq_host zeromq rpc_zmq_ipc_dir zeromq rpc_zmq_matchmaker zeromq -rpc_zmq_port zeromq rpc_zmq_topic_backlog zeromq sahara_control_exchange exchange sample_source exchange @@ -78,7 +80,9 @@ use_stderr logging use_syslog logging use_syslog_rfc_format logging verbose logging +watch_log_file logging zaqar_control_exchange zaqar +zmq_use_broker zeromq alarm/alarm_max_actions alarm alarm/evaluation_interval alarm alarm/notifier_rpc_topic alarm @@ -209,7 +213,6 @@ keystone_authtoken/token_cache_time auth_token matchmaker_redis/host redis matchmaker_redis/password redis matchmaker_redis/port redis -matchmaker_ring/ringfile redis meter/meter_definitions_cfg_file common notification/ack_on_event_error events notification/disable_non_metric_meters notification @@ -225,12 +228,17 @@ oslo_messaging_amqp/broadcast_prefix rpc oslo_messaging_amqp/container_name rpc oslo_messaging_amqp/group_request_prefix rpc oslo_messaging_amqp/idle_timeout rpc +oslo_messaging_amqp/password rpc +oslo_messaging_amqp/sasl_config_dir rpc +oslo_messaging_amqp/sasl_config_name rpc +oslo_messaging_amqp/sasl_mechanisms rpc oslo_messaging_amqp/server_request_prefix rpc oslo_messaging_amqp/ssl_ca_file rpc oslo_messaging_amqp/ssl_cert_file rpc oslo_messaging_amqp/ssl_key_file rpc oslo_messaging_amqp/ssl_key_password rpc oslo_messaging_amqp/trace rpc +oslo_messaging_amqp/username rpc oslo_messaging_qpid/amqp_auto_delete qpid oslo_messaging_qpid/amqp_durable_queues qpid oslo_messaging_qpid/qpid_heartbeat qpid