openstack-manuals/doc/common/tables/swift-proxy-server-app-proxy-server.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-proxy-server]</literal> in <literal>proxy-server.conf</literal>
    </caption>
    <col width="50%"/>
    <col width="50%"/>
    <thead>
      <tr>
        <th>Configuration option = Default value</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td>account_autocreate = false</td>
        <td>If set to 'true' authorized accounts that do not yet exist within the Swift cluster will be automatically created.</td>
      </tr>
      <tr>
        <td>allow_account_management = false</td>
        <td>Whether account PUTs and DELETEs are even callable</td>
      </tr>
      <tr>
        <td>auto_create_account_prefix = .</td>
        <td>Prefix to use when automatically creating accounts</td>
      </tr>
      <tr>
        <td>client_chunk_size = 65536</td>
        <td>Chunk size to read from clients</td>
      </tr>
      <tr>
        <td>conn_timeout = 0.5</td>
        <td>Connection timeout to external services</td>
      </tr>
      <tr>
        <td>deny_host_headers = </td>
        <td>No help text available for this option.</td>
      </tr>
      <tr>
        <td>error_suppression_interval = 60</td>
        <td>Time in seconds that must elapse since the last error for a node to be considered no longer error limited</td>
      </tr>
      <tr>
        <td>error_suppression_limit = 10</td>
        <td>Error count to consider a node error limited</td>
      </tr>
      <tr>
        <td>log_handoffs = true</td>
        <td>No help text available for this option.</td>
      </tr>
      <tr>
        <td>max_containers_per_account = 0</td>
        <td>If set to a positive value, trying to create a container when the account already has at least this maximum containers will result in a 403 Forbidden. Note: This is a soft limit, meaning a user might exceed the cap for recheck_account_existence before the 403s kick in.</td>
      </tr>
      <tr>
        <td>max_containers_whitelist = </td>
        <td>is a comma separated list of account names that ignore the max_containers_per_account cap.</td>
      </tr>
      <tr>
        <td>max_large_object_get_time = 86400</td>
        <td>No help text available for this option.</td>
      </tr>
      <tr>
        <td>node_timeout = 10</td>
        <td>Request timeout to external services</td>
      </tr>
      <tr>
        <td>object_chunk_size = 65536</td>
        <td>Chunk size to read from object servers</td>
      </tr>
      <tr>
        <td>object_post_as_copy = true</td>
        <td>Set object_post_as_copy  =  false to turn on fast posts where only the metadata changes are stored anew and the original data file is kept in place. This makes for quicker posts; but since the container metadata isn't updated in this mode, features like container sync won't be able to sync posts.</td>
      </tr>
      <tr>
        <td>post_quorum_timeout = 0.5</td>
        <td>No help text available for this option.</td>
      </tr>
      <tr>
        <td>put_queue_depth = 10</td>
        <td>No help text available for this option.</td>
      </tr>
      <tr>
        <td>read_affinity = r1z1=100, r1z2=200, r2=300</td>
        <td>No help text available for this option.</td>
      </tr>
      <tr>
        <td>recheck_account_existence = 60</td>
        <td>Cache timeout in seconds to send memcached for account existence</td>
      </tr>
      <tr>
        <td>recheck_container_existence = 60</td>
        <td>Cache timeout in seconds to send memcached for container existence</td>
      </tr>
      <tr>
        <td>recoverable_node_timeout = node_timeout</td>
        <td>Request timeout to external services for requests that, on failure, can be recovered from. For example, object GET. from a client external services</td>
      </tr>
      <tr>
        <td>request_node_count = 2 * replicas</td>
        <td>* replicas     Set to the number of nodes to contact for a normal request. You can use '* replicas' at the end to have it use the number given times the number of replicas for the ring being used for the request. conf file for    values will only be shown to the list of      swift_owners. The exact default          definition of a swift_owner is headers&gt;         up to the auth system in use, but usually indicates administrative responsibilities. paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request</td>
      </tr>
      <tr>
        <td>set log_address = /dev/log</td>
        <td>Location where syslog sends the logs to</td>
      </tr>
      <tr>
        <td>set log_facility = LOG_LOCAL0</td>
        <td>Syslog log facility</td>
      </tr>
      <tr>
        <td>set log_level = INFO</td>
        <td>Log level</td>
      </tr>
      <tr>
        <td>set log_name = proxy-server</td>
        <td>Label to use when logging</td>
      </tr>
      <tr>
        <td>sorting_method = shuffle</td>
        <td>No help text available for this option.</td>
      </tr>
      <tr>
        <td>swift_owner_headers = x-container-read, x-container-write, x-container-sync-key, x-container-sync-to, x-account-meta-temp-url-key, x-account-meta-temp-url-key-2, x-account-access-control</td>
        <td>the sample  These are the headers whose conf file for    values will only be shown to the list of      swift_owners. The exact default          definition of a swift_owner is headers&gt;         up to the auth system in use, but usually indicates administrative responsibilities. paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request</td>
      </tr>
      <tr>
        <td>timing_expiry = 300</td>
        <td>No help text available for this option.</td>
      </tr>
      <tr>
        <td>use = egg:swift#proxy</td>
        <td>Entry point of paste.deploy in the server</td>
      </tr>
      <tr>
        <td>write_affinity = r1, r2</td>
        <td>No help text available for this option.</td>
      </tr>
      <tr>
        <td>write_affinity_node_count = 2 * replicas</td>
        <td>No help text available for this option.</td>
      </tr>
    </tbody>
  </table>
</para>