openstack-manuals/doc/common/tables/swift-conf-changes.xml

<?xml version='1.0' encoding='UTF-8'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="swift-conf-changes-juno">
  <!-- Warning: Do not edit this file. It is automatically generated and your changes will be overwritten. The tool to do so lives in the openstack-doc-tools repository. -->
  <title>New, updated and deprecated options in Juno for OpenStack Object Storage</title>
  <table>
    <caption>New options</caption>
    <col width="50%"/>
    <col width="50%"/>
    <thead>
      <tr>
        <td>Option = default value</td>
        <td>(Type) Help string</td>
      </tr>
    </thead>
    <tr>
      <td>account-server.conf: [DEFAULT] log_max_line_length = 0</td>
      <td>(StrOpt) Caps the length of log lines to the value given; no limit if set to 0, the default.</td>
    </tr>
    <tr>
      <td>account-server.conf: [filter-xprofile] dump_interval = 5.0</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>account-server.conf: [filter-xprofile] dump_timestamp = false</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>account-server.conf: [filter-xprofile] flush_at_shutdown = false</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>account-server.conf: [filter-xprofile] log_filename_prefix = /tmp/log/swift/profile/default.profile</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>account-server.conf: [filter-xprofile] path = /__profile__</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>account-server.conf: [filter-xprofile] profile_module = eventlet.green.profile</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>account-server.conf: [filter-xprofile] unwind = false</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>account-server.conf: [filter-xprofile] use = egg:swift#xprofile</td>
      <td>(StrOpt) Entry point of paste.deploy in the server</td>
    </tr>
    <tr>
      <td>container-reconciler.conf: [DEFAULT] log_address = /dev/log</td>
      <td>(StrOpt) Location where syslog sends the logs to</td>
    </tr>
    <tr>
      <td>container-reconciler.conf: [DEFAULT] log_custom_handlers = </td>
      <td>(StrOpt) Comma-separated list of functions to call to setup custom log handlers.</td>
    </tr>
    <tr>
      <td>container-reconciler.conf: [DEFAULT] log_facility = LOG_LOCAL0</td>
      <td>(StrOpt) Syslog log facility</td>
    </tr>
    <tr>
      <td>container-reconciler.conf: [DEFAULT] log_level = INFO</td>
      <td>(StrOpt) Logging level</td>
    </tr>
    <tr>
      <td>container-reconciler.conf: [DEFAULT] log_name = swift</td>
      <td>(StrOpt) Label used when logging</td>
    </tr>
    <tr>
      <td>container-reconciler.conf: [DEFAULT] log_statsd_default_sample_rate = 1.0</td>
      <td>(StrOpt) Defines the probability of sending a sample for any given event or
                    timing measurement.</td>
    </tr>
    <tr>
      <td>container-reconciler.conf: [DEFAULT] log_statsd_host = localhost</td>
      <td>(StrOpt) If not set, the StatsD feature is disabled.</td>
    </tr>
    <tr>
      <td>container-reconciler.conf: [DEFAULT] log_statsd_metric_prefix = </td>
      <td>(StrOpt) Value will be prepended to every metric sent to the StatsD server.</td>
    </tr>
    <tr>
      <td>container-reconciler.conf: [DEFAULT] log_statsd_port = 8125</td>
      <td>(StrOpt) Port value for the StatsD server.</td>
    </tr>
    <tr>
      <td>container-reconciler.conf: [DEFAULT] log_statsd_sample_rate_factor = 1.0</td>
      <td>(StrOpt) 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>container-reconciler.conf: [DEFAULT] log_udp_host = </td>
      <td>(StrOpt) If not set, the UDP receiver for syslog is disabled.</td>
    </tr>
    <tr>
      <td>container-reconciler.conf: [DEFAULT] log_udp_port = 514</td>
      <td>(StrOpt) Port value for UDP receiver, if enabled.</td>
    </tr>
    <tr>
      <td>container-reconciler.conf: [DEFAULT] swift_dir = /etc/swift</td>
      <td>(StrOpt) Swift configuration directory</td>
    </tr>
    <tr>
      <td>container-reconciler.conf: [DEFAULT] user = swift</td>
      <td>(StrOpt) User to run as</td>
    </tr>
    <tr>
      <td>container-reconciler.conf: [app-proxy-server] use = egg:swift#proxy</td>
      <td>(StrOpt) Entry point of paste.deploy in the server</td>
    </tr>
    <tr>
      <td>container-reconciler.conf: [container-reconciler] interval = 30</td>
      <td>(StrOpt) Minimum time for a pass to take</td>
    </tr>
    <tr>
      <td>container-reconciler.conf: [container-reconciler] reclaim_age = 604800</td>
      <td>(StrOpt) Time elapsed in seconds before an object can be reclaimed</td>
    </tr>
    <tr>
      <td>container-reconciler.conf: [container-reconciler] request_tries = 3</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>container-reconciler.conf: [filter-cache] use = egg:swift#memcache</td>
      <td>(StrOpt) Entry point of paste.deploy in the server</td>
    </tr>
    <tr>
      <td>container-reconciler.conf: [filter-catch_errors] use = egg:swift#catch_errors</td>
      <td>(StrOpt) Entry point of paste.deploy in the server</td>
    </tr>
    <tr>
      <td>container-reconciler.conf: [filter-proxy-logging] use = egg:swift#proxy_logging</td>
      <td>(StrOpt) Entry point of paste.deploy in the server</td>
    </tr>
    <tr>
      <td>container-reconciler.conf: [pipeline-main] pipeline = catch_errors proxy-logging cache proxy-server</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>container-server.conf: [DEFAULT] log_max_line_length = 0</td>
      <td>(StrOpt) Caps the length of log lines to the value given; no limit if set to 0, the default.</td>
    </tr>
    <tr>
      <td>container-server.conf: [filter-xprofile] dump_interval = 5.0</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>container-server.conf: [filter-xprofile] dump_timestamp = false</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>container-server.conf: [filter-xprofile] flush_at_shutdown = false</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>container-server.conf: [filter-xprofile] log_filename_prefix = /tmp/log/swift/profile/default.profile</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>container-server.conf: [filter-xprofile] path = /__profile__</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>container-server.conf: [filter-xprofile] profile_module = eventlet.green.profile</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>container-server.conf: [filter-xprofile] unwind = false</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>container-server.conf: [filter-xprofile] use = egg:swift#xprofile</td>
      <td>(StrOpt) Entry point of paste.deploy in the server</td>
    </tr>
    <tr>
      <td>drive-audit.conf: [drive-audit] log_max_line_length = 0</td>
      <td>(StrOpt) Caps the length of log lines to the value given; no limit if set to 0, the default.</td>
    </tr>
    <tr>
      <td>object-expirer.conf: [DEFAULT] log_max_line_length = 0</td>
      <td>(StrOpt) Caps the length of log lines to the value given; no limit if set to 0, the default.</td>
    </tr>
    <tr>
      <td>object-expirer.conf: [filter-proxy-logging] access_log_address = /dev/log</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>object-expirer.conf: [filter-proxy-logging] access_log_facility = LOG_LOCAL0</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>object-expirer.conf: [filter-proxy-logging] access_log_headers = false</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>object-expirer.conf: [filter-proxy-logging] access_log_headers_only = </td>
      <td>(StrOpt) If access_log_headers is True and access_log_headers_only is set only
            these headers are logged. Multiple headers can be defined as comma separated list like this:
            access_log_headers_only = Host, X-Object-Meta-Mtime</td>
    </tr>
    <tr>
      <td>object-expirer.conf: [filter-proxy-logging] access_log_level = INFO</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>object-expirer.conf: [filter-proxy-logging] access_log_name = swift</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>object-expirer.conf: [filter-proxy-logging] access_log_statsd_default_sample_rate = 1.0</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>object-expirer.conf: [filter-proxy-logging] access_log_statsd_host = localhost</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>object-expirer.conf: [filter-proxy-logging] access_log_statsd_metric_prefix = </td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>object-expirer.conf: [filter-proxy-logging] access_log_statsd_port = 8125</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>object-expirer.conf: [filter-proxy-logging] access_log_statsd_sample_rate_factor = 1.0</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>object-expirer.conf: [filter-proxy-logging] access_log_udp_host = </td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>object-expirer.conf: [filter-proxy-logging] access_log_udp_port = 514</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>object-expirer.conf: [filter-proxy-logging] log_statsd_valid_http_methods = GET,HEAD,POST,PUT,DELETE,COPY,OPTIONS</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>object-expirer.conf: [filter-proxy-logging] logged with access_log_headers = True.</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>object-expirer.conf: [filter-proxy-logging] reveal_sensitive_prefix = 16</td>
      <td>(StrOpt) The X-Auth-Token is sensitive data. If revealed to an unauthorised person,
            they can now make requests against an account until the token expires.

            Set reveal_sensitive_prefix to the number of characters of the token that are logged.
            For example reveal_sensitive_prefix = 12 so only first 12 characters of the token are logged.
            Or, set to 0 to completely remove the token.</td>
    </tr>
    <tr>
      <td>object-expirer.conf: [filter-proxy-logging] use = egg:swift#proxy_logging</td>
      <td>(StrOpt) Entry point of paste.deploy in the server</td>
    </tr>
    <tr>
      <td>object-expirer.conf: [object-expirer] reclaim_age = 604800</td>
      <td>(StrOpt) Time elapsed in seconds before an object can be reclaimed</td>
    </tr>
    <tr>
      <td>object-expirer.conf: [object-expirer] recon_cache_path = /var/cache/swift</td>
      <td>(StrOpt) Directory where stats for a few items will be stored</td>
    </tr>
    <tr>
      <td>object-server.conf: [DEFAULT] log_max_line_length = 0</td>
      <td>(StrOpt) Caps the length of log lines to the value given; no limit if set to 0, the default.</td>
    </tr>
    <tr>
      <td>object-server.conf: [app-object-server] splice = no</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>object-server.conf: [filter-xprofile] dump_interval = 5.0</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>object-server.conf: [filter-xprofile] dump_timestamp = false</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>object-server.conf: [filter-xprofile] flush_at_shutdown = false</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>object-server.conf: [filter-xprofile] log_filename_prefix = /tmp/log/swift/profile/default.profile</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>object-server.conf: [filter-xprofile] path = /__profile__</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>object-server.conf: [filter-xprofile] profile_module = eventlet.green.profile</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>object-server.conf: [filter-xprofile] unwind = false</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>object-server.conf: [filter-xprofile] use = egg:swift#xprofile</td>
      <td>(StrOpt) Entry point of paste.deploy in the server</td>
    </tr>
    <tr>
      <td>object-server.conf: [object-auditor] concurrency = 1</td>
      <td>(StrOpt) Number of replication workers to spawn</td>
    </tr>
    <tr>
      <td>object-server.conf: [object-auditor] disk_chunk_size = 65536</td>
      <td>(StrOpt) Size of chunks to read/write to disk</td>
    </tr>
    <tr>
      <td>proxy-server.conf: [DEFAULT] log_max_line_length = 0</td>
      <td>(StrOpt) Caps the length of log lines to the value given; no limit if set to 0, the default.</td>
    </tr>
    <tr>
      <td>proxy-server.conf: [DEFAULT] strict_cors_mode = True</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>proxy-server.conf: [filter-container_sync] current = //REALM/CLUSTER</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>proxy-server.conf: [filter-keystoneauth] allow_names_in_acls = true</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>proxy-server.conf: [filter-keystoneauth] default_domain_id = default</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>proxy-server.conf: [filter-xprofile] dump_interval = 5.0</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>proxy-server.conf: [filter-xprofile] dump_timestamp = false</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>proxy-server.conf: [filter-xprofile] flush_at_shutdown = false</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>proxy-server.conf: [filter-xprofile] log_filename_prefix = /tmp/log/swift/profile/default.profile</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>proxy-server.conf: [filter-xprofile] path = /__profile__</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>proxy-server.conf: [filter-xprofile] profile_module = eventlet.green.profile</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>proxy-server.conf: [filter-xprofile] unwind = false</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>proxy-server.conf: [filter-xprofile] use = egg:swift#xprofile</td>
      <td>(StrOpt) Entry point of paste.deploy in the server</td>
    </tr>
    <tr>
      <td>swift.conf: [storage-policy-0] default = yes</td>
      <td>(StrOpt) 0 means to not use a per-disk thread pool. It is recommended to keep this value small, as large values can result in high read latencies due to large queue depths. A good starting point is 4 threads per disk.</td>
    </tr>
    <tr>
      <td>swift.conf: [storage-policy-0] name = Policy-0</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
    <tr>
      <td>swift.conf: [storage-policy-1] name = silver</td>
      <td>(StrOpt) No help text available for this option.</td>
    </tr>
  </table>
  <table>
    <caption>New default values</caption>
    <col width="33%"/>
    <col width="33%"/>
    <col width="33%"/>
    <thead>
      <tr>
        <td>Option</td>
        <td>Previous default value</td>
        <td>New default value</td>
      </tr>
    </thead>
    <tr>
      <td>dispersion.conf: [dispersion] auth_version</td>
      <td>2.0</td>
      <td>1.0</td>
    </tr>
    <tr>
      <td>drive-audit.conf: [drive-audit] log_file_pattern</td>
      <td>/var/log/kern*</td>
      <td>/var/log/kern.*[!.][!g][!z]</td>
    </tr>
    <tr>
      <td>object-expirer.conf: [pipeline-main] pipeline</td>
      <td>catch_errors cache proxy-server</td>
      <td>catch_errors proxy-logging cache proxy-server</td>
    </tr>
    <tr>
      <td>proxy-server.conf: [DEFAULT] bind_port</td>
      <td>80</td>
      <td>8080</td>
    </tr>
    <tr>
      <td>proxy-server.conf: [DEFAULT] disallowed_sections</td>
      <td>container_quotas, tempurl</td>
      <td>container_quotas, tempurl, bulk_delete.max_failed_deletes</td>
    </tr>
    <tr>
      <td>proxy-server.conf: [app-proxy-server] client_chunk_size</td>
      <td>8192</td>
      <td>65536</td>
    </tr>
    <tr>
      <td>proxy-server.conf: [app-proxy-server] object_chunk_size</td>
      <td>8192</td>
      <td>65536</td>
    </tr>
    <tr>
      <td>proxy-server.conf: [filter-proxy-logging] reveal_sensitive_prefix</td>
      <td>8192</td>
      <td>16</td>
    </tr>
    <tr>
      <td>proxy-server.conf: [filter-tempurl] methods</td>
      <td>GET HEAD PUT</td>
      <td>GET HEAD PUT POST DELETE</td>
    </tr>
    <tr>
      <td>proxy-server.conf: [pipeline-main] pipeline</td>
      <td>catch_errors gatekeeper healthcheck proxy-logging cache container_sync bulk tempurl slo dlo ratelimit tempauth container-quotas account-quotas proxy-logging proxy-server</td>
      <td>catch_errors gatekeeper healthcheck proxy-logging cache container_sync bulk tempurl ratelimit tempauth container-quotas account-quotas slo dlo proxy-logging proxy-server</td>
    </tr>
  </table>
</section>