openstack-manuals/doc/config-reference/ch_objectstorageconfigure.xml
Gauvain Pocentek 5624694c68 Swift config-ref: include some unused tables
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
2014-04-27 18:23:40 +02:00

189 lines
9.7 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="ch_configuring-object-storage">
<title>Object Storage</title>
<para>OpenStack Object Storage uses multiple configuration files
for multiple services and background daemons, and
<command>paste.deploy</command> to manage server
configurations. Default configuration options appear in the
<code>[DEFAULT]</code> section. You can override the default values
by setting values in the other sections.</para>
<xi:include href="../common/section_about-object-storage.xml"/>
<xi:include
href="object-storage/section_object-storage-general-service-conf.xml"/>
<section xml:id="object-server-configuration">
<title>Object server configuration</title>
<para>Find an example object server configuration at
<filename>etc/object-server.conf-sample</filename> in the source code
repository.</para>
<para>The available configuration options are:</para>
<xi:include
href="../common/tables/swift-object-server-DEFAULT.xml"/>
<xi:include
href="../common/tables/swift-object-server-app-object-server.xml"/>
<xi:include
href="../common/tables/swift-object-server-pipeline-main.xml"/>
<xi:include
href="../common/tables/swift-object-server-object-replicator.xml"/>
<xi:include
href="../common/tables/swift-object-server-object-updater.xml"/>
<xi:include
href="../common/tables/swift-object-server-object-auditor.xml"/>
<xi:include
href="../common/tables/swift-object-server-filter-healthcheck.xml"/>
<xi:include
href="../common/tables/swift-object-server-filter-recon.xml"/>
<section xml:id="object-server-conf">
<title>Sample object server configuration file</title>
<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
<filename>etc/container-server.conf-sample</filename>
in the source code repository.</para>
<para>The available configuration options are:</para>
<xi:include
href="../common/tables/swift-container-server-DEFAULT.xml"/>
<xi:include
href="../common/tables/swift-container-server-app-container-server.xml"/>
<xi:include
href="../common/tables/swift-container-server-pipeline-main.xml"/>
<xi:include
href="../common/tables/swift-container-server-container-replicator.xml"/>
<xi:include
href="../common/tables/swift-container-server-container-updater.xml"/>
<xi:include
href="../common/tables/swift-container-server-container-auditor.xml"/>
<xi:include
href="../common/tables/swift-container-server-container-sync.xml"/>
<xi:include
href="../common/tables/swift-container-server-filter-healthcheck.xml"/>
<xi:include
href="../common/tables/swift-container-server-filter-recon.xml"/>
<section xml:id="container-server-conf">
<title>Sample container server configuration file</title>
<programlisting language="ini"><xi:include parse="text" href="http://git.openstack.org/cgit/openstack/swift/plain/etc/container-server.conf-sample?h=stable/icehouse"/></programlisting>
</section>
</section>
<section xml:id="account-server-configuration">
<title>Account server configuration</title>
<para>Find an example account server configuration at
<filename>etc/account-server.conf-sample</filename> in
the source code repository.</para>
<para>The available configuration options are:</para>
<xi:include
href="../common/tables/swift-account-server-DEFAULT.xml"/>
<xi:include
href="../common/tables/swift-account-server-app-account-server.xml"/>
<xi:include
href="../common/tables/swift-account-server-pipeline-main.xml"/>
<xi:include
href="../common/tables/swift-account-server-account-replicator.xml"/>
<xi:include
href="../common/tables/swift-account-server-account-auditor.xml"/>
<xi:include
href="../common/tables/swift-account-server-account-reaper.xml"/>
<xi:include
href="../common/tables/swift-account-server-filter-healthcheck.xml"/>
<xi:include
href="../common/tables/swift-account-server-filter-recon.xml"/>
<section xml:id="account-server-conf">
<title>Sample account server configuration file</title>
<programlisting language="ini"><xi:include parse="text" href="http://git.openstack.org/cgit/openstack/swift/plain/etc/account-server.conf-sample?h=stable/icehouse"/></programlisting>
</section>
</section>
<section xml:id="proxy-server-configuration">
<title>Proxy server configuration</title>
<para>Find an example proxy server configuration at
<filename>etc/proxy-server.conf-sample</filename> in
the source code repository.</para>
<para>The available configuration options are:</para>
<xi:include
href="../common/tables/swift-proxy-server-DEFAULT.xml"/>
<xi:include
href="../common/tables/swift-proxy-server-app-proxy-server.xml"/>
<xi:include
href="../common/tables/swift-proxy-server-pipeline-main.xml"/>
<xi:include
href="../common/tables/swift-proxy-server-filter-account-quotas.xml"/>
<xi:include
href="../common/tables/swift-proxy-server-filter-authtoken.xml"/>
<xi:include
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
href="../common/tables/swift-proxy-server-filter-keystoneauth.xml"/>
<xi:include
href="../common/tables/swift-proxy-server-filter-list-endpoints.xml"/>
<xi:include
href="../common/tables/swift-proxy-server-filter-proxy-logging.xml"/>
<xi:include
href="../common/tables/swift-proxy-server-filter-tempauth.xml"/>
<section xml:id="proxy-server-conf">
<title>Sample proxy server configuration file</title>
<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"/>
</chapter>