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

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

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically <!-- The tool that generated this table lives in the
generated and your changes will be overwritten. tools directory of this repository. As it was a one-time
The tool to do so lives in the tools directory of this generation, you can edit this file. -->
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0"> <para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <literal>[DEFAULT]</literal> in <literal>account-server.conf-sample</literal></caption> <caption>Description of configuration options for <literal>[DEFAULT]</literal> in <literal>account-server.conf-sample</literal></caption>
@ -27,9 +26,6 @@
<tr> <tr>
<td>backlog=4096</td><td>Maximum number of allowed pending TCP connections</td> <td>backlog=4096</td><td>Maximum number of allowed pending TCP connections</td>
</tr> </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> <td>user=swift</td><td>User to run as</td>
</tr> </tr>
@ -44,6 +40,19 @@
</tr> </tr>
<tr> <tr>
<td>disable_fallocate=false</td><td>Disable "fast fail" fallocate checks if the underlying filesystem does not support it.</td> <td>disable_fallocate=false</td><td>Disable "fast fail" fallocate checks if the underlying filesystem does not support it.</td>
</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>
<tr> <tr>
<td>log_name=swift</td><td>Label used when logging</td> <td>log_name=swift</td><td>Label used when logging</td>
@ -55,31 +64,34 @@
<td>log_level=INFO</td><td>Logging level</td> <td>log_level=INFO</td><td>Logging level</td>
</tr> </tr>
<tr> <tr>
<td>log_address=/dev/log</td><td>No help text available for this option</td> <td>log_address=/dev/log</td><td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>log_custom_handlers=</td><td>Comma-separated list of functions to call to setup custom log handlers.</td> <td>log_custom_handlers=</td><td>Comma-separated list of functions to call to setup custom log handlers.</td>
</tr> </tr>
<tr> <tr>
<td>log_udp_host=</td><td>No help text available for this option</td> <td>log_udp_host=</td><td>If not set, the UDB receiver for syslog is disabled.</td>
</tr> </tr>
<tr> <tr>
<td>log_udp_port=514</td><td>No help text available for this option</td> <td>log_udp_port=514</td><td>Port value for UDB receiver, if enabled.</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_host=localhost</td><td>No help text available for this option</td> <td>log_statsd_host=localhost</td><td>If not set, the StatsD feature is disabled.</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_port=8125</td><td>No help text available for this option</td> <td>log_statsd_port=8125</td><td>Port value for the StatsD server.</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_default_sample_rate=1.0</td><td>No help text available for this option</td> <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>
<tr> <tr>
<td>log_statsd_sample_rate_factor=1.0</td><td>No help text available for this option</td> <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>
<tr> <tr>
<td>log_statsd_metric_prefix=</td><td>No help text available for this option</td> <td>log_statsd_metric_prefix=</td><td>Value will be prepended to every metric sent to the StatsD server.</td>
</tr> </tr>
<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> <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>

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

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

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

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically <!-- The tool that generated this table lives in the
generated and your changes will be overwritten. tools directory of this repository. As it was a one-time
The tool to do so lives in the tools directory of this generation, you can edit this file. -->
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0"> <para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <literal>[account-reaper]</literal> in <literal>account-server.conf-sample</literal></caption> <caption>Description of configuration options for <literal>[account-reaper]</literal> in <literal>account-server.conf-sample</literal></caption>
@ -25,7 +24,7 @@
<td>log_level=INFO</td><td>Logging level</td> <td>log_level=INFO</td><td>Logging level</td>
</tr> </tr>
<tr> <tr>
<td>log_address=/dev/log</td><td>No help text available for this option</td> <td>log_address=/dev/log</td><td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>concurrency=25</td><td>Number of replication workers to spawn</td> <td>concurrency=25</td><td>Number of replication workers to spawn</td>

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

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically <!-- The tool that generated this table lives in the
generated and your changes will be overwritten. tools directory of this repository. As it was a one-time
The tool to do so lives in the tools directory of this generation, you can edit this file. -->
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0"> <para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <literal>[account-replicator]</literal> in <literal>account-server.conf-sample</literal></caption> <caption>Description of configuration options for <literal>[account-replicator]</literal> in <literal>account-server.conf-sample</literal></caption>
@ -25,7 +24,7 @@
<td>log_level=INFO</td><td>Logging level</td> <td>log_level=INFO</td><td>Logging level</td>
</tr> </tr>
<tr> <tr>
<td>log_address=/dev/log</td><td>No help text available for this option</td> <td>log_address=/dev/log</td><td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>vm_test_mode=no</td><td>Indicates that you are using a VM environment</td> <td>vm_test_mode=no</td><td>Indicates that you are using a VM environment</td>
@ -34,7 +33,7 @@
<td>per_diff=1000</td><td>Limit number of items to get per diff</td> <td>per_diff=1000</td><td>Limit number of items to get per diff</td>
</tr> </tr>
<tr> <tr>
<td>max_diffs=100</td><td>Caps how long the replicator tries to spend syncing a database per pass</td> <td>max_diffs=100</td><td>Caps how long the replicator spends trying to sync a database per pass</td>
</tr> </tr>
<tr> <tr>
<td>concurrency=8</td><td>Number of replication workers to spawn</td> <td>concurrency=8</td><td>Number of replication workers to spawn</td>
@ -61,7 +60,7 @@
<td>run_pause=30</td><td>Time in seconds to wait between replication passes</td> <td>run_pause=30</td><td>Time in seconds to wait between replication passes</td>
</tr> </tr>
<tr> <tr>
<td>recon_cache_path=/var/cache/swift</td><td>No help text available for this option</td> <td>recon_cache_path=/var/cache/swift</td><td>Directory where stats for a few items will be stored</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>

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

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

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

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

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

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

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

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

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically <!-- The tool that generated this table lives in the
generated and your changes will be overwritten. tools directory of this repository. As it was a one-time
The tool to do so lives in the tools directory of this generation, you can edit this file. -->
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0"> <para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <literal>[DEFAULT]</literal> in <literal>container-server.conf-sample</literal></caption> <caption>Description of configuration options for <literal>[DEFAULT]</literal> in <literal>container-server.conf-sample</literal></caption>
@ -27,9 +26,6 @@
<tr> <tr>
<td>backlog=4096</td><td>Maximum number of allowed pending TCP connections</td> <td>backlog=4096</td><td>Maximum number of allowed pending TCP connections</td>
</tr> </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> <td>user=swift</td><td>User to run as</td>
</tr> </tr>
@ -44,6 +40,19 @@
</tr> </tr>
<tr> <tr>
<td>disable_fallocate=false</td><td>Disable "fast fail" fallocate checks if the underlying filesystem does not support it.</td> <td>disable_fallocate=false</td><td>Disable "fast fail" fallocate checks if the underlying filesystem does not support it.</td>
</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>
<tr> <tr>
<td>allowed_sync_hosts=127.0.0.1</td><td>No help text available for this option</td> <td>allowed_sync_hosts=127.0.0.1</td><td>No help text available for this option</td>
@ -58,31 +67,34 @@
<td>log_level=INFO</td><td>Logging level</td> <td>log_level=INFO</td><td>Logging level</td>
</tr> </tr>
<tr> <tr>
<td>log_address=/dev/log</td><td>No help text available for this option</td> <td>log_address=/dev/log</td><td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>log_custom_handlers=</td><td>Comma-separated list of functions to call to setup custom log handlers.</td> <td>log_custom_handlers=</td><td>Comma-separated list of functions to call to setup custom log handlers.</td>
</tr> </tr>
<tr> <tr>
<td>log_udp_host=</td><td>No help text available for this option</td> <td>log_udp_host=</td><td>If not set, the UDB receiver for syslog is disabled.</td>
</tr> </tr>
<tr> <tr>
<td>log_udp_port=514</td><td>No help text available for this option</td> <td>log_udp_port=514</td><td>Port value for UDB receiver, if enabled.</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_host=localhost</td><td>No help text available for this option</td> <td>log_statsd_host=localhost</td><td>If not set, the StatsD feature is disabled.</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_port=8125</td><td>No help text available for this option</td> <td>log_statsd_port=8125</td><td>Port value for the StatsD server.</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_default_sample_rate=1.0</td><td>No help text available for this option</td> <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>
<tr> <tr>
<td>log_statsd_sample_rate_factor=1.0</td><td>No help text available for this option</td> <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>
<tr> <tr>
<td>log_statsd_metric_prefix=</td><td>No help text available for this option</td> <td>log_statsd_metric_prefix=</td><td>Value will be prepended to every metric sent to the StatsD server.</td>
</tr> </tr>
<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> <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>

