openstack-manuals/doc/common/tables/ceilometer-common.xml
Gauvain Pocentek d6de8863f8 [config-ref] ceilometer config tables update
Change-Id: Ifd1adc90efa4a297dcda0e9d3ba798f8cbbeba20
2015-07-19 10:57:19 +02:00

102 lines
4.9 KiB
XML

<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_ceilometer_common">
<caption>Description of common 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">[DEFAULT]</th>
</tr>
<tr>
<td><option>host</option> = <replaceable>localhost</replaceable></td>
<td>(StrOpt) 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.</td>
</tr>
<tr>
<td><option>http_timeout</option> = <replaceable>600</replaceable></td>
<td>(IntOpt) Timeout seconds for HTTP requests. Set it to None to disable timeout.</td>
</tr>
<tr>
<td><option>memcached_servers</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) Memcached servers or None for in process cache.</td>
</tr>
<tr>
<td><option>notification_workers</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Number of workers for notification service. A single notification agent is enabled by default.</td>
</tr>
<tr>
<td><option>polling_namespaces</option> = <replaceable>['compute', 'central']</replaceable></td>
<td>(MultiChoicesOpt) Polling namespace(s) to be used while resource polling</td>
</tr>
<tr>
<td><option>pollster_list</option> = <replaceable>[]</replaceable></td>
<td>(MultiChoicesOpt) List of pollsters (or wildcard templates) to be used while polling</td>
</tr>
<tr>
<td><option>rootwrap_config</option> = <replaceable>/etc/ceilometer/rootwrap.conf</replaceable></td>
<td>(StrOpt) Path to the rootwrap configuration file touse for running commands as root</td>
</tr>
<tr>
<td><option>shuffle_time_before_polling_task</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) To reduce large requests at same time to Nova or other components from different compute agents, shuffle start time of polling task.</td>
</tr>
<tr>
<td><option>sql_expire_samples_only</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Indicates if expirer expires only samples. If set true, expired samples will be deleted, but residual resource and meter definition data will remain.</td>
</tr>
<tr>
<th colspan="2">[compute]</th>
</tr>
<tr>
<td><option>workload_partitioning</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable work-load partitioning, allowing multiple compute agents to be run simultaneously.</td>
</tr>
<tr>
<th colspan="2">[coordination]</th>
</tr>
<tr>
<td><option>backend_url</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The backend URL to use for distributed coordination. If left empty, per-deployment central agent and per-host compute agent won't do workload partitioning and will only function correctly if a single instance of that service is running.</td>
</tr>
<tr>
<td><option>check_watchers</option> = <replaceable>10.0</replaceable></td>
<td>(FloatOpt) Number of seconds between checks to see if group membership has changed</td>
</tr>
<tr>
<td><option>heartbeat</option> = <replaceable>1.0</replaceable></td>
<td>(FloatOpt) Number of seconds between heartbeats for distributed coordination.</td>
</tr>
<tr>
<th colspan="2">[keystone_authtoken]</th>
</tr>
<tr>
<td><option>memcached_servers</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.</td>
</tr>
<tr>
<th colspan="2">[meter]</th>
</tr>
<tr>
<td><option>meter_definitions_cfg_file</option> = <replaceable>meters.yaml</replaceable></td>
<td>(StrOpt) Configuration file for defining meter notifications.</td>
</tr>
<tr>
<th colspan="2">[polling]</th>
</tr>
<tr>
<td><option>partitioning_group_prefix</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Work-load partitioning group prefix. Use only if you want to run multiple polling agents with different config files. For each sub-group of the agent pool with the same partitioning_group_prefix a disjoint subset of pollsters should be loaded.</td>
</tr>
</tbody>
</table>
</para>