openstack/openstack-manuals
Code Issues Proposed changes

Update Config Reference for ceilometer

Browse Source 
* collector: remove deprecated RPC code: https://review.openstack.org/#/c/227923/
* verify gnocchi connection before processing: https://review.openstack.org/253635
* Use keystoneauth1 instead of manual setup: https://review.openstack.org/237537
* dispatcher: remove deprecated CADF code in HTTP: https://review.openstack.org/227914
* Remove eventlet usage: https://review.openstack.org/240953
* Remove alarming code: https://review.openstack.org/197161

Change-Id: I49b90e2ec04eb826e610fabb1f484cccdf2c5c5d
This commit is contained in:
ZhiQiang Fan 2015-12-17 01:59:31 -07:00
parent 7819581415
commit f72cc60015
35 changed files with 163 additions and 279 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
doc/common/tables/ceilometer-alarm.xml
View File

@ -1,80 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_alarm">
<caption>Description of alarm configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[alarm]</th>
</tr>
<tr>
<td><option>alarm_max_actions</option> = <replaceable>-1</replaceable></td>
<td>(IntOpt) Maximum count of actions for each state of an alarm, non-positive number means no limit.</td>
</tr>
<tr>
<td><option>evaluation_interval</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Period of evaluation cycle, should be &gt;= than configured pipeline interval for collection of underlying meters.</td>
</tr>
<tr>
<td><option>notifier_rpc_topic</option> = <replaceable>alarm_notifier</replaceable></td>
<td>(StrOpt) The topic that ceilometer uses for alarm notifier messages.</td>
</tr>
<tr>
<td><option>project_alarm_quota</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Maximum number of alarms defined for a project.</td>
</tr>
<tr>
<td><option>record_history</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Record alarm change events.</td>
</tr>
<tr>
<td><option>rest_notifier_certificate_file</option> = <replaceable></replaceable></td>
<td>(StrOpt) SSL Client certificate for REST notifier.</td>
</tr>
<tr>
<td><option>rest_notifier_certificate_key</option> = <replaceable></replaceable></td>
<td>(StrOpt) SSL Client private key for REST notifier.</td>
</tr>
<tr>
<td><option>rest_notifier_max_retries</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Number of retries for REST notifier</td>
</tr>
<tr>
<td><option>rest_notifier_ssl_verify</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Whether to verify the SSL Server certificate when calling alarm action.</td>
</tr>
<tr>
<td><option>user_alarm_quota</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Maximum number of alarms defined for a user.</td>
</tr>
</tbody>
</table>
</para>

4
doc/common/tables/ceilometer-amqp.xml
View File

@ -47,6 +47,10 @@
<td><option>notification_topics</option> = <replaceable>notifications</replaceable></td>
<td>(ListOpt) AMQP topic used for OpenStack notifications.</td>
</tr>
<tr>
<td><option>notification_transport_url</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC.</td>
</tr>
<tr>
<td><option>transport_url</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.</td>

4
doc/common/tables/ceilometer-api.xml
View File

@ -100,7 +100,7 @@
</tr>
<tr>
<td><option>port</option> = <replaceable>8777</replaceable></td>
<td>(IntOpt) The port for the ceilometer API server.</td>
<td>(PortOpt) The port for the ceilometer API server.</td>
</tr>
<tr>
<td><option>workers</option> = <replaceable>1</replaceable></td>
@ -111,7 +111,7 @@
</tr>
<tr>
<td><option>max_request_body_size</option> = <replaceable>114688</replaceable></td>
<td>(IntOpt) The maximum body size for each request, in bytes.</td>
<td>(IntOpt) The maximum body size for each request, in bytes.</td>
</tr>
<tr>
<td><option>secure_proxy_ssl_header</option> = <replaceable>X-Forwarded-Proto</replaceable></td>

46
doc/common/tables/ceilometer-auth.xml
View File