19
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"?> <?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically <!-- The tool that generated this table lives in the
generated and your changes will be overwritten. tools directory of this repository. As it was a one-time
The tool to do so lives in the tools directory of this generation, you can edit this file. -->
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0"> <para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <literal>[app:container-server]</literal> in <literal>container-server.conf-sample</literal></caption> <caption>Description of configuration options for <literal>[app:container-server]</literal> in <literal>container-server.conf-sample</literal></caption>
@ -16,10 +15,10 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>use=egg:swift#container</td><td>No help text available for this option</td> <td>use=egg:swift#container</td><td>Entry point of paste.deploy in the server</td>
</tr> </tr>
<tr> <tr>
<td>set log_name=container-server</td><td>Label used when logging</td> <td>set log_name=container-server</td><td>Label to use when logging</td>
</tr> </tr>
<tr> <tr>
<td>set log_facility=LOG_LOCAL0</td><td>Syslog log facility</td> <td>set log_facility=LOG_LOCAL0</td><td>Syslog log facility</td>
@ -28,7 +27,7 @@
<td>set log_level=INFO</td><td>Log level</td> <td>set log_level=INFO</td><td>Log level</td>
</tr> </tr>
<tr> <tr>
<td>set log_requests=true</td><td>No help text available for this option</td> <td>set log_requests=true</td><td>Whether or not to log requests</td>
</tr> </tr>
<tr> <tr>
<td>set log_address=/dev/log</td><td>No help text available for this option</td> <td>set log_address=/dev/log</td><td>No help text available for this option</td>
@ -40,13 +39,13 @@
<td>conn_timeout=0.5</td><td>Connection timeout to external services</td> <td>conn_timeout=0.5</td><td>Connection timeout to external services</td>
</tr> </tr>
<tr> <tr>
<td>allow_versions=false</td><td>No help text available for this option</td> <td>allow_versions=false</td><td>Enable/Disable object versioning feature </td>
</tr> </tr>
<tr> <tr>
<td>auto_create_account_prefix=.</td><td>Prefix used when automatically creating accounts</td> <td>auto_create_account_prefix=.</td><td>Prefix to use when automatically creating accounts</td>
</tr> </tr>
<tr> <tr>
<td>replication_server=false</td><td>No help text available for this option</td> <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>
</tbody> </tbody>
</table> </table>

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

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically <!-- The tool that generated this table lives in the
generated and your changes will be overwritten. tools directory of this repository. As it was a one-time
The tool to do so lives in the tools directory of this generation, you can edit this file. -->
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0"> <para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <literal>[container-auditor]</literal> in <literal>container-server.conf-sample</literal></caption> <caption>Description of configuration options for <literal>[container-auditor]</literal> in <literal>container-server.conf-sample</literal></caption>
@ -25,7 +24,7 @@
<td>log_level=INFO</td><td>Logging level</td> <td>log_level=INFO</td><td>Logging level</td>
</tr> </tr>
<tr> <tr>
<td>log_address=/dev/log</td><td>No help text available for this option</td> <td>log_address=/dev/log</td><td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>interval=1800</td><td>Minimum time for a pass to take</td> <td>interval=1800</td><td>Minimum time for a pass to take</td>

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

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically <!-- The tool that generated this table lives in the
generated and your changes will be overwritten. tools directory of this repository. As it was a one-time
The tool to do so lives in the tools directory of this generation, you can edit this file. -->
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0"> <para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <literal>[container-replicator]</literal> in <literal>container-server.conf-sample</literal></caption> <caption>Description of configuration options for <literal>[container-replicator]</literal> in <literal>container-server.conf-sample</literal></caption>
@ -25,7 +24,7 @@
<td>log_level=INFO</td><td>Logging level</td> <td>log_level=INFO</td><td>Logging level</td>
</tr> </tr>
<tr> <tr>
<td>log_address=/dev/log</td><td>No help text available for this option</td> <td>log_address=/dev/log</td><td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>vm_test_mode=no</td><td>Indicates that you are using a VM environment</td> <td>vm_test_mode=no</td><td>Indicates that you are using a VM environment</td>

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

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically <!-- The tool that generated this table lives in the
generated and your changes will be overwritten. tools directory of this repository. As it was a one-time
The tool to do so lives in the tools directory of this generation, you can edit this file. -->
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0"> <para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <literal>[container-sync]</literal> in <literal>container-server.conf-sample</literal></caption> <caption>Description of configuration options for <literal>[container-sync]</literal> in <literal>container-server.conf-sample</literal></caption>
@ -25,7 +24,7 @@
<td>log_level=INFO</td><td>Logging level</td> <td>log_level=INFO</td><td>Logging level</td>
</tr> </tr>
<tr> <tr>
<td>log_address=/dev/log</td><td>No help text available for this option</td> <td>log_address=/dev/log</td><td>Location where syslog sends the logs to</td>
</tr> </tr>
<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> <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>

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

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically <!-- The tool that generated this table lives in the
generated and your changes will be overwritten. tools directory of this repository. As it was a one-time
The tool to do so lives in the tools directory of this generation, you can edit this file. -->
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0"> <para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <literal>[container-updater]</literal> in <literal>container-server.conf-sample</literal></caption> <caption>Description of configuration options for <literal>[container-updater]</literal> in <literal>container-server.conf-sample</literal></caption>
@ -25,7 +24,7 @@
<td>log_level=INFO</td><td>Logging level</td> <td>log_level=INFO</td><td>Logging level</td>
</tr> </tr>
<tr> <tr>
<td>log_address=/dev/log</td><td>No help text available for this option</td> <td>log_address=/dev/log</td><td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>interval=300</td><td>Minimum time for a pass to take</td> <td>interval=300</td><td>Minimum time for a pass to take</td>
@ -43,7 +42,8 @@
<td>slowdown=0.01</td><td>Time in seconds to wait between objects</td> <td>slowdown=0.01</td><td>Time in seconds to wait between objects</td>
</tr> </tr>
<tr> <tr>
<td>account_suppression_time=60</td><td>Seconds to suppress updating an account that has generated an</td> <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>
<tr> <tr>
<td>recon_cache_path=/var/cache/swift</td><td>Directory where stats for a few items will be stored</td> <td>recon_cache_path=/var/cache/swift</td><td>Directory where stats for a few items will be stored</td>

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

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

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

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

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

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

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

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

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

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically <!-- The tool that generated this table lives in the
generated and your changes will be overwritten. tools directory of this repository. As it was a one-time
The tool to do so lives in the tools directory of this generation, you can edit this file. -->
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0"> <para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <literal>[drive-audit]</literal> in <literal>drive-audit.conf-sample</literal></caption> <caption>Description of configuration options for <literal>[drive-audit]</literal> in <literal>drive-audit.conf-sample</literal></caption>
@ -25,13 +24,19 @@
<td>log_level=INFO</td><td>Logging level</td> <td>log_level=INFO</td><td>Logging level</td>
</tr> </tr>
<tr> <tr>
<td>log_address=/dev/log</td><td>No help text available for this option</td> <td>log_address=/dev/log</td><td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>minutes=60</td><td>Number of minutes to look back in `/var/log/kern.log`</td> <td>minutes=60</td><td>Number of minutes to look back in `/var/log/kern.log`</td>
</tr> </tr>
<tr> <tr>
<td>error_limit=1</td><td>Number of errors to find before a device is unmounted</td> <td>error_limit=1</td><td>Number of errors to find before a device is unmounted</td>
</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> </tr>
</tbody> </tbody>
</table> </table>

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

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

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

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

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

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

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

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

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

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically <!-- The tool that generated this table lives in the
generated and your changes will be overwritten. tools directory of this repository. As it was a one-time
The tool to do so lives in the tools directory of this generation, you can edit this file. -->
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0"> <para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <literal>[object-expirer]</literal> in <literal>object-expirer.conf-sample</literal></caption> <caption>Description of configuration options for <literal>[object-expirer]</literal> in <literal>object-expirer.conf-sample</literal></caption>
@ -19,7 +18,7 @@
<td>interval=300</td><td>Minimum time for a pass to take</td> <td>interval=300</td><td>Minimum time for a pass to take</td>
</tr> </tr>
<tr> <tr>
<td>auto_create_account_prefix=.</td><td>No help text available for this option</td> <td>auto_create_account_prefix=.</td><td>Prefix to use when automatically creating accounts</td>
</tr> </tr>
<tr> <tr>
<td>report_interval=300</td><td>No help text available for this option</td> <td>report_interval=300</td><td>No help text available for this option</td>
@ -31,7 +30,9 @@
<td>processes=0</td><td>No help text available for this option</td> <td>processes=0</td><td>No help text available for this option</td>
</tr> </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> <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> </tr>
</tbody> </tbody>
</table> </table>

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

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

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

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically <!-- The tool that generated this table lives in the
generated and your changes will be overwritten. tools directory of this repository. As it was a one-time
The tool to do so lives in the tools directory of this generation, you can edit this file. -->
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0"> <para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <literal>[DEFAULT]</literal> in <literal>object-server.conf-sample</literal></caption> <caption>Description of configuration options for <literal>[DEFAULT]</literal> in <literal>object-server.conf-sample</literal></caption>
@ -27,9 +26,6 @@
<tr> <tr>
<td>backlog=4096</td><td>Maximum number of allowed pending TCP connections</td> <td>backlog=4096</td><td>Maximum number of allowed pending TCP connections</td>
</tr> </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> <td>user=swift</td><td>User to run as</td>
</tr> </tr>
@ -47,6 +43,19 @@
</tr> </tr>
<tr> <tr>
<td>expiring_objects_container_divisor=86400</td><td>No help text available for this option</td> <td>expiring_objects_container_divisor=86400</td><td>No help text available for this option</td>
</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>
<tr> <tr>
<td>log_name=swift</td><td>Label used when logging</td> <td>log_name=swift</td><td>Label used when logging</td>
@ -58,31 +67,34 @@
<td>log_level=INFO</td><td>Logging level</td> <td>log_level=INFO</td><td>Logging level</td>
</tr> </tr>
<tr> <tr>
<td>log_address=/dev/log</td><td>No help text available for this option</td> <td>log_address=/dev/log</td><td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>log_custom_handlers=</td><td>Comma-separated list of functions to call to setup custom log handlers.</td> <td>log_custom_handlers=</td><td>Comma-separated list of functions to call to setup custom log handlers.</td>
</tr> </tr>
<tr> <tr>
<td>log_udp_host=</td><td>No help text available for this option</td> <td>log_udp_host=</td><td>If not set, the UDB receiver for syslog is disabled.</td>
</tr> </tr>
<tr> <tr>
<td>log_udp_port=514</td><td>No help text available for this option</td> <td>log_udp_port=514</td><td>Port value for UDB receiver, if enabled.</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_host=localhost</td><td>No help text available for this option</td> <td>log_statsd_host=localhost</td><td>If not set, the StatsD feature is disabled.</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_port=8125</td><td>No help text available for this option</td> <td>log_statsd_port=8125</td><td>Port value for the StatsD server.</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_default_sample_rate=1.0</td><td>No help text available for this option</td> <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>
<tr> <tr>
<td>log_statsd_sample_rate_factor=1.0</td><td>No help text available for this option</td> <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>
<tr> <tr>
<td>log_statsd_metric_prefix=</td><td>No help text available for this option</td> <td>log_statsd_metric_prefix=</td><td>Value will be prepended to every metric sent to the StatsD server.</td>
</tr> </tr>
<tr> <tr>
<td>eventlet_debug=false</td><td>If true, turn on debug logging for eventlet</td> <td>eventlet_debug=false</td><td>If true, turn on debug logging for eventlet</td>

