openstack/openstack-manuals
Code Issues Proposed changes

Make swift config tables the source of truth

Browse Source 
As discussed on the mailing list, this patch will make the swift
configuration tables found in common a source of truth for the
helptext. The script that generates them has been updated for this,
and will now only add/remove options, update default values, and
replace helptext where it does not exist in the tables. Another
run of the script was done and tables were updated.

Backstory: All projects other than Swift use OpenStack Common for
configuration, and define option, default value and help text in the
code in a way that it's possible to extract.

Since the code is able to act in this way, we can stop maintaining
separate instructive lines for configuration options, and instead
fix any text problems in the code itself. This both improves the
quality of the code and fixes our double maintenance problem.

For swift, we needed a different approach. Unfortunately, I think we
don't have the ability to treat the code as the definitive source and
move all maintenance there. The lack of instruction for every option,
and absence of structure precludes this.

So I wrote some nasty scraping things (from RST and sample conf file)
to seed an initial list of configuration options.

My plan from here was to make the 'update' portion of the script
treat the textual descriptions in common/tables/swift-*.xml as
definitive.

The script would still search the swift code to add or remove
options, so we could guarantee completeness, and after an initial
push to write out proper help text the maintenance becomes far
simpler.

Change-Id: I2464f5c63cb0da110e1871a09a59380dad9b6b27
This commit is contained in:
Tom Fifield 2013-09-03 10:39:38 +10:00
parent 7a42fcd01a
commit dea0e970d1
63 changed files with 1016 additions and 993 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

92
doc/src/docbkx/common/tables/swift-account-server-DEFAULT.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[DEFAULT]</literal> in <literal>account-server.conf-sample</literal></caption>
@ -17,79 +16,92 @@
<tbody>
<tr>
<td>bind_ip=0.0.0.0</td><td>IP Address for server to bind to</td>
</tr>
</tr>
<tr>
<td>bind_port=6002</td><td>Port for server to bind to</td>
</tr>
</tr>
<tr>
<td>bind_timeout=30</td><td>Seconds to attempt bind before giving up</td>
</tr>
</tr>
<tr>
<td>backlog=4096</td><td>Maximum number of allowed pending TCP connections</td>
</tr>
<tr>
<td>workers=1</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>
</tr>
<tr>
<td>user=swift</td><td>User to run as</td>
</tr>
</tr>
<tr>
<td>swift_dir=/etc/swift</td><td>Swift configuration directory</td>
</tr>
</tr>
<tr>
<td>devices=/srv/node</td><td>Parent directory of where devices are mounted</td>
</tr>
</tr>
<tr>
<td>mount_check=true</td><td>Whether or not check if the devices are mounted to prevent accidentally writing to the root device</td>
</tr>
</tr>
<tr>
<td>disable_fallocate=false</td><td>Disable "fast fail" fallocate checks if the underlying filesystem does not support it.</td>
</tr>
</tr>
<tr>
<td>workers=auto</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>
<tr>
<td>max_clients=1024</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>log_name=swift</td><td>Label used when logging</td>
</tr>
</tr>
<tr>
<td>log_facility=LOG_LOCAL0</td><td>Syslog log facility</td>
</tr>
</tr>
<tr>
<td>log_level=INFO</td><td>Logging level</td>
</tr>
</tr>
<tr>
<td>log_address=/dev/log</td><td>No help text available for this option</td>
</tr>
<td>log_address=/dev/log</td><td>Location where syslog sends the logs to</td>
</tr>
<tr>
<td>log_custom_handlers=</td><td>Comma-separated list of functions to call to setup custom log handlers.</td>
</tr>
</tr>
<tr>
<td>log_udp_host=</td><td>No help text available for this option</td>
</tr>
<td>log_udp_host=</td><td>If not set, the UDB receiver for syslog is disabled.</td>
</tr>
<tr>
<td>log_udp_port=514</td><td>No help text available for this option</td>
</tr>
<td>log_udp_port=514</td><td>Port value for UDB receiver, if enabled.</td>
</tr>
<tr>
<td>log_statsd_host=localhost</td><td>No help text available for this option</td>
</tr>
<td>log_statsd_host=localhost</td><td>If not set, the StatsD feature is disabled.</td>
</tr>
<tr>
<td>log_statsd_port=8125</td><td>No help text available for this option</td>
</tr>
<td>log_statsd_port=8125</td><td>Port value for the StatsD server.</td>
</tr>
<tr>
<td>log_statsd_default_sample_rate=1.0</td><td>No help text available for this option</td>
</tr>
<td>log_statsd_default_sample_rate=1.0</td><td>Defines the probability of sending a sample for any given event or
timing measurement.</td>
</tr>
<tr>
<td>log_statsd_sample_rate_factor=1.0</td><td>No help text available for this option</td>
</tr>
<td>log_statsd_sample_rate_factor=1.0</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>log_statsd_metric_prefix=</td><td>No help text available for this option</td>
</tr>
<td>log_statsd_metric_prefix=</td><td>Value will be prepended to every metric sent to the StatsD server.</td>
</tr>
<tr>
<td>db_preallocation=off</td><td>If you don't mind the extra disk space usage in overhead, you can turn this on to preallocate disk space with SQLite databases to decrease fragmentation. underlying filesystem does not support it. to setup custom log handlers. bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#account`. replication passes account can be reclaimed</td>
</tr>
</tr>
<tr>
<td>eventlet_debug=false</td><td>If true, turn on debug logging for eventlet</td>
</tr>
</tr>
<tr>
<td>fallocate_reserve=0</td><td>You can set fallocate_reserve to the number of bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#object`.</td>
</tr>
</tr>
</tbody>
</table>
</para>
</para>

32
doc/src/docbkx/common/tables/swift-account-server-account-auditor.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[account-auditor]</literal> in <literal>account-server.conf-sample</literal></caption>
@ -17,32 +16,31 @@
<tbody>
<tr>
<td>log_name=account-auditor</td><td>Label used when logging</td>
</tr>
</tr>
<tr>
<td>log_facility=LOG_LOCAL0</td><td>Syslog log facility</td>
</tr>
</tr>
<tr>
<td>log_level=INFO</td><td>Logging level</td>
</tr>
</tr>
<tr>
<td>log_address=/dev/log</td><td>No help text available for this option</td>
</tr>
<td>log_address=/dev/log</td><td>Location where syslog sends the logs to</td>
</tr>
<tr>
<td>interval=1800</td><td>Minimum time for a pass to take</td>
</tr>
</tr>
<tr>
<td>log_facility=LOG_LOCAL0</td><td>Syslog log facility</td>
</tr>
</tr>
<tr>
<td>log_level=INFO</td><td>Logging level</td>
</tr>
</tr>
<tr>
<td>accounts_per_second=200</td><td>Maximum accounts audited per second. Should be tuned according to individual system specs. 0 is unlimited.</td>
</tr>
</tr>
<tr>
<td>recon_cache_path=/var/cache/swift</td><td>Directory where stats for a
few items will be stored</td>
</tr>
<td>recon_cache_path=/var/cache/swift</td><td>Directory where stats for a few items will be stored</td>
</tr>
</tbody>
</table>
</para>
</para>

29
doc/src/docbkx/common/tables/swift-account-server-account-reaper.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[account-reaper]</literal> in <literal>account-server.conf-sample</literal></caption>
@ -17,34 +16,34 @@
<tbody>
<tr>
<td>log_name=account-reaper</td><td>Label used when logging</td>
</tr>
</tr>
<tr>
<td>log_facility=LOG_LOCAL0</td><td>Syslog log facility</td>
</tr>
</tr>
<tr>
<td>log_level=INFO</td><td>Logging level</td>
</tr>
</tr>
<tr>
<td>log_address=/dev/log</td><td>No help text available for this option</td>
</tr>
<td>log_address=/dev/log</td><td>Location where syslog sends the logs to</td>
</tr>
<tr>
<td>concurrency=25</td><td>Number of replication workers to spawn</td>
</tr>
</tr>
<tr>
<td>interval=3600</td><td>Minimum time for a pass to take</td>
</tr>
</tr>
<tr>
<td>node_timeout=10</td><td>Request timeout to external services</td>
</tr>
</tr>
<tr>
<td>conn_timeout=0.5</td><td>Connection timeout to external services</td>
</tr>
</tr>
<tr>
<td>delay_reaping=0</td><td>Normally, the reaper begins deleting account information for deleted accounts immediately; you can set this to delay its work however. The value is in seconds, 2592000 = 30 days, for example. bind to giving up worker can process simultaneously (it will actually accept(2) N + 1). Setting this to one (1) will only handle one request at a time, without accepting another request concurrently. By increasing the number of workers to a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.</td>
</tr>
</tr>
<tr>
<td>reap_warn_after=2592000</td><td>No help text available for this option</td>
</tr>
</tr>
</tbody>
</table>
</para>

47
doc/src/docbkx/common/tables/swift-account-server-account-replicator.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[account-replicator]</literal> in <literal>account-server.conf-sample</literal></caption>
@ -17,52 +16,52 @@
<tbody>
<tr>
<td>log_name=account-replicator</td><td>Label used when logging</td>
</tr>
</tr>
<tr>
<td>log_facility=LOG_LOCAL0</td><td>Syslog log facility</td>
</tr>
</tr>
<tr>
<td>log_level=INFO</td><td>Logging level</td>
</tr>
</tr>
<tr>
<td>log_address=/dev/log</td><td>No help text available for this option</td>
</tr>
<td>log_address=/dev/log</td><td>Location where syslog sends the logs to</td>
</tr>
<tr>
<td>vm_test_mode=no</td><td>Indicates that you are using a VM environment</td>
</tr>
</tr>
<tr>
<td>per_diff=1000</td><td>Limit number of items to get per diff</td>
</tr>
</tr>
<tr>
<td>max_diffs=100</td><td>Caps how long the replicator tries to spend syncing a database per pass</td>
</tr>
<td>max_diffs=100</td><td>Caps how long the replicator spends trying to sync a database per pass</td>
</tr>
<tr>
<td>concurrency=8</td><td>Number of replication workers to spawn</td>
</tr>
</tr>
<tr>
<td>interval=30</td><td>Minimum time for a pass to take</td>
</tr>
</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>
<tr>
<td>error_suppression_limit=10</td><td>Error count to consider a node error limited</td>
</tr>
</tr>
<tr>
<td>node_timeout=10</td><td>Request timeout to external services</td>
</tr>
</tr>
<tr>
<td>conn_timeout=0.5</td><td>Connection timeout to external services</td>
</tr>
</tr>
<tr>
<td>reclaim_age=604800</td><td>Time elapsed in seconds before an object can be reclaimed</td>
</tr>
</tr>
<tr>
<td>run_pause=30</td><td>Time in seconds to wait between replication passes</td>
</tr>
</tr>
<tr>
<td>recon_cache_path=/var/cache/swift</td><td>No help text available for this option</td>
</tr>
<td>recon_cache_path=/var/cache/swift</td><td>Directory where stats for a few items will be stored</td>
</tr>
</tbody>
</table>
</para>
</para>