@ -35,41 +35,41 @@
<tr>
<th colspan="2">[service_credentials]</th>
</tr>
<tr>
<td><option>auth_section</option> = <replaceable>None</replaceable></td>
<td>(Opt) Config Section from which to load plugin specific options</td>
</tr>
<tr>
<td><option>auth_type</option> = <replaceable>None</replaceable></td>
<td>(Opt) Authentication type to load</td>
</tr>
<tr>
<td><option>cafile</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections.</td>
</tr>
<tr>
<td><option>certfile</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) PEM encoded client certificate cert file</td>
</tr>
<tr>
<td><option>insecure</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Disables X.509 certificate validation when an SSL connection to Identity Service is established.</td>
<td>(BoolOpt) Verify HTTPS connections.</td>
</tr>
<tr>
<td><option>os_auth_url</option> = <replaceable>http://localhost:5000/v2.0</replaceable></td>
<td>(StrOpt) Auth URL to use for OpenStack service access.</td>
</tr>
<tr>
<td><option>os_cacert</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Certificate chain for SSL validation.</td>
</tr>
<tr>
<td><option>os_endpoint_type</option> = <replaceable>publicURL</replaceable></td>
<td><option>interface</option> = <replaceable>public</replaceable></td>
<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>(StrOpt) Password to use for OpenStack service access.</td>
<td><option>keyfile</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) PEM encoded client certificate key file</td>
</tr>
<tr>
<td><option>os_region_name</option> = <replaceable>None</replaceable></td>
<td><option>region_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Region name to use for OpenStack service endpoints.</td>
</tr>
<tr>
<td><option>os_tenant_id</option> = <replaceable></replaceable></td>
<td>(StrOpt) Tenant ID to use for OpenStack service access.</td>
</tr>
<tr>
<td><option>os_tenant_name</option> = <replaceable>admin</replaceable></td>
<td>(StrOpt) Tenant name to use for OpenStack service access.</td>
</tr>
<tr>
<td><option>os_username</option> = <replaceable>ceilometer</replaceable></td>
<td>(StrOpt) User name to use for OpenStack service access.</td>
<td><option>timeout</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Timeout value for http requests</td>
</tr>
</tbody>
</table>

12
doc/common/tables/ceilometer-auth_token.xml
View File

