openstack-manuals/doc/common/tables/ceilometer-api.xml

66 lines
2.2 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>api_paste_config = api_paste.ini</td>
<td>(StrOpt) Configuration file for WSGI definition of API.</td>
</tr>
<tr>
<td>pipeline_cfg_file = pipeline.yaml</td>
<td>(StrOpt) Configuration file for pipeline definition.</td>
</tr>
<tr>
<td>policy_default_rule = default</td>
<td>(StrOpt) Default rule. Enforced when a requested rule is not found.</td>
</tr>
<tr>
<td>policy_file = policy.json</td>
<td>(StrOpt) The JSON file that defines policies.</td>
</tr>
<tr>
<td>reserved_metadata_length = 256</td>
<td>(IntOpt) Limit on length of reserved metadata values.</td>
</tr>
<tr>
<td>reserved_metadata_namespace = metering.</td>
<td>(ListOpt) List of metadata prefixes reserved for metering use.</td>
</tr>
<tr>
<th colspan="2">[api]</th>
</tr>
<tr>
<td>enable_reverse_dns_lookup = False</td>
<td>(BoolOpt) Set it to False if your environment does not need or have dns server, otherwise it will delay the response from api.</td>
</tr>
<tr>
<td>host = 0.0.0.0</td>
<td>(StrOpt) The listen IP for the ceilometer API server.</td>
</tr>
<tr>
<td>pecan_debug = False</td>
<td>(BoolOpt) Toggle Pecan Debug Middleware. Defaults to global debug value.</td>
</tr>
<tr>
<td>port = 8777</td>
<td>(IntOpt) The port for the ceilometer API server.</td>
</tr>
</tbody>
</table>
</para>