43
doc/src/docbkx/common/tables/swift-account-server-app-account-server.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[app:account-server]</literal> in <literal>account-server.conf-sample</literal></caption>
@ -16,35 +15,29 @@
</thead>
<tbody>
<tr>
<td>use=egg:swift#account</td><td>Entry point for paste.deploy for the server</td>
</tr>
<td>use=egg:swift#account</td><td>Entry point of paste.deploy in the server</td>
</tr>
<tr>
<td>set log_name=account-server</td><td>Label used when logging</td>
</tr>
<td>set log_name=account-server</td><td>Label to use when logging</td>
</tr>
<tr>
<td>set log_facility=LOG_LOCAL0</td><td>Syslog log facility</td>
</tr>
</tr>
<tr>
<td>set log_level=INFO</td><td>Logging level</td>
</tr>
<td>set log_level=INFO</td><td>Log level</td>
</tr>
<tr>
<td>set log_requests=true</td><td>Whether or not to log each requests</td>
</tr>
<td>set log_requests=true</td><td>Whether or not to log requests</td>
</tr>
<tr>
<td>set log_address=/dev/log</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>auto_create_account_prefix=.</td><td>Prefix used when automatically creating accounts</td>
</tr>
<td>auto_create_account_prefix=.</td><td>Prefix to use when automatically creating accounts</td>
</tr>
<tr>
<td>max_clients=1024</td><td>Maximum number of clients one worker can process simultaneously (it will actually</td>
</tr>
<tr>
<td>replication_server=false</td><td>If defined, tells server how to handle
replication verbs in requests. When set to True (or 1), only replication verbs will be accepted.
When set to False, replication verbs will be rejected. When undefined, server will accept any verb
in request.</td>
</tr>
<td>replication_server=false</td><td>If defined, tells server how to handle replication verbs in requests. When set to True (or 1), only replication verbs will be accepted. When set to False, replication verbs will be rejected. When undefined, server will accept any verb in the request.</td>
</tr>
</tbody>
</table>
</para>
</para>

13
doc/src/docbkx/common/tables/swift-account-server-filter-healthcheck.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[filter:healthcheck]</literal> in <literal>account-server.conf-sample</literal></caption>
@ -16,11 +15,11 @@
</thead>
<tbody>
<tr>
<td>use=egg:swift#healthcheck</td><td>No help text available for this option</td>
</tr>
<td>use=egg:swift#healthcheck</td><td>Entry point of paste.deploy in the server</td>
</tr>
<tr>
<td>disable_path=</td><td>No help text available for this option</td>
</tr>
</tr>
</tbody>
</table>
</para>

15
doc/src/docbkx/common/tables/swift-account-server-filter-recon.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[filter:recon]</literal> in <literal>account-server.conf-sample</literal></caption>
@ -16,11 +15,11 @@
</thead>
<tbody>
<tr>
<td>use=egg:swift#recon</td><td>No help text available for this option</td>
</tr>
<td>use=egg:swift#recon</td><td>Entry point of paste.deploy in the server</td>
</tr>
<tr>
<td>recon_cache_path=/var/cache/swift</td><td>No help text available for this option</td>
</tr>
<td>recon_cache_path=/var/cache/swift</td><td>Directory where stats for a few items will be stored</td>
</tr>
</tbody>
</table>
</para>

9
doc/src/docbkx/common/tables/swift-account-server-pipeline-main.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[pipeline:main]</literal> in <literal>account-server.conf-sample</literal></caption>
@ -17,7 +16,7 @@
<tbody>
<tr>
<td>pipeline=healthcheck recon account-server</td><td>No help text available for this option</td>
</tr>
</tr>
</tbody>
</table>
</para>

94
doc/src/docbkx/common/tables/swift-container-server-DEFAULT.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[DEFAULT]</literal> in <literal>container-server.conf-sample</literal></caption>
@ -17,82 +16,95 @@
<tbody>
<tr>
<td>bind_ip=0.0.0.0</td><td>IP Address for server to bind to</td>
</tr>
</tr>
<tr>
<td>bind_port=6001</td><td>Port for server to bind to</td>
</tr>
</tr>
<tr>
<td>bind_timeout=30</td><td>Seconds to attempt bind before giving up</td>
</tr>
</tr>
<tr>
<td>backlog=4096</td><td>Maximum number of allowed pending TCP connections</td>
</tr>
<tr>
<td>workers=1</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>
</tr>
<tr>
<td>user=swift</td><td>User to run as</td>
</tr>
</tr>
<tr>
<td>swift_dir=/etc/swift</td><td>Swift configuration directory</td>
</tr>
</tr>
<tr>
<td>devices=/srv/node</td><td>Parent directory of where devices are mounted</td>
</tr>
</tr>
<tr>
<td>mount_check=true</td><td>Whether or not check if the devices are mounted to prevent accidentally writing to the root device</td>
</tr>
</tr>
<tr>
<td>disable_fallocate=false</td><td>Disable "fast fail" fallocate checks if the underlying filesystem does not support it.</td>
</tr>
</tr>
<tr>
<td>workers=auto</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>
<tr>
<td>max_clients=1024</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>allowed_sync_hosts=127.0.0.1</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>log_name=swift</td><td>Label used when logging</td>
</tr>
</tr>
<tr>
<td>log_facility=LOG_LOCAL0</td><td>Syslog log facility</td>
</tr>
</tr>
<tr>
<td>log_level=INFO</td><td>Logging level</td>
</tr>
</tr>
<tr>
<td>log_address=/dev/log</td><td>No help text available for this option</td>
</tr>
<td>log_address=/dev/log</td><td>Location where syslog sends the logs to</td>
</tr>
<tr>
<td>log_custom_handlers=</td><td>Comma-separated list of functions to call to setup custom log handlers.</td>
</tr>
</tr>
<tr>
<td>log_udp_host=</td><td>No help text available for this option</td>
</tr>
<td>log_udp_host=</td><td>If not set, the UDB receiver for syslog is disabled.</td>
</tr>
<tr>
<td>log_udp_port=514</td><td>No help text available for this option</td>
</tr>
<td>log_udp_port=514</td><td>Port value for UDB receiver, if enabled.</td>
</tr>
<tr>
<td>log_statsd_host=localhost</td><td>No help text available for this option</td>
</tr>
<td>log_statsd_host=localhost</td><td>If not set, the StatsD feature is disabled.</td>
</tr>
<tr>
<td>log_statsd_port=8125</td><td>No help text available for this option</td>
</tr>
<td>log_statsd_port=8125</td><td>Port value for the StatsD server.</td>
</tr>
<tr>
<td>log_statsd_default_sample_rate=1.0</td><td>No help text available for this option</td>
</tr>
<td>log_statsd_default_sample_rate=1.0</td><td>Defines the probability of sending a sample for any given event or
timing measurement.</td>
</tr>
<tr>
<td>log_statsd_sample_rate_factor=1.0</td><td>No help text available for this option</td>
</tr>
<td>log_statsd_sample_rate_factor=1.0</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>log_statsd_metric_prefix=</td><td>No help text available for this option</td>
</tr>
<td>log_statsd_metric_prefix=</td><td>Value will be prepended to every metric sent to the StatsD server.</td>
</tr>
<tr>
<td>db_preallocation=off</td><td>If you don't mind the extra disk space usage in overhead, you can turn this on to preallocate disk space with SQLite databases to decrease fragmentation. underlying filesystem does not support it. to setup custom log handlers. bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#account`. replication passes account can be reclaimed</td>
</tr>
</tr>
<tr>
<td>eventlet_debug=false</td><td>If true, turn on debug logging for eventlet</td>
</tr>
</tr>
<tr>
<td>fallocate_reserve=0</td><td>You can set fallocate_reserve to the number of bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#object`.</td>
</tr>
</tr>
</tbody>
</table>
</para>
</para>

43
doc/src/docbkx/common/tables/swift-container-server-app-container-server.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[app:container-server]</literal> in <literal>container-server.conf-sample</literal></caption>
@ -16,38 +15,38 @@
</thead>
<tbody>
<tr>
<td>use=egg:swift#container</td><td>No help text available for this option</td>
</tr>
<td>use=egg:swift#container</td><td>Entry point of paste.deploy in the server</td>
</tr>
<tr>
<td>set log_name=container-server</td><td>Label used when logging</td>
</tr>
<td>set log_name=container-server</td><td>Label to use when logging</td>
</tr>
<tr>
<td>set log_facility=LOG_LOCAL0</td><td>Syslog log facility</td>
</tr>
</tr>
<tr>
<td>set log_level=INFO</td><td>Log level</td>
</tr>
</tr>
<tr>
<td>set log_requests=true</td><td>No help text available for this option</td>
</tr>
<td>set log_requests=true</td><td>Whether or not to log requests</td>
</tr>
<tr>
<td>set log_address=/dev/log</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>node_timeout=3</td><td>Request timeout to external services</td>
</tr>
</tr>
<tr>
<td>conn_timeout=0.5</td><td>Connection timeout to external services</td>
</tr>
</tr>
<tr>
<td>allow_versions=false</td><td>No help text available for this option</td>
</tr>
<td>allow_versions=false</td><td>Enable/Disable object versioning feature </td>
</tr>
<tr>
<td>auto_create_account_prefix=.</td><td>Prefix used when automatically creating accounts</td>
</tr>
<td>auto_create_account_prefix=.</td><td>Prefix to use when automatically creating accounts</td>
</tr>
<tr>
<td>replication_server=false</td><td>No help text available for this option</td>
</tr>
<td>replication_server=false</td><td>If defined, tells server how to handle replication verbs in requests. When set to True (or 1), only replication verbs will be accepted. When set to False, replication verbs will be rejected. When undefined, server will accept any verb in the request.</td>
</tr>
</tbody>
</table>
</para>
</para>

25
doc/src/docbkx/common/tables/swift-container-server-container-auditor.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[container-auditor]</literal> in <literal>container-server.conf-sample</literal></caption>
@ -17,25 +16,25 @@
<tbody>
<tr>
<td>log_name=container-auditor</td><td>Label used when logging</td>
</tr>
</tr>
<tr>
<td>log_facility=LOG_LOCAL0</td><td>Syslog log facility</td>
</tr>
</tr>
<tr>
<td>log_level=INFO</td><td>Logging level</td>
</tr>
</tr>
<tr>
<td>log_address=/dev/log</td><td>No help text available for this option</td>
</tr>
<td>log_address=/dev/log</td><td>Location where syslog sends the logs to</td>
</tr>
<tr>
<td>interval=1800</td><td>Minimum time for a pass to take</td>
</tr>
</tr>
<tr>
<td>containers_per_second=200</td><td>Maximum containers audited per second. Should be tuned according to individual system specs. 0 is unlimited. mounted to prevent accidentally writing to the root device process simultaneously (it will actually accept(2) N + 1). Setting this to one (1) will only handle one request at a time, without accepting another request concurrently. By increasing the number of workers to a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.</td>
</tr>
</tr>
<tr>
<td>recon_cache_path=/var/cache/swift</td><td>Directory where stats for a few items will be stored</td>
</tr>
</tr>
</tbody>
</table>
</para>
</para>

39
doc/src/docbkx/common/tables/swift-container-server-container-replicator.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[container-replicator]</literal> in <literal>container-server.conf-sample</literal></caption>
@ -17,46 +16,46 @@
<tbody>
<tr>
<td>log_name=container-replicator</td><td>Label used when logging</td>
</tr>
</tr>
<tr>
<td>log_facility=LOG_LOCAL0</td><td>Syslog log facility</td>
</tr>
</tr>
<tr>
<td>log_level=INFO</td><td>Logging level</td>
</tr>
</tr>
<tr>
<td>log_address=/dev/log</td><td>No help text available for this option</td>
</tr>
<td>log_address=/dev/log</td><td>Location where syslog sends the logs to</td>
</tr>
<tr>
<td>vm_test_mode=no</td><td>Indicates that you are using a VM environment</td>
</tr>
</tr>
<tr>
<td>per_diff=1000</td><td>Limit number of items to get per diff</td>
</tr>
</tr>
<tr>
<td>max_diffs=100</td><td>Caps how long the replicator spends trying to sync a database per pass</td>
</tr>
</tr>
<tr>
<td>concurrency=8</td><td>Number of replication workers to spawn</td>
</tr>
</tr>
<tr>
<td>interval=30</td><td>Minimum time for a pass to take</td>
</tr>
</tr>
<tr>
<td>node_timeout=10</td><td>Request timeout to external services</td>
</tr>
</tr>
<tr>
<td>conn_timeout=0.5</td><td>Connection timeout to external services</td>
</tr>
</tr>
<tr>
<td>reclaim_age=604800</td><td>Time elapsed in seconds before an object can be reclaimed</td>
</tr>
</tr>
<tr>
<td>run_pause=30</td><td>Time in seconds to wait between replication passes</td>
</tr>
</tr>
<tr>
<td>recon_cache_path=/var/cache/swift</td><td>Directory where stats for a few items will be stored</td>
</tr>
</tr>
</tbody>
</table>
</para>
</para>

25
doc/src/docbkx/common/tables/swift-container-server-container-sync.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[container-sync]</literal> in <literal>container-server.conf-sample</literal></caption>
@ -17,25 +16,25 @@
<tbody>
<tr>
<td>log_name=container-sync</td><td>Label used when logging</td>
</tr>
</tr>
<tr>
<td>log_facility=LOG_LOCAL0</td><td>Syslog log facility</td>
</tr>
</tr>
<tr>
<td>log_level=INFO</td><td>Logging level</td>
</tr>
</tr>
<tr>
<td>log_address=/dev/log</td><td>No help text available for this option</td>
</tr>
<td>log_address=/dev/log</td><td>Location where syslog sends the logs to</td>
</tr>
<tr>
<td>sync_proxy=http://127.0.0.1:8888</td><td>If you need to use an HTTP proxy, set it here. Defaults to no proxy.</td>
</tr>
</tr>
<tr>
<td>interval=300</td><td>Minimum time for a pass to take</td>
</tr>
</tr>
<tr>
<td>container_time=60</td><td>Maximum amount of time to spend syncing each container</td>
</tr>
</tr>
</tbody>
</table>
</para>
</para>

36
doc/src/docbkx/common/tables/swift-container-server-container-updater.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[container-updater]</literal> in <literal>container-server.conf-sample</literal></caption>
@ -17,37 +16,38 @@
<tbody>
<tr>
<td>log_name=container-updater</td><td>Label used when logging</td>
</tr>
</tr>
<tr>
<td>log_facility=LOG_LOCAL0</td><td>Syslog log facility</td>
</tr>
</tr>
<tr>
<td>log_level=INFO</td><td>Logging level</td>
</tr>
</tr>
<tr>
<td>log_address=/dev/log</td><td>No help text available for this option</td>
</tr>
<td>log_address=/dev/log</td><td>Location where syslog sends the logs to</td>
</tr>
<tr>
<td>interval=300</td><td>Minimum time for a pass to take</td>
</tr>
</tr>
<tr>
<td>concurrency=4</td><td>Number of replication workers to spawn</td>
</tr>
</tr>
<tr>
<td>node_timeout=3</td><td>Request timeout to external services</td>
</tr>
</tr>
<tr>
<td>conn_timeout=0.5</td><td>Connection timeout to external services</td>
</tr>
</tr>
<tr>
<td>slowdown=0.01</td><td>Time in seconds to wait between objects</td>
</tr>
</tr>
<tr>
<td>account_suppression_time=60</td><td>Seconds to suppress updating an account that has generated an</td>
</tr>
<td>account_suppression_time=60</td><td>Seconds to suppress updating an account that has generated an
error (timeout, not yet found, etc.) </td>
</tr>
<tr>
<td>recon_cache_path=/var/cache/swift</td><td>Directory where stats for a few items will be stored</td>
</tr>
</tr>
</tbody>
</table>
</para>
</para>

13
doc/src/docbkx/common/tables/swift-container-server-filter-healthcheck.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[filter:healthcheck]</literal> in <literal>container-server.conf-sample</literal></caption>
@ -16,11 +15,11 @@
</thead>
<tbody>
<tr>
<td>use=egg:swift#healthcheck</td><td>No help text available for this option</td>
</tr>
<td>use=egg:swift#healthcheck</td><td>Entry point of paste.deploy in the server</td>
</tr>
<tr>
<td>disable_path=</td><td>No help text available for this option</td>
</tr>
</tr>
</tbody>
</table>
</para>

15
doc/src/docbkx/common/tables/swift-container-server-filter-recon.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[filter:recon]</literal> in <literal>container-server.conf-sample</literal></caption>
@ -16,11 +15,11 @@
</thead>
<tbody>
<tr>
<td>use=egg:swift#recon</td><td>No help text available for this option</td>
</tr>
<td>use=egg:swift#recon</td><td>Entry point of paste.deploy in the server</td>
</tr>
<tr>
<td>recon_cache_path=/var/cache/swift</td><td>No help text available for this option</td>
</tr>
<td>recon_cache_path=/var/cache/swift</td><td>Directory where stats for a few items will be stored</td>
</tr>
</tbody>
</table>
</para>

9
doc/src/docbkx/common/tables/swift-container-server-pipeline-main.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[pipeline:main]</literal> in <literal>container-server.conf-sample</literal></caption>
@ -17,7 +16,7 @@
<tbody>
<tr>
<td>pipeline=healthcheck recon container-server</td><td>No help text available for this option</td>
</tr>
</tr>
</tbody>
</table>
</para>

54
doc/src/docbkx/common/tables/swift-dispersion-dispersion.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[dispersion]</literal> in <literal>dispersion.conf-sample</literal></caption>
@ -16,50 +15,53 @@
</thead>
<tbody>
<tr>
<td>auth_url=http://localhost:8080/auth/v1.0</td><td>No help text available for this option</td>
</tr>
<td>auth_url=http://localhost:8080/auth/v1.0</td><td>Endpoint for auth server, such as keystone</td>
</tr>
<tr>
<td>auth_user=test:tester</td><td>No help text available for this option</td>
</tr>
<td>auth_user=test:tester</td><td>Default user for dispersion in this context</td>
</tr>
<tr>
<td>auth_key=testing</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>auth_url=http://saio:5000/v2.0/</td><td>No help text available for this option</td>
</tr>
<td>auth_url=http://saio:5000/v2.0/</td><td>Endpoint for auth server, such as keystone</td>
</tr>
<tr>
<td>auth_user=test:tester</td><td>No help text available for this option</td>
</tr>
<td>auth_user=test:tester</td><td>Default user for dispersion in this context</td>
</tr>
<tr>
<td>auth_key=testing</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>auth_version=2.0</td><td>No help text available for this option</td>
</tr>
<td>auth_version=2.0</td><td>Indicates which version of auth</td>
</tr>
<tr>
<td>endpoint_type=publicURL</td><td>No help text available for this option</td>
</tr>
<td>endpoint_type=publicURL</td><td>Indicates whether endpoint for auth is public or internal</td>
</tr>
<tr>
<td>keystone_api_insecure=no</td><td>No help text available for this option</td>
</tr>
<tr>
<td>swift_dir=/etc/swift</td><td>Swift configuration directory</td>
</tr>
</tr>
<tr>
<td>dispersion_coverage=1</td><td>No help text available for this option</td>
</tr>
<td>dispersion_coverage=1.0</td><td>No help text available for this option</td>
</tr>
<tr>
<td>retries=5</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>concurrency=25</td><td>Number of replication workers to spawn</td>
</tr>
</tr>
<tr>
<td>container_report=yes</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>object_report=yes</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>dump_json=no</td><td>No help text available for this option</td>
</tr>
</tr>
</tbody>
</table>
</para>

27
doc/src/docbkx/common/tables/swift-drive-audit-drive-audit.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[drive-audit]</literal> in <literal>drive-audit.conf-sample</literal></caption>
@ -17,22 +16,28 @@
<tbody>
<tr>
<td>device_dir=/srv/node</td><td>Directory devices are mounted under</td>
</tr>
</tr>
<tr>
<td>log_facility=LOG_LOCAL0</td><td>Syslog log facility</td>
</tr>
</tr>
<tr>
<td>log_level=INFO</td><td>Logging level</td>
</tr>
</tr>
<tr>
<td>log_address=/dev/log</td><td>No help text available for this option</td>
</tr>
<td>log_address=/dev/log</td><td>Location where syslog sends the logs to</td>
</tr>
<tr>
<td>minutes=60</td><td>Number of minutes to look back in `/var/log/kern.log`</td>
</tr>
</tr>
<tr>
<td>error_limit=1</td><td>Number of errors to find before a device is unmounted</td>
</tr>
</tr>
<tr>
<td>log_file_pattern=/var/log/kern*</td><td>Location of the log file with globbing pattern to check against device errors locate device blocks with errors in the log file</td>
</tr>
<tr>
<td>regex_pattern_1=\berror\b.*\b(dm-[0-9]{1,2}\d?)\b</td><td>No help text available for this option</td>
</tr>
</tbody>
</table>
</para>

11
doc/src/docbkx/common/tables/swift-memcache-memcache.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[memcache]</literal> in <literal>memcache.conf-sample</literal></caption>
@ -17,10 +16,10 @@
<tbody>
<tr>
<td>memcache_servers=127.0.0.1:11211</td><td>Comma separated list of memcached servers ip:port services</td>
</tr>
</tr>
<tr>
<td>memcache_serialization_support=2</td><td>No help text available for this option</td>
</tr>
</tr>
</tbody>
</table>
</para>

54
doc/src/docbkx/common/tables/swift-object-expirer-DEFAULT.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[DEFAULT]</literal> in <literal>object-expirer.conf-sample</literal></caption>
@ -17,46 +16,49 @@
<tbody>
<tr>
<td>swift_dir=/etc/swift</td><td>Swift configuration directory</td>
</tr>
</tr>
<tr>
<td>user=swift</td><td>User to run as</td>
</tr>
</tr>
<tr>
<td>log_name=swift</td><td>Label used when logging</td>
</tr>
</tr>
<tr>
<td>log_facility=LOG_LOCAL0</td><td>Syslog log facility</td>
</tr>
</tr>
<tr>
<td>log_level=INFO</td><td>Logging level</td>
</tr>
</tr>
<tr>
<td>log_address=/dev/log</td><td>No help text available for this option</td>
</tr>
<td>log_address=/dev/log</td><td>Location where syslog sends the logs to</td>
</tr>
<tr>
<td>log_custom_handlers=</td><td>Comma-separated list of functions to call to setup custom log handlers.</td>
</tr>
</tr>
<tr>
<td>log_udp_host=</td><td>No help text available for this option</td>
</tr>
<td>log_udp_host=</td><td>If not set, the UDB receiver for syslog is disabled.</td>
</tr>
<tr>
<td>log_udp_port=514</td><td>No help text available for this option</td>
</tr>
<td>log_udp_port=514</td><td>Port value for UDB receiver, if enabled.</td>
</tr>
<tr>
<td>log_statsd_host=localhost</td><td>No help text available for this option</td>
</tr>
<td>log_statsd_host=localhost</td><td>If not set, the StatsD feature is disabled.</td>
</tr>
<tr>
<td>log_statsd_port=8125</td><td>No help text available for this option</td>
</tr>
<td>log_statsd_port=8125</td><td>Port value for the StatsD server.</td>
</tr>
<tr>
<td>log_statsd_default_sample_rate=1.0</td><td>No help text available for this option</td>
</tr>
<td>log_statsd_default_sample_rate=1.0</td><td>Defines the probability of sending a sample for any given event or
timing measurement.</td>
</tr>
<tr>
<td>log_statsd_sample_rate_factor=1.0</td><td>No help text available for this option</td>
</tr>
<td>log_statsd_sample_rate_factor=1.0</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>log_statsd_metric_prefix=</td><td>No help text available for this option</td>
</tr>
<td>log_statsd_metric_prefix=</td><td>Value will be prepended to every metric sent to the StatsD server.</td>
</tr>
</tbody>
</table>
</para>

11
doc/src/docbkx/common/tables/swift-object-expirer-app-proxy-server.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[app:proxy-server]</literal> in <literal>object-expirer.conf-sample</literal></caption>
@ -16,8 +15,8 @@
</thead>
<tbody>
<tr>
<td>use=egg:swift#proxy</td><td>No help text available for this option</td>
</tr>
<td>use=egg:swift#proxy</td><td>Entry point of paste.deploy in the server</td>
</tr>
</tbody>
</table>
</para>

11
doc/src/docbkx/common/tables/swift-object-expirer-filter-cache.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[filter:cache]</literal> in <literal>object-expirer.conf-sample</literal></caption>
@ -16,8 +15,8 @@
</thead>
<tbody>
<tr>
<td>use=egg:swift#memcache</td><td>No help text available for this option</td>
</tr>
<td>use=egg:swift#memcache</td><td>Entry point of paste.deploy in the server</td>
</tr>
</tbody>
</table>
</para>

11
doc/src/docbkx/common/tables/swift-object-expirer-filter-catch_errors.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[filter:catch_errors]</literal> in <literal>object-expirer.conf-sample</literal></caption>
@ -16,8 +15,8 @@
</thead>
<tbody>
<tr>
<td>use=egg:swift#catch_errors</td><td>No help text available for this option</td>
</tr>
<td>use=egg:swift#catch_errors</td><td>Entry point of paste.deploy in the server</td>
</tr>
</tbody>
</table>
</para>

25
doc/src/docbkx/common/tables/swift-object-expirer-object-expirer.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[object-expirer]</literal> in <literal>object-expirer.conf-sample</literal></caption>
@ -17,22 +16,24 @@
<tbody>
<tr>
<td>interval=300</td><td>Minimum time for a pass to take</td>
</tr>
</tr>
<tr>
<td>auto_create_account_prefix=.</td><td>No help text available for this option</td>
</tr>
<td>auto_create_account_prefix=.</td><td>Prefix to use when automatically creating accounts</td>
</tr>
<tr>
<td>report_interval=300</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>concurrency=1</td><td>Number of replication workers to spawn</td>
</tr>
</tr>
<tr>
<td>processes=0</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>process=0</td><td>(it will actually accept(2) N + 1). Setting this to one (1) will only handle one request at a time, without accepting another request concurrently. By increasing the number of workers to a much higher value, one can</td>
</tr>
<td>process=0</td><td>(it will actually accept(2) N + 1). Setting this to one (1) will
only handle one request at a time, without
accepting another request concurrently. </td>
</tr>
</tbody>
</table>
</para>

9
doc/src/docbkx/common/tables/swift-object-expirer-pipeline-main.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[pipeline:main]</literal> in <literal>object-expirer.conf-sample</literal></caption>
@ -17,7 +16,7 @@
<tbody>
<tr>
<td>pipeline=catch_errors cache proxy-server</td><td>No help text available for this option</td>
</tr>
</tr>
</tbody>
</table>
</para>

92
doc/src/docbkx/common/tables/swift-object-server-DEFAULT.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[DEFAULT]</literal> in <literal>object-server.conf-sample</literal></caption>
@ -17,79 +16,92 @@
<tbody>
<tr>
<td>bind_ip=0.0.0.0</td><td>IP Address for server to bind to</td>
</tr>
</tr>
<tr>
<td>bind_port=6000</td><td>Port for server to bind to</td>
</tr>
</tr>
<tr>
<td>bind_timeout=30</td><td>Seconds to attempt bind before giving up</td>
</tr>
</tr>
<tr>
<td>backlog=4096</td><td>Maximum number of allowed pending TCP connections</td>
</tr>
<tr>
<td>workers=1</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>
</tr>
<tr>
<td>user=swift</td><td>User to run as</td>
</tr>
</tr>
<tr>
<td>swift_dir=/etc/swift</td><td>Swift configuration directory</td>
</tr>
</tr>
<tr>
<td>devices=/srv/node</td><td>Parent directory of where devices are mounted</td>
</tr>
</tr>
<tr>
<td>mount_check=true</td><td>Whether or not check if the devices are mounted to prevent accidentally writing to the root device</td>
</tr>
</tr>
<tr>
<td>disable_fallocate=false</td><td>Disable "fast fail" fallocate checks if the underlying filesystem does not support it.</td>
</tr>
</tr>
<tr>
<td>expiring_objects_container_divisor=86400</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>workers=auto</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>
<tr>
<td>max_clients=1024</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>log_name=swift</td><td>Label used when logging</td>
</tr>
</tr>
<tr>
<td>log_facility=LOG_LOCAL0</td><td>Syslog log facility</td>
</tr>
</tr>
<tr>
<td>log_level=INFO</td><td>Logging level</td>
</tr>
</tr>
<tr>
<td>log_address=/dev/log</td><td>No help text available for this option</td>
</tr>
<td>log_address=/dev/log</td><td>Location where syslog sends the logs to</td>
</tr>
<tr>
<td>log_custom_handlers=</td><td>Comma-separated list of functions to call to setup custom log handlers.</td>
</tr>
</tr>
<tr>
<td>log_udp_host=</td><td>No help text available for this option</td>
</tr>
<td>log_udp_host=</td><td>If not set, the UDB receiver for syslog is disabled.</td>
</tr>
<tr>
<td>log_udp_port=514</td><td>No help text available for this option</td>
</tr>
<td>log_udp_port=514</td><td>Port value for UDB receiver, if enabled.</td>
</tr>
<tr>
<td>log_statsd_host=localhost</td><td>No help text available for this option</td>
</tr>
<td>log_statsd_host=localhost</td><td>If not set, the StatsD feature is disabled.</td>
</tr>
<tr>
<td>log_statsd_port=8125</td><td>No help text available for this option</td>
</tr>
<td>log_statsd_port=8125</td><td>Port value for the StatsD server.</td>
</tr>
<tr>
<td>log_statsd_default_sample_rate=1.0</td><td>No help text available for this option</td>
</tr>
<td>log_statsd_default_sample_rate=1.0</td><td>Defines the probability of sending a sample for any given event or
timing measurement.</td>
</tr>
<tr>
<td>log_statsd_sample_rate_factor=1.0</td><td>No help text available for this option</td>
</tr>
<td>log_statsd_sample_rate_factor=1.0</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>log_statsd_metric_prefix=</td><td>No help text available for this option</td>
</tr>
<td>log_statsd_metric_prefix=</td><td>Value will be prepended to every metric sent to the StatsD server.</td>
</tr>
<tr>
<td>eventlet_debug=false</td><td>If true, turn on debug logging for eventlet</td>
</tr>
</tr>
<tr>
<td>fallocate_reserve=0</td><td>You can set fallocate_reserve to the number of bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#object`.</td>
</tr>
</tr>
</tbody>
</table>
</para>
</para>

54
doc/src/docbkx/common/tables/swift-object-server-app-object-server.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[app:object-server]</literal> in <literal>object-server.conf-sample</literal></caption>
@ -17,64 +16,61 @@
<tbody>
<tr>
<td>use=egg:swift#object</td><td>Entry point of paste.deploy in the server</td>
</tr>
</tr>
<tr>
<td>set log_name=object-server</td><td>Label used when logging</td>
</tr>
<td>set log_name=object-server</td><td>Label to use when logging</td>
</tr>
<tr>
<td>set log_facility=LOG_LOCAL0</td><td>Syslog log facility</td>
</tr>
</tr>
<tr>
<td>set log_level=INFO</td><td>Log level</td>
</tr>
</tr>
<tr>
<td>set log_requests=true</td><td>Whether or not to log requests</td>
</tr>
</tr>
<tr>
<td>set log_address=/dev/log</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>node_timeout=3</td><td>Request timeout to external services</td>
</tr>
</tr>
<tr>
<td>conn_timeout=0.5</td><td>Connection timeout to external services</td>
</tr>
</tr>
<tr>
<td>network_chunk_size=65536</td><td>Size of chunks to read/write over the network</td>
</tr>
</tr>
<tr>
<td>disk_chunk_size=65536</td><td>Size of chunks to read/write to disk</td>
</tr>
</tr>
<tr>
<td>max_upload_time=86400</td><td>Maximum time allowed to upload an object</td>
</tr>
</tr>
<tr>
<td>slow=0</td><td>If > 0, Minimum time in seconds for a PUT or DELETE request to complete</td>
</tr>
</tr>
<tr>
<td>keep_cache_size=5424880</td><td>Largest object size to keep in buffer cache</td>
</tr>
</tr>
<tr>
<td>keep_cache_private=false</td><td>Allow non-public objects to stay in kernel's buffer cache</td>
</tr>
</tr>
<tr>
<td>mb_per_sync=512</td><td>On PUT requests, sync file every n MB</td>
</tr>
</tr>
<tr>
<td>allowed_headers=Content-Disposition, Content-Encoding, X-Delete-At, X-Object-Manifest, X-Static-Large-Object</td><td>Comma-separated list of headers that can be set in metadata of an object</td>
</tr>
</tr>
<tr>
<td>auto_create_account_prefix=.</td><td>Prefix used when automatically creating accounts</td>
</tr>
<tr>
<td>max_clients=1024</td><td>Maximum number of clients one worker can process simultaneously (it will actually</td>
</tr>
<td>auto_create_account_prefix=.</td><td>Prefix to use when automatically creating accounts</td>
</tr>
<tr>
<td>replication_server=false</td><td>If defined, tells server how to handle replication verbs in requests. When set to True (or 1), only replication verbs will be accepted. When set to False, replication verbs will be rejected. When undefined, server will accept any verb in the request.</td>
</tr>
</tr>
<tr>
<td>threads_per_disk=0</td><td>Size of the per-disk thread pool used for performing disk I/O. The default of 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>
</tbody>
</table>
</para>
</para>

13
doc/src/docbkx/common/tables/swift-object-server-filter-healthcheck.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[filter:healthcheck]</literal> in <literal>object-server.conf-sample</literal></caption>
@ -16,11 +15,11 @@
</thead>
<tbody>
<tr>
<td>use=egg:swift#healthcheck</td><td>No help text available for this option</td>
</tr>
<td>use=egg:swift#healthcheck</td><td>Entry point of paste.deploy in the server</td>
</tr>
<tr>
<td>disable_path=</td><td>No help text available for this option</td>
</tr>
</tr>
</tbody>
</table>
</para>

17
doc/src/docbkx/common/tables/swift-object-server-filter-recon.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[filter:recon]</literal> in <literal>object-server.conf-sample</literal></caption>
@ -16,14 +15,14 @@
</thead>
<tbody>
<tr>
<td>use=egg:swift#recon</td><td>No help text available for this option</td>
</tr>
<td>use=egg:swift#recon</td><td>Entry point of paste.deploy in the server</td>
</tr>
<tr>
<td>recon_cache_path=/var/cache/swift</td><td>No help text available for this option</td>
</tr>
<td>recon_cache_path=/var/cache/swift</td><td>Directory where stats for a few items will be stored</td>
</tr>
<tr>
<td>recon_lock_path=/var/lock</td><td>No help text available for this option</td>
</tr>
</tr>
</tbody>
</table>
</para>

33
doc/src/docbkx/common/tables/swift-object-server-object-auditor.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[object-auditor]</literal> in <literal>object-server.conf-sample</literal></caption>
@ -17,34 +16,34 @@
<tbody>
<tr>
<td>log_name=object-auditor</td><td>Label used when logging</td>
</tr>
</tr>
<tr>
<td>log_facility=LOG_LOCAL0</td><td>Syslog log facility</td>
</tr>
</tr>
<tr>
<td>log_level=INFO</td><td>Logging level</td>
</tr>
</tr>
<tr>
<td>log_address=/dev/log</td><td>No help text available for this option</td>
</tr>
<td>log_address=/dev/log</td><td>Location where syslog sends the logs to</td>
</tr>
<tr>
<td>files_per_second=20</td><td>Maximum files audited per second. Should be tuned according to individual system specs. 0 is unlimited.</td>
</tr>
</tr>
<tr>
<td>bytes_per_second=10000000</td><td>Maximum bytes audited per second. Should be tuned according to individual system specs. 0 is unlimited. mounted to prevent accidentally writing to the root device process simultaneously (it will actually accept(2) N + 1). Setting this to one (1) will only handle one request at a time, without accepting another request concurrently. By increasing the number of workers to a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests. underlying filesystem does not support it. to setup custom log handlers. bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. container server. For most cases, this should be `egg:swift#container`.</td>
</tr>
</tr>
<tr>
<td>log_time=3600</td><td>Frequency of status logs in seconds.</td>
</tr>
</tr>
<tr>
<td>zero_byte_files_per_second=50</td><td>Maximum zero byte files audited per second.</td>
</tr>
</tr>
<tr>
<td>recon_cache_path=/var/cache/swift</td><td>No help text available for this option</td>
</tr>
<td>recon_cache_path=/var/cache/swift</td><td>Directory where stats for a few items will be stored</td>
</tr>
<tr>
<td>object_size_stats=</td><td>No help text available for this option</td>
</tr>
</tr>
</tbody>
</table>
</para>
</para>

48
doc/src/docbkx/common/tables/swift-object-server-object-replicator.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[object-replicator]</literal> in <literal>object-server.conf-sample</literal></caption>
@ -17,55 +16,58 @@
<tbody>
<tr>
<td>log_name=object-replicator</td><td>Label used when logging</td>
</tr>
</tr>
<tr>
<td>log_facility=LOG_LOCAL0</td><td>Syslog log facility</td>
</tr>
</tr>
<tr>
<td>log_level=INFO</td><td>Logging level</td>
</tr>
</tr>
<tr>
<td>log_address=/dev/log</td><td>No help text available for this option</td>
</tr>
<td>log_address=/dev/log</td><td>Location where syslog sends the logs to</td>
</tr>
<tr>
<td>vm_test_mode=no</td><td>Indicates that you are using a VM environment</td>
</tr>
</tr>
<tr>
<td>daemonize=on</td><td>Whether or not to run replication as a daemon</td>
</tr>
</tr>
<tr>
<td>run_pause=30</td><td>Time in seconds to wait between replication passes</td>
</tr>
</tr>
<tr>
<td>concurrency=1</td><td>Number of replication workers to spawn</td>
</tr>
</tr>
<tr>
<td>stats_interval=300</td><td>Interval in seconds between logging replication statistics</td>
</tr>
</tr>
<tr>
<td>rsync_timeout=900</td><td>Max duration (seconds) of a partition rsync</td>
</tr>
</tr>
<tr>
<td>rsync_bwlimit=0</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>rsync_io_timeout=30</td><td>Passed to rsync for a max duration (seconds) of an I/O op</td>
</tr>
</tr>
<tr>
<td>http_timeout=60</td><td>Maximum duration for an HTTP request</td>
</tr>
</tr>
<tr>
<td>lockup_timeout=1800</td><td>Attempts to kill all workers if nothing replications for lockup_timeout seconds</td>
</tr>
</tr>
<tr>
<td>reclaim_age=604800</td><td>Time elapsed in seconds before an object can be reclaimed</td>
</tr>
</tr>
<tr>
<td>ring_check_interval=15</td><td>How often (in seconds) to check the ring</td>
</tr>
</tr>
<tr>
<td>recon_cache_path=/var/cache/swift</td><td>Directory where stats for a few items will be stored</td>
</tr>
</tr>
<tr>
<td>rsync_error_log_line_length=0</td><td>No help text available for this option</td>
</tr>
</tbody>
</table>
</para>
</para>

31
doc/src/docbkx/common/tables/swift-object-server-object-updater.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[object-updater]</literal> in <literal>object-server.conf-sample</literal></caption>
@ -17,34 +16,34 @@
<tbody>
<tr>
<td>log_name=object-updater</td><td>Label used when logging</td>
</tr>
</tr>
<tr>
<td>log_facility=LOG_LOCAL0</td><td>Syslog log facility</td>
</tr>
</tr>
<tr>
<td>log_level=INFO</td><td>Logging level</td>
</tr>
</tr>
<tr>
<td>log_address=/dev/log</td><td>No help text available for this option</td>
</tr>
<td>log_address=/dev/log</td><td>Location where syslog sends the logs to</td>
</tr>
<tr>
<td>interval=300</td><td>Minimum time for a pass to take</td>
</tr>
</tr>
<tr>
<td>concurrency=1</td><td>Number of replication workers to spawn</td>
</tr>
</tr>
<tr>
<td>node_timeout=10</td><td>Request timeout to external services</td>
</tr>
</tr>
<tr>
<td>conn_timeout=0.5</td><td>Connection timeout to external services</td>
</tr>
</tr>
<tr>
<td>slowdown=0.01</td><td>Time in seconds to wait between objects</td>
</tr>
</tr>
<tr>
<td>recon_cache_path=/var/cache/swift</td><td>Directory where stats for a few items will be stored</td>
</tr>
</tr>
</tbody>
</table>
</para>
</para>

9
doc/src/docbkx/common/tables/swift-object-server-pipeline-main.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[pipeline:main]</literal> in <literal>object-server.conf-sample</literal></caption>
@ -17,7 +16,7 @@
<tbody>
<tr>
<td>pipeline=healthcheck recon object-server</td><td>No help text available for this option</td>
</tr>
</tr>
</tbody>
</table>
</para>

99
doc/src/docbkx/common/tables/swift-proxy-server-DEFAULT.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[DEFAULT]</literal> in <literal>proxy-server.conf-sample</literal></caption>
@ -17,88 +16,98 @@
<tbody>
<tr>
<td>bind_ip=0.0.0.0</td><td>IP Address for server to bind to</td>
</tr>
</tr>
<tr>
<td>bind_port=80</td><td>Port for server to bind to</td>
</tr>
</tr>
<tr>
<td>bind_timeout=30</td><td>Seconds to attempt bind before giving up</td>
</tr>
</tr>
<tr>
<td>backlog=4096</td><td>Maximum number of allowed pending TCP connections</td>
</tr>
</tr>
<tr>
<td>swift_dir=/etc/swift</td><td>Swift configuration directory</td>
</tr>
<tr>
<td>workers=1</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>
</tr>
<tr>
<td>user=swift</td><td>User to run as</td>
</tr>
</tr>
<tr>
<td>workers=auto</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>
<tr>
<td>max_clients=1024</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>cert_file=/etc/swift/proxy.crt</td><td>to the ssl .crt. This should be enabled for testing purposes only.</td>
</tr>
</tr>
<tr>
<td>key_file=/etc/swift/proxy.key</td><td>to the ssl .key. This should be enabled for testing purposes only.</td>
</tr>
</tr>
<tr>
<td>expiring_objects_container_divisor=86400</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>log_name=swift</td><td>Label used when logging</td>
</tr>
</tr>
<tr>
<td>log_facility=LOG_LOCAL0</td><td>Syslog log facility</td>
</tr>
</tr>
<tr>
<td>log_level=INFO</td><td>Logging level</td>
</tr>
</tr>
<tr>
<td>log_headers=false</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>log_address=/dev/log</td><td>No help text available for this option</td>
</tr>
<td>log_address=/dev/log</td><td>Location where syslog sends the logs to</td>
</tr>
<tr>
<td>trans_id_suffix=</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>log_custom_handlers=</td><td>Comma-separated list of functions to call to setup custom log handlers.</td>
</tr>
</tr>
<tr>
<td>log_udp_host=</td><td>No help text available for this option</td>
</tr>
<td>log_udp_host=</td><td>If not set, the UDB receiver for syslog is disabled.</td>
</tr>
<tr>
<td>log_udp_port=514</td><td>No help text available for this option</td>
</tr>
<td>log_udp_port=514</td><td>Port value for UDB receiver, if enabled.</td>
</tr>
<tr>
<td>log_statsd_host=localhost</td><td>No help text available for this option</td>
</tr>
<td>log_statsd_host=localhost</td><td>If not set, the StatsD feature is disabled.</td>
</tr>
<tr>
<td>log_statsd_port=8125</td><td>No help text available for this option</td>
</tr>
<td>log_statsd_port=8125</td><td>Port value for the StatsD server.</td>
</tr>
<tr>
<td>log_statsd_default_sample_rate=1.0</td><td>No help text available for this option</td>
</tr>
<td>log_statsd_default_sample_rate=1.0</td><td>Defines the probability of sending a sample for any given event or
timing measurement.</td>
</tr>
<tr>
<td>log_statsd_sample_rate_factor=1.0</td><td>No help text available for this option</td>
</tr>
<td>log_statsd_sample_rate_factor=1.0</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>log_statsd_metric_prefix=</td><td>No help text available for this option</td>
</tr>
<td>log_statsd_metric_prefix=</td><td>Value will be prepended to every metric sent to the StatsD server.</td>
</tr>
<tr>
<td>cors_allow_origin=</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>
<tr>
<td>client_timeout=60</td><td>Timeout to read one chunk from a client external services</td>
</tr>
</tr>
<tr>
<td>eventlet_debug=false</td><td>If true, turn on debug logging for eventlet</td>
</tr>
<tr>
<td>max_clients=1024</td><td>Maximum number of clients one worker can process simultaneously (it will actually</td>
</tr>
</tr>
</tbody>
</table>
</para>
</para>

84
doc/src/docbkx/common/tables/swift-proxy-server-app-proxy-server.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[app:proxy-server]</literal> in <literal>proxy-server.conf-sample</literal></caption>
@ -16,107 +15,110 @@
</thead>
<tbody>
<tr>
<td>use=egg:swift#proxy</td><td>No help text available for this option</td>
</tr>
<td>use=egg:swift#proxy</td><td>Entry point of paste.deploy in the server</td>
</tr>
<tr>
<td>set log_name=proxy-server</td><td>Label to use when logging</td>
</tr>
</tr>
<tr>
<td>set log_facility=LOG_LOCAL0</td><td>Syslog log facility</td>
</tr>
</tr>
<tr>
<td>set log_level=INFO</td><td>Log level</td>
</tr>
</tr>
<tr>
<td>set log_address=/dev/log</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>log_handoffs=true</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>recheck_account_existence=60</td><td>Cache timeout in seconds to send memcached for account existence</td>
</tr>
</tr>
<tr>
<td>recheck_container_existence=60</td><td>Cache timeout in seconds to send memcached for container existence</td>
</tr>
</tr>
<tr>
<td>object_chunk_size=8192</td><td>Chunk size to read from object servers</td>
</tr>
</tr>
<tr>
<td>client_chunk_size=8192</td><td>Chunk size to read from clients</td>
</tr>
</tr>
<tr>
<td>node_timeout=10</td><td>Request timeout to external services</td>
</tr>
</tr>
<tr>
<td>conn_timeout=0.5</td><td>Connection timeout to external services</td>
</tr>
</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>
<tr>
<td>error_suppression_limit=10</td><td>Error count to consider a node error limited</td>
</tr>
</tr>
<tr>
<td>allow_account_management=false</td><td>Whether account PUTs and DELETEs are even callable</td>
</tr>
</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>
<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>
<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>
<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>
<tr>
<td>deny_host_headers=</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>auto_create_account_prefix=.</td><td>Prefix to use when automatically creating accounts</td>
</tr>
</tr>
<tr>
<td>put_queue_depth=10</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>rate_limit_after_segment=10</td><td>Rate limit the download of large object segments after this segment is downloaded.</td>
</tr>
</tr>
<tr>
<td>rate_limit_segments_per_sec=1</td><td>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>
<tr>
<td>sorting_method=shuffle</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>timing_expiry=300</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>allow_static_large_object=true</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>max_large_object_get_time=86400</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>request_node_count=2 * replicas</td><td>No help text available for this option</td>
</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> 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>read_affinity=r1z1=100, r1z2=200, r2=300</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>read_affinity=</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>write_affinity=r1, r2</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>write_affinity=</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>write_affinity_node_count=2 * replicas</td><td>No help text available for this option</td>
</tr>
</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</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> 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>
</tbody>
</table>
</para>
</para>

11
doc/src/docbkx/common/tables/swift-proxy-server-filter-account-quotas.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[filter:account-quotas]</literal> in <literal>proxy-server.conf-sample</literal></caption>
@ -16,8 +15,8 @@
</thead>
<tbody>
<tr>
<td>use=egg:swift#account_quotas</td><td>No help text available for this option</td>
</tr>
<td>use=egg:swift#account_quotas</td><td>Entry point of paste.deploy in the server</td>
</tr>
</tbody>
</table>
</para>

25
doc/src/docbkx/common/tables/swift-proxy-server-filter-authtoken.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[filter:authtoken]</literal> in <literal>proxy-server.conf-sample</literal></caption>
@ -17,31 +16,31 @@
<tbody>
<tr>
<td>auth_host=keystonehost</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>auth_port=35357</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>auth_protocol=http</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>auth_uri=http://keystonehost:5000/</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>admin_tenant_name=service</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>admin_user=swift</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>admin_password=password</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>delay_auth_decision=1</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>cache=swift.cache</td><td>No help text available for this option</td>
</tr>
</tr>
</tbody>
</table>
</para>

19
doc/src/docbkx/common/tables/swift-proxy-server-filter-bulk.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[filter:bulk]</literal> in <literal>proxy-server.conf-sample</literal></caption>
@ -16,20 +15,20 @@
</thead>
<tbody>
<tr>
<td>use=egg:swift#bulk</td><td>No help text available for this option</td>
</tr>
<td>use=egg:swift#bulk</td><td>Entry point of paste.deploy in the server</td>
</tr>
<tr>
<td>max_containers_per_extraction=10000</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>max_failed_extractions=1000</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>max_deletes_per_request=10000</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>yield_frequency=60</td><td>No help text available for this option</td>
</tr>
</tr>
</tbody>
</table>
</para>

33
doc/src/docbkx/common/tables/swift-proxy-server-filter-cache.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[filter:cache]</literal> in <literal>proxy-server.conf-sample</literal></caption>
@ -16,29 +15,29 @@
</thead>
<tbody>
<tr>
<td>use=egg:swift#memcache</td><td>No help text available for this option</td>
</tr>
<td>use=egg:swift#memcache</td><td>Entry point of paste.deploy in the server</td>
</tr>
<tr>
<td>set log_name=cache</td><td>No help text available for this option</td>
</tr>
<td>set log_name=cache</td><td>Label to use when logging</td>
</tr>
<tr>
<td>set log_facility=LOG_LOCAL0</td><td>No help text available for this option</td>
</tr>
<td>set log_facility=LOG_LOCAL0</td><td>Syslog log facility</td>
</tr>
<tr>
<td>set log_level=INFO</td><td>No help text available for this option</td>
</tr>
<td>set log_level=INFO</td><td>Log level</td>
</tr>
<tr>
<td>set log_headers=false</td><td>No help text available for this option</td>
</tr>
<td>set log_headers=false</td><td>If True, log headers in each request</td>
</tr>
<tr>
<td>set log_address=/dev/log</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>memcache_servers=127.0.0.1:11211</td><td>Comma separated list of memcached servers ip:port services</td>
</tr>
</tr>
<tr>
<td>memcache_serialization_support=2</td><td>No help text available for this option</td>
</tr>
</tr>
</tbody>
</table>
</para>

29
doc/src/docbkx/common/tables/swift-proxy-server-filter-catch_errors.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[filter:catch_errors]</literal> in <literal>proxy-server.conf-sample</literal></caption>
@ -16,23 +15,23 @@
</thead>
<tbody>
<tr>
<td>use=egg:swift#catch_errors</td><td>No help text available for this option</td>
</tr>
<td>use=egg:swift#catch_errors</td><td>Entry point of paste.deploy in the server</td>
</tr>
<tr>
<td>set log_name=catch_errors</td><td>No help text available for this option</td>
</tr>
<td>set log_name=catch_errors</td><td>Label to use when logging</td>
</tr>
<tr>
<td>set log_facility=LOG_LOCAL0</td><td>No help text available for this option</td>
</tr>
<td>set log_facility=LOG_LOCAL0</td><td>Syslog log facility</td>
</tr>
<tr>
<td>set log_level=INFO</td><td>No help text available for this option</td>
</tr>
<td>set log_level=INFO</td><td>Log level</td>
</tr>
<tr>
<td>set log_headers=false</td><td>No help text available for this option</td>
</tr>
<td>set log_headers=false</td><td>If True, log headers in each request</td>
</tr>
<tr>
<td>set log_address=/dev/log</td><td>No help text available for this option</td>
</tr>
</tr>
</tbody>
</table>
</para>

31
doc/src/docbkx/common/tables/swift-proxy-server-filter-cname_lookup.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[filter:cname_lookup]</literal> in <literal>proxy-server.conf-sample</literal></caption>
@ -16,29 +15,29 @@
</thead>
<tbody>
<tr>
<td>use=egg:swift#cname_lookup</td><td>No help text available for this option</td>
</tr>
<td>use=egg:swift#cname_lookup</td><td>Entry point of paste.deploy in the server</td>
</tr>
<tr>
<td>set log_name=cname_lookup</td><td>Label used when logging</td>
</tr>
<td>set log_name=cname_lookup</td><td>Label to use when logging</td>
</tr>
<tr>
<td>set log_facility=LOG_LOCAL0</td><td>Syslog log facility</td>
</tr>
</tr>
<tr>
<td>set log_level=INFO</td><td>Log level</td>
</tr>
</tr>
<tr>
<td>set log_headers=false</td><td>If True, log headers in each request</td>
</tr>
</tr>
<tr>
<td>set log_address=/dev/log</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>storage_domain=example.com</td><td>No help text available for this option</td>
</tr>
<td>storage_domain=example.com</td><td>Domain to use for remap</td>
</tr>
<tr>
<td>lookup_depth=1</td><td>As CNAMES can be recursive, how many levels to search through</td>
</tr>
</tr>
</tbody>
</table>
</para>
</para>

11
doc/src/docbkx/common/tables/swift-proxy-server-filter-container-quotas.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[filter:container-quotas]</literal> in <literal>proxy-server.conf-sample</literal></caption>
@ -16,8 +15,8 @@
</thead>
<tbody>
<tr>
<td>use=egg:swift#container_quotas</td><td>No help text available for this option</td>
</tr>
<td>use=egg:swift#container_quotas</td><td>Entry point of paste.deploy in the server</td>
</tr>
</tbody>
</table>
</para>

33
doc/src/docbkx/common/tables/swift-proxy-server-filter-domain_remap.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[filter:domain_remap]</literal> in <literal>proxy-server.conf-sample</literal></caption>
@ -16,32 +15,32 @@
</thead>
<tbody>
<tr>
<td>use=egg:swift#domain_remap</td><td>No help text available for this option</td>
</tr>
<td>use=egg:swift#domain_remap</td><td>Entry point of paste.deploy in the server</td>
</tr>
<tr>
<td>set log_name=domain_remap</td><td>Label used when logging</td>
</tr>
<td>set log_name=domain_remap</td><td>Label to use when logging</td>
</tr>
<tr>
<td>set log_facility=LOG_LOCAL0</td><td>Syslog log facility</td>
</tr>
</tr>
<tr>
<td>set log_level=INFO</td><td>Log level</td>
</tr>
</tr>
<tr>
<td>set log_headers=false</td><td>If True, log headers with each request</td>
</tr>
<td>set log_headers=false</td><td>If True, log headers in each request</td>
</tr>
<tr>
<td>set log_address=/dev/log</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>storage_domain=example.com</td><td>Domain to use for remap</td>
</tr>
</tr>
<tr>
<td>path_root=v1</td><td>Root path</td>
</tr>
</tr>
<tr>
<td>reseller_prefixes=AUTH</td><td>Reseller prefix</td>
</tr>
</tr>
</tbody>
</table>
</para>
</para>

11
doc/src/docbkx/common/tables/swift-proxy-server-filter-formpost.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[filter:formpost]</literal> in <literal>proxy-server.conf-sample</literal></caption>
@ -16,8 +15,8 @@
</thead>
<tbody>
<tr>
<td>use=egg:swift#formpost</td><td>No help text available for this option</td>
</tr>
<td>use=egg:swift#formpost</td><td>Entry point of paste.deploy in the server</td>
</tr>
</tbody>
</table>
</para>

13
doc/src/docbkx/common/tables/swift-proxy-server-filter-healthcheck.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[filter:healthcheck]</literal> in <literal>proxy-server.conf-sample</literal></caption>
@ -16,11 +15,11 @@
</thead>
<tbody>
<tr>
<td>use=egg:swift#healthcheck</td><td>No help text available for this option</td>
</tr>
<td>use=egg:swift#healthcheck</td><td>Entry point of paste.deploy in the server</td>
</tr>
<tr>
<td>disable_path=</td><td>No help text available for this option</td>
</tr>
</tr>
</tbody>
</table>
</para>

13
doc/src/docbkx/common/tables/swift-proxy-server-filter-keystoneauth.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[filter:keystoneauth]</literal> in <literal>proxy-server.conf-sample</literal></caption>
@ -16,11 +15,11 @@
</thead>
<tbody>
<tr>
<td>use=egg:swift#keystoneauth</td><td>No help text available for this option</td>
</tr>
<td>use=egg:swift#keystoneauth</td><td>Entry point of paste.deploy in the server</td>
</tr>
<tr>
<td>operator_roles=admin, swiftoperator</td><td>No help text available for this option</td>
</tr>
</tr>
</tbody>
</table>
</para>

13
doc/src/docbkx/common/tables/swift-proxy-server-filter-list-endpoints.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[filter:list-endpoints]</literal> in <literal>proxy-server.conf-sample</literal></caption>
@ -16,11 +15,11 @@
</thead>
<tbody>
<tr>
<td>use=egg:swift#list_endpoints</td><td>No help text available for this option</td>
</tr>
<td>use=egg:swift#list_endpoints</td><td>Entry point of paste.deploy in the server</td>
</tr>
<tr>
<td>list_endpoints_path=/endpoints/</td><td>No help text available for this option</td>
</tr>
</tr>
</tbody>
</table>
</para>

19
doc/src/docbkx/common/tables/swift-proxy-server-filter-name_check.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[filter:name_check]</literal> in <literal>proxy-server.conf-sample</literal></caption>
@ -16,17 +15,17 @@
</thead>
<tbody>
<tr>
<td>use=egg:swift#name_check</td><td>No help text available for this option</td>
</tr>
<td>use=egg:swift#name_check</td><td>Entry point of paste.deploy in the server</td>
</tr>
<tr>
<td>forbidden_chars='"`&lt;&gt;</td><td>Characters that are not allowed in a name</td>
</tr>
</tr>
<tr>
<td>maximum_length=255</td><td>Maximum length of a name</td>
</tr>
</tr>
<tr>
<td>forbidden_regexp=/\./|/\.\./|/\.$|/\.\.$</td><td>Substrings to forbid, using regular expression syntax</td>
</tr>
</tr>
</tbody>
</table>
</para>
</para>

43
doc/src/docbkx/common/tables/swift-proxy-server-filter-proxy-logging.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[filter:proxy-logging]</literal> in <literal>proxy-server.conf-sample</literal></caption>
@ -16,47 +15,53 @@
</thead>
<tbody>
<tr>
<td>use=egg:swift#proxy_logging</td><td>No help text available for this option</td>
</tr>
<td>use=egg:swift#proxy_logging</td><td>Entry point of paste.deploy in the server</td>
</tr>
<tr>
<td>access_log_name=swift</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>access_log_facility=LOG_LOCAL0</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>access_log_level=INFO</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>access_log_address=/dev/log</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>access_log_udp_host=</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>access_log_udp_port=514</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>access_log_statsd_host=localhost</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>access_log_statsd_port=8125</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>access_log_statsd_default_sample_rate=1.0</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>access_log_statsd_sample_rate_factor=1.0</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>access_log_statsd_metric_prefix=</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>access_log_headers=false</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>logged with access_log_headers=True.</td><td>No help text available for this option</td>
</tr>
<tr>
<td>reveal_sensitive_prefix=8192</td><td>No help text available for this option</td>
</tr>
<tr>
<td>log_statsd_valid_http_methods=GET,HEAD,POST,PUT,DELETE,COPY,OPTIONS</td><td>No help text available for this option</td>
</tr>
</tr>
</tbody>
</table>
</para>

71
doc/src/docbkx/common/tables/swift-proxy-server-filter-ratelimit.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[filter:ratelimit]</literal> in <literal>proxy-server.conf-sample</literal></caption>
@ -16,65 +15,65 @@
</thead>
<tbody>
<tr>
<td>use=egg:swift#ratelimit</td><td>No help text available for this option</td>
</tr>
<td>use=egg:swift#ratelimit</td><td>Entry point of paste.deploy in the server</td>
</tr>
<tr>
<td>set log_name=ratelimit</td><td>No help text available for this option</td>
</tr>
<td>set log_name=ratelimit</td><td>Label to use when logging</td>
</tr>
<tr>
<td>set log_facility=LOG_LOCAL0</td><td>No help text available for this option</td>
</tr>
<td>set log_facility=LOG_LOCAL0</td><td>Syslog log facility</td>
</tr>
<tr>
<td>set log_level=INFO</td><td>No help text available for this option</td>
</tr>
<td>set log_level=INFO</td><td>Log level</td>
</tr>
<tr>
<td>set log_headers=false</td><td>No help text available for this option</td>
</tr>
<td>set log_headers=false</td><td>If True, log headers in each request</td>
</tr>
<tr>
<td>set log_address=/dev/log</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>clock_accuracy=1000</td><td>No help text available for this option</td>
</tr>
<td>clock_accuracy=1000</td><td>Represents how accurate the proxy servers' system clocks are with each other. 1000 means that all the proxies' clock are accurate to each other within 1 millisecond. No ratelimit should be higher than the clock accuracy.</td>
</tr>
<tr>
<td>max_sleep_time_seconds=60</td><td>No help text available for this option</td>
</tr>
<td>max_sleep_time_seconds=60</td><td>App will immediately return a 498 response if the necessary sleep time ever exceeds the given max_sleep_time_seconds.</td>
</tr>
<tr>
<td>log_sleep_time_seconds=0</td><td>No help text available for this option</td>
</tr>
<td>log_sleep_time_seconds=0</td><td>To allow visibility into rate limiting set this value > 0 and all sleeps greater than the number will be logged.</td>
</tr>
<tr>
<td>rate_buffer_seconds=5</td><td>No help text available for this option</td>
</tr>
<td>rate_buffer_seconds=5</td><td>Number of seconds the rate counter can drop and be allowed to catch up (at a faster than listed rate). A larger number will result in larger spikes in rate but better average accuracy.</td>
</tr>
<tr>
<td>account_ratelimit=0</td><td>No help text available for this option</td>
</tr>
<td>account_ratelimit=0</td><td>If set, will limit PUT and DELETE requests to /account_name/container_name. Number is in requests per second.</td>
</tr>
<tr>
<td>account_whitelist=a,b</td><td>No help text available for this option</td>
</tr>
<td>account_whitelist=a,b</td><td>Comma separated lists of account names that will not be rate limited.</td>
</tr>
<tr>
<td>account_blacklist=c,d</td><td>No help text available for this option</td>
</tr>
<td>account_blacklist=c,d</td><td>Comma separated lists of account names that will not be allowed. Returns a 497 response. r: for containers of size x, limit requests per second to r. Will limit PUT, DELETE, and POST requests to /a/c/o. container_listing_ratelimit_x = r: for containers of size x, limit listing requests per second to r. Will limit GET requests to /a/c.</td>
</tr>
<tr>
<td>with container_limit_x=r</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>container_ratelimit_0=100</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>container_ratelimit_10=50</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>container_ratelimit_50=20</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>container_listing_ratelimit_0=100</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>container_listing_ratelimit_10=50</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>container_listing_ratelimit_50=20</td><td>No help text available for this option</td>
</tr>
</tr>
</tbody>
</table>
</para>

17
doc/src/docbkx/common/tables/swift-proxy-server-filter-slo.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[filter:slo]</literal> in <literal>proxy-server.conf-sample</literal></caption>
@ -16,17 +15,17 @@
</thead>
<tbody>
<tr>
<td>use=egg:swift#slo</td><td>No help text available for this option</td>
</tr>
<td>use=egg:swift#slo</td><td>Entry point of paste.deploy in the server</td>
</tr>
<tr>
<td>max_manifest_segments=1000</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>max_manifest_size=2097152</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>min_segment_size=1048576</td><td>No help text available for this option</td>
</tr>
</tr>
</tbody>
</table>
</para>

11
doc/src/docbkx/common/tables/swift-proxy-server-filter-staticweb.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[filter:staticweb]</literal> in <literal>proxy-server.conf-sample</literal></caption>
@ -16,8 +15,8 @@
</thead>
<tbody>
<tr>
<td>use=egg:swift#staticweb</td><td>No help text available for this option</td>
</tr>
<td>use=egg:swift#staticweb</td><td>Entry point of paste.deploy in the server</td>
</tr>
</tbody>
</table>
</para>

47
doc/src/docbkx/common/tables/swift-proxy-server-filter-tempauth.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[filter:tempauth]</literal> in <literal>proxy-server.conf-sample</literal></caption>
@ -16,50 +15,50 @@
</thead>
<tbody>
<tr>
<td>use=egg:swift#tempauth</td><td>No help text available for this option</td>
</tr>
<td>use=egg:swift#tempauth</td><td>Entry point of paste.deploy in the server</td>
</tr>
<tr>
<td>set log_name=tempauth</td><td>No help text available for this option</td>
</tr>
<td>set log_name=tempauth</td><td>Label to use when logging</td>
</tr>
<tr>
<td>set log_facility=LOG_LOCAL0</td><td>No help text available for this option</td>
</tr>
<td>set log_facility=LOG_LOCAL0</td><td>Syslog log facility</td>
</tr>
<tr>
<td>set log_level=INFO</td><td>No help text available for this option</td>
</tr>
<td>set log_level=INFO</td><td>Log level</td>
</tr>
<tr>
<td>set log_headers=false</td><td>No help text available for this option</td>
</tr>
<td>set log_headers=false</td><td>If True, log headers in each request</td>
</tr>
<tr>
<td>set log_address=/dev/log</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>reseller_prefix=AUTH</td><td>The naming scope for the auth service. Swift</td>
</tr>
</tr>
<tr>
<td>auth_prefix=/auth/</td><td>The HTTP request path prefix for the auth service. Swift itself reserves anything beginning with the letter `v`.</td>
</tr>
</tr>
<tr>
<td>token_life=86400</td><td>The number of seconds a token is valid.</td>
</tr>
</tr>
<tr>
<td>allow_overrides=true</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>storage_url_scheme=default</td><td>Scheme to return with storage urls: http, https, or default (chooses based on what the server is running as) This can be useful with an SSL load balancer in front of a non-SSL server.</td>
</tr>
</tr>
<tr>
<td>user_admin_admin=admin .admin .reseller_admin</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>user_test_tester=testing .admin</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>user_test2_tester2=testing2 .admin</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>user_test_tester3=testing3</td><td>No help text available for this option</td>
</tr>
</tr>
</tbody>
</table>
</para>

21
doc/src/docbkx/common/tables/swift-proxy-server-filter-tempurl.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[filter:tempurl]</literal> in <literal>proxy-server.conf-sample</literal></caption>
@ -16,23 +15,23 @@
</thead>
<tbody>
<tr>
<td>use=egg:swift#tempurl</td><td>No help text available for this option</td>
</tr>
<td>use=egg:swift#tempurl</td><td>Entry point of paste.deploy in the server</td>
</tr>
<tr>
<td>methods=GET HEAD PUT</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>incoming_remove_headers=x-timestamp</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>incoming_allow_headers=</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>outgoing_remove_headers=x-object-meta-*</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>outgoing_allow_headers=x-object-meta-public-*</td><td>No help text available for this option</td>
</tr>
</tr>
</tbody>
</table>
</para>

9
doc/src/docbkx/common/tables/swift-proxy-server-pipeline-main.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[pipeline:main]</literal> in <literal>proxy-server.conf-sample</literal></caption>
@ -17,7 +16,7 @@
<tbody>
<tr>
<td>pipeline=catch_errors healthcheck proxy-logging cache bulk slo ratelimit tempauth container-quotas account-quotas proxy-logging proxy-server</td><td>No help text available for this option</td>
</tr>
</tr>
</tbody>
</table>
</para>

15
doc/src/docbkx/common/tables/swift-rsyncd-account.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[account]</literal> in <literal>rsyncd.conf-sample</literal></caption>
@ -17,16 +16,16 @@
<tbody>
<tr>
<td>max connections=2</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>path=/srv/node</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>read only=false</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>lock file=/var/lock/account.lock</td><td>No help text available for this option</td>
</tr>
</tr>
</tbody>
</table>
</para>

15
doc/src/docbkx/common/tables/swift-rsyncd-container.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[container]</literal> in <literal>rsyncd.conf-sample</literal></caption>
@ -17,16 +16,16 @@
<tbody>
<tr>
<td>max connections=4</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>path=/srv/node</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>read only=false</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>lock file=/var/lock/container.lock</td><td>No help text available for this option</td>
</tr>
</tr>
</tbody>
</table>
</para>

15
doc/src/docbkx/common/tables/swift-rsyncd-object.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[object]</literal> in <literal>rsyncd.conf-sample</literal></caption>
@ -17,16 +16,16 @@
<tbody>
<tr>
<td>max connections=8</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>path=/srv/node</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>read only=false</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>lock file=/var/lock/object.lock</td><td>No help text available for this option</td>
</tr>
</tr>
</tbody>
</table>
</para>

59
doc/src/docbkx/common/tables/swift-swift-bench-bench.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[bench]</literal> in <literal>swift-bench.conf-sample</literal></caption>
@ -17,79 +16,79 @@
<tbody>
<tr>
<td>auth=http://localhost:8080/auth/v1.0</td><td>Swift storage accounts and auth tokens will begin with this prefix.</td>
</tr>
</tr>
<tr>
<td>user=test:tester</td><td>User to run as</td>
</tr>
</tr>
<tr>
<td>key=testing</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>auth_version=1.0</td><td>No help text available for this option</td>
</tr>
<td>auth_version=1.0</td><td>Indicates which version of auth</td>
</tr>
<tr>
<td>log-level=INFO</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>timeout=10</td><td>Timeout value sent to rsync --timeout and --contimeout options</td>
</tr>
</tr>
<tr>
<td>put_concurrency=10</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>get_concurrency=10</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>del_concurrency=10</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>concurrency=</td><td>Number of replication workers to spawn</td>
</tr>
</tr>
<tr>
<td>object_sources=</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>lower_object_size=10</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>upper_object_size=10</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>object_size=1</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>num_objects=1000</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>num_gets=10000</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>num_containers=20</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>container_name=(randomly-chosen uuid4)</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>delete=yes</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>use_proxy=yes</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>use_proxy=no, this setting is required and used as the X-Storage-Url when</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>url=</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>account=</td><td>has generated an error (timeout, not yet found, etc.)</td>
</tr>
</tr>
<tr>
<td>use_proxy=no.</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>devices=sdb1</td><td>Parent directory of where devices are mounted</td>
</tr>
</tr>
</tbody>
</table>
</para>

29
doc/src/docbkx/common/tables/swift-swift-swift-constraints.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[swift-constraints]</literal> in <literal>swift.conf-sample</literal></caption>
@ -17,37 +16,37 @@
<tbody>
<tr>
<td>max_file_size=5368709122</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>max_meta_name_length=128</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>max_meta_value_length=256</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>max_meta_count=90</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>max_meta_overall_size=4096</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>max_header_size=8192</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>max_object_name_length=1024</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>container_listing_limit=10000</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>account_listing_limit=10000</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>max_account_name_length=256</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>max_container_name_length=256</td><td>No help text available for this option</td>
</tr>
</tr>
</tbody>
</table>
</para>

11
doc/src/docbkx/common/tables/swift-swift-swift-hash.xml
View File

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<!-- The tool that generated this table lives in the
tools directory of this repository. As it was a one-time
generation, you can edit this file. -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for <literal>[swift-hash]</literal> in <literal>swift.conf-sample</literal></caption>
@ -17,10 +16,10 @@
<tbody>
<tr>
<td>swift_hash_path_suffix=changeme</td><td>No help text available for this option</td>
</tr>
</tr>
<tr>
<td>swift_hash_path_prefix=changeme</td><td>No help text available for this option</td>
</tr>
</tr>
</tbody>
</table>
</para>

113
tools/autogenerate-config-docs/extract_swift_flags.py
View File

@ -12,6 +12,7 @@ from xml.sax.saxutils import escape
# and generally only having a single entry
# after the equals (the default value)
def parse_line(line):
"""
takes a line from a swift sample configuration file and attempts
@ -32,26 +33,33 @@ def parse_line(line):
return None
return config, default.strip()
def get_existing_options(optfile):
def get_existing_options(optfiles):
"""
parses an existing XML table to compile a list of existing options
"""
options = []
xmldoc = minidom.parse(optfile)
tdlist = xmldoc.getElementsByTagName('td')
for td in tdlist:
try:
tdvalue = td.childNodes[0].nodeValue
except IndexError:
continue
if '=' in tdvalue and ' ' not in tdvalue:
options.append(tdvalue.split('=',1)[0])
options = {}
for optfile in optfiles:
xmldoc = minidom.parse(optfile)
tbody = xmldoc.getElementsByTagName('tbody')[0]
trlist = tbody.getElementsByTagName('tr')
for tr in trlist:
try:
optentry = tr.childNodes[1].childNodes[0]
option, default = optentry.nodeValue.split('=', 1)
helptext = tr.childNodes[2].childNodes[0].nodeValue
except IndexError:
continue
if option not in options or 'No help text' in options[option]:
#options[option.split('=',1)[0]] = helptext
options[option] = helptext
return options
def extract_descriptions_from_devref(repo, options):
"""
loop through the devref RST files, looking for lines formatted
such that they might contain a description of a particular
such that they might contain a description of a particular
option
"""
option_descs = {}
@ -68,29 +76,31 @@ def extract_descriptions_from_devref(repo, options):
in_option_block = False
continue
if line[0] == ' ' and prev_option is not None:
option_descs[prev_option] = option_descs[prev_option] + ' ' + line.strip()
option_descs[prev_option] = (option_descs[prev_option]
+ ' ' + line.strip())
for option in options:
line_parts = line.strip().split(None, 2)
if (' ' in line and len(line_parts) == 3
and option == line_parts[0]
and line_parts[1] != '=' and option != 'use'
and (option not in option_descs or
and (option not in option_descs or
len(option_descs[option]) < len(line_parts[2]))):
option_descs[option] = line_parts[2]
prev_option = option
return option_descs
def new_section_file(sample, current_section):
section_filename = ('swift-' +
path.basename(sample).split('.conf')[0]
+ '-' + current_section.replace('[','').replace(']','').replace(':','-')
+ '-'
+ current_section.replace('[', '').replace(']', '').replace(':', '-')
+ '.xml')
section_file = open(section_filename, 'w')
section_file.write('<?xml version="1.0" encoding="UTF-8"?>\n\
<!-- Warning: Do not edit this file. It is automatically\n\
generated and your changes will be overwritten.\n\
The tool to do so lives in the tools directory of this\n\
repository -->\n\
<!-- The tool that generated this table lives in the\n\
tools directory of this repository. As it was a one-time\n\
generation, you can edit this file. -->\n\
<para xmlns="http://docbook.org/ns/docbook" version="5.0">\n\
<table rules="all">\n\
<caption>Description of configuration options for <literal>'
@ -107,66 +117,75 @@ def new_section_file(sample, current_section):
<tbody>')
return section_file
def create_new_tables(repo, vebose, existing_options=None):
def create_new_tables(repo, verbose):
"""
writes a set of docbook-formatted tables, one per section in swift
configuration files. Uses existing tables and swift devref as a source
of truth in that order to determine helptext for options found in
sample config files
"""
existing_tables = glob.glob('../../doc/src/docbkx/common/tables/swift*xml')
options = []
for table in existing_tables:
options.extend(get_existing_options(table))
options = {}
#use the existing tables to get a list of option names
options = get_existing_options(existing_tables)
option_descs = extract_descriptions_from_devref(repo, options)
conf_samples = glob.glob(repo + '/etc/*conf-sample')
conf_samples = glob.glob(repo + '/etc/*conf-sample')
for sample in conf_samples:
current_section = None
section_file = None
sample_file = open(sample,'r')
sample_file = open(sample, 'r')
for line in sample_file:
if '[' in line and ']\n' in line and '=' not in line:
#header line
"""
it's a header line in the conf file, open a new table file
for this section and close any existing one
"""
if current_section != line.strip('#').strip():
if section_file is not None:
section_file.write('\n </tbody>\n\
</table>\n\
</para>')
section_file.close()
current_section = line.strip('#').strip()
current_section = line.strip('#').strip()
section_file = new_section_file(sample, current_section)
elif section_file is not None:
#config option line
"""
it's a config option line in the conf file, find out the
help text and write to the table file.
"""
parsed_line = parse_line(line)
if parsed_line is not None:
if parsed_line[0] in option_descs:
option_desc = option_descs[parsed_line[0]]
if (parsed_line[0] in options.keys()
and 'No help text' not in options[parsed_line[0]]):
# use the help text from existing tables
option_desc = options[parsed_line[0]].replace(u'\xa0', u' ')
elif parsed_line[0] in option_descs:
# use the help text from the devref
option_desc = option_descs[parsed_line[0]].replace(u'\xa0', u' ')
else:
option_desc = 'No help text available for this option'
#if (existing_options is not None
# and parsed_line[0] not in existing_options):
# print "New Option: " + parsed_line[0]
#elif existing_options is not None:
# existing_options.remove(parsed_line[0])
if verbose > 0:
print parsed_line[0] + "has no help text"
section_file.write('\n <tr>\n\
<td>' + parsed_line[0] + '=' + escape(str(parsed_line[1])) +
'</td><td>'+ option_desc + '</td>\n' + ' </tr>')
<td>' + parsed_line[0] + '=' +
escape(str(parsed_line[1])) +
'</td><td>' + option_desc + '</td>\n' +
' </tr>')
if section_file is not None:
section_file.write('\n </tbody>\n\
</table>\n\
</para>')
section_file.close()
#print "Removed: " + str(existing_options)
def main(repo, verbose=0):
"""
writes a set of docbook-formatted files, based on configuration sections
in swift sample configuration files
actions: new - creates blank configuration files
update - creates updated configuration files based on existing ones
"""
action = 'create'
#action = 'update'
if action == "create":
create_new_tables(repo, verbose)
elif action == "update":
options = get_existing_options('/home/fifieldt/temp/os-doc-on-a-plane-2/doc/src/docbkx/common/tables/swift-object-server-[DEFAULT].xml')
create_new_tables(repo, verbose, options)
create_new_tables(repo, verbose)
if __name__ == "__main__":
main(sys.argv[1])