zaqar/doc/user-guide/zaqar-config-ref/common/tables/zaqar-api.xml
Victoria Martínez de la Cruz 752c6e1cd3 Zaqar configuration reference docs
This change adds the basic configuration reference
in the user guide.

It includes the document structure outline according
the OpenStack configuration reference standard and
a list of configuration options present in zaqar.conf
with a description of default values and value types.

Configuration option tables has been generated using
the autogenerate_config_docs tool in openstack-doc-tools
repo. Needed files to easier update this tables in the
near future are located in the autogen folder.

blueprint document-config-options

Change-Id: I17884400f711f6d2723b0774c20e7df4ffb0e812
2014-09-02 16:04:39 -03:00

39 lines
1.1 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_zaqar_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>admin_mode = False</td>
<td>(BoolOpt) Activate privileged endpoints.</td>
</tr>
<tr>
<td>daemon = False</td>
<td>(BoolOpt) Run Zaqar server in the background.</td>
</tr>
<tr>
<td>disable_process_locking = False</td>
<td>(BoolOpt) Enables or disables inter-process locks.</td>
</tr>
<tr>
<td>lock_path = None</td>
<td>(StrOpt) Directory to use for lock files.</td>
</tr>
</tbody>
</table>
</para>