@ -59,10 +59,6 @@
<td><option>auth_host</option> = <replaceable>127.0.0.1</replaceable></td>
<td>(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.</td>
</tr>
<tr>
<td><option>auth_plugin</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Name of the plugin to load</td>
</tr>
<tr>
<td><option>auth_port</option> = <replaceable>35357</replaceable></td>
<td>(IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri.</td>
@ -73,7 +69,11 @@
</tr>
<tr>
<td><option>auth_section</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Config Section from which to load plugin specific options</td>
<td>(Opt) Config Section from which to load plugin specific options</td>
</tr>
<tr>
<td><option>auth_type</option> = <replaceable>None</replaceable></td>
<td>(Opt) Authentication type to load</td>
</tr>
<tr>
<td><option>auth_uri</option> = <replaceable>None</replaceable></td>
@ -161,7 +161,7 @@
</tr>
<tr>
<td><option>memcache_security_strategy</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
<td>(StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
</tr>
<tr>
<td><option>memcache_use_advanced_pool</option> = <replaceable>False</replaceable></td>

6
doc/common/tables/ceilometer-collector.xml
View File

@ -35,10 +35,6 @@
<tr>
<th colspan="2">[collector]</th>
</tr>
<tr>
<td><option>enable_rpc</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable the RPC functionality of collector. This functionality is now deprecated in favour of notifier publisher and queues.</td>
</tr>
<tr>
<td><option>requeue_event_on_dispatcher_error</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Requeue the event on the collector event queue when the collector fails to dispatch it.</td>
@ -53,7 +49,7 @@
</tr>
<tr>
<td><option>udp_port</option> = <replaceable>4952</replaceable></td>
<td>(IntOpt) Port to which the UDP socket is bound.</td>
<td>(PortOpt) Port to which the UDP socket is bound.</td>
</tr>
<tr>
<td><option>workers</option> = <replaceable>1</replaceable></td>

4
doc/common/tables/ceilometer-cors.xml
View File

@ -49,7 +49,7 @@
</tr>
<tr>
<td><option>allowed_origin</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.</td>
<td>(ListOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.</td>
</tr>
<tr>
<td><option>expose_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>
@ -76,7 +76,7 @@
</tr>
<tr>
<td><option>allowed_origin</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.</td>
<td>(ListOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.</td>
</tr>
<tr>
<td><option>expose_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>

12
doc/common/tables/ceilometer-database.xml
View File

@ -42,14 +42,6 @@
<tr>
<th colspan="2">[database]</th>
</tr>
<tr>
<td><option>alarm_connection</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The connection string used to connect to the alarm database. (if unset, connection is used)</td>
</tr>
<tr>
<td><option>alarm_history_time_to_live</option> = <replaceable>-1</replaceable></td>
<td>(IntOpt) Number of seconds that alarm histories are kept in the database for (&lt;= 0 means forever).</td>
</tr>
<tr>
<td><option>backend</option> = <replaceable>sqlalchemy</replaceable></td>
<td>(StrOpt) The back end to use for the database.</td>
@ -122,10 +114,6 @@
<td><option>min_pool_size</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Minimum number of SQL connections to keep open in a pool.</td>
</tr>
<tr>
<td><option>mongodb_replica_set</option> = <replaceable></replaceable></td>
<td>(StrOpt) The name of the replica set which is used to connect to MongoDB database. Add "?replicaSet=myreplicatset" in your connection URI instead.</td>
</tr>
<tr>
<td><option>mysql_sql_mode</option> = <replaceable>TRADITIONAL</replaceable></td>
<td>(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=</td>

2
doc/common/tables/ceilometer-debug.xml
View File

@ -37,7 +37,7 @@
</tr>
<tr>
<td><option>nova_http_log_debug</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Allow novaclient's debug log output.</td>
<td>(BoolOpt) Allow novaclient's debug log output. (Use default_log_levels instead)</td>
</tr>
</tbody>
</table>

10
doc/common/tables/ceilometer-dispatcher_gnocchi.xml
View File

@ -36,13 +36,9 @@
<th colspan="2">[dispatcher_gnocchi]</th>
</tr>
<tr>
<td><option>archive_policy</option> = <replaceable>low</replaceable></td>
<td><option>archive_policy</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The archive policy to use when the dispatcher create a new metric.</td>
</tr>
<tr>
<td><option>archive_policy_file</option> = <replaceable>gnocchi_archive_policy_map.yaml</replaceable></td>
<td>(StrOpt) The Yaml file that defines per metric archive policies.</td>
</tr>
<tr>
<td><option>filter_project</option> = <replaceable>gnocchi</replaceable></td>
<td>(StrOpt) Gnocchi project used to filter out samples generated by Gnocchi service activity</td>
@ -56,8 +52,8 @@
<td>(StrOpt) The Yaml file that defines mapping between samples and gnocchi resources/metrics</td>
</tr>
<tr>
<td><option>url</option> = <replaceable>http://localhost:8041</replaceable></td>
<td>(StrOpt) URL to Gnocchi.</td>
<td><option>url</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) URL to Gnocchi. default: autodetection</td>
</tr>
</tbody>
</table>

4
doc/common/tables/ceilometer-dispatcher_http.xml
View File

@ -35,10 +35,6 @@
<tr>
<th colspan="2">[dispatcher_http]</th>
</tr>
<tr>
<td><option>cadf_only</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) The flag that indicates if only cadf message should be posted. If false, all meters will be posted. This is deprecated in favor of keystonemiddleware's audit middleware functionality</td>
</tr>
<tr>
<td><option>event_target</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The target for event data where the http request will be sent to. If this is not set, it will default to same as Sample target.</td>

14
doc/common/tables/ceilometer-alarms.xml → doc/common/tables/ceilometer-dispatchers.xml
View File

@ -21,8 +21,8 @@
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_alarms">
<caption>Description of alarms configuration options</caption>
<table rules="all" xml:id="config_table_ceilometer_dispatchers">
<caption>Description of dispatchers configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
@ -33,11 +33,15 @@
</thead>
<tbody>
<tr>
<th colspan="2">[alarms]</th>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>gnocchi_url</option> = <replaceable>http://localhost:8041</replaceable></td>
<td>(StrOpt) URL to Gnocchi.</td>
<td><option>event_dispatchers</option> = <replaceable>['database']</replaceable></td>
<td>(MultiStrOpt) Dispatchers to process event data.</td>
</tr>
<tr>
<td><option>meter_dispatchers</option> = <replaceable>['database']</replaceable></td>
<td>(MultiStrOpt) Dispatchers to process metering data.</td>
</tr>
</tbody>
</table>

6
doc/common/tables/ceilometer-logging.xml
View File

@ -73,7 +73,7 @@
</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. This option is ignored if log_config_append is set.</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>
@ -91,6 +91,10 @@
<td><option>logging_exception_prefix</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s</replaceable></td>
<td>(StrOpt) Prefix each line of exception output with this format.</td>
</tr>
<tr>
<td><option>logging_user_identity_format</option> = <replaceable>%(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s</replaceable></td>
<td>(StrOpt) Format string for user_identity field of the logging_context_format_string</td>
</tr>
<tr>
<td><option>publish_errors</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enables or disables publication of error events.</td>

2
doc/common/tables/ceilometer-policy.xml
View File

@ -41,7 +41,7 @@
</tr>
<tr>
<td><option>policy_dirs</option> = <replaceable>['policy.d']</replaceable></td>
<td>(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.</td>
<td>(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.</td>
</tr>
<tr>
<td><option>policy_file</option> = <replaceable>policy.json</replaceable></td>

2
doc/common/tables/ceilometer-qpid.xml
View File

@ -81,7 +81,7 @@
</tr>
<tr>
<td><option>qpid_topology_version</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.</td>
<td>(IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.</td>
</tr>
<tr>
<td><option>qpid_username</option> = <replaceable></replaceable></td>

13
doc/common/tables/ceilometer-rpc.xml
View File

@ -35,10 +35,6 @@
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>dispatcher</option> = <replaceable>['database']</replaceable></td>
<td>(MultiStrOpt) Dispatcher to process data.</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>
@ -75,7 +71,7 @@
</tr>
<tr>
<td><option>lock_path</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set.</td>
<td>(StrOpt) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set.</td>
</tr>
<tr>
<th colspan="2">[oslo_messaging_amqp]</th>
@ -166,13 +162,6 @@
<td><option>telemetry_driver</option> = <replaceable>messagingv2</replaceable></td>
<td>(StrOpt) The driver that ceilometer uses for metering notifications.</td>
</tr>
<tr>
<th colspan="2">[publisher_rpc]</th>
</tr>
<tr>
<td><option>metering_topic</option> = <replaceable>metering</replaceable></td>
<td>(StrOpt) The topic that ceilometer uses for metering messages.</td>
</tr>
</tbody>
</table>
</para>

48
doc/common/tables/ceilometer-storage.xml Normal file
View File

@ -0,0 +1,48 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_storage">
<caption>Description of storage configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[storage]</th>
</tr>
<tr>
<td><option>max_retries</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Maximum number of connection retries during startup. Set to -1 to specify an infinite retry count.</td>
</tr>
<tr>
<td><option>retry_interval</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Interval (in seconds) between retries of connection.</td>
</tr>
</tbody>
</table>
</para>

2
doc/common/tables/ceilometer-vmware.xml
View File

@ -53,7 +53,7 @@
</tr>
<tr>
<td><option>host_port</option> = <replaceable>443</replaceable></td>
<td>(IntOpt) Port of the VMware vSphere host.</td>
<td>(PortOpt) Port of the VMware vSphere host.</td>
</tr>
<tr>
<td><option>host_username</option> = <replaceable></replaceable></td>

4
doc/common/tables/ceilometer-xenapi.xml
View File

@ -47,10 +47,6 @@
<td><option>connection_username</option> = <replaceable>root</replaceable></td>
<td>(StrOpt) Username for connection to XenServer/Xen Cloud Platform.</td>
</tr>
<tr>
<td><option>login_timeout</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Timeout in seconds for XenAPI login.</td>
</tr>
</tbody>
</table>
</para>

12
doc/common/tables/ceilometer-zeromq.xml
View File

@ -43,6 +43,10 @@
<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_bind_port_retries</option> = <replaceable>100</replaceable></td>
<td>(IntOpt) Number of retries to find free port number before fail with ZMQBindError.</td>
</tr>
<tr>
<td><option>rpc_zmq_concurrency</option> = <replaceable>eventlet</replaceable></td>
<td>(StrOpt) Type of concurrency used. Either "native" or "eventlet"</td>
@ -63,6 +67,14 @@
<td><option>rpc_zmq_matchmaker</option> = <replaceable>redis</replaceable></td>
<td>(StrOpt) MatchMaker driver.</td>
</tr>
<tr>
<td><option>rpc_zmq_max_port</option> = <replaceable>65536</replaceable></td>
<td>(IntOpt) Maximal port number for random ports range.</td>
</tr>
<tr>
<td><option>rpc_zmq_min_port</option> = <replaceable>49152</replaceable></td>
<td>(IntOpt) Minimal port number for random ports range.</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>

40
doc/config-ref-rst/source/tables/ceilometer-alarm.rst
View File

@ -1,40 +0,0 @@
..
Warning: Do not edit this file. It is automatically generated from the
software project's code and your changes will be overwritten.
The tool to generate this file lives in openstack-doc-tools repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools repository, or
ask for help on the documentation mailing list, IRC channel or meeting.
.. _ceilometer-alarm:
.. list-table:: Description of alarm configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[alarm]**
-
* - ``alarm_max_actions`` = ``-1``
- (IntOpt) Maximum count of actions for each state of an alarm, non-positive number means no limit.
* - ``evaluation_interval`` = ``60``
- (IntOpt) Period of evaluation cycle, should be >= than configured pipeline interval for collection of underlying meters.
* - ``notifier_rpc_topic`` = ``alarm_notifier``
- (StrOpt) The topic that ceilometer uses for alarm notifier messages.
* - ``project_alarm_quota`` = ``None``
- (IntOpt) Maximum number of alarms defined for a project.
* - ``record_history`` = ``True``
- (BoolOpt) Record alarm change events.
* - ``rest_notifier_certificate_file`` = `` ``
- (StrOpt) SSL Client certificate for REST notifier.
* - ``rest_notifier_certificate_key`` = `` ``
- (StrOpt) SSL Client private key for REST notifier.
* - ``rest_notifier_max_retries`` = ``0``
- (IntOpt) Number of retries for REST notifier
* - ``rest_notifier_ssl_verify`` = ``True``
- (BoolOpt) Whether to verify the SSL Server certificate when calling alarm action.
* - ``user_alarm_quota`` = ``None``
- (IntOpt) Maximum number of alarms defined for a user.

30
doc/config-ref-rst/source/tables/ceilometer-auth.rst
View File

@ -18,21 +18,21 @@
- Description
* - **[service_credentials]**
-
* - ``auth_section`` = ``None``
- (Opt) Config Section from which to load plugin specific options
* - ``auth_type`` = ``None``
- (Opt) Authentication type to load
* - ``cafile`` = ``None``
- (StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections.
* - ``certfile`` = ``None``
- (StrOpt) PEM encoded client certificate cert file
* - ``insecure`` = ``False``
- (BoolOpt) Disables X.509 certificate validation when an SSL connection to Identity Service is established.
* - ``os_auth_url`` = ``http://localhost:5000/v2.0``
- (StrOpt) Auth URL to use for OpenStack service access.
* - ``os_cacert`` = ``None``
- (StrOpt) Certificate chain for SSL validation.
* - ``os_endpoint_type`` = ``publicURL``
- (BoolOpt) Verify HTTPS connections.
* - ``interface`` = ``public``
- (StrOpt) Type of endpoint in Identity service catalog to use for communication with OpenStack services.
* - ``os_password`` = ``admin``
- (StrOpt) Password to use for OpenStack service access.
* - ``os_region_name`` = ``None``
* - ``keyfile`` = ``None``
- (StrOpt) PEM encoded client certificate key file
* - ``region_name`` = ``None``
- (StrOpt) Region name to use for OpenStack service endpoints.
* - ``os_tenant_id`` =
- (StrOpt) Tenant ID to use for OpenStack service access.
* - ``os_tenant_name`` = ``admin``
- (StrOpt) Tenant name to use for OpenStack service access.
* - ``os_username`` = ``ceilometer``
- (StrOpt) User name to use for OpenStack service access.
* - ``timeout`` = ``None``
- (IntOpt) Timeout value for http requests

6
doc/config-ref-rst/source/tables/ceilometer-auth_token.rst
View File

@ -30,14 +30,14 @@
- (StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.
* - ``auth_host`` = ``127.0.0.1``
- (StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.
* - ``auth_plugin`` = ``None``
- (StrOpt) Name of the plugin to load
* - ``auth_port`` = ``35357``
- (IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri.
* - ``auth_protocol`` = ``https``
- (StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri.
* - ``auth_section`` = ``None``
- (StrOpt) Config Section from which to load plugin specific options
- (Opt) Config Section from which to load plugin specific options
* - ``auth_type`` = ``None``
- (Opt) Authentication type to load
* - ``auth_uri`` = ``None``
- (StrOpt) Complete public Identity API endpoint.
* - ``auth_version`` = ``None``

2
doc/config-ref-rst/source/tables/ceilometer-collector.rst
View File

@ -18,8 +18,6 @@
- Description
* - **[collector]**
-
* - ``enable_rpc`` = ``False``
- (BoolOpt) Enable the RPC functionality of collector. This functionality is now deprecated in favour of notifier publisher and queues.
* - ``requeue_event_on_dispatcher_error`` = ``False``
- (BoolOpt) Requeue the event on the collector event queue when the collector fails to dispatch it.
* - ``requeue_sample_on_dispatcher_error`` = ``False``

4
doc/config-ref-rst/source/tables/ceilometer-cors.rst
View File

@ -25,7 +25,7 @@
* - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS``
- (ListOpt) Indicate which methods can be used during the actual request.
* - ``allowed_origin`` = ``None``
- (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.
- (ListOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.
* - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma``
- (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.
* - ``max_age`` = ``3600``
@ -39,7 +39,7 @@
* - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS``
- (ListOpt) Indicate which methods can be used during the actual request.
* - ``allowed_origin`` = ``None``
- (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.
- (ListOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.
* - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma``
- (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.
* - ``max_age`` = ``3600``

4
doc/config-ref-rst/source/tables/ceilometer-database.rst
View File

@ -22,10 +22,6 @@
- (StrOpt) DEPRECATED - Database connection string.
* - **[database]**
-
* - ``alarm_connection`` = ``None``
- (StrOpt) The connection string used to connect to the alarm database. (if unset, connection is used)
* - ``alarm_history_time_to_live`` = ``-1``
- (IntOpt) Number of seconds that alarm histories are kept in the database for (<= 0 means forever).
* - ``backend`` = ``sqlalchemy``
- (StrOpt) The back end to use for the database.
* - ``connection`` = ``None``

2
doc/config-ref-rst/source/tables/ceilometer-debug.rst
View File

@ -19,4 +19,4 @@
* - **[DEFAULT]**
-
* - ``nova_http_log_debug`` = ``False``
- (BoolOpt) Allow novaclient's debug log output.
- (BoolOpt) Allow novaclient's debug log output. (Use default_log_levels instead)

4
doc/config-ref-rst/source/tables/ceilometer-dispatcher_gnocchi.rst
View File

@ -26,5 +26,5 @@
- (BoolOpt) Filter out samples generated by Gnocchi service activity
* - ``resources_definition_file`` = ``gnocchi_resources.yaml``
- (StrOpt) The Yaml file that defines mapping between samples and gnocchi resources/metrics
* - ``url`` = ``http://localhost:8041``
- (StrOpt) URL to Gnocchi.
* - ``url`` = ``None``
- (StrOpt) URL to Gnocchi. default: autodetection

2
doc/config-ref-rst/source/tables/ceilometer-dispatcher_http.rst
View File

@ -18,8 +18,6 @@
- Description
* - **[dispatcher_http]**
-
* - ``cadf_only`` = ``False``
- (BoolOpt) The flag that indicates if only cadf message should be posted. If false, all meters will be posted. This is deprecated in favor of keystonemiddleware's audit middleware functionality
* - ``event_target`` = ``None``
- (StrOpt) The target for event data where the http request will be sent to. If this is not set, it will default to same as Sample target.
* - ``target`` =

4
doc/config-ref-rst/source/tables/ceilometer-rpc.rst
View File

@ -84,7 +84,3 @@
- (StrOpt) The topic that ceilometer uses for metering notifications.
* - ``telemetry_driver`` = ``messagingv2``
- (StrOpt) The driver that ceilometer uses for metering notifications.
* - **[publisher_rpc]**
-
* - ``metering_topic`` = ``metering``
- (StrOpt) The topic that ceilometer uses for metering messages.

12
doc/config-ref-rst/source/tables/ceilometer-alarms.rst → doc/config-ref-rst/source/tables/ceilometer-storage.rst
View File

@ -8,15 +8,17 @@
autogenerate-config-doc tool from the openstack-doc-tools repository, or
ask for help on the documentation mailing list, IRC channel or meeting.
.. _ceilometer-alarms:
.. _ceilometer-storage:
.. list-table:: Description of alarms configuration options
.. list-table:: Description of storage configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[alarms]**
* - **[storage]**
-
* - ``gnocchi_url`` = ``http://localhost:8041``
- (StrOpt) URL to Gnocchi.
* - ``max_retries`` = ``10``
- (IntOpt) Maximum number of connection retries during startup. Set to -1 to specify an infinite retry count.
* - ``retry_interval`` = ``10``
- (IntOpt) Interval (in seconds) between retries of connection.

3
doc/config-ref-rst/source/telemetry/telemetry_service_config_opts.rst
View File

@ -5,8 +5,6 @@ Telemetry configuration options
The following tables provide a comprehensive list of the Telemetry
configuration options.
.. include:: ../tables/ceilometer-alarm.rst
.. include:: ../tables/ceilometer-alarms.rst
.. include:: ../tables/ceilometer-amqp.rst
.. include:: ../tables/ceilometer-api.rst
.. include:: ../tables/ceilometer-auth.rst
@ -33,6 +31,7 @@ configuration options.
.. include:: ../tables/ceilometer-rgw.rst
.. include:: ../tables/ceilometer-rpc.rst
.. include:: ../tables/ceilometer-service_types.rst
.. include:: ../tables/ceilometer-storage.rst
.. include:: ../tables/ceilometer-swift.rst
.. include:: ../tables/ceilometer-tripleo.rst
.. include:: ../tables/ceilometer-vmware.rst

2
doc/config-reference/telemetry/section_telemetry-service-config-opts.xml
View File

@ -6,8 +6,6 @@
<title>Telemetry configuration options</title>
<para>The following tables provide a comprehensive list of the Telemetry
configuration options.</para>
<xi:include href="../../common/tables/ceilometer-alarm.xml"/>
<xi:include href="../../common/tables/ceilometer-alarms.xml"/>
<xi:include href="../../common/tables/ceilometer-amqp.xml"/>
<xi:include href="../../common/tables/ceilometer-api.xml"/>
<xi:include href="../../common/tables/ceilometer-auth.xml"/>

37
tools/autogenerate-config-flagmappings/ceilometer.flagmappings
View File

@ -89,17 +89,6 @@ 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
alarm/project_alarm_quota alarm
alarm/record_history alarm
alarm/rest_notifier_certificate_file alarm
alarm/rest_notifier_certificate_key alarm
alarm/rest_notifier_max_retries alarm
alarm/rest_notifier_ssl_verify alarm
alarm/user_alarm_quota alarm
alarms/gnocchi_url alarms
api/aodh_is_enabled api
api/aodh_url api
api/default_api_return_limit api
@ -108,7 +97,6 @@ api/host api
api/pecan_debug api
api/port api
api/workers api
collector/enable_rpc collector
collector/requeue_event_on_dispatcher_error collector
collector/requeue_sample_on_dispatcher_error collector
collector/udp_address collector
@ -130,8 +118,6 @@ cors.subdomain/allow_methods cors
cors.subdomain/allowed_origin cors
cors.subdomain/expose_headers cors
cors.subdomain/max_age cors
database/alarm_connection database
database/alarm_history_time_to_live database
database/backend database
database/connection database
database/connection_debug database
@ -165,7 +151,6 @@ dispatcher_gnocchi/filter_project dispatcher_gnocchi
dispatcher_gnocchi/filter_service_activity dispatcher_gnocchi
dispatcher_gnocchi/resources_definition_file dispatcher_gnocchi
dispatcher_gnocchi/url dispatcher_gnocchi
dispatcher_http/cadf_only dispatcher_http
dispatcher_http/event_target dispatcher_http
dispatcher_http/target dispatcher_http
dispatcher_http/timeout dispatcher_http
@ -184,10 +169,10 @@ keystone_authtoken/admin_token auth_token
keystone_authtoken/admin_user auth_token
keystone_authtoken/auth_admin_prefix auth_token
keystone_authtoken/auth_host auth_token
keystone_authtoken/auth_plugin auth_token
keystone_authtoken/auth_port auth_token
keystone_authtoken/auth_protocol auth_token
keystone_authtoken/auth_section auth_token
keystone_authtoken/auth_type auth_token
keystone_authtoken/auth_uri auth_token
keystone_authtoken/auth_version auth_token
keystone_authtoken/cache auth_token
@ -293,24 +278,25 @@ publisher/telemetry_secret rpc
publisher_notifier/event_topic rpc
publisher_notifier/metering_topic rpc
publisher_notifier/telemetry_driver rpc
publisher_rpc/metering_topic rpc
rgw_admin_credentials/access_key rgw
rgw_admin_credentials/secret_key rgw
service_credentials/auth_section auth
service_credentials/auth_type auth
service_credentials/cafile auth
service_credentials/certfile auth
service_credentials/insecure auth
service_credentials/os_auth_url auth
service_credentials/os_cacert auth
service_credentials/os_endpoint_type auth
service_credentials/os_password auth
service_credentials/os_region_name auth
service_credentials/os_tenant_id auth
service_credentials/os_tenant_name auth
service_credentials/os_username auth
service_credentials/interface auth
service_credentials/keyfile auth
service_credentials/region_name auth
service_credentials/timeout auth
service_types/glance service_types
service_types/kwapi service_types
service_types/neutron service_types
service_types/nova service_types
service_types/radosgw service_types
service_types/swift service_types
storage/max_retries storage
storage/retry_interval storage
vmware/api_retry_count vmware
vmware/ca_file vmware
vmware/host_ip vmware
@ -323,4 +309,3 @@ vmware/wsdl_location vmware
xenapi/connection_password xenapi
xenapi/connection_url xenapi
xenapi/connection_username xenapi
xenapi/login_timeout xenapi

3
tools/autogenerate-config-flagmappings/ceilometer.headers
View File

@ -1,5 +1,3 @@
alarm alarm
alarms alarms
collector collector
dispatcher_http HTTP dispatcher
dispatcher_gnocchi Gnocchi dispatcher
@ -10,4 +8,5 @@ magnetodb MagnetoDB
notification notification
rgw Rados gateway
service_types service types
storage storage
zaqar Zaqar