openstack-manuals/doc/common/tables/swift-swift-swift-constraints.xml
Gauvain Pocentek e7cbc675ce update the config reference tables for liberty
Change-Id: I959cc6884633ada1deb55f44ca1fc6f230bdebd9
2015-10-29 07:45:04 +01:00

87 lines
4.0 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>[swift-constraints]</literal> in <filename>swift.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>account_listing_limit</option> = <replaceable>10000</replaceable></td>
<td>The default (and maximum) number of items returned for an account listing request.</td>
</tr>
<tr>
<td><option>container_listing_limit</option> = <replaceable>10000</replaceable></td>
<td>The default (and maximum) number of items returned for a container listing request.</td>
</tr>
<tr>
<td><option>extra_header_count</option> = <replaceable>0</replaceable></td>
<td>By default the maximum number of allowed headers depends on the number of max allowed metadata settings plus a default value of 32 for regular http headers. If for some reason this is not enough (custom middleware for example) it can be increased with the extra_header_count constraint.</td>
</tr>
<tr>
<td><option>max_account_name_length</option> = <replaceable>256</replaceable></td>
<td>The maximum number of bytes in the utf8 encoding of an account name.</td>
</tr>
<tr>
<td><option>max_container_name_length</option> = <replaceable>256</replaceable></td>
<td>The maximum number of bytes in the utf8 encoding of a container name.</td>
</tr>
<tr>
<td><option>max_file_size</option> = <replaceable>5368709122</replaceable></td>
<td>The largest normal object that can be saved in the cluster.
This is also the limit on the size of each segment of a large object
when using the large object manifest support. This value is set in bytes.
Setting it to lower than 1MiB will cause some tests to fail. It is
STRONGLY recommended to leave this value at the default (5 * 2**30 + 2).</td>
</tr>
<tr>
<td><option>max_header_size</option> = <replaceable>8192</replaceable></td>
<td>The max number of bytes in the utf8 encoding of each header.
Using 8192 as default because eventlet use 8192
as maximum size of header line. You may need to increase this value when using
identity v3 API tokens including more than 7 catalog entries.
See also include_service_catalog in proxy-server.conf-sample
(documented in overview_auth.rst).</td>
</tr>
<tr>
<td><option>max_meta_count</option> = <replaceable>90</replaceable></td>
<td>The max number of metadata keys that can be stored
on a single account, container, or object.</td>
</tr>
<tr>
<td><option>max_meta_name_length</option> = <replaceable>128</replaceable></td>
<td>The max number of bytes in the utf8 encoding
of the name portion of a metadata header.</td>
</tr>
<tr>
<td><option>max_meta_overall_size</option> = <replaceable>4096</replaceable></td>
<td>The max number of bytes in the utf8 encoding of the
metadata (keys + values).</td>
</tr>
<tr>
<td><option>max_meta_value_length</option> = <replaceable>256</replaceable></td>
<td>The max number of bytes in the utf8 encoding of a metadata value.</td>
</tr>
<tr>
<td><option>max_object_name_length</option> = <replaceable>1024</replaceable></td>
<td>The max number of bytes in the utf8 encoding
of an object name.</td>
</tr>
<tr>
<td><option>valid_api_versions</option> = <replaceable>v0,v1,v2</replaceable></td>
<td>No help text available for this option.</td>
</tr>
</tbody>
</table>
</para>