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

@@ -22,7 +22,7 @@
         <td>(BoolOpt) Disables X.509 certificate validation when an SSL connection to Identity Service is established.</td>
       </tr>
       <tr>
-        <td><option>os_auth_url</option> = <replaceable>http://localhost:5000/v2.0</replaceable></td>
+        <td><option>os_auth_url</option> = <replaceable>http://localhost:35357/v2.0</replaceable></td>
         <td>(StrOpt) Auth URL to use for OpenStack service access.</td>
       </tr>
       <tr>
@@ -34,7 +34,7 @@
         <td>(StrOpt) Type of endpoint in Identity service catalog to use for communication with OpenStack services.</td>
       </tr>
       <tr>
-        <td><option>os_password</option> = <replaceable>admin</replaceable></td>
+        <td><option>os_password</option> = <replaceable>stack</replaceable></td>
         <td>(StrOpt) Password to use for OpenStack service access.</td>
       </tr>
       <tr>
@@ -42,7 +42,7 @@
         <td>(StrOpt) Region name to use for OpenStack service endpoints.</td>
       </tr>
       <tr>
-        <td><option>os_tenant_id</option> = <replaceable></replaceable></td>
+        <td><option>os_tenant_id</option> = <replaceable>admin</replaceable></td>
         <td>(StrOpt) Tenant ID to use for OpenStack service access.</td>
       </tr>
       <tr>
@@ -50,7 +50,7 @@
         <td>(StrOpt) Tenant name to use for OpenStack service access.</td>
       </tr>
       <tr>
-        <td><option>os_username</option> = <replaceable>ceilometer</replaceable></td>
+        <td><option>os_username</option> = <replaceable>admin</replaceable></td>
         <td>(StrOpt) User name to use for OpenStack service access.</td>
       </tr>
     </tbody>

doc/common/tables/ceilometer-logging.xml

@@ -23,7 +23,7 @@
       </tr>
       <tr>
         <td><option>default_log_levels</option> = <replaceable>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</replaceable></td>
