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

89 lines
3.7 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_api">
<caption>Description of API 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>api_paste_config</option> = <replaceable>api_paste.ini</replaceable></td>
<td>(StrOpt) Configuration file for WSGI definition of API.</td>
</tr>
<tr>
<td><option>api_workers</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Number of workers for Ceilometer API server.</td>
</tr>
<tr>
<td><option>event_pipeline_cfg_file</option> = <replaceable>event_pipeline.yaml</replaceable></td>
<td>(StrOpt) Configuration file for event pipeline definition.</td>
</tr>
<tr>
<td><option>pipeline_cfg_file</option> = <replaceable>pipeline.yaml</replaceable></td>
<td>(StrOpt) Configuration file for pipeline definition.</td>
</tr>
<tr>
<td><option>pipeline_polling_interval</option> = <replaceable>20</replaceable></td>
<td>(IntOpt) Polling interval for pipeline file configuration in seconds.</td>
</tr>
<tr>
<td><option>refresh_pipeline_cfg</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Refresh Pipeline configuration on-the-fly.</td>
</tr>
<tr>
<td><option>reserved_metadata_keys</option> = <replaceable></replaceable></td>
<td>(ListOpt) List of metadata keys reserved for metering use. And these keys are additional to the ones included in the namespace.</td>
</tr>
<tr>
<td><option>reserved_metadata_length</option> = <replaceable>256</replaceable></td>
<td>(IntOpt) Limit on length of reserved metadata values.</td>
</tr>
<tr>
<td><option>reserved_metadata_namespace</option> = <replaceable>metering.</replaceable></td>
<td>(ListOpt) List of metadata prefixes reserved for metering use.</td>
</tr>
<tr>
<th colspan="2">[api]</th>
</tr>
<tr>
<td><option>default_api_return_limit</option> = <replaceable>1000</replaceable></td>
<td>(IntOpt) Default maximum number of items returned by API request.</td>
</tr>
<tr>
<td><option>host</option> = <replaceable>0.0.0.0</replaceable></td>
<td>(StrOpt) The listen IP for the ceilometer API server.</td>
</tr>
<tr>
<td><option>pecan_debug</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Toggle Pecan Debug Middleware.</td>
</tr>
<tr>
<td><option>port</option> = <replaceable>8777</replaceable></td>
<td>(IntOpt) The port for the ceilometer API server.</td>
</tr>
<tr>
<th colspan="2">[oslo_middleware]</th>
</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>
</tr>
<tr>
<td><option>secure_proxy_ssl_header</option> = <replaceable>X-Forwarded-Proto</replaceable></td>
<td>(StrOpt) The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy.</td>
</tr>
</tbody>
</table>
</para>