openstack/openstack-manuals
Code Issues Proposed changes

Swift config-ref: include some unused tables

Browse Source 
Several configuration options tables were not included in the config-ref
for swift. This patch includes most of those tables.

Remove the swift-swift-bench-bench.xml table (swift-bench is not part of
the swift repository anymore).

The realm synchronization tables are not included, they need a proper
documentation (coming in another patch).

Change-Id: Id7be936b02e3932e32ebd2468884df58ebd2b9b7
This commit is contained in:
Gauvain Pocentek 2014-04-27 17:55:01 +02:00
parent 0597e30627
commit 5624694c68
3 changed files with 57 additions and 94 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

94
doc/common/tables/swift-swift-bench-bench.xml
View File

@ -1,94 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[bench]</literal> in <literal>swift-bench.conf-sample</literal></caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>auth = http://localhost:8080/auth/v1.0</td><td>Swift storage accounts and auth tokens will begin with this prefix.</td>
</tr>
<tr>
<td>user = test:tester</td><td>User to run as</td>
</tr>
<tr>
<td>key = testing</td><td>No help text available for this option</td>
</tr>
<tr>
<td>auth_version = 1.0</td><td>Indicates which version of auth</td>
</tr>
<tr>
<td>log-level = INFO</td><td>No help text available for this option</td>
</tr>
<tr>
<td>timeout = 10</td><td>Timeout value sent to rsync --timeout and --contimeout options</td>
</tr>
<tr>
<td>put_concurrency = 10</td><td>No help text available for this option</td>
</tr>
<tr>
<td>get_concurrency = 10</td><td>No help text available for this option</td>
</tr>
<tr>
<td>del_concurrency = 10</td><td>No help text available for this option</td>
</tr>
<tr>
<td>concurrency = </td><td>Number of replication workers to spawn</td>
</tr>
<tr>
<td>object_sources = </td><td>No help text available for this option</td>
</tr>
<tr>
<td>lower_object_size = 10</td><td>No help text available for this option</td>
</tr>
<tr>
<td>upper_object_size = 10</td><td>No help text available for this option</td>
</tr>
<tr>
<td>object_size = 1</td><td>No help text available for this option</td>
</tr>
<tr>
<td>num_objects = 1000</td><td>No help text available for this option</td>
</tr>
<tr>
<td>num_gets = 10000</td><td>No help text available for this option</td>
</tr>
<tr>
<td>num_containers = 20</td><td>No help text available for this option</td>
</tr>
<tr>
<td>container_name = (randomly-chosen uuid4)</td><td>No help text available for this option</td>
</tr>
<tr>
<td>delete = yes</td><td>No help text available for this option</td>
</tr>
<tr>
<td>use_proxy = yes</td><td>No help text available for this option</td>
</tr>
<tr>
<td>use_proxy = no, this setting is required and used as the X-Storage-Url when</td><td>No help text available for this option</td>
</tr>
<tr>
<td>url = </td><td>No help text available for this option</td>
</tr>
<tr>
<td>account = </td><td>has generated an error (timeout, not yet found, etc.)</td>
</tr>
<tr>
<td>use_proxy = no.</td><td>No help text available for this option</td>
</tr>
<tr>
<td>devices = sdb1</td><td>Parent directory of where devices are mounted</td>
</tr>
</tbody>
</table>
</para>

50
doc/config-reference/ch_objectstorageconfigure.xml
View File

@ -40,6 +40,29 @@
<programlisting language="ini"><xi:include parse="text" href="http://git.openstack.org/cgit/openstack/swift/plain/etc/object-server.conf-sample?h=stable/icehouse"/></programlisting>
</section>
</section>
<section xml:id="object-expirer-configuration">
<title>Object expirer configuration</title>
<para>Find an example object expirer configuration at
<filename>etc/object-expirer.conf-sample</filename> in the source code
repository.</para>
<para>The available configuration options are:</para>
<xi:include
href="../common/tables/swift-object-expirer-DEFAULT.xml"/>
<xi:include
href="../common/tables/swift-object-expirer-app-proxy-server.xml"/>
<xi:include
href="../common/tables/swift-object-expirer-filter-cache.xml"/>
<xi:include
href="../common/tables/swift-object-expirer-filter-catch_errors.xml"/>
<xi:include
href="../common/tables/swift-object-expirer-object-expirer.xml"/>
<xi:include
href="../common/tables/swift-object-expirer-pipeline-main.xml"/>
<section xml:id="object-expirer-conf">
<title>Sample object expirer configuration file</title>
<programlisting language="ini"><xi:include parse="text" href="http://git.openstack.org/cgit/openstack/swift/plain/etc/object-expirer.conf-sample?h=stable/icehouse"/></programlisting>
</section>
</section>
<section xml:id="container-server-configuration">
<title>Container server configuration</title>
<para>Find an example container server configuration at
@ -117,6 +140,10 @@
href="../common/tables/swift-proxy-server-filter-cache.xml"/>
<xi:include
href="../common/tables/swift-proxy-server-filter-catch_errors.xml"/>
<xi:include
href="../common/tables/swift-proxy-server-filter-dlo.xml"/>
<xi:include
href="../common/tables/swift-proxy-server-filter-gatekeeper.xml"/>
<xi:include
href="../common/tables/swift-proxy-server-filter-healthcheck.xml"/>
<xi:include
@ -132,6 +159,29 @@
<programlisting language="ini"><xi:include parse="text" href="http://git.openstack.org/cgit/openstack/swift/plain/etc/proxy-server.conf-sample?h=stable/icehouse"/></programlisting>
</section>
</section>
<section xml:id="swift-memcache-configuration">
<title>Proxy server memcache configuration</title>
<para>Find an example memcache configuration for the proxy server at
<filename>etc/memcache.conf-sample</filename>
in the source code repository.</para>
<para>The available configuration options are:</para>
<xi:include
href="../common/tables/swift-memcache-memcache.xml"/>
</section>
<section xml:id="rsyncd-configuration">
<title>Rsyncd configuration</title>
<para>Find an example rsyncd configuration at
<filename>etc/rsyncd.conf-sample</filename>
in the source code repository.</para>
<para>The available configuration options are:</para>
<xi:include
href="../common/tables/swift-rsyncd-account.xml"/>
<xi:include
href="../common/tables/swift-rsyncd-container.xml"/>
<xi:include
href="../common/tables/swift-rsyncd-object.xml"/>
</section>
<!-- section on Object Storage Features -->
<xi:include
href="object-storage/section_object-storage-features.xml"/>

7
doc/config-reference/object-storage/section_object-storage-general-service-conf.xml
View File

@ -110,4 +110,11 @@ Error: missing config path argument
You can inspect the resulting combined configuration object using
the <command>swift-config</command> command-line tool.
</para>
<para>All the services of an Object Store deployment share a common
configuration in the <literal>[swift-hash]</literal> section of the
<filename>/etc/swift/swift.conf</filename> file. The
<option>swift_hash_path_suffix</option> and
<option>swift_hash_path_prefix</option> values must be identical on all
the nodes.</para>
<xi:include href="../../common/tables/swift-swift-swift-hash.xml"/>
</section>