-        <td>(ListOpt) List of logger=LEVEL pairs.</td>
+        <td>(ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set.</td>
       </tr>
       <tr>
         <td><option>fatal_deprecations</option> = <replaceable>False</replaceable></td>
@@ -39,23 +39,23 @@
       </tr>
       <tr>
         <td><option>log_config_append</option> = <replaceable>None</replaceable></td>
-        <td>(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.</td>
+        <td>(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).</td>
       </tr>
       <tr>
         <td><option>log_date_format</option> = <replaceable>%Y-%m-%d %H:%M:%S</replaceable></td>
-        <td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .</td>
+        <td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set.</td>
       </tr>
       <tr>
         <td><option>log_dir</option> = <replaceable>None</replaceable></td>
-        <td>(StrOpt) (Optional) The base directory used for relative --log-file paths.</td>
+        <td>(StrOpt) (Optional) The base directory used for relative --log-file paths. This option is ignored if log_config_append is set.</td>
       </tr>
       <tr>
         <td><option>log_file</option> = <replaceable>None</replaceable></td>
-        <td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
+        <td>(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.</td>
       </tr>
       <tr>
         <td><option>log_format</option> = <replaceable>None</replaceable></td>
-        <td>(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.</td>
+        <td>(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.</td>
       </tr>
       <tr>
         <td><option>logging_context_format_string</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</replaceable></td>
@@ -79,24 +79,28 @@
       </tr>
       <tr>
         <td><option>syslog_log_facility</option> = <replaceable>LOG_USER</replaceable></td>
-        <td>(StrOpt) Syslog facility to receive log lines.</td>
+        <td>(StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set.</td>
       </tr>
       <tr>
         <td><option>use_stderr</option> = <replaceable>True</replaceable></td>
-        <td>(BoolOpt) Log output to standard error.</td>
+        <td>(BoolOpt) Log output to standard error. This option is ignored if log_config_append is set.</td>
       </tr>
       <tr>
         <td><option>use_syslog</option> = <replaceable>False</replaceable></td>
-        <td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424.</td>
+        <td>(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.</td>
       </tr>
       <tr>
         <td><option>use_syslog_rfc_format</option> = <replaceable>True</replaceable></td>
-        <td>(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.</td>
+        <td>(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.</td>
       </tr>
       <tr>
         <td><option>verbose</option> = <replaceable>True</replaceable></td>
         <td>(BoolOpt) If set to false, will disable INFO logging level, making WARNING the default.</td>
       </tr>
+      <tr>
+        <td><option>watch_log_file</option> = <replaceable>False</replaceable></td>
+        <td>(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.</td>
+      </tr>
     </tbody>
   </table>
 </para>

doc/common/tables/ceilometer-redis.xml

@@ -15,14 +15,10 @@
     </thead>
     <tbody>
       <tr>
-        <th colspan="2">[matchmaker_redis]</th>
+        <th colspan="2">[DEFAULT]</th>
       </tr>
       <tr>
-        <td><option>host</option> = <replaceable>127.0.0.1</replaceable></td>
+        <td><option>password</option> = <replaceable></replaceable></td>
-        <td>(StrOpt) Host to locate redis.</td>
-      </tr>
-      <tr>
-        <td><option>password</option> = <replaceable>None</replaceable></td>
         <td>(StrOpt) Password for Redis server (optional).</td>
       </tr>
       <tr>
@@ -30,11 +26,19 @@
         <td>(IntOpt) Use this port to connect to redis host.</td>
       </tr>
       <tr>
-        <th colspan="2">[matchmaker_ring]</th>
+        <th colspan="2">[matchmaker_redis]</th>
       </tr>
       <tr>
-        <td><option>ringfile</option> = <replaceable>/etc/oslo/matchmaker_ring.json</replaceable></td>
+        <td><option>host</option> = <replaceable>127.0.0.1</replaceable></td>
-        <td>(StrOpt) Matchmaker ring file (JSON).</td>
+        <td>(StrOpt) Host to locate redis.</td>
+      </tr>
+      <tr>
+        <td><option>password</option> = <replaceable></replaceable></td>
+        <td>(StrOpt) Password for Redis server (optional).</td>
+      </tr>
+      <tr>
+        <td><option>port</option> = <replaceable>6379</replaceable></td>
+        <td>(IntOpt) Use this port to connect to redis host.</td>
       </tr>
     </tbody>
   </table>

doc/common/tables/ceilometer-rpc.xml

@@ -21,14 +21,6 @@
         <td><option>dispatcher</option> = <replaceable>['database']</replaceable></td>
         <td>(MultiStrOpt) Dispatcher to process data.</td>
       </tr>
-      <tr>
-        <td><option>matchmaker_heartbeat_freq</option> = <replaceable>300</replaceable></td>
-        <td>(IntOpt) Heartbeat frequency.</td>
-      </tr>
-      <tr>
-        <td><option>matchmaker_heartbeat_ttl</option> = <replaceable>600</replaceable></td>
-        <td>(IntOpt) Heartbeat time-to-live.</td>
-      </tr>
       <tr>
         <td><option>rpc_backend</option> = <replaceable>rabbit</replaceable></td>
         <td>(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.</td>
@@ -41,6 +33,10 @@
         <td><option>rpc_conn_pool_size</option> = <replaceable>30</replaceable></td>
         <td>(IntOpt) Size of RPC connection pool.</td>
       </tr>
+      <tr>
+        <td><option>rpc_poll_timeout</option> = <replaceable>1</replaceable></td>
+        <td>(IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired.</td>
+      </tr>
       <tr>
         <td><option>rpc_response_timeout</option> = <replaceable>60</replaceable></td>
         <td>(IntOpt) Seconds to wait for a response from a call.</td>
@@ -86,6 +82,22 @@
         <td><option>idle_timeout</option> = <replaceable>0</replaceable></td>
         <td>(IntOpt) Timeout for inactive connections (in seconds)</td>
       </tr>
+      <tr>
+        <td><option>password</option> = <replaceable></replaceable></td>
+        <td>(StrOpt) Password for message broker authentication</td>
+      </tr>
+      <tr>
+        <td><option>sasl_config_dir</option> = <replaceable></replaceable></td>
+        <td>(StrOpt) Path to directory that contains the SASL configuration</td>
+      </tr>
+      <tr>
+        <td><option>sasl_config_name</option> = <replaceable></replaceable></td>
+        <td>(StrOpt) Name of configuration file (without .conf suffix)</td>
+      </tr>
+      <tr>
+        <td><option>sasl_mechanisms</option> = <replaceable></replaceable></td>
+        <td>(StrOpt) Space separated list of acceptable SASL mechanisms</td>
+      </tr>
       <tr>
         <td><option>server_request_prefix</option> = <replaceable>exclusive</replaceable></td>
         <td>(StrOpt) address prefix used when sending to a specific server</td>
@@ -110,6 +122,10 @@
         <td><option>trace</option> = <replaceable>False</replaceable></td>
         <td>(BoolOpt) Debug: dump AMQP frames to stdout</td>
       </tr>
+      <tr>
+        <td><option>username</option> = <replaceable></replaceable></td>
+        <td>(StrOpt) User name for message broker authentication</td>
+      </tr>
       <tr>
         <th colspan="2">[publisher]</th>
       </tr>

doc/common/tables/ceilometer-zeromq.xml

@@ -17,10 +17,18 @@
       <tr>
         <th colspan="2">[DEFAULT]</th>
       </tr>
+      <tr>
+        <td><option>rpc_zmq_all_req_rep</option> = <replaceable>True</replaceable></td>
+        <td>(BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT.</td>
+      </tr>
       <tr>
         <td><option>rpc_zmq_bind_address</option> = <replaceable>*</replaceable></td>
         <td>(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.</td>
       </tr>
+      <tr>
+        <td><option>rpc_zmq_concurrency</option> = <replaceable>eventlet</replaceable></td>
+        <td>(StrOpt) Type of concurrency used. Either "native" or "eventlet"</td>
+      </tr>
       <tr>
         <td><option>rpc_zmq_contexts</option> = <replaceable>1</replaceable></td>
         <td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
@@ -34,17 +42,17 @@
         <td>(StrOpt) Directory for holding IPC sockets.</td>
       </tr>
       <tr>
-        <td><option>rpc_zmq_matchmaker</option> = <replaceable>local</replaceable></td>
+        <td><option>rpc_zmq_matchmaker</option> = <replaceable>redis</replaceable></td>
         <td>(StrOpt) MatchMaker driver.</td>
       </tr>
-      <tr>
-        <td><option>rpc_zmq_port</option> = <replaceable>9501</replaceable></td>
-        <td>(IntOpt) ZeroMQ receiver listening port.</td>
-      </tr>
       <tr>
         <td><option>rpc_zmq_topic_backlog</option> = <replaceable>None</replaceable></td>
         <td>(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.</td>
       </tr>
+      <tr>
+        <td><option>zmq_use_broker</option> = <replaceable>True</replaceable></td>
+        <td>(BoolOpt) Shows whether zmq-messaging uses broker or not.</td>
+      </tr>
     </tbody>
   </table>
 </para>

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