openstack-manuals/doc/common/tables/swift-object-server-app-object-server.xml
Christian Berendt 2cc66311cb Update Swift configuration tables
Change-Id: Ib57f5db125421e317c7d0cf0c14ec744b4066a46
2015-03-02 13:06:05 +01:00

106 lines
5.1 KiB
XML

<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- The tool that generated this table lives in the
openstack-doc-tools repository. The editions made in
this file will *not* be lost if you run the script again. -->
<table rules="all">
<caption>Description of configuration options for
<literal>[app-object-server]</literal> in <filename>object-server.conf</filename>
</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><option>allowed_headers</option> = <replaceable>Content-Disposition, Content-Encoding, X-Delete-At, X-Object-Manifest, X-Static-Large-Object</replaceable></td>
<td>Comma-separated list of headers that can be set in metadata of an object</td>
</tr>
<tr>
<td><option>auto_create_account_prefix</option> = <replaceable>.</replaceable></td>
<td>Prefix to use when automatically creating accounts</td>
</tr>
<tr>
<td><option>keep_cache_private</option> = <replaceable>false</replaceable></td>
<td>Allow non-public objects to stay in kernel's buffer cache</td>
</tr>
<tr>
<td><option>keep_cache_size</option> = <replaceable>5242880</replaceable></td>
<td>Largest object size to keep in buffer cache</td>
</tr>
<tr>
<td><option>max_upload_time</option> = <replaceable>86400</replaceable></td>
<td>Maximum time allowed to upload an object</td>
</tr>
<tr>
<td><option>mb_per_sync</option> = <replaceable>512</replaceable></td>
<td>On PUT requests, sync file every n MB</td>
</tr>
<tr>
<td><option>replication_concurrency</option> = <replaceable>4</replaceable></td>
<td>Set to restrict the number of concurrent incoming REPLICATION requests; set to 0 for unlimited</td>
</tr>
<tr>
<td><option>replication_failure_ratio</option> = <replaceable>1.0</replaceable></td>
<td>If the value of failures / successes of REPLICATION subrequests exceeds this ratio, the overall REPLICATION request will be aborted</td>
</tr>
<tr>
<td><option>replication_failure_threshold</option> = <replaceable>100</replaceable></td>
<td>The number of subrequest failures before the replication_failure_ratio is checked</td>
</tr>
<tr>
<td><option>replication_lock_timeout</option> = <replaceable>15</replaceable></td>
<td>Number of seconds to wait for an existing replication device lock before giving up.</td>
</tr>
<tr>
<td><option>replication_one_per_device</option> = <replaceable>True</replaceable></td>
<td>Restricts incoming REPLICATION requests to one per device, replication_currency above allowing. This can help control I/O to each device, but you may wish to set this to False to allow multiple REPLICATION requests (up to the above replication_concurrency setting) per device.</td>
</tr>
<tr>
<td><option>replication_server</option> = <replaceable>false</replaceable></td>
<td>If defined, tells server how to handle replication verbs in requests. When set to True (or 1), only replication verbs will be accepted. When set to False, replication verbs will be rejected. When undefined, server will accept any verb in the request.</td>
</tr>
<tr>
<td><option>set log_address</option> = <replaceable>/dev/log</replaceable></td>
<td>Location where syslog sends the logs to</td>
</tr>
<tr>
<td><option>set log_facility</option> = <replaceable>LOG_LOCAL0</replaceable></td>
<td>Syslog log facility</td>
</tr>
<tr>
<td><option>set log_level</option> = <replaceable>INFO</replaceable></td>
<td>Log level</td>
</tr>
<tr>
<td><option>set log_name</option> = <replaceable>object-server</replaceable></td>
<td>Label to use when logging</td>
</tr>
<tr>
<td><option>set log_requests</option> = <replaceable>true</replaceable></td>
<td>Whether or not to log requests</td>
</tr>
<tr>
<td><option>slow</option> = <replaceable>0</replaceable></td>
<td>If &gt; 0, Minimum time in seconds for a PUT or DELETE request to complete</td>
</tr>
<tr>
<td><option>splice</option> = <replaceable>no</replaceable></td>
<td>No help text available for this option.</td>
</tr>
<tr>
<td><option>threads_per_disk</option> = <replaceable>0</replaceable></td>
<td>Size of the per-disk thread pool used for performing disk I/O. The default of 0 means to not use a per-disk thread pool. It is recommended to keep this value small, as large values can result in high read latencies due to large queue depths. A good starting point is 4 threads per disk.</td>
</tr>
<tr>
<td><option>use</option> = <replaceable>egg:swift#object</replaceable></td>
<td>Entry point of paste.deploy in the server</td>
</tr>
</tbody>
</table>
</para>