New and updated options for swift in icehouse
Include the output of our diff_branches script for swift. This output is generated with: https://review.openstack.org/#/c/100070/ https://review.openstack.org/#/c/100332/ https://review.openstack.org/#/c/100348/ Change-Id: I15058715b45fc93adacab20118ba747e5a8d0349 backport: icehouse
This commit is contained in:
Gauvain Pocentek
parent
0145486f23
commit
4680033ba6
|
|
@ -0,0 +1,270 @@
|
|||
<?xml version='1.0' encoding='UTF-8'?>
|
||||
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="swift-conf-changes-icehouse">
|
||||
<!-- 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 for swift</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>container-sync-realms.conf: [DEFAULT]/mtime_check_interval = 300</td>
|
||||
<td>(StrOpt) No help text available for this option.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>container-sync-realms.conf: [realm1]/cluster_name1 = https://host1/v1/</td>
|
||||
<td>(StrOpt) No help text available for this option.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>container-sync-realms.conf: [realm1]/cluster_name2 = https://host2/v1/</td>
|
||||
<td>(StrOpt) No help text available for this option.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>container-sync-realms.conf: [realm1]/key = realm1key</td>
|
||||
<td>(StrOpt) No help text available for this option.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>container-sync-realms.conf: [realm1]/key2 = realm1key2</td>
|
||||
<td>(StrOpt) No help text available for this option.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>container-sync-realms.conf: [realm2]/cluster_name3 = https://host3/v1/</td>
|
||||
<td>(StrOpt) No help text available for this option.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>container-sync-realms.conf: [realm2]/cluster_name4 = https://host4/v1/</td>
|
||||
<td>(StrOpt) No help text available for this option.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>container-sync-realms.conf: [realm2]/key = realm2key</td>
|
||||
<td>(StrOpt) No help text available for this option.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>container-sync-realms.conf: [realm2]/key2 = realm2key2</td>
|
||||
<td>(StrOpt) No help text available for this option.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>dispersion.conf: [dispersion]/container_populate = yes</td>
|
||||
<td>(StrOpt) No help text available for this option.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>dispersion.conf: [dispersion]/object_populate = yes</td>
|
||||
<td>(StrOpt) No help text available for this option.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>memcache.conf: [memcache]/memcache_max_connections = 2</td>
|
||||
<td>(StrOpt) Max number of connections to each memcached server per worker services</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>object-expirer.conf: [object-expirer]/expiring_objects_account_name = expiring_objects</td>
|
||||
<td>(StrOpt) No help text available for this option.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>object-server.conf: [DEFAULT]/client_timeout = 60</td>
|
||||
<td>(StrOpt) Timeout to read one chunk from a client external services</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>object-server.conf: [DEFAULT]/conn_timeout = 0.5</td>
|
||||
<td>(StrOpt) Connection timeout to external services</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>object-server.conf: [DEFAULT]/disk_chunk_size = 65536</td>
|
||||
<td>(StrOpt) Size of chunks to read/write to disk</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>object-server.conf: [DEFAULT]/expiring_objects_account_name = expiring_objects</td>
|
||||
<td>(StrOpt) No help text available for this option.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>object-server.conf: [DEFAULT]/network_chunk_size = 65536</td>
|
||||
<td>(StrOpt) Size of chunks to read/write over the network</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>object-server.conf: [DEFAULT]/node_timeout = 3</td>
|
||||
<td>(StrOpt) Request timeout to external services</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>object-server.conf: [app-object-server]/replication_concurrency = 4</td>
|
||||
<td>(StrOpt) Set to restrict the number of concurrent incoming REPLICATION requests; set to 0 for unlimited</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>object-server.conf: [app-object-server]/replication_failure_ratio = 1.0</td>
|
||||
<td>(StrOpt) If the value of failures / successes of REPLICATION subrequests exceeds this ratio, the overall REPLICATION request will be aborted</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>object-server.conf: [app-object-server]/replication_failure_threshold = 100</td>
|
||||
<td>(StrOpt) The number of subrequest failures before the replication_failure_ratio is checked</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>object-server.conf: [app-object-server]/replication_lock_timeout = 15</td>
|
||||
<td>(StrOpt) Number of seconds to wait for an existing replication device lock before giving up.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>object-server.conf: [app-object-server]/replication_one_per_device = True</td>
|
||||
<td>(StrOpt) Restricts incoming REPLICATION requests to one per device, replication_currency above allowing. This can help control I/O to each device, but you may wish to set this to False to allow multiple REPLICATION requests (up to the above replication_concurrency setting) per device.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>object-server.conf: [object-replicator]/handoff_delete = auto</td>
|
||||
<td>(StrOpt) By default handoff partitions will be removed when it has successfully replicated to all the canonical nodes. If set to an integer n, it will remove the partition if it is successfully replicated to n nodes. The default setting should not be changed, except for extremem situations. This uses what's set here, or what's set in the DEFAULT section, or 10 (though other sections use 3 as the final default).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>object-server.conf: [object-replicator]/handoffs_first = False</td>
|
||||
<td>(StrOpt) If set to True, partitions that are not supposed to be on the node will be replicated first. The default setting should not be changed, except for extreme situations.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>object-server.conf: [object-replicator]/node_timeout = &lt;whatever's in the DEFAULT section or 10&gt;</td>
|
||||
<td>(StrOpt) Request timeout to external services</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>object-server.conf: [object-replicator]/sync_method = rsync</td>
|
||||
<td>(StrOpt) No help text available for this option.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>proxy-server.conf: [DEFAULT]/admin_key = secret_admin_key</td>
|
||||
<td>(StrOpt) 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>proxy-server.conf: [DEFAULT]/disallowed_sections = container_quotas, tempurl</td>
|
||||
<td>(StrOpt) No help text available for this option.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>proxy-server.conf: [DEFAULT]/expiring_objects_account_name = expiring_objects</td>
|
||||
<td>(StrOpt) No help text available for this option.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>proxy-server.conf: [DEFAULT]/expose_info = true</td>
|
||||
<td>(StrOpt) Enables exposing configuration settings via HTTP GET /info.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>proxy-server.conf: [app-proxy-server]/post_quorum_timeout = 0.5</td>
|
||||
<td>(StrOpt) No help text available for this option.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>proxy-server.conf: [app-proxy-server]/recoverable_node_timeout = node_timeout</td>
|
||||
<td>(StrOpt) 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>proxy-server.conf: [filter-authtoken]/include_service_catalog = False</td>
|
||||
<td>(StrOpt) No help text available for this option.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>proxy-server.conf: [filter-bulk]/delete_container_retry_count = 0</td>
|
||||
<td>(StrOpt) No help text available for this option.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>proxy-server.conf: [filter-bulk]/max_failed_deletes = 1000</td>
|
||||
<td>(StrOpt) No help text available for this option.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>proxy-server.conf: [filter-cache]/memcache_max_connections = 2</td>
|
||||
<td>(StrOpt) Max number of connections to each memcached server per worker services</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>proxy-server.conf: [filter-container_sync]/allow_full_urls = true</td>
|
||||
<td>(StrOpt) No help text available for this option.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>proxy-server.conf: [filter-container_sync]/use = egg:swift#container_sync</td>
|
||||
<td>(StrOpt) Entry point of paste.deploy in the server</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>proxy-server.conf: [filter-dlo]/max_get_time = 86400</td>
|
||||
<td>(StrOpt) No help text available for this option.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>proxy-server.conf: [filter-dlo]/rate_limit_after_segment = 10</td>
|
||||
<td>(StrOpt) Rate limit the download of large object segments after this segment is downloaded.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>proxy-server.conf: [filter-dlo]/rate_limit_segments_per_sec = 1</td>
|
||||
<td>(StrOpt) Rate limit large object downloads at this rate. 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. paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>proxy-server.conf: [filter-dlo]/use = egg:swift#dlo</td>
|
||||
<td>(StrOpt) Entry point of paste.deploy in the server</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>proxy-server.conf: [filter-gatekeeper]/set log_address = /dev/log</td>
|
||||
<td>(StrOpt) Location where syslog sends the logs to</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>proxy-server.conf: [filter-gatekeeper]/set log_facility = LOG_LOCAL0</td>
|
||||
<td>(StrOpt) Syslog log facility</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>proxy-server.conf: [filter-gatekeeper]/set log_headers = false</td>
|
||||
<td>(StrOpt) If True, log headers in each request</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>proxy-server.conf: [filter-gatekeeper]/set log_level = INFO</td>
|
||||
<td>(StrOpt) Log level</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>proxy-server.conf: [filter-gatekeeper]/set log_name = gatekeeper</td>
|
||||
<td>(StrOpt) Label to use when logging</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>proxy-server.conf: [filter-gatekeeper]/use = egg:swift#gatekeeper</td>
|
||||
<td>(StrOpt) Entry point of paste.deploy in the server</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>proxy-server.conf: [filter-proxy-logging]/access_log_headers_only = </td>
|
||||
<td>(StrOpt) No help text available for this option.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>proxy-server.conf: [filter-slo]/max_get_time = 86400</td>
|
||||
<td>(StrOpt) No help text available for this option.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>proxy-server.conf: [filter-slo]/rate_limit_after_segment = 10</td>
|
||||
<td>(StrOpt) Rate limit the download of large object segments after this segment is downloaded.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>proxy-server.conf: [filter-slo]/rate_limit_segments_per_sec = 0</td>
|
||||
<td>(StrOpt) Rate limit large object downloads at this rate. 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. paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request</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>container-server.conf: [container-sync]/sync_proxy</td>
|
||||
<td>http://127.0.0.1:8888</td>
|
||||
<td>http://10.1.1.1:8888,http://10.1.1.2:8888</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>object-server.conf: [object-updater]/node_timeout</td>
|
||||
<td>10</td>
|
||||
<td>&lt;whatever's in the DEFAULT section or 10&gt;</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>proxy-server.conf: [app-proxy-server]/swift_owner_headers</td>
|
||||
<td>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</td>
|
||||
<td>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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>proxy-server.conf: [filter-bulk]/yield_frequency</td>
|
||||
<td>60</td>
|
||||
<td>10</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>proxy-server.conf: [pipeline-main]/pipeline</td>
|
||||
<td>catch_errors healthcheck proxy-logging cache bulk slo ratelimit tempauth container-quotas account-quotas proxy-logging proxy-server</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>
|
||||
</tr>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -204,4 +204,6 @@
|
|||
<!-- section on Object Storage Features -->
|
||||
<xi:include
|
||||
href="object-storage/section_object-storage-features.xml"/>
|
||||
|
||||
<xi:include href="../common/tables/swift-conf-changes-icehouse.xml"/>
|
||||
</chapter>
|
||||
|
|
|
|||
Loading…
Reference in New Issue