33990c31fb
Update the config reference with using the autohelp-wrapper script. Change-Id: Ia37e966001a3466b65071e570a202e3f31502cde Closes-Bug: #1418299 Closes-Bug: #1418622 Closes-Bug: #1418372
78 lines
3.5 KiB
XML
78 lines
3.5 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>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>policy_default_rule</option> = <replaceable>default</replaceable></td>
|
|
<td>(StrOpt) Default rule. Enforced when a requested rule is not found.</td>
|
|
</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.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>policy_file</option> = <replaceable>policy.json</replaceable></td>
|
|
<td>(StrOpt) The JSON file that defines policies.</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>enable_reverse_dns_lookup</option> = <replaceable>False</replaceable></td>
|
|
<td>(BoolOpt) Set it to False if your environment does not need or have a DNS server, otherwise it will delay the response from the API.</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>None</replaceable></td>
|
|
<td>(BoolOpt) Toggle Pecan Debug Middleware. If it is not set, global debug value will be used.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>port</option> = <replaceable>8777</replaceable></td>
|
|
<td>(IntOpt) The port for the ceilometer API server.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</para>
|