14
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"?> <?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically <!-- The tool that generated this table lives in the
generated and your changes will be overwritten. tools directory of this repository. As it was a one-time
The tool to do so lives in the tools directory of this generation, you can edit this file. -->
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0"> <para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <literal>[app:object-server]</literal> in <literal>object-server.conf-sample</literal></caption> <caption>Description of configuration options for <literal>[app:object-server]</literal> in <literal>object-server.conf-sample</literal></caption>
@ -19,7 +18,7 @@
<td>use=egg:swift#object</td><td>Entry point of paste.deploy in the server</td> <td>use=egg:swift#object</td><td>Entry point of paste.deploy in the server</td>
</tr> </tr>
<tr> <tr>
<td>set log_name=object-server</td><td>Label used when logging</td> <td>set log_name=object-server</td><td>Label to use when logging</td>
</tr> </tr>
<tr> <tr>
<td>set log_facility=LOG_LOCAL0</td><td>Syslog log facility</td> <td>set log_facility=LOG_LOCAL0</td><td>Syslog log facility</td>
@ -64,10 +63,7 @@
<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> <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> <tr>
<td>auto_create_account_prefix=.</td><td>Prefix used when automatically creating accounts</td> <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>
<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> <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>

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

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

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

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

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

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically <!-- The tool that generated this table lives in the
generated and your changes will be overwritten. tools directory of this repository. As it was a one-time
The tool to do so lives in the tools directory of this generation, you can edit this file. -->
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0"> <para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <literal>[object-auditor]</literal> in <literal>object-server.conf-sample</literal></caption> <caption>Description of configuration options for <literal>[object-auditor]</literal> in <literal>object-server.conf-sample</literal></caption>
@ -25,7 +24,7 @@
<td>log_level=INFO</td><td>Logging level</td> <td>log_level=INFO</td><td>Logging level</td>
</tr> </tr>
<tr> <tr>
<td>log_address=/dev/log</td><td>No help text available for this option</td> <td>log_address=/dev/log</td><td>Location where syslog sends the logs to</td>
</tr> </tr>
<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> <td>files_per_second=20</td><td>Maximum files audited per second. Should be tuned according to individual system specs. 0 is unlimited.</td>
@ -40,7 +39,7 @@
<td>zero_byte_files_per_second=50</td><td>Maximum zero byte files audited per second.</td> <td>zero_byte_files_per_second=50</td><td>Maximum zero byte files audited per second.</td>
</tr> </tr>
<tr> <tr>
<td>recon_cache_path=/var/cache/swift</td><td>No help text available for this option</td> <td>recon_cache_path=/var/cache/swift</td><td>Directory where stats for a few items will be stored</td>
</tr> </tr>
<tr> <tr>
<td>object_size_stats=</td><td>No help text available for this option</td> <td>object_size_stats=</td><td>No help text available for this option</td>

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

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically <!-- The tool that generated this table lives in the
generated and your changes will be overwritten. tools directory of this repository. As it was a one-time
The tool to do so lives in the tools directory of this generation, you can edit this file. -->
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0"> <para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <literal>[object-replicator]</literal> in <literal>object-server.conf-sample</literal></caption> <caption>Description of configuration options for <literal>[object-replicator]</literal> in <literal>object-server.conf-sample</literal></caption>
@ -25,7 +24,7 @@
<td>log_level=INFO</td><td>Logging level</td> <td>log_level=INFO</td><td>Logging level</td>
</tr> </tr>
<tr> <tr>
<td>log_address=/dev/log</td><td>No help text available for this option</td> <td>log_address=/dev/log</td><td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>vm_test_mode=no</td><td>Indicates that you are using a VM environment</td> <td>vm_test_mode=no</td><td>Indicates that you are using a VM environment</td>
@ -65,6 +64,9 @@
</tr> </tr>
<tr> <tr>
<td>recon_cache_path=/var/cache/swift</td><td>Directory where stats for a few items will be stored</td> <td>recon_cache_path=/var/cache/swift</td><td>Directory where stats for a few items will be stored</td>
</tr>
<tr>
<td>rsync_error_log_line_length=0</td><td>No help text available for this option</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>

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

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically <!-- The tool that generated this table lives in the
generated and your changes will be overwritten. tools directory of this repository. As it was a one-time
The tool to do so lives in the tools directory of this generation, you can edit this file. -->
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0"> <para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <literal>[object-updater]</literal> in <literal>object-server.conf-sample</literal></caption> <caption>Description of configuration options for <literal>[object-updater]</literal> in <literal>object-server.conf-sample</literal></caption>
@ -25,7 +24,7 @@
<td>log_level=INFO</td><td>Logging level</td> <td>log_level=INFO</td><td>Logging level</td>
</tr> </tr>
<tr> <tr>
<td>log_address=/dev/log</td><td>No help text available for this option</td> <td>log_address=/dev/log</td><td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>interval=300</td><td>Minimum time for a pass to take</td> <td>interval=300</td><td>Minimum time for a pass to take</td>

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

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

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

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically <!-- The tool that generated this table lives in the
generated and your changes will be overwritten. tools directory of this repository. As it was a one-time
The tool to do so lives in the tools directory of this generation, you can edit this file. -->
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0"> <para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <literal>[DEFAULT]</literal> in <literal>proxy-server.conf-sample</literal></caption> <caption>Description of configuration options for <literal>[DEFAULT]</literal> in <literal>proxy-server.conf-sample</literal></caption>
@ -31,10 +30,20 @@
<td>swift_dir=/etc/swift</td><td>Swift configuration directory</td> <td>swift_dir=/etc/swift</td><td>Swift configuration directory</td>
</tr> </tr>
<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> <td>user=swift</td><td>User to run as</td>
</tr> </tr>
<tr> <tr>
<td>user=swift</td><td>User to run as</td> <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>
<tr> <tr>
<td>cert_file=/etc/swift/proxy.crt</td><td>to the ssl .crt. This should be enabled for testing purposes only.</td> <td>cert_file=/etc/swift/proxy.crt</td><td>to the ssl .crt. This should be enabled for testing purposes only.</td>
@ -58,7 +67,7 @@
<td>log_headers=false</td><td>No help text available for this option</td> <td>log_headers=false</td><td>No help text available for this option</td>
</tr> </tr>
<tr> <tr>
<td>log_address=/dev/log</td><td>No help text available for this option</td> <td>log_address=/dev/log</td><td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>trans_id_suffix=</td><td>No help text available for this option</td> <td>trans_id_suffix=</td><td>No help text available for this option</td>
@ -67,25 +76,28 @@
<td>log_custom_handlers=</td><td>Comma-separated list of functions to call to setup custom log handlers.</td> <td>log_custom_handlers=</td><td>Comma-separated list of functions to call to setup custom log handlers.</td>
</tr> </tr>
<tr> <tr>
<td>log_udp_host=</td><td>No help text available for this option</td> <td>log_udp_host=</td><td>If not set, the UDB receiver for syslog is disabled.</td>
</tr> </tr>
<tr> <tr>
<td>log_udp_port=514</td><td>No help text available for this option</td> <td>log_udp_port=514</td><td>Port value for UDB receiver, if enabled.</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_host=localhost</td><td>No help text available for this option</td> <td>log_statsd_host=localhost</td><td>If not set, the StatsD feature is disabled.</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_port=8125</td><td>No help text available for this option</td> <td>log_statsd_port=8125</td><td>Port value for the StatsD server.</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_default_sample_rate=1.0</td><td>No help text available for this option</td> <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>
<tr> <tr>
<td>log_statsd_sample_rate_factor=1.0</td><td>No help text available for this option</td> <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>
<tr> <tr>
<td>log_statsd_metric_prefix=</td><td>No help text available for this option</td> <td>log_statsd_metric_prefix=</td><td>Value will be prepended to every metric sent to the StatsD server.</td>
</tr> </tr>
<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> <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>
@ -96,9 +108,6 @@
<tr> <tr>
<td>eventlet_debug=false</td><td>If true, turn on debug logging for eventlet</td> <td>eventlet_debug=false</td><td>If true, turn on debug logging for eventlet</td>
</tr> </tr>
<tr>
<td>max_clients=1024</td><td>Maximum number of clients one worker can process simultaneously (it will actually</td>
</tr>
</tbody> </tbody>
</table> </table>
</para> </para>

14
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"?> <?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically <!-- The tool that generated this table lives in the
generated and your changes will be overwritten. tools directory of this repository. As it was a one-time
The tool to do so lives in the tools directory of this generation, you can edit this file. -->
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0"> <para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <literal>[app:proxy-server]</literal> in <literal>proxy-server.conf-sample</literal></caption> <caption>Description of configuration options for <literal>[app:proxy-server]</literal> in <literal>proxy-server.conf-sample</literal></caption>
@ -16,7 +15,7 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>use=egg:swift#proxy</td><td>No help text available for this option</td> <td>use=egg:swift#proxy</td><td>Entry point of paste.deploy in the server</td>
</tr> </tr>
<tr> <tr>
<td>set log_name=proxy-server</td><td>Label to use when logging</td> <td>set log_name=proxy-server</td><td>Label to use when logging</td>
@ -100,7 +99,7 @@
<td>max_large_object_get_time=86400</td><td>No help text available for this option</td> <td>max_large_object_get_time=86400</td><td>No help text available for this option</td>
</tr> </tr>
<tr> <tr>
<td>request_node_count=2 * replicas</td><td>No help text available for this option</td> <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>
<tr> <tr>
<td>read_affinity=r1z1=100, r1z2=200, r2=300</td><td>No help text available for this option</td> <td>read_affinity=r1z1=100, r1z2=200, r2=300</td><td>No help text available for this option</td>
@ -116,6 +115,9 @@
</tr> </tr>
<tr> <tr>
<td>write_affinity_node_count=2 * replicas</td><td>No help text available for this option</td> <td>write_affinity_node_count=2 * replicas</td><td>No help text available for this option</td>
</tr>
<tr>
<td>swift_owner_headers=x-container-read, x-container-write, x-container-sync-key, x-container-sync-to, x-account-meta-temp-url-key, x-account-meta-temp-url-key-2</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> </tr>
</tbody> </tbody>
</table> </table>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@ -1,8 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically <!-- The tool that generated this table lives in the
generated and your changes will be overwritten. tools directory of this repository. As it was a one-time
The tool to do so lives in the tools directory of this generation, you can edit this file. -->
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0"> <para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <literal>[filter:ratelimit]</literal> in <literal>proxy-server.conf-sample</literal></caption> <caption>Description of configuration options for <literal>[filter:ratelimit]</literal> in <literal>proxy-server.conf-sample</literal></caption>
@ -16,43 +15,43 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>use=egg:swift#ratelimit</td><td>No help text available for this option</td> <td>use=egg:swift#ratelimit</td><td>Entry point of paste.deploy in the server</td>
</tr> </tr>
<tr> <tr>
<td>set log_name=ratelimit</td><td>No help text available for this option</td> <td>set log_name=ratelimit</td><td>Label to use when logging</td>
</tr> </tr>
<tr> <tr>
<td>set log_facility=LOG_LOCAL0</td><td>No help text available for this option</td> <td>set log_facility=LOG_LOCAL0</td><td>Syslog log facility</td>
</tr> </tr>
<tr> <tr>
<td>set log_level=INFO</td><td>No help text available for this option</td> <td>set log_level=INFO</td><td>Log level</td>
</tr> </tr>
<tr> <tr>
<td>set log_headers=false</td><td>No help text available for this option</td> <td>set log_headers=false</td><td>If True, log headers in each request</td>
</tr> </tr>
<tr> <tr>
<td>set log_address=/dev/log</td><td>No help text available for this option</td> <td>set log_address=/dev/log</td><td>No help text available for this option</td>
</tr> </tr>
<tr> <tr>
<td>clock_accuracy=1000</td><td>No help text available for this option</td> <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>
<tr> <tr>
<td>max_sleep_time_seconds=60</td><td>No help text available for this option</td> <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>
<tr> <tr>
<td>log_sleep_time_seconds=0</td><td>No help text available for this option</td> <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>
<tr> <tr>
<td>rate_buffer_seconds=5</td><td>No help text available for this option</td> <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>
<tr> <tr>
<td>account_ratelimit=0</td><td>No help text available for this option</td> <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>
<tr> <tr>
<td>account_whitelist=a,b</td><td>No help text available for this option</td> <td>account_whitelist=a,b</td><td>Comma separated lists of account names that will not be rate limited.</td>
</tr> </tr>
<tr> <tr>
<td>account_blacklist=c,d</td><td>No help text available for this option</td> <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>
<tr> <tr>
<td>with container_limit_x=r</td><td>No help text available for this option</td> <td>with container_limit_x=r</td><td>No help text available for this option</td>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

93
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 # and generally only having a single entry
# after the equals (the default value) # after the equals (the default value)
def parse_line(line): def parse_line(line):
""" """
takes a line from a swift sample configuration file and attempts takes a line from a swift sample configuration file and attempts
@ -32,22 +33,29 @@ def parse_line(line):
return None return None
return config, default.strip() 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 parses an existing XML table to compile a list of existing options
""" """
options = [] options = {}
for optfile in optfiles:
xmldoc = minidom.parse(optfile) xmldoc = minidom.parse(optfile)
tdlist = xmldoc.getElementsByTagName('td') tbody = xmldoc.getElementsByTagName('tbody')[0]
for td in tdlist: trlist = tbody.getElementsByTagName('tr')
for tr in trlist:
try: try:
tdvalue = td.childNodes[0].nodeValue optentry = tr.childNodes[1].childNodes[0]
option, default = optentry.nodeValue.split('=', 1)
helptext = tr.childNodes[2].childNodes[0].nodeValue
except IndexError: except IndexError:
continue continue
if '=' in tdvalue and ' ' not in tdvalue: if option not in options or 'No help text' in options[option]:
options.append(tdvalue.split('=',1)[0]) #options[option.split('=',1)[0]] = helptext
options[option] = helptext
return options return options
def extract_descriptions_from_devref(repo, options): def extract_descriptions_from_devref(repo, options):
""" """
loop through the devref RST files, looking for lines formatted loop through the devref RST files, looking for lines formatted
@ -68,7 +76,8 @@ def extract_descriptions_from_devref(repo, options):
in_option_block = False in_option_block = False
continue continue
if line[0] == ' ' and prev_option is not None: 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: for option in options:
line_parts = line.strip().split(None, 2) line_parts = line.strip().split(None, 2)
if (' ' in line and len(line_parts) == 3 if (' ' in line and len(line_parts) == 3
@ -80,17 +89,18 @@ def extract_descriptions_from_devref(repo, options):
prev_option = option prev_option = option
return option_descs return option_descs
def new_section_file(sample, current_section): def new_section_file(sample, current_section):
section_filename = ('swift-' + section_filename = ('swift-' +
path.basename(sample).split('.conf')[0] path.basename(sample).split('.conf')[0]
+ '-' + current_section.replace('[','').replace(']','').replace(':','-') + '-'
+ current_section.replace('[', '').replace(']', '').replace(':', '-')
+ '.xml') + '.xml')
section_file = open(section_filename, 'w') section_file = open(section_filename, 'w')
section_file.write('<?xml version="1.0" encoding="UTF-8"?>\n\ section_file.write('<?xml version="1.0" encoding="UTF-8"?>\n\
<!-- Warning: Do not edit this file. It is automatically\n\ <!-- The tool that generated this table lives in the\n\
generated and your changes will be overwritten.\n\ tools directory of this repository. As it was a one-time\n\
The tool to do so lives in the tools directory of this\n\ generation, you can edit this file. -->\n\
repository -->\n\
<para xmlns="http://docbook.org/ns/docbook" version="5.0">\n\ <para xmlns="http://docbook.org/ns/docbook" version="5.0">\n\
<table rules="all">\n\ <table rules="all">\n\
<caption>Description of configuration options for <literal>' <caption>Description of configuration options for <literal>'
@ -107,11 +117,18 @@ def new_section_file(sample, current_section):
<tbody>') <tbody>')
return section_file 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') existing_tables = glob.glob('../../doc/src/docbkx/common/tables/swift*xml')
options = [] options = {}
for table in existing_tables: #use the existing tables to get a list of option names
options.extend(get_existing_options(table)) options = get_existing_options(existing_tables)
option_descs = extract_descriptions_from_devref(repo, options) 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: for sample in conf_samples:
@ -120,7 +137,10 @@ def create_new_tables(repo, vebose, existing_options=None):
sample_file = open(sample, 'r') sample_file = open(sample, 'r')
for line in sample_file: for line in sample_file:
if '[' in line and ']\n' in line and '=' not in line: 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 current_section != line.strip('#').strip():
if section_file is not None: if section_file is not None:
section_file.write('\n </tbody>\n\ section_file.write('\n </tbody>\n\
@ -130,43 +150,42 @@ def create_new_tables(repo, vebose, existing_options=None):
current_section = line.strip('#').strip() current_section = line.strip('#').strip()
section_file = new_section_file(sample, current_section) section_file = new_section_file(sample, current_section)
elif section_file is not None: 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) parsed_line = parse_line(line)
if parsed_line is not None: if parsed_line is not None:
if parsed_line[0] in option_descs: if (parsed_line[0] in options.keys()
option_desc = option_descs[parsed_line[0]] 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: else:
option_desc = 'No help text available for this option' option_desc = 'No help text available for this option'
#if (existing_options is not None if verbose > 0:
# and parsed_line[0] not in existing_options): print parsed_line[0] + "has no help text"
# print "New Option: " + parsed_line[0]
#elif existing_options is not None:
# existing_options.remove(parsed_line[0])
section_file.write('\n <tr>\n\ section_file.write('\n <tr>\n\
<td>' + parsed_line[0] + '=' + escape(str(parsed_line[1])) + <td>' + parsed_line[0] + '=' +
'</td><td>'+ option_desc + '</td>\n' + ' </tr>') escape(str(parsed_line[1])) +
'</td><td>' + option_desc + '</td>\n' +
' </tr>')
if section_file is not None: if section_file is not None:
section_file.write('\n </tbody>\n\ section_file.write('\n </tbody>\n\
</table>\n\ </table>\n\
</para>') </para>')
section_file.close() section_file.close()
#print "Removed: " + str(existing_options)
def main(repo, verbose=0): def main(repo, verbose=0):
""" """
writes a set of docbook-formatted files, based on configuration sections writes a set of docbook-formatted files, based on configuration sections
in swift sample configuration files 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) 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)
if __name__ == "__main__": if __name__ == "__main__":
main(sys.argv[1]) main(sys.argv[1])