openstack-manuals/doc/common/tables/swift-proxy-server-DEFAULT.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>[DEFAULT]</literal> in <filename>proxy-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>admin_key</option> = <replaceable>secret_admin_key</replaceable></td>
        <td>to use for admin calls that are HMAC signed.  Default is empty, which will disable admin calls to /info. the proxy server.  For most cases, this should be `egg:swift#proxy`. request whenever it has to failover to a handoff node</td>
      </tr>
      <tr>
        <td><option>backlog</option> = <replaceable>4096</replaceable></td>
        <td>Maximum number of allowed pending TCP connections</td>
      </tr>
      <tr>
        <td><option>bind_ip</option> = <replaceable>0.0.0.0</replaceable></td>
        <td>IP Address for server to bind to</td>
      </tr>
      <tr>
        <td><option>bind_port</option> = <replaceable>8080</replaceable></td>
        <td>Port for server to bind to</td>
      </tr>
      <tr>
        <td><option>bind_timeout</option> = <replaceable>30</replaceable></td>
        <td>Seconds to attempt bind before giving up</td>
      </tr>
      <tr>
        <td><option>cert_file</option> = <replaceable>/etc/swift/proxy.crt</replaceable></td>
        <td>to the ssl .crt. This should be enabled for testing purposes only.</td>
      </tr>
      <tr>
        <td><option>client_timeout</option> = <replaceable>60</replaceable></td>
        <td>Timeout to read one chunk from a client external services</td>
      </tr>
      <tr>
        <td><option>cors_allow_origin</option> = <replaceable></replaceable></td>
        <td>is a list of hosts that are included with any CORS request by default and returned with the Access-Control-Allow-Origin header in addition to what the container has set. to call to setup custom log handlers. for eventlet the proxy server.  For most cases, this should be `egg:swift#proxy`. request whenever it has to failover to a handoff node</td>
      </tr>
      <tr>
        <td><option>disallowed_sections</option> = <replaceable>swift.valid_api_versions, container_quotas, tempurl</replaceable></td>
        <td>No help text available for this option.</td>
      </tr>
      <tr>
        <td><option>eventlet_debug</option> = <replaceable>false</replaceable></td>
        <td>If true, turn on debug logging for eventlet</td>
      </tr>
      <tr>
        <td><option>expiring_objects_account_name</option> = <replaceable>expiring_objects</replaceable></td>
        <td>No help text available for this option.</td>
      </tr>
      <tr>
        <td><option>expiring_objects_container_divisor</option> = <replaceable>86400</replaceable></td>
        <td>No help text available for this option.</td>
      </tr>
      <tr>
        <td><option>expose_info</option> = <replaceable>true</replaceable></td>
        <td>Enables exposing configuration settings via HTTP GET /info.</td>
      </tr>
      <tr>
        <td><option>key_file</option> = <replaceable>/etc/swift/proxy.key</replaceable></td>
        <td>to the ssl .key. This should be enabled for testing purposes only.</td>
      </tr>
      <tr>
        <td><option>log_address</option> = <replaceable>/dev/log</replaceable></td>
        <td>Location where syslog sends the logs to</td>
      </tr>
      <tr>
        <td><option>log_custom_handlers</option> = <replaceable></replaceable></td>
        <td>Comma-separated list of functions to call to setup custom log handlers.</td>
      </tr>
      <tr>
        <td><option>log_facility</option> = <replaceable>LOG_LOCAL0</replaceable></td>
        <td>Syslog log facility</td>
      </tr>
      <tr>
        <td><option>log_headers</option> = <replaceable>false</replaceable></td>
        <td>No help text available for this option.</td>
      </tr>
      <tr>
        <td><option>log_level</option> = <replaceable>INFO</replaceable></td>
        <td>Logging level</td>
      </tr>
      <tr>
        <td><option>log_max_line_length</option> = <replaceable>0</replaceable></td>
        <td>Caps the length of log lines to the value given; no limit if set to 0, the default.</td>
      </tr>
      <tr>
        <td><option>log_name</option> = <replaceable>swift</replaceable></td>
        <td>Label used when logging</td>
      </tr>
      <tr>
        <td><option>log_statsd_default_sample_rate</option> = <replaceable>1.0</replaceable></td>
        <td>Defines the probability of sending a sample for any given event or
                    timing measurement.</td>
      </tr>
      <tr>
        <td><option>log_statsd_host</option> = <replaceable>localhost</replaceable></td>
        <td>If not set, the StatsD feature is disabled.</td>
      </tr>
      <tr>
        <td><option>log_statsd_metric_prefix</option> = <replaceable></replaceable></td>
        <td>Value will be prepended to every metric sent to the StatsD server.</td>
      </tr>
      <tr>
        <td><option>log_statsd_port</option> = <replaceable>8125</replaceable></td>
        <td>Port value for the StatsD server.</td>
      </tr>
      <tr>
        <td><option>log_statsd_sample_rate_factor</option> = <replaceable>1.0</replaceable></td>
        <td>Not recommended to set this to a value less than 1.0, if frequency
                    of logging is too high, tune the
                    log_statsd_default_sample_rate instead.</td>
      </tr>
      <tr>
        <td><option>log_udp_host</option> = <replaceable></replaceable></td>
        <td>If not set, the UDP receiver for syslog is disabled.</td>
      </tr>
      <tr>
        <td><option>log_udp_port</option> = <replaceable>514</replaceable></td>
        <td>Port value for UDP receiver, if enabled.</td>
      </tr>
      <tr>
        <td><option>max_clients</option> = <replaceable>1024</replaceable></td>
        <td>Maximum number of clients one worker can process simultaneously
Lowering the number of clients handled per worker, and raising the
number of workers can lessen the impact that a CPU intensive, or
blocking, request can have on other requests served by the same
worker. If the maximum number of clients is set to one, then a given worker
will not perform another call while processing, allowing
other workers a chance to process it.</td>
      </tr>
      <tr>
        <td><option>strict_cors_mode</option> = <replaceable>True</replaceable></td>
        <td>No help text available for this option.</td>
      </tr>
      <tr>
        <td><option>swift_dir</option> = <replaceable>/etc/swift</replaceable></td>
        <td>Swift configuration directory</td>
      </tr>
      <tr>
        <td><option>trans_id_suffix</option> = <replaceable></replaceable></td>
        <td>No help text available for this option.</td>
      </tr>
      <tr>
        <td><option>user</option> = <replaceable>swift</replaceable></td>
        <td>User to run as</td>
      </tr>
      <tr>
        <td><option>workers</option> = <replaceable>auto</replaceable></td>
        <td>a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.</td>
      </tr>
    </tbody>
  </table>
</para>