openstack/openstack-manuals
Code Issues Proposed changes

Update Swift configuration tables

Browse Source 
Change-Id: Ib57f5db125421e317c7d0cf0c14ec744b4066a46
This commit is contained in:
Christian Berendt 2015-03-02 13:05:49 +01:00
parent bf1b27a30c
commit 2cc66311cb
81 changed files with 767 additions and 723 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
doc/common/tables/swift-account-server-DEFAULT.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[DEFAULT]</literal> in <literal>account-server.conf</literal> <literal>[DEFAULT]</literal> in <filename>account-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,98 +17,98 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>backlog = 4096</td> <td><option>backlog</option> = <replaceable>4096</replaceable></td>
<td>Maximum number of allowed pending TCP connections</td> <td>Maximum number of allowed pending TCP connections</td>
</tr> </tr>
<tr> <tr>
<td>bind_ip = 0.0.0.0</td> <td><option>bind_ip</option> = <replaceable>0.0.0.0</replaceable></td>
<td>IP Address for server to bind to</td> <td>IP Address for server to bind to</td>
</tr> </tr>
<tr> <tr>
<td>bind_port = 6002</td> <td><option>bind_port</option> = <replaceable>6002</replaceable></td>
<td>Port for server to bind to</td> <td>Port for server to bind to</td>
</tr> </tr>
<tr> <tr>
<td>bind_timeout = 30</td> <td><option>bind_timeout</option> = <replaceable>30</replaceable></td>
<td>Seconds to attempt bind before giving up</td> <td>Seconds to attempt bind before giving up</td>
</tr> </tr>
<tr> <tr>
<td>db_preallocation = off</td> <td><option>db_preallocation</option> = <replaceable>off</replaceable></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>If you don't mind the extra disk space usage in overhead, you can turn this on to preallocate disk space with SQLite databases to decrease fragmentation. underlying filesystem does not support it. to setup custom log handlers. bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#account`. replication passes account can be reclaimed</td>
</tr> </tr>
<tr> <tr>
<td>devices = /srv/node</td> <td><option>devices</option> = <replaceable>/srv/node</replaceable></td>
<td>Parent directory of where devices are mounted</td> <td>Parent directory of where devices are mounted</td>
</tr> </tr>
<tr> <tr>
<td>disable_fallocate = false</td> <td><option>disable_fallocate</option> = <replaceable>false</replaceable></td>
<td>Disable "fast fail" fallocate checks if the underlying filesystem does not support it.</td> <td>Disable "fast fail" fallocate checks if the underlying filesystem does not support it.</td>
</tr> </tr>
<tr> <tr>
<td>eventlet_debug = false</td> <td><option>eventlet_debug</option> = <replaceable>false</replaceable></td>
<td>If true, turn on debug logging for eventlet</td> <td>If true, turn on debug logging for eventlet</td>
</tr> </tr>
<tr> <tr>
<td>fallocate_reserve = 0</td> <td><option>fallocate_reserve</option> = <replaceable>0</replaceable></td>
<td>You can set fallocate_reserve to the number of bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#object`.</td> <td>You can set fallocate_reserve to the number of bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#object`.</td>
</tr> </tr>
<tr> <tr>
<td>log_address = /dev/log</td> <td><option>log_address</option> = <replaceable>/dev/log</replaceable></td>
<td>Location where syslog sends the logs to</td> <td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>log_custom_handlers = </td> <td><option>log_custom_handlers</option> = <replaceable></replaceable></td>
<td>Comma-separated list of functions to call to setup custom log handlers.</td> <td>Comma-separated list of functions to call to setup custom log handlers.</td>
</tr> </tr>
<tr> <tr>
<td>log_facility = LOG_LOCAL0</td> <td><option>log_facility</option> = <replaceable>LOG_LOCAL0</replaceable></td>
<td>Syslog log facility</td> <td>Syslog log facility</td>
</tr> </tr>
<tr> <tr>
<td>log_level = INFO</td> <td><option>log_level</option> = <replaceable>INFO</replaceable></td>
<td>Logging level</td> <td>Logging level</td>
</tr> </tr>
<tr> <tr>
<td>log_max_line_length = 0</td> <td><option>log_max_line_length</option> = <replaceable>0</replaceable></td>
<td>Caps the length of log lines to the value given; no limit if set to 0, the default.</td> <td>Caps the length of log lines to the value given; no limit if set to 0, the default.</td>
</tr> </tr>
<tr> <tr>
<td>log_name = swift</td> <td><option>log_name</option> = <replaceable>swift</replaceable></td>
<td>Label used when logging</td> <td>Label used when logging</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_default_sample_rate = 1.0</td> <td><option>log_statsd_default_sample_rate</option> = <replaceable>1.0</replaceable></td>
<td>Defines the probability of sending a sample for any given event or <td>Defines the probability of sending a sample for any given event or
timing measurement.</td> timing measurement.</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_host = localhost</td> <td><option>log_statsd_host</option> = <replaceable>localhost</replaceable></td>
<td>If not set, the StatsD feature is disabled.</td> <td>If not set, the StatsD feature is disabled.</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_metric_prefix = </td> <td><option>log_statsd_metric_prefix</option> = <replaceable></replaceable></td>
<td>Value will be prepended to every metric sent to the StatsD server.</td> <td>Value will be prepended to every metric sent to the StatsD server.</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_port = 8125</td> <td><option>log_statsd_port</option> = <replaceable>8125</replaceable></td>
<td>Port value for the StatsD server.</td> <td>Port value for the StatsD server.</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_sample_rate_factor = 1.0</td> <td><option>log_statsd_sample_rate_factor</option> = <replaceable>1.0</replaceable></td>
<td>Not recommended to set this to a value less than 1.0, if frequency <td>Not recommended to set this to a value less than 1.0, if frequency
of logging is too high, tune the of logging is too high, tune the
log_statsd_default_sample_rate instead.</td> log_statsd_default_sample_rate instead.</td>
</tr> </tr>
<tr> <tr>
<td>log_udp_host = </td> <td><option>log_udp_host</option> = <replaceable></replaceable></td>
<td>If not set, the UDP receiver for syslog is disabled.</td> <td>If not set, the UDP receiver for syslog is disabled.</td>
</tr> </tr>
<tr> <tr>
<td>log_udp_port = 514</td> <td><option>log_udp_port</option> = <replaceable>514</replaceable></td>
<td>Port value for UDP receiver, if enabled.</td> <td>Port value for UDP receiver, if enabled.</td>
</tr> </tr>
<tr> <tr>
<td>max_clients = 1024</td> <td><option>max_clients</option> = <replaceable>1024</replaceable></td>
<td>Maximum number of clients one worker can process simultaneously <td>Maximum number of clients one worker can process simultaneously
Lowering the number of clients handled per worker, and raising the Lowering the number of clients handled per worker, and raising the
number of workers can lessen the impact that a CPU intensive, or number of workers can lessen the impact that a CPU intensive, or
@ -119,19 +119,19 @@ other workers a chance to process it.
</td> </td>
</tr> </tr>
<tr> <tr>
<td>mount_check = true</td> <td><option>mount_check</option> = <replaceable>true</replaceable></td>
<td>Whether or not check if the devices are mounted to prevent accidentally writing to the root device</td> <td>Whether or not check if the devices are mounted to prevent accidentally writing to the root device</td>
</tr> </tr>
<tr> <tr>
<td>swift_dir = /etc/swift</td> <td><option>swift_dir</option> = <replaceable>/etc/swift</replaceable></td>
<td>Swift configuration directory</td> <td>Swift configuration directory</td>
</tr> </tr>
<tr> <tr>
<td>user = swift</td> <td><option>user</option> = <replaceable>swift</replaceable></td>
<td>User to run as</td> <td>User to run as</td>
</tr> </tr>
<tr> <tr>
<td>workers = auto</td> <td><option>workers</option> = <replaceable>auto</replaceable></td>
<td>a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.</td> <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>
</tbody> </tbody>

16
doc/common/tables/swift-account-server-account-auditor.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[account-auditor]</literal> in <literal>account-server.conf</literal> <literal>[account-auditor]</literal> in <filename>account-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,31 +17,31 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>accounts_per_second = 200</td> <td><option>accounts_per_second</option> = <replaceable>200</replaceable></td>
<td>Maximum accounts audited per second. Should be tuned according to individual system specs. 0 is unlimited.</td> <td>Maximum accounts audited per second. Should be tuned according to individual system specs. 0 is unlimited.</td>
</tr> </tr>
<tr> <tr>
<td>interval = 1800</td> <td><option>interval</option> = <replaceable>1800</replaceable></td>
<td>Minimum time for a pass to take</td> <td>Minimum time for a pass to take</td>
</tr> </tr>
<tr> <tr>
<td>log_address = /dev/log</td> <td><option>log_address</option> = <replaceable>/dev/log</replaceable></td>
<td>Location where syslog sends the logs to</td> <td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>log_facility = LOG_LOCAL0</td> <td><option>log_facility</option> = <replaceable>LOG_LOCAL0</replaceable></td>
<td>Syslog log facility</td> <td>Syslog log facility</td>
</tr> </tr>
<tr> <tr>
<td>log_level = INFO</td> <td><option>log_level</option> = <replaceable>INFO</replaceable></td>
<td>Logging level</td> <td>Logging level</td>
</tr> </tr>
<tr> <tr>
<td>log_name = account-auditor</td> <td><option>log_name</option> = <replaceable>account-auditor</replaceable></td>
<td>Label used when logging</td> <td>Label used when logging</td>
</tr> </tr>
<tr> <tr>
<td>recon_cache_path = /var/cache/swift</td> <td><option>recon_cache_path</option> = <replaceable>/var/cache/swift</replaceable></td>
<td>Directory where stats for a few items will be stored</td> <td>Directory where stats for a few items will be stored</td>
</tr> </tr>
</tbody> </tbody>

22
doc/common/tables/swift-account-server-account-reaper.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[account-reaper]</literal> in <literal>account-server.conf</literal> <literal>[account-reaper]</literal> in <filename>account-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,43 +17,43 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>concurrency = 25</td> <td><option>concurrency</option> = <replaceable>25</replaceable></td>
<td>Number of replication workers to spawn</td> <td>Number of replication workers to spawn</td>
</tr> </tr>
<tr> <tr>
<td>conn_timeout = 0.5</td> <td><option>conn_timeout</option> = <replaceable>0.5</replaceable></td>
<td>Connection timeout to external services</td> <td>Connection timeout to external services</td>
</tr> </tr>
<tr> <tr>
<td>delay_reaping = 0</td> <td><option>delay_reaping</option> = <replaceable>0</replaceable></td>
<td>Normally, the reaper begins deleting account information for deleted accounts immediately; you can set this to delay its work however. The value is in seconds, 2592000 = 30 days, for example. bind to giving up worker can process simultaneously (it will actually accept(2) N + 1). Setting this to one (1) will only handle one request at a time, without accepting another request concurrently. By increasing the number of workers to a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.</td> <td>Normally, the reaper begins deleting account information for deleted accounts immediately; you can set this to delay its work however. The value is in seconds, 2592000 = 30 days, for example. bind to giving up worker can process simultaneously (it will actually accept(2) N + 1). Setting this to one (1) will only handle one request at a time, without accepting another request concurrently. By increasing the number of workers to a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.</td>
</tr> </tr>
<tr> <tr>
<td>interval = 3600</td> <td><option>interval</option> = <replaceable>3600</replaceable></td>
<td>Minimum time for a pass to take</td> <td>Minimum time for a pass to take</td>
</tr> </tr>
<tr> <tr>
<td>log_address = /dev/log</td> <td><option>log_address</option> = <replaceable>/dev/log</replaceable></td>
<td>Location where syslog sends the logs to</td> <td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>log_facility = LOG_LOCAL0</td> <td><option>log_facility</option> = <replaceable>LOG_LOCAL0</replaceable></td>
<td>Syslog log facility</td> <td>Syslog log facility</td>
</tr> </tr>
<tr> <tr>
<td>log_level = INFO</td> <td><option>log_level</option> = <replaceable>INFO</replaceable></td>
<td>Logging level</td> <td>Logging level</td>
</tr> </tr>
<tr> <tr>
<td>log_name = account-reaper</td> <td><option>log_name</option> = <replaceable>account-reaper</replaceable></td>
<td>Label used when logging</td> <td>Label used when logging</td>
</tr> </tr>
<tr> <tr>
<td>node_timeout = 10</td> <td><option>node_timeout</option> = <replaceable>10</replaceable></td>
<td>Request timeout to external services</td> <td>Request timeout to external services</td>
</tr> </tr>
<tr> <tr>
<td>reap_warn_after = 2592000</td> <td><option>reap_warn_after</option> = <replaceable>2592000</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
</tbody> </tbody>

34
doc/common/tables/swift-account-server-account-replicator.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[account-replicator]</literal> in <literal>account-server.conf</literal> <literal>[account-replicator]</literal> in <filename>account-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,67 +17,67 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>concurrency = 8</td> <td><option>concurrency</option> = <replaceable>8</replaceable></td>
<td>Number of replication workers to spawn</td> <td>Number of replication workers to spawn</td>
</tr> </tr>
<tr> <tr>
<td>conn_timeout = 0.5</td> <td><option>conn_timeout</option> = <replaceable>0.5</replaceable></td>
<td>Connection timeout to external services</td> <td>Connection timeout to external services</td>
</tr> </tr>
<tr> <tr>
<td>error_suppression_interval = 60</td> <td><option>error_suppression_interval</option> = <replaceable>60</replaceable></td>
<td>Time in seconds that must elapse since the last error for a node to be considered no longer error limited</td> <td>Time in seconds that must elapse since the last error for a node to be considered no longer error limited</td>
</tr> </tr>
<tr> <tr>
<td>error_suppression_limit = 10</td> <td><option>error_suppression_limit</option> = <replaceable>10</replaceable></td>
<td>Error count to consider a node error limited</td> <td>Error count to consider a node error limited</td>
</tr> </tr>
<tr> <tr>
<td>interval = 30</td> <td><option>interval</option> = <replaceable>30</replaceable></td>
<td>Minimum time for a pass to take</td> <td>Minimum time for a pass to take</td>
</tr> </tr>
<tr> <tr>
<td>log_address = /dev/log</td> <td><option>log_address</option> = <replaceable>/dev/log</replaceable></td>
<td>Location where syslog sends the logs to</td> <td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>log_facility = LOG_LOCAL0</td> <td><option>log_facility</option> = <replaceable>LOG_LOCAL0</replaceable></td>
<td>Syslog log facility</td> <td>Syslog log facility</td>
</tr> </tr>
<tr> <tr>
<td>log_level = INFO</td> <td><option>log_level</option> = <replaceable>INFO</replaceable></td>
<td>Logging level</td> <td>Logging level</td>
</tr> </tr>
<tr> <tr>
<td>log_name = account-replicator</td> <td><option>log_name</option> = <replaceable>account-replicator</replaceable></td>
<td>Label used when logging</td> <td>Label used when logging</td>
</tr> </tr>
<tr> <tr>
<td>max_diffs = 100</td> <td><option>max_diffs</option> = <replaceable>100</replaceable></td>
<td>Caps how long the replicator spends trying to sync a database per pass</td> <td>Caps how long the replicator spends trying to sync a database per pass</td>
</tr> </tr>
<tr> <tr>
<td>node_timeout = 10</td> <td><option>node_timeout</option> = <replaceable>10</replaceable></td>
<td>Request timeout to external services</td> <td>Request timeout to external services</td>
</tr> </tr>
<tr> <tr>
<td>per_diff = 1000</td> <td><option>per_diff</option> = <replaceable>1000</replaceable></td>
<td>Limit number of items to get per diff</td> <td>Limit number of items to get per diff</td>
</tr> </tr>
<tr> <tr>
<td>reclaim_age = 604800</td> <td><option>reclaim_age</option> = <replaceable>604800</replaceable></td>
<td>Time elapsed in seconds before an object can be reclaimed</td> <td>Time elapsed in seconds before an object can be reclaimed</td>
</tr> </tr>
<tr> <tr>
<td>recon_cache_path = /var/cache/swift</td> <td><option>recon_cache_path</option> = <replaceable>/var/cache/swift</replaceable></td>
<td>Directory where stats for a few items will be stored</td> <td>Directory where stats for a few items will be stored</td>
</tr> </tr>
<tr> <tr>
<td>run_pause = 30</td> <td><option>run_pause</option> = <replaceable>30</replaceable></td>
<td>Time in seconds to wait between replication passes</td> <td>Time in seconds to wait between replication passes</td>
</tr> </tr>
<tr> <tr>
<td>vm_test_mode = no</td> <td><option>vm_test_mode</option> = <replaceable>no</replaceable></td>
<td>Indicates that you are using a VM environment</td> <td>Indicates that you are using a VM environment</td>
</tr> </tr>
</tbody> </tbody>

18
doc/common/tables/swift-account-server-app-account-server.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[app-account-server]</literal> in <literal>account-server.conf</literal> <literal>[app-account-server]</literal> in <filename>account-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,35 +17,35 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>auto_create_account_prefix = .</td> <td><option>auto_create_account_prefix</option> = <replaceable>.</replaceable></td>
<td>Prefix to use when automatically creating accounts</td> <td>Prefix to use when automatically creating accounts</td>
</tr> </tr>
<tr> <tr>
<td>replication_server = false</td> <td><option>replication_server</option> = <replaceable>false</replaceable></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>If defined, tells server how to handle replication verbs in requests. When set to True (or 1), only replication verbs will be accepted. When set to False, replication verbs will be rejected. When undefined, server will accept any verb in the request.</td>
</tr> </tr>
<tr> <tr>
<td>set log_address = /dev/log</td> <td><option>set log_address</option> = <replaceable>/dev/log</replaceable></td>
<td>Location where syslog sends the logs to</td> <td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>set log_facility = LOG_LOCAL0</td> <td><option>set log_facility</option> = <replaceable>LOG_LOCAL0</replaceable></td>
<td>Syslog log facility</td> <td>Syslog log facility</td>
</tr> </tr>
<tr> <tr>
<td>set log_level = INFO</td> <td><option>set log_level</option> = <replaceable>INFO</replaceable></td>
<td>Log level</td> <td>Log level</td>
</tr> </tr>
<tr> <tr>
<td>set log_name = account-server</td> <td><option>set log_name</option> = <replaceable>account-server</replaceable></td>
<td>Label to use when logging</td> <td>Label to use when logging</td>
</tr> </tr>
<tr> <tr>
<td>set log_requests = true</td> <td><option>set log_requests</option> = <replaceable>true</replaceable></td>
<td>Whether or not to log requests</td> <td>Whether or not to log requests</td>
</tr> </tr>
<tr> <tr>
<td>use = egg:swift#account</td> <td><option>use</option> = <replaceable>egg:swift#account</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

6
doc/common/tables/swift-account-server-filter-healthcheck.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-healthcheck]</literal> in <literal>account-server.conf</literal> <literal>[filter-healthcheck]</literal> in <filename>account-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,11 +17,11 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>disable_path = </td> <td><option>disable_path</option> = <replaceable></replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>use = egg:swift#healthcheck</td> <td><option>use</option> = <replaceable>egg:swift#healthcheck</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

6
doc/common/tables/swift-account-server-filter-recon.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-recon]</literal> in <literal>account-server.conf</literal> <literal>[filter-recon]</literal> in <filename>account-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,11 +17,11 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>recon_cache_path = /var/cache/swift</td> <td><option>recon_cache_path</option> = <replaceable>/var/cache/swift</replaceable></td>
<td>Directory where stats for a few items will be stored</td> <td>Directory where stats for a few items will be stored</td>
</tr> </tr>
<tr> <tr>
<td>use = egg:swift#recon</td> <td><option>use</option> = <replaceable>egg:swift#recon</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

18
doc/common/tables/swift-account-server-filter-xprofile.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-xprofile]</literal> in <literal>account-server.conf</literal> <literal>[filter-xprofile]</literal> in <filename>account-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,35 +17,35 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>dump_interval = 5.0</td> <td><option>dump_interval</option> = <replaceable>5.0</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>dump_timestamp = false</td> <td><option>dump_timestamp</option> = <replaceable>false</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>flush_at_shutdown = false</td> <td><option>flush_at_shutdown</option> = <replaceable>false</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>log_filename_prefix = /tmp/log/swift/profile/default.profile</td> <td><option>log_filename_prefix</option> = <replaceable>/tmp/log/swift/profile/default.profile</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>path = /__profile__</td> <td><option>path</option> = <replaceable>/__profile__</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>profile_module = eventlet.green.profile</td> <td><option>profile_module</option> = <replaceable>eventlet.green.profile</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>unwind = false</td> <td><option>unwind</option> = <replaceable>false</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>use = egg:swift#xprofile</td> <td><option>use</option> = <replaceable>egg:swift#xprofile</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

4
doc/common/tables/swift-account-server-pipeline-main.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[pipeline-main]</literal> in <literal>account-server.conf</literal> <literal>[pipeline-main]</literal> in <filename>account-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,7 +17,7 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>pipeline = healthcheck recon account-server</td> <td><option>pipeline</option> = <replaceable>healthcheck recon account-server</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
</tbody> </tbody>

30
doc/common/tables/swift-container-reconciler-DEFAULT.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[DEFAULT]</literal> in <literal>container-reconciler.conf</literal> <literal>[DEFAULT]</literal> in <filename>container-reconciler.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,62 +17,62 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>log_address = /dev/log</td> <td><option>log_address</option> = <replaceable>/dev/log</replaceable></td>
<td>Location where syslog sends the logs to</td> <td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>log_custom_handlers = </td> <td><option>log_custom_handlers</option> = <replaceable></replaceable></td>
<td>Comma-separated list of functions to call to setup custom log handlers.</td> <td>Comma-separated list of functions to call to setup custom log handlers.</td>
</tr> </tr>
<tr> <tr>
<td>log_facility = LOG_LOCAL0</td> <td><option>log_facility</option> = <replaceable>LOG_LOCAL0</replaceable></td>
<td>Syslog log facility</td> <td>Syslog log facility</td>
</tr> </tr>
<tr> <tr>
<td>log_level = INFO</td> <td><option>log_level</option> = <replaceable>INFO</replaceable></td>
<td>Logging level</td> <td>Logging level</td>
</tr> </tr>
<tr> <tr>
<td>log_name = swift</td> <td><option>log_name</option> = <replaceable>swift</replaceable></td>
<td>Label used when logging</td> <td>Label used when logging</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_default_sample_rate = 1.0</td> <td><option>log_statsd_default_sample_rate</option> = <replaceable>1.0</replaceable></td>
<td>Defines the probability of sending a sample for any given event or <td>Defines the probability of sending a sample for any given event or
timing measurement.</td> timing measurement.</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_host = localhost</td> <td><option>log_statsd_host</option> = <replaceable>localhost</replaceable></td>
<td>If not set, the StatsD feature is disabled.</td> <td>If not set, the StatsD feature is disabled.</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_metric_prefix = </td> <td><option>log_statsd_metric_prefix</option> = <replaceable></replaceable></td>
<td>Value will be prepended to every metric sent to the StatsD server.</td> <td>Value will be prepended to every metric sent to the StatsD server.</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_port = 8125</td> <td><option>log_statsd_port</option> = <replaceable>8125</replaceable></td>
<td>Port value for the StatsD server.</td> <td>Port value for the StatsD server.</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_sample_rate_factor = 1.0</td> <td><option>log_statsd_sample_rate_factor</option> = <replaceable>1.0</replaceable></td>
<td>Not recommended to set this to a value less than 1.0, if frequency <td>Not recommended to set this to a value less than 1.0, if frequency
of logging is too high, tune the of logging is too high, tune the
log_statsd_default_sample_rate instead.</td> log_statsd_default_sample_rate instead.</td>
</tr> </tr>
<tr> <tr>
<td>log_udp_host = </td> <td><option>log_udp_host</option> = <replaceable></replaceable></td>
<td>If not set, the UDP receiver for syslog is disabled.</td> <td>If not set, the UDP receiver for syslog is disabled.</td>
</tr> </tr>
<tr> <tr>
<td>log_udp_port = 514</td> <td><option>log_udp_port</option> = <replaceable>514</replaceable></td>
<td>Port value for UDP receiver, if enabled.</td> <td>Port value for UDP receiver, if enabled.</td>
</tr> </tr>
<tr> <tr>
<td>swift_dir = /etc/swift</td> <td><option>swift_dir</option> = <replaceable>/etc/swift</replaceable></td>
<td>Swift configuration directory</td> <td>Swift configuration directory</td>
</tr> </tr>
<tr> <tr>
<td>user = swift</td> <td><option>user</option> = <replaceable>swift</replaceable></td>
<td>User to run as</td> <td>User to run as</td>
</tr> </tr>
</tbody> </tbody>

4
doc/common/tables/swift-container-reconciler-app-proxy-server.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[app-proxy-server]</literal> in <literal>container-reconciler.conf</literal> <literal>[app-proxy-server]</literal> in <filename>container-reconciler.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,7 +17,7 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>use = egg:swift#proxy</td> <td><option>use</option> = <replaceable>egg:swift#proxy</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

8
doc/common/tables/swift-container-reconciler-container-reconciler.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[container-reconciler]</literal> in <literal>container-reconciler.conf</literal> <literal>[container-reconciler]</literal> in <filename>container-reconciler.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,15 +17,15 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>interval = 30</td> <td><option>interval</option> = <replaceable>30</replaceable></td>
<td>Minimum time for a pass to take</td> <td>Minimum time for a pass to take</td>
</tr> </tr>
<tr> <tr>
<td>reclaim_age = 604800</td> <td><option>reclaim_age</option> = <replaceable>604800</replaceable></td>
<td>Time elapsed in seconds before an object can be reclaimed</td> <td>Time elapsed in seconds before an object can be reclaimed</td>
</tr> </tr>
<tr> <tr>
<td>request_tries = 3</td> <td><option>request_tries</option> = <replaceable>3</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
</tbody> </tbody>

4
doc/common/tables/swift-container-reconciler-filter-cache.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-cache]</literal> in <literal>container-reconciler.conf</literal> <literal>[filter-cache]</literal> in <filename>container-reconciler.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,7 +17,7 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>use = egg:swift#memcache</td> <td><option>use</option> = <replaceable>egg:swift#memcache</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

4
doc/common/tables/swift-container-reconciler-filter-catch_errors.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-catch_errors]</literal> in <literal>container-reconciler.conf</literal> <literal>[filter-catch_errors]</literal> in <filename>container-reconciler.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,7 +17,7 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>use = egg:swift#catch_errors</td> <td><option>use</option> = <replaceable>egg:swift#catch_errors</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

4
doc/common/tables/swift-container-reconciler-filter-proxy-logging.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-proxy-logging]</literal> in <literal>container-reconciler.conf</literal> <literal>[filter-proxy-logging]</literal> in <filename>container-reconciler.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,7 +17,7 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>use = egg:swift#proxy_logging</td> <td><option>use</option> = <replaceable>egg:swift#proxy_logging</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

4
doc/common/tables/swift-container-reconciler-pipeline-main.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[pipeline-main]</literal> in <literal>container-reconciler.conf</literal> <literal>[pipeline-main]</literal> in <filename>container-reconciler.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,7 +17,7 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>pipeline = catch_errors proxy-logging cache proxy-server</td> <td><option>pipeline</option> = <replaceable>catch_errors proxy-logging cache proxy-server</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
</tbody> </tbody>

58
doc/common/tables/swift-container-server-DEFAULT.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[DEFAULT]</literal> in <literal>container-server.conf</literal> <literal>[DEFAULT]</literal> in <filename>container-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,102 +17,102 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>allowed_sync_hosts = 127.0.0.1</td> <td><option>allowed_sync_hosts</option> = <replaceable>127.0.0.1</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>backlog = 4096</td> <td><option>backlog</option> = <replaceable>4096</replaceable></td>
<td>Maximum number of allowed pending TCP connections</td> <td>Maximum number of allowed pending TCP connections</td>
</tr> </tr>
<tr> <tr>
<td>bind_ip = 0.0.0.0</td> <td><option>bind_ip</option> = <replaceable>0.0.0.0</replaceable></td>
<td>IP Address for server to bind to</td> <td>IP Address for server to bind to</td>
</tr> </tr>
<tr> <tr>
<td>bind_port = 6001</td> <td><option>bind_port</option> = <replaceable>6001</replaceable></td>
<td>Port for server to bind to</td> <td>Port for server to bind to</td>
</tr> </tr>
<tr> <tr>
<td>bind_timeout = 30</td> <td><option>bind_timeout</option> = <replaceable>30</replaceable></td>
<td>Seconds to attempt bind before giving up</td> <td>Seconds to attempt bind before giving up</td>
</tr> </tr>
<tr> <tr>
<td>db_preallocation = off</td> <td><option>db_preallocation</option> = <replaceable>off</replaceable></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>If you don't mind the extra disk space usage in overhead, you can turn this on to preallocate disk space with SQLite databases to decrease fragmentation. underlying filesystem does not support it. to setup custom log handlers. bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#account`. replication passes account can be reclaimed</td>
</tr> </tr>
<tr> <tr>
<td>devices = /srv/node</td> <td><option>devices</option> = <replaceable>/srv/node</replaceable></td>
<td>Parent directory of where devices are mounted</td> <td>Parent directory of where devices are mounted</td>
</tr> </tr>
<tr> <tr>
<td>disable_fallocate = false</td> <td><option>disable_fallocate</option> = <replaceable>false</replaceable></td>
<td>Disable "fast fail" fallocate checks if the underlying filesystem does not support it.</td> <td>Disable "fast fail" fallocate checks if the underlying filesystem does not support it.</td>
</tr> </tr>
<tr> <tr>
<td>eventlet_debug = false</td> <td><option>eventlet_debug</option> = <replaceable>false</replaceable></td>
<td>If true, turn on debug logging for eventlet</td> <td>If true, turn on debug logging for eventlet</td>
</tr> </tr>
<tr> <tr>
<td>fallocate_reserve = 0</td> <td><option>fallocate_reserve</option> = <replaceable>0</replaceable></td>
<td>You can set fallocate_reserve to the number of bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#object`.</td> <td>You can set fallocate_reserve to the number of bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#object`.</td>
</tr> </tr>
<tr> <tr>
<td>log_address = /dev/log</td> <td><option>log_address</option> = <replaceable>/dev/log</replaceable></td>
<td>Location where syslog sends the logs to</td> <td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>log_custom_handlers = </td> <td><option>log_custom_handlers</option> = <replaceable></replaceable></td>
<td>Comma-separated list of functions to call to setup custom log handlers.</td> <td>Comma-separated list of functions to call to setup custom log handlers.</td>
</tr> </tr>
<tr> <tr>
<td>log_facility = LOG_LOCAL0</td> <td><option>log_facility</option> = <replaceable>LOG_LOCAL0</replaceable></td>
<td>Syslog log facility</td> <td>Syslog log facility</td>
</tr> </tr>
<tr> <tr>
<td>log_level = INFO</td> <td><option>log_level</option> = <replaceable>INFO</replaceable></td>
<td>Logging level</td> <td>Logging level</td>
</tr> </tr>
<tr> <tr>
<td>log_max_line_length = 0</td> <td><option>log_max_line_length</option> = <replaceable>0</replaceable></td>
<td>Caps the length of log lines to the value given; no limit if set to 0, the default.</td> <td>Caps the length of log lines to the value given; no limit if set to 0, the default.</td>
</tr> </tr>
<tr> <tr>
<td>log_name = swift</td> <td><option>log_name</option> = <replaceable>swift</replaceable></td>
<td>Label used when logging</td> <td>Label used when logging</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_default_sample_rate = 1.0</td> <td><option>log_statsd_default_sample_rate</option> = <replaceable>1.0</replaceable></td>
<td>Defines the probability of sending a sample for any given event or <td>Defines the probability of sending a sample for any given event or
timing measurement.</td> timing measurement.</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_host = localhost</td> <td><option>log_statsd_host</option> = <replaceable>localhost</replaceable></td>
<td>If not set, the StatsD feature is disabled.</td> <td>If not set, the StatsD feature is disabled.</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_metric_prefix = </td> <td><option>log_statsd_metric_prefix</option> = <replaceable></replaceable></td>
<td>Value will be prepended to every metric sent to the StatsD server.</td> <td>Value will be prepended to every metric sent to the StatsD server.</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_port = 8125</td> <td><option>log_statsd_port</option> = <replaceable>8125</replaceable></td>
<td>Port value for the StatsD server.</td> <td>Port value for the StatsD server.</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_sample_rate_factor = 1.0</td> <td><option>log_statsd_sample_rate_factor</option> = <replaceable>1.0</replaceable></td>
<td>Not recommended to set this to a value less than 1.0, if frequency <td>Not recommended to set this to a value less than 1.0, if frequency
of logging is too high, tune the of logging is too high, tune the
log_statsd_default_sample_rate instead.</td> log_statsd_default_sample_rate instead.</td>
</tr> </tr>
<tr> <tr>
<td>log_udp_host = </td> <td><option>log_udp_host</option> = <replaceable></replaceable></td>
<td>If not set, the UDP receiver for syslog is disabled.</td> <td>If not set, the UDP receiver for syslog is disabled.</td>
</tr> </tr>
<tr> <tr>
<td>log_udp_port = 514</td> <td><option>log_udp_port</option> = <replaceable>514</replaceable></td>
<td>Port value for UDP receiver, if enabled.</td> <td>Port value for UDP receiver, if enabled.</td>
</tr> </tr>
<tr> <tr>
<td>max_clients = 1024</td> <td><option>max_clients</option> = <replaceable>1024</replaceable></td>
<td>Maximum number of clients one worker can process simultaneously <td>Maximum number of clients one worker can process simultaneously
Lowering the number of clients handled per worker, and raising the Lowering the number of clients handled per worker, and raising the
number of workers can lessen the impact that a CPU intensive, or number of workers can lessen the impact that a CPU intensive, or
@ -123,19 +123,19 @@ other workers a chance to process it.
</td> </td>
</tr> </tr>
<tr> <tr>
<td>mount_check = true</td> <td><option>mount_check</option> = <replaceable>true</replaceable></td>
<td>Whether or not check if the devices are mounted to prevent accidentally writing to the root device</td> <td>Whether or not check if the devices are mounted to prevent accidentally writing to the root device</td>
</tr> </tr>
<tr> <tr>
<td>swift_dir = /etc/swift</td> <td><option>swift_dir</option> = <replaceable>/etc/swift</replaceable></td>
<td>Swift configuration directory</td> <td>Swift configuration directory</td>
</tr> </tr>
<tr> <tr>
<td>user = swift</td> <td><option>user</option> = <replaceable>swift</replaceable></td>
<td>User to run as</td> <td>User to run as</td>
</tr> </tr>
<tr> <tr>
<td>workers = auto</td> <td><option>workers</option> = <replaceable>auto</replaceable></td>
<td>a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.</td> <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>
</tbody> </tbody>

24
doc/common/tables/swift-container-server-app-container-server.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[app-container-server]</literal> in <literal>container-server.conf</literal> <literal>[app-container-server]</literal> in <filename>container-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,47 +17,47 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>allow_versions = false</td> <td><option>allow_versions</option> = <replaceable>false</replaceable></td>
<td>Enable/Disable object versioning feature</td> <td>Enable/Disable object versioning feature</td>
</tr> </tr>
<tr> <tr>
<td>auto_create_account_prefix = .</td> <td><option>auto_create_account_prefix</option> = <replaceable>.</replaceable></td>
<td>Prefix to use when automatically creating accounts</td> <td>Prefix to use when automatically creating accounts</td>
</tr> </tr>
<tr> <tr>
<td>conn_timeout = 0.5</td> <td><option>conn_timeout</option> = <replaceable>0.5</replaceable></td>
<td>Connection timeout to external services</td> <td>Connection timeout to external services</td>
</tr> </tr>
<tr> <tr>
<td>node_timeout = 3</td> <td><option>node_timeout</option> = <replaceable>3</replaceable></td>
<td>Request timeout to external services</td> <td>Request timeout to external services</td>
</tr> </tr>
<tr> <tr>
<td>replication_server = false</td> <td><option>replication_server</option> = <replaceable>false</replaceable></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>If defined, tells server how to handle replication verbs in requests. When set to True (or 1), only replication verbs will be accepted. When set to False, replication verbs will be rejected. When undefined, server will accept any verb in the request.</td>
</tr> </tr>
<tr> <tr>
<td>set log_address = /dev/log</td> <td><option>set log_address</option> = <replaceable>/dev/log</replaceable></td>
<td>Location where syslog sends the logs to</td> <td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>set log_facility = LOG_LOCAL0</td> <td><option>set log_facility</option> = <replaceable>LOG_LOCAL0</replaceable></td>
<td>Syslog log facility</td> <td>Syslog log facility</td>
</tr> </tr>
<tr> <tr>
<td>set log_level = INFO</td> <td><option>set log_level</option> = <replaceable>INFO</replaceable></td>
<td>Log level</td> <td>Log level</td>
</tr> </tr>
<tr> <tr>
<td>set log_name = container-server</td> <td><option>set log_name</option> = <replaceable>container-server</replaceable></td>
<td>Label to use when logging</td> <td>Label to use when logging</td>
</tr> </tr>
<tr> <tr>
<td>set log_requests = true</td> <td><option>set log_requests</option> = <replaceable>true</replaceable></td>
<td>Whether or not to log requests</td> <td>Whether or not to log requests</td>
</tr> </tr>
<tr> <tr>
<td>use = egg:swift#container</td> <td><option>use</option> = <replaceable>egg:swift#container</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

16
doc/common/tables/swift-container-server-container-auditor.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[container-auditor]</literal> in <literal>container-server.conf</literal> <literal>[container-auditor]</literal> in <filename>container-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,31 +17,31 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>containers_per_second = 200</td> <td><option>containers_per_second</option> = <replaceable>200</replaceable></td>
<td>Maximum containers audited per second. Should be tuned according to individual system specs. 0 is unlimited. mounted to prevent accidentally writing to the root device process simultaneously (it will actually accept(2) N + 1). Setting this to one (1) will only handle one request at a time, without accepting another request concurrently. By increasing the number of workers to a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.</td> <td>Maximum containers audited per second. Should be tuned according to individual system specs. 0 is unlimited. mounted to prevent accidentally writing to the root device process simultaneously (it will actually accept(2) N + 1). Setting this to one (1) will only handle one request at a time, without accepting another request concurrently. By increasing the number of workers to a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.</td>
</tr> </tr>
<tr> <tr>
<td>interval = 1800</td> <td><option>interval</option> = <replaceable>1800</replaceable></td>
<td>Minimum time for a pass to take</td> <td>Minimum time for a pass to take</td>
</tr> </tr>
<tr> <tr>
<td>log_address = /dev/log</td> <td><option>log_address</option> = <replaceable>/dev/log</replaceable></td>
<td>Location where syslog sends the logs to</td> <td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>log_facility = LOG_LOCAL0</td> <td><option>log_facility</option> = <replaceable>LOG_LOCAL0</replaceable></td>
<td>Syslog log facility</td> <td>Syslog log facility</td>
</tr> </tr>
<tr> <tr>
<td>log_level = INFO</td> <td><option>log_level</option> = <replaceable>INFO</replaceable></td>
<td>Logging level</td> <td>Logging level</td>
</tr> </tr>
<tr> <tr>
<td>log_name = container-auditor</td> <td><option>log_name</option> = <replaceable>container-auditor</replaceable></td>
<td>Label used when logging</td> <td>Label used when logging</td>
</tr> </tr>
<tr> <tr>
<td>recon_cache_path = /var/cache/swift</td> <td><option>recon_cache_path</option> = <replaceable>/var/cache/swift</replaceable></td>
<td>Directory where stats for a few items will be stored</td> <td>Directory where stats for a few items will be stored</td>
</tr> </tr>
</tbody> </tbody>

30
doc/common/tables/swift-container-server-container-replicator.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[container-replicator]</literal> in <literal>container-server.conf</literal> <literal>[container-replicator]</literal> in <filename>container-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,59 +17,59 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>concurrency = 8</td> <td><option>concurrency</option> = <replaceable>8</replaceable></td>
<td>Number of replication workers to spawn</td> <td>Number of replication workers to spawn</td>
</tr> </tr>
<tr> <tr>
<td>conn_timeout = 0.5</td> <td><option>conn_timeout</option> = <replaceable>0.5</replaceable></td>
<td>Connection timeout to external services</td> <td>Connection timeout to external services</td>
</tr> </tr>
<tr> <tr>
<td>interval = 30</td> <td><option>interval</option> = <replaceable>30</replaceable></td>
<td>Minimum time for a pass to take</td> <td>Minimum time for a pass to take</td>
</tr> </tr>
<tr> <tr>
<td>log_address = /dev/log</td> <td><option>log_address</option> = <replaceable>/dev/log</replaceable></td>
<td>Location where syslog sends the logs to</td> <td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>log_facility = LOG_LOCAL0</td> <td><option>log_facility</option> = <replaceable>LOG_LOCAL0</replaceable></td>
<td>Syslog log facility</td> <td>Syslog log facility</td>
</tr> </tr>
<tr> <tr>
<td>log_level = INFO</td> <td><option>log_level</option> = <replaceable>INFO</replaceable></td>
<td>Logging level</td> <td>Logging level</td>
</tr> </tr>
<tr> <tr>
<td>log_name = container-replicator</td> <td><option>log_name</option> = <replaceable>container-replicator</replaceable></td>
<td>Label used when logging</td> <td>Label used when logging</td>
</tr> </tr>
<tr> <tr>
<td>max_diffs = 100</td> <td><option>max_diffs</option> = <replaceable>100</replaceable></td>
<td>Caps how long the replicator spends trying to sync a database per pass</td> <td>Caps how long the replicator spends trying to sync a database per pass</td>
</tr> </tr>
<tr> <tr>
<td>node_timeout = 10</td> <td><option>node_timeout</option> = <replaceable>10</replaceable></td>
<td>Request timeout to external services</td> <td>Request timeout to external services</td>
</tr> </tr>
<tr> <tr>
<td>per_diff = 1000</td> <td><option>per_diff</option> = <replaceable>1000</replaceable></td>
<td>Limit number of items to get per diff</td> <td>Limit number of items to get per diff</td>
</tr> </tr>
<tr> <tr>
<td>reclaim_age = 604800</td> <td><option>reclaim_age</option> = <replaceable>604800</replaceable></td>
<td>Time elapsed in seconds before an object can be reclaimed</td> <td>Time elapsed in seconds before an object can be reclaimed</td>
</tr> </tr>
<tr> <tr>
<td>recon_cache_path = /var/cache/swift</td> <td><option>recon_cache_path</option> = <replaceable>/var/cache/swift</replaceable></td>
<td>Directory where stats for a few items will be stored</td> <td>Directory where stats for a few items will be stored</td>
</tr> </tr>
<tr> <tr>
<td>run_pause = 30</td> <td><option>run_pause</option> = <replaceable>30</replaceable></td>
<td>Time in seconds to wait between replication passes</td> <td>Time in seconds to wait between replication passes</td>
</tr> </tr>
<tr> <tr>
<td>vm_test_mode = no</td> <td><option>vm_test_mode</option> = <replaceable>no</replaceable></td>
<td>Indicates that you are using a VM environment</td> <td>Indicates that you are using a VM environment</td>
</tr> </tr>
</tbody> </tbody>

16
doc/common/tables/swift-container-server-container-sync.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[container-sync]</literal> in <literal>container-server.conf</literal> <literal>[container-sync]</literal> in <filename>container-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,31 +17,31 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>container_time = 60</td> <td><option>container_time</option> = <replaceable>60</replaceable></td>
<td>Maximum amount of time to spend syncing each container</td> <td>Maximum amount of time to spend syncing each container</td>
</tr> </tr>
<tr> <tr>
<td>interval = 300</td> <td><option>interval</option> = <replaceable>300</replaceable></td>
<td>Minimum time for a pass to take</td> <td>Minimum time for a pass to take</td>
</tr> </tr>
<tr> <tr>
<td>log_address = /dev/log</td> <td><option>log_address</option> = <replaceable>/dev/log</replaceable></td>
<td>Location where syslog sends the logs to</td> <td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>log_facility = LOG_LOCAL0</td> <td><option>log_facility</option> = <replaceable>LOG_LOCAL0</replaceable></td>
<td>Syslog log facility</td> <td>Syslog log facility</td>
</tr> </tr>
<tr> <tr>
<td>log_level = INFO</td> <td><option>log_level</option> = <replaceable>INFO</replaceable></td>
<td>Logging level</td> <td>Logging level</td>
</tr> </tr>
<tr> <tr>
<td>log_name = container-sync</td> <td><option>log_name</option> = <replaceable>container-sync</replaceable></td>
<td>Label used when logging</td> <td>Label used when logging</td>
</tr> </tr>
<tr> <tr>
<td>sync_proxy = http://10.1.1.1:8888,http://10.1.1.2:8888</td> <td><option>sync_proxy</option> = <replaceable>http://10.1.1.1:8888,http://10.1.1.2:8888</replaceable></td>
<td>If you need to use an HTTP proxy, set it here. Defaults to no proxy.</td> <td>If you need to use an HTTP proxy, set it here. Defaults to no proxy.</td>
</tr> </tr>
</tbody> </tbody>

24
doc/common/tables/swift-container-server-container-updater.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[container-updater]</literal> in <literal>container-server.conf</literal> <literal>[container-updater]</literal> in <filename>container-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,48 +17,48 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>account_suppression_time = 60</td> <td><option>account_suppression_time</option> = <replaceable>60</replaceable></td>
<td>Seconds to suppress updating an account that has generated an <td>Seconds to suppress updating an account that has generated an
error (timeout, not yet found, etc.)</td> error (timeout, not yet found, etc.)</td>
</tr> </tr>
<tr> <tr>
<td>concurrency = 4</td> <td><option>concurrency</option> = <replaceable>4</replaceable></td>
<td>Number of replication workers to spawn</td> <td>Number of replication workers to spawn</td>
</tr> </tr>
<tr> <tr>
<td>conn_timeout = 0.5</td> <td><option>conn_timeout</option> = <replaceable>0.5</replaceable></td>
<td>Connection timeout to external services</td> <td>Connection timeout to external services</td>
</tr> </tr>
<tr> <tr>
<td>interval = 300</td> <td><option>interval</option> = <replaceable>300</replaceable></td>
<td>Minimum time for a pass to take</td> <td>Minimum time for a pass to take</td>
</tr> </tr>
<tr> <tr>
<td>log_address = /dev/log</td> <td><option>log_address</option> = <replaceable>/dev/log</replaceable></td>
<td>Location where syslog sends the logs to</td> <td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>log_facility = LOG_LOCAL0</td> <td><option>log_facility</option> = <replaceable>LOG_LOCAL0</replaceable></td>
<td>Syslog log facility</td> <td>Syslog log facility</td>
</tr> </tr>
<tr> <tr>
<td>log_level = INFO</td> <td><option>log_level</option> = <replaceable>INFO</replaceable></td>
<td>Logging level</td> <td>Logging level</td>
</tr> </tr>
<tr> <tr>
<td>log_name = container-updater</td> <td><option>log_name</option> = <replaceable>container-updater</replaceable></td>
<td>Label used when logging</td> <td>Label used when logging</td>
</tr> </tr>
<tr> <tr>
<td>node_timeout = 3</td> <td><option>node_timeout</option> = <replaceable>3</replaceable></td>
<td>Request timeout to external services</td> <td>Request timeout to external services</td>
</tr> </tr>
<tr> <tr>
<td>recon_cache_path = /var/cache/swift</td> <td><option>recon_cache_path</option> = <replaceable>/var/cache/swift</replaceable></td>
<td>Directory where stats for a few items will be stored</td> <td>Directory where stats for a few items will be stored</td>
</tr> </tr>
<tr> <tr>
<td>slowdown = 0.01</td> <td><option>slowdown</option> = <replaceable>0.01</replaceable></td>
<td>Time in seconds to wait between objects</td> <td>Time in seconds to wait between objects</td>
</tr> </tr>
</tbody> </tbody>

6
doc/common/tables/swift-container-server-filter-healthcheck.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-healthcheck]</literal> in <literal>container-server.conf</literal> <literal>[filter-healthcheck]</literal> in <filename>container-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,11 +17,11 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>disable_path = </td> <td><option>disable_path</option> = <replaceable></replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>use = egg:swift#healthcheck</td> <td><option>use</option> = <replaceable>egg:swift#healthcheck</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

6
doc/common/tables/swift-container-server-filter-recon.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-recon]</literal> in <literal>container-server.conf</literal> <literal>[filter-recon]</literal> in <filename>container-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,11 +17,11 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>recon_cache_path = /var/cache/swift</td> <td><option>recon_cache_path</option> = <replaceable>/var/cache/swift</replaceable></td>
<td>Directory where stats for a few items will be stored</td> <td>Directory where stats for a few items will be stored</td>
</tr> </tr>
<tr> <tr>
<td>use = egg:swift#recon</td> <td><option>use</option> = <replaceable>egg:swift#recon</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

18
doc/common/tables/swift-container-server-filter-xprofile.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-xprofile]</literal> in <literal>container-server.conf</literal> <literal>[filter-xprofile]</literal> in <filename>container-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,35 +17,35 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>dump_interval = 5.0</td> <td><option>dump_interval</option> = <replaceable>5.0</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>dump_timestamp = false</td> <td><option>dump_timestamp</option> = <replaceable>false</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>flush_at_shutdown = false</td> <td><option>flush_at_shutdown</option> = <replaceable>false</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>log_filename_prefix = /tmp/log/swift/profile/default.profile</td> <td><option>log_filename_prefix</option> = <replaceable>/tmp/log/swift/profile/default.profile</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>path = /__profile__</td> <td><option>path</option> = <replaceable>/__profile__</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>profile_module = eventlet.green.profile</td> <td><option>profile_module</option> = <replaceable>eventlet.green.profile</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>unwind = false</td> <td><option>unwind</option> = <replaceable>false</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>use = egg:swift#xprofile</td> <td><option>use</option> = <replaceable>egg:swift#xprofile</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

4
doc/common/tables/swift-container-server-pipeline-main.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[pipeline-main]</literal> in <literal>container-server.conf</literal> <literal>[pipeline-main]</literal> in <filename>container-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,7 +17,7 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>pipeline = healthcheck recon container-server</td> <td><option>pipeline</option> = <replaceable>healthcheck recon container-server</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
</tbody> </tbody>

4
doc/common/tables/swift-container-sync-realms-DEFAULT.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[DEFAULT]</literal> in <literal>container-sync-realms.conf</literal> <literal>[DEFAULT]</literal> in <filename>container-sync-realms.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,7 +17,7 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>mtime_check_interval = 300</td> <td><option>mtime_check_interval</option> = <replaceable>300</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
</tbody> </tbody>

10
doc/common/tables/swift-container-sync-realms-realm1.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[realm1]</literal> in <literal>container-sync-realms.conf</literal> <literal>[realm1]</literal> in <filename>container-sync-realms.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,19 +17,19 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>cluster_name1 = https://host1/v1/</td> <td><option>cluster_name1</option> = <replaceable>https://host1/v1/</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>cluster_name2 = https://host2/v1/</td> <td><option>cluster_name2</option> = <replaceable>https://host2/v1/</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>key = realm1key</td> <td><option>key</option> = <replaceable>realm1key</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>key2 = realm1key2</td> <td><option>key2</option> = <replaceable>realm1key2</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
</tbody> </tbody>

10
doc/common/tables/swift-container-sync-realms-realm2.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[realm2]</literal> in <literal>container-sync-realms.conf</literal> <literal>[realm2]</literal> in <filename>container-sync-realms.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,19 +17,19 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>cluster_name3 = https://host3/v1/</td> <td><option>cluster_name3</option> = <replaceable>https://host3/v1/</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>cluster_name4 = https://host4/v1/</td> <td><option>cluster_name4</option> = <replaceable>https://host4/v1/</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>key = realm2key</td> <td><option>key</option> = <replaceable>realm2key</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>key2 = realm2key2</td> <td><option>key2</option> = <replaceable>realm2key2</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
</tbody> </tbody>

32
doc/common/tables/swift-dispersion-dispersion.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[dispersion]</literal> in <literal>dispersion.conf</literal> <literal>[dispersion]</literal> in <filename>dispersion.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,63 +17,63 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>auth_key = testing</td> <td><option>auth_key</option> = <replaceable>testing</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>auth_url = http://localhost:8080/auth/v1.0</td> <td><option>auth_url</option> = <replaceable>http://localhost:8080/auth/v1.0</replaceable></td>
<td>Endpoint for auth server, such as keystone</td> <td>Endpoint for auth server, such as keystone</td>
</tr> </tr>
<tr> <tr>
<td>auth_user = test:tester</td> <td><option>auth_user</option> = <replaceable>test:tester</replaceable></td>
<td>Default user for dispersion in this context</td> <td>Default user for dispersion in this context</td>
</tr> </tr>
<tr> <tr>
<td>auth_version = 1.0</td> <td><option>auth_version</option> = <replaceable>1.0</replaceable></td>
<td>Indicates which version of auth</td> <td>Indicates which version of auth</td>
</tr> </tr>
<tr> <tr>
<td>concurrency = 25</td> <td><option>concurrency</option> = <replaceable>25</replaceable></td>
<td>Number of replication workers to spawn</td> <td>Number of replication workers to spawn</td>
</tr> </tr>
<tr> <tr>
<td>container_populate = yes</td> <td><option>container_populate</option> = <replaceable>yes</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>container_report = yes</td> <td><option>container_report</option> = <replaceable>yes</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>dispersion_coverage = 1.0</td> <td><option>dispersion_coverage</option> = <replaceable>1.0</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>dump_json = no</td> <td><option>dump_json</option> = <replaceable>no</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>endpoint_type = publicURL</td> <td><option>endpoint_type</option> = <replaceable>publicURL</replaceable></td>
<td>Indicates whether endpoint for auth is public or internal</td> <td>Indicates whether endpoint for auth is public or internal</td>
</tr> </tr>
<tr> <tr>
<td>keystone_api_insecure = no</td> <td><option>keystone_api_insecure</option> = <replaceable>no</replaceable></td>
<td>Allow accessing insecure keystone server. The keystone's certificate will not be verified.</td> <td>Allow accessing insecure keystone server. The keystone's certificate will not be verified.</td>
</tr> </tr>
<tr> <tr>
<td>object_populate = yes</td> <td><option>object_populate</option> = <replaceable>yes</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>object_report = yes</td> <td><option>object_report</option> = <replaceable>yes</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>retries = 5</td> <td><option>retries</option> = <replaceable>5</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>swift_dir = /etc/swift</td> <td><option>swift_dir</option> = <replaceable>/etc/swift</replaceable></td>
<td>Swift configuration directory</td> <td>Swift configuration directory</td>
</tr> </tr>
</tbody> </tbody>

32
doc/common/tables/swift-drive-audit-drive-audit.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[drive-audit]</literal> in <literal>drive-audit.conf</literal> <literal>[drive-audit]</literal> in <filename>drive-audit.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,39 +17,51 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>device_dir = /srv/node</td> <td><option>device_dir</option> = <replaceable>/srv/node</replaceable></td>
<td>Directory devices are mounted under</td> <td>Directory devices are mounted under</td>
</tr> </tr>
<tr> <tr>
<td>error_limit = 1</td> <td><option>error_limit</option> = <replaceable>1</replaceable></td>
<td>Number of errors to find before a device is unmounted</td> <td>Number of errors to find before a device is unmounted</td>
</tr> </tr>
<tr> <tr>
<td>log_address = /dev/log</td> <td><option>log_address</option> = <replaceable>/dev/log</replaceable></td>
<td>Location where syslog sends the logs to</td> <td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>log_facility = LOG_LOCAL0</td> <td><option>log_facility</option> = <replaceable>LOG_LOCAL0</replaceable></td>
<td>Syslog log facility</td> <td>Syslog log facility</td>
</tr> </tr>
<tr> <tr>
<td>log_file_pattern = /var/log/kern.*[!.][!g][!z]</td> <td><option>log_file_pattern</option> = <replaceable>/var/log/kern.*[!.][!g][!z]</replaceable></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> <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>
<tr> <tr>
<td>log_level = INFO</td> <td><option>log_level</option> = <replaceable>INFO</replaceable></td>
<td>Logging level</td> <td>Logging level</td>
</tr> </tr>
<tr> <tr>
<td>log_max_line_length = 0</td> <td><option>log_max_line_length</option> = <replaceable>0</replaceable></td>
<td>Caps the length of log lines to the value given; no limit if set to 0, the default.</td> <td>Caps the length of log lines to the value given; no limit if set to 0, the default.</td>
</tr> </tr>
<tr> <tr>
<td>minutes = 60</td> <td><option>log_to_console</option> = <replaceable>False</replaceable></td>
<td>No help text available for this option.</td>
</tr>
<tr>
<td><option>minutes</option> = <replaceable>60</replaceable></td>
<td>Number of minutes to look back in `/var/log/kern.log`</td> <td>Number of minutes to look back in `/var/log/kern.log`</td>
</tr> </tr>
<tr> <tr>
<td>regex_pattern_1 = \berror\b.*\b(dm-[0-9]{1,2}\d?)\b</td> <td><option>recon_cache_path</option> = <replaceable>/var/cache/swift</replaceable></td>
<td>Directory where stats for a few items will be stored</td>
</tr>
<tr>
<td><option>regex_pattern_1</option> = <replaceable>\berror\b.*\b(dm-[0-9]{1,2}\d?)\b</replaceable></td>
<td>No help text available for this option.</td>
</tr>
<tr>
<td><option>unmount_failed_device</option> = <replaceable>True</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
</tbody> </tbody>

30
doc/common/tables/swift-memcache-memcache.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[memcache]</literal> in <literal>memcache.conf</literal> <literal>[memcache]</literal> in <filename>memcache.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,17 +17,33 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>memcache_max_connections = 2</td> <td><option>connect_timeout</option> = <replaceable>0.3</replaceable></td>
<td>Max number of connections to each memcached server per worker services</td>
</tr>
<tr>
<td>memcache_serialization_support = 2</td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>memcache_servers = 127.0.0.1:11211</td> <td><option>io_timeout</option> = <replaceable>2.0</replaceable></td>
<td>No help text available for this option.</td>
</tr>
<tr>
<td><option>memcache_max_connections</option> = <replaceable>2</replaceable></td>
<td>Max number of connections to each memcached server per worker services</td>
</tr>
<tr>
<td><option>memcache_serialization_support</option> = <replaceable>2</replaceable></td>
<td>No help text available for this option.</td>
</tr>
<tr>
<td><option>memcache_servers</option> = <replaceable>127.0.0.1:11211</replaceable></td>
<td>Comma separated list of memcached servers ip:port services</td> <td>Comma separated list of memcached servers ip:port services</td>
</tr> </tr>
<tr>
<td><option>pool_timeout</option> = <replaceable>1.0</replaceable></td>
<td>No help text available for this option.</td>
</tr>
<tr>
<td><option>tries</option> = <replaceable>3</replaceable></td>
<td>No help text available for this option.</td>
</tr>
</tbody> </tbody>
</table> </table>
</para> </para>

32
doc/common/tables/swift-object-expirer-DEFAULT.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[DEFAULT]</literal> in <literal>object-expirer.conf</literal> <literal>[DEFAULT]</literal> in <filename>object-expirer.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,66 +17,66 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>log_address = /dev/log</td> <td><option>log_address</option> = <replaceable>/dev/log</replaceable></td>
<td>Location where syslog sends the logs to</td> <td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>log_custom_handlers = </td> <td><option>log_custom_handlers</option> = <replaceable></replaceable></td>
<td>Comma-separated list of functions to call to setup custom log handlers.</td> <td>Comma-separated list of functions to call to setup custom log handlers.</td>
</tr> </tr>
<tr> <tr>
<td>log_facility = LOG_LOCAL0</td> <td><option>log_facility</option> = <replaceable>LOG_LOCAL0</replaceable></td>
<td>Syslog log facility</td> <td>Syslog log facility</td>
</tr> </tr>
<tr> <tr>
<td>log_level = INFO</td> <td><option>log_level</option> = <replaceable>INFO</replaceable></td>
<td>Logging level</td> <td>Logging level</td>
</tr> </tr>
<tr> <tr>
<td>log_max_line_length = 0</td> <td><option>log_max_line_length</option> = <replaceable>0</replaceable></td>
<td>Caps the length of log lines to the value given; no limit if set to 0, the default.</td> <td>Caps the length of log lines to the value given; no limit if set to 0, the default.</td>
</tr> </tr>
<tr> <tr>
<td>log_name = swift</td> <td><option>log_name</option> = <replaceable>swift</replaceable></td>
<td>Label used when logging</td> <td>Label used when logging</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_default_sample_rate = 1.0</td> <td><option>log_statsd_default_sample_rate</option> = <replaceable>1.0</replaceable></td>
<td>Defines the probability of sending a sample for any given event or <td>Defines the probability of sending a sample for any given event or
timing measurement.</td> timing measurement.</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_host = localhost</td> <td><option>log_statsd_host</option> = <replaceable>localhost</replaceable></td>
<td>If not set, the StatsD feature is disabled.</td> <td>If not set, the StatsD feature is disabled.</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_metric_prefix = </td> <td><option>log_statsd_metric_prefix</option> = <replaceable></replaceable></td>
<td>Value will be prepended to every metric sent to the StatsD server.</td> <td>Value will be prepended to every metric sent to the StatsD server.</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_port = 8125</td> <td><option>log_statsd_port</option> = <replaceable>8125</replaceable></td>
<td>Port value for the StatsD server.</td> <td>Port value for the StatsD server.</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_sample_rate_factor = 1.0</td> <td><option>log_statsd_sample_rate_factor</option> = <replaceable>1.0</replaceable></td>
<td>Not recommended to set this to a value less than 1.0, if frequency <td>Not recommended to set this to a value less than 1.0, if frequency
of logging is too high, tune the of logging is too high, tune the
log_statsd_default_sample_rate instead.</td> log_statsd_default_sample_rate instead.</td>
</tr> </tr>
<tr> <tr>
<td>log_udp_host = </td> <td><option>log_udp_host</option> = <replaceable></replaceable></td>
<td>If not set, the UDP receiver for syslog is disabled.</td> <td>If not set, the UDP receiver for syslog is disabled.</td>
</tr> </tr>
<tr> <tr>
<td>log_udp_port = 514</td> <td><option>log_udp_port</option> = <replaceable>514</replaceable></td>
<td>Port value for UDP receiver, if enabled.</td> <td>Port value for UDP receiver, if enabled.</td>
</tr> </tr>
<tr> <tr>
<td>swift_dir = /etc/swift</td> <td><option>swift_dir</option> = <replaceable>/etc/swift</replaceable></td>
<td>Swift configuration directory</td> <td>Swift configuration directory</td>
</tr> </tr>
<tr> <tr>
<td>user = swift</td> <td><option>user</option> = <replaceable>swift</replaceable></td>
<td>User to run as</td> <td>User to run as</td>
</tr> </tr>
</tbody> </tbody>

4
doc/common/tables/swift-object-expirer-app-proxy-server.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[app-proxy-server]</literal> in <literal>object-expirer.conf</literal> <literal>[app-proxy-server]</literal> in <filename>object-expirer.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,7 +17,7 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>use = egg:swift#proxy</td> <td><option>use</option> = <replaceable>egg:swift#proxy</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

4
doc/common/tables/swift-object-expirer-filter-cache.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-cache]</literal> in <literal>object-expirer.conf</literal> <literal>[filter-cache]</literal> in <filename>object-expirer.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,7 +17,7 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>use = egg:swift#memcache</td> <td><option>use</option> = <replaceable>egg:swift#memcache</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

4
doc/common/tables/swift-object-expirer-filter-catch_errors.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-catch_errors]</literal> in <literal>object-expirer.conf</literal> <literal>[filter-catch_errors]</literal> in <filename>object-expirer.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,7 +17,7 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>use = egg:swift#catch_errors</td> <td><option>use</option> = <replaceable>egg:swift#catch_errors</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

36
doc/common/tables/swift-object-expirer-filter-proxy-logging.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-proxy-logging]</literal> in <literal>object-expirer.conf</literal> <literal>[filter-proxy-logging]</literal> in <filename>object-expirer.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,69 +17,69 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>access_log_address = /dev/log</td> <td><option>access_log_address</option> = <replaceable>/dev/log</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>access_log_facility = LOG_LOCAL0</td> <td><option>access_log_facility</option> = <replaceable>LOG_LOCAL0</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>access_log_headers = false</td> <td><option>access_log_headers</option> = <replaceable>false</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>access_log_headers_only = </td> <td><option>access_log_headers_only</option> = <replaceable></replaceable></td>
<td>If access_log_headers is True and access_log_headers_only is set only <td>If access_log_headers is True and access_log_headers_only is set only
these headers are logged. Multiple headers can be defined as comma separated list like this: these headers are logged. Multiple headers can be defined as comma separated list like this:
access_log_headers_only = Host, X-Object-Meta-Mtime</td> access_log_headers_only = Host, X-Object-Meta-Mtime</td>
</tr> </tr>
<tr> <tr>
<td>access_log_level = INFO</td> <td><option>access_log_level</option> = <replaceable>INFO</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>access_log_name = swift</td> <td><option>access_log_name</option> = <replaceable>swift</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>access_log_statsd_default_sample_rate = 1.0</td> <td><option>access_log_statsd_default_sample_rate</option> = <replaceable>1.0</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>access_log_statsd_host = localhost</td> <td><option>access_log_statsd_host</option> = <replaceable>localhost</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>access_log_statsd_metric_prefix = </td> <td><option>access_log_statsd_metric_prefix</option> = <replaceable></replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>access_log_statsd_port = 8125</td> <td><option>access_log_statsd_port</option> = <replaceable>8125</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>access_log_statsd_sample_rate_factor = 1.0</td> <td><option>access_log_statsd_sample_rate_factor</option> = <replaceable>1.0</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>access_log_udp_host = </td> <td><option>access_log_udp_host</option> = <replaceable></replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>access_log_udp_port = 514</td> <td><option>access_log_udp_port</option> = <replaceable>514</replaceable></td>
<td>No help text available for this option.</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><option>log_statsd_valid_http_methods</option> = <replaceable>GET,HEAD,POST,PUT,DELETE,COPY,OPTIONS</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>logged with access_log_headers = True.</td> <td><option>logged with access_log_headers</option> = <replaceable>True.</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>reveal_sensitive_prefix = 16</td> <td><option>reveal_sensitive_prefix</option> = <replaceable>16</replaceable></td>
<td>The X-Auth-Token is sensitive data. If revealed to an unauthorised person, <td>The X-Auth-Token is sensitive data. If revealed to an unauthorised person,
they can now make requests against an account until the token expires. they can now make requests against an account until the token expires.
@ -88,7 +88,7 @@
Or, set to 0 to completely remove the token.</td> Or, set to 0 to completely remove the token.</td>
</tr> </tr>
<tr> <tr>
<td>use = egg:swift#proxy_logging</td> <td><option>use</option> = <replaceable>egg:swift#proxy_logging</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

20
doc/common/tables/swift-object-expirer-object-expirer.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[object-expirer]</literal> in <literal>object-expirer.conf</literal> <literal>[object-expirer]</literal> in <filename>object-expirer.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,41 +17,41 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>auto_create_account_prefix = .</td> <td><option>auto_create_account_prefix</option> = <replaceable>.</replaceable></td>
<td>Prefix to use when automatically creating accounts</td> <td>Prefix to use when automatically creating accounts</td>
</tr> </tr>
<tr> <tr>
<td>concurrency = 1</td> <td><option>concurrency</option> = <replaceable>1</replaceable></td>
<td>Number of replication workers to spawn</td> <td>Number of replication workers to spawn</td>
</tr> </tr>
<tr> <tr>
<td>expiring_objects_account_name = expiring_objects</td> <td><option>expiring_objects_account_name</option> = <replaceable>expiring_objects</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>interval = 300</td> <td><option>interval</option> = <replaceable>300</replaceable></td>
<td>Minimum time for a pass to take</td> <td>Minimum time for a pass to take</td>
</tr> </tr>
<tr> <tr>
<td>process = 0</td> <td><option>process</option> = <replaceable>0</replaceable></td>
<td>(it will actually accept(2) N + 1). Setting this to one (1) will <td>(it will actually accept(2) N + 1). Setting this to one (1) will
only handle one request at a time, without only handle one request at a time, without
accepting another request concurrently.</td> accepting another request concurrently.</td>
</tr> </tr>
<tr> <tr>
<td>processes = 0</td> <td><option>processes</option> = <replaceable>0</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>reclaim_age = 604800</td> <td><option>reclaim_age</option> = <replaceable>604800</replaceable></td>
<td>Time elapsed in seconds before an object can be reclaimed</td> <td>Time elapsed in seconds before an object can be reclaimed</td>
</tr> </tr>
<tr> <tr>
<td>recon_cache_path = /var/cache/swift</td> <td><option>recon_cache_path</option> = <replaceable>/var/cache/swift</replaceable></td>
<td>Directory where stats for a few items will be stored</td> <td>Directory where stats for a few items will be stored</td>
</tr> </tr>
<tr> <tr>
<td>report_interval = 300</td> <td><option>report_interval</option> = <replaceable>300</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
</tbody> </tbody>

4
doc/common/tables/swift-object-expirer-pipeline-main.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[pipeline-main]</literal> in <literal>object-expirer.conf</literal> <literal>[pipeline-main]</literal> in <filename>object-expirer.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,7 +17,7 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>pipeline = catch_errors proxy-logging cache proxy-server</td> <td><option>pipeline</option> = <replaceable>catch_errors proxy-logging cache proxy-server</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
</tbody> </tbody>

68
doc/common/tables/swift-object-server-DEFAULT.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[DEFAULT]</literal> in <literal>object-server.conf</literal> <literal>[DEFAULT]</literal> in <filename>object-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,114 +17,114 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>backlog = 4096</td> <td><option>backlog</option> = <replaceable>4096</replaceable></td>
<td>Maximum number of allowed pending TCP connections</td> <td>Maximum number of allowed pending TCP connections</td>
</tr> </tr>
<tr> <tr>
<td>bind_ip = 0.0.0.0</td> <td><option>bind_ip</option> = <replaceable>0.0.0.0</replaceable></td>
<td>IP Address for server to bind to</td> <td>IP Address for server to bind to</td>
</tr> </tr>
<tr> <tr>
<td>bind_port = 6000</td> <td><option>bind_port</option> = <replaceable>6000</replaceable></td>
<td>Port for server to bind to</td> <td>Port for server to bind to</td>
</tr> </tr>
<tr> <tr>
<td>bind_timeout = 30</td> <td><option>bind_timeout</option> = <replaceable>30</replaceable></td>
<td>Seconds to attempt bind before giving up</td> <td>Seconds to attempt bind before giving up</td>
</tr> </tr>
<tr> <tr>
<td>client_timeout = 60</td> <td><option>client_timeout</option> = <replaceable>60</replaceable></td>
<td>Timeout to read one chunk from a client external services</td> <td>Timeout to read one chunk from a client external services</td>
</tr> </tr>
<tr> <tr>
<td>conn_timeout = 0.5</td> <td><option>conn_timeout</option> = <replaceable>0.5</replaceable></td>
<td>Connection timeout to external services</td> <td>Connection timeout to external services</td>
</tr> </tr>
<tr> <tr>
<td>devices = /srv/node</td> <td><option>devices</option> = <replaceable>/srv/node</replaceable></td>
<td>Parent directory of where devices are mounted</td> <td>Parent directory of where devices are mounted</td>
</tr> </tr>
<tr> <tr>
<td>disable_fallocate = false</td> <td><option>disable_fallocate</option> = <replaceable>false</replaceable></td>
<td>Disable "fast fail" fallocate checks if the underlying filesystem does not support it.</td> <td>Disable "fast fail" fallocate checks if the underlying filesystem does not support it.</td>
</tr> </tr>
<tr> <tr>
<td>disk_chunk_size = 65536</td> <td><option>disk_chunk_size</option> = <replaceable>65536</replaceable></td>
<td>Size of chunks to read/write to disk</td> <td>Size of chunks to read/write to disk</td>
</tr> </tr>
<tr> <tr>
<td>eventlet_debug = false</td> <td><option>eventlet_debug</option> = <replaceable>false</replaceable></td>
<td>If true, turn on debug logging for eventlet</td> <td>If true, turn on debug logging for eventlet</td>
</tr> </tr>
<tr> <tr>
<td>expiring_objects_account_name = expiring_objects</td> <td><option>expiring_objects_account_name</option> = <replaceable>expiring_objects</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>expiring_objects_container_divisor = 86400</td> <td><option>expiring_objects_container_divisor</option> = <replaceable>86400</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>fallocate_reserve = 0</td> <td><option>fallocate_reserve</option> = <replaceable>0</replaceable></td>
<td>You can set fallocate_reserve to the number of bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#object`.</td> <td>You can set fallocate_reserve to the number of bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#object`.</td>
</tr> </tr>
<tr> <tr>
<td>log_address = /dev/log</td> <td><option>log_address</option> = <replaceable>/dev/log</replaceable></td>
<td>Location where syslog sends the logs to</td> <td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>log_custom_handlers = </td> <td><option>log_custom_handlers</option> = <replaceable></replaceable></td>
<td>Comma-separated list of functions to call to setup custom log handlers.</td> <td>Comma-separated list of functions to call to setup custom log handlers.</td>
</tr> </tr>
<tr> <tr>
<td>log_facility = LOG_LOCAL0</td> <td><option>log_facility</option> = <replaceable>LOG_LOCAL0</replaceable></td>
<td>Syslog log facility</td> <td>Syslog log facility</td>
</tr> </tr>
<tr> <tr>
<td>log_level = INFO</td> <td><option>log_level</option> = <replaceable>INFO</replaceable></td>
<td>Logging level</td> <td>Logging level</td>
</tr> </tr>
<tr> <tr>
<td>log_max_line_length = 0</td> <td><option>log_max_line_length</option> = <replaceable>0</replaceable></td>
<td>Caps the length of log lines to the value given; no limit if set to 0, the default.</td> <td>Caps the length of log lines to the value given; no limit if set to 0, the default.</td>
</tr> </tr>
<tr> <tr>
<td>log_name = swift</td> <td><option>log_name</option> = <replaceable>swift</replaceable></td>
<td>Label used when logging</td> <td>Label used when logging</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_default_sample_rate = 1.0</td> <td><option>log_statsd_default_sample_rate</option> = <replaceable>1.0</replaceable></td>
<td>Defines the probability of sending a sample for any given event or <td>Defines the probability of sending a sample for any given event or
timing measurement.</td> timing measurement.</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_host = localhost</td> <td><option>log_statsd_host</option> = <replaceable>localhost</replaceable></td>
<td>If not set, the StatsD feature is disabled.</td> <td>If not set, the StatsD feature is disabled.</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_metric_prefix = </td> <td><option>log_statsd_metric_prefix</option> = <replaceable></replaceable></td>
<td>Value will be prepended to every metric sent to the StatsD server.</td> <td>Value will be prepended to every metric sent to the StatsD server.</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_port = 8125</td> <td><option>log_statsd_port</option> = <replaceable>8125</replaceable></td>
<td>Port value for the StatsD server.</td> <td>Port value for the StatsD server.</td>
</tr> </tr>
<tr> <tr>
<td>log_statsd_sample_rate_factor = 1.0</td> <td><option>log_statsd_sample_rate_factor</option> = <replaceable>1.0</replaceable></td>
<td>Not recommended to set this to a value less than 1.0, if frequency <td>Not recommended to set this to a value less than 1.0, if frequency
of logging is too high, tune the of logging is too high, tune the
log_statsd_default_sample_rate instead.</td> log_statsd_default_sample_rate instead.</td>
</tr> </tr>
<tr> <tr>
<td>log_udp_host = </td> <td><option>log_udp_host</option> = <replaceable></replaceable></td>
<td>If not set, the UDP receiver for syslog is disabled.</td> <td>If not set, the UDP receiver for syslog is disabled.</td>
</tr> </tr>
<tr> <tr>
<td>log_udp_port = 514</td> <td><option>log_udp_port</option> = <replaceable>514</replaceable></td>
<td>Port value for UDP receiver, if enabled.</td> <td>Port value for UDP receiver, if enabled.</td>
</tr> </tr>
<tr> <tr>
<td>max_clients = 1024</td> <td><option>max_clients</option> = <replaceable>1024</replaceable></td>
<td>Maximum number of clients one worker can process simultaneously <td>Maximum number of clients one worker can process simultaneously
Lowering the number of clients handled per worker, and raising the Lowering the number of clients handled per worker, and raising the
number of workers can lessen the impact that a CPU intensive, or number of workers can lessen the impact that a CPU intensive, or
@ -135,27 +135,27 @@ other workers a chance to process it.
</td> </td>
</tr> </tr>
<tr> <tr>
<td>mount_check = true</td> <td><option>mount_check</option> = <replaceable>true</replaceable></td>
<td>Whether or not check if the devices are mounted to prevent accidentally writing to the root device</td> <td>Whether or not check if the devices are mounted to prevent accidentally writing to the root device</td>
</tr> </tr>
<tr> <tr>
<td>network_chunk_size = 65536</td> <td><option>network_chunk_size</option> = <replaceable>65536</replaceable></td>
<td>Size of chunks to read/write over the network</td> <td>Size of chunks to read/write over the network</td>
</tr> </tr>
<tr> <tr>
<td>node_timeout = 3</td> <td><option>node_timeout</option> = <replaceable>3</replaceable></td>
<td>Request timeout to external services</td> <td>Request timeout to external services</td>
</tr> </tr>
<tr> <tr>
<td>swift_dir = /etc/swift</td> <td><option>swift_dir</option> = <replaceable>/etc/swift</replaceable></td>
<td>Swift configuration directory</td> <td>Swift configuration directory</td>
</tr> </tr>
<tr> <tr>
<td>user = swift</td> <td><option>user</option> = <replaceable>swift</replaceable></td>
<td>User to run as</td> <td>User to run as</td>
</tr> </tr>
<tr> <tr>
<td>workers = auto</td> <td><option>workers</option> = <replaceable>auto</replaceable></td>
<td>a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.</td> <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>
</tbody> </tbody>

44
doc/common/tables/swift-object-server-app-object-server.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[app-object-server]</literal> in <literal>object-server.conf</literal> <literal>[app-object-server]</literal> in <filename>object-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,87 +17,87 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>allowed_headers = Content-Disposition, Content-Encoding, X-Delete-At, X-Object-Manifest, X-Static-Large-Object</td> <td><option>allowed_headers</option> = <replaceable>Content-Disposition, Content-Encoding, X-Delete-At, X-Object-Manifest, X-Static-Large-Object</replaceable></td>
<td>Comma-separated list of headers that can be set in metadata of an 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><option>auto_create_account_prefix</option> = <replaceable>.</replaceable></td>
<td>Prefix to use when automatically creating accounts</td> <td>Prefix to use when automatically creating accounts</td>
</tr> </tr>
<tr> <tr>
<td>keep_cache_private = false</td> <td><option>keep_cache_private</option> = <replaceable>false</replaceable></td>
<td>Allow non-public objects to stay in kernel's buffer cache</td> <td>Allow non-public objects to stay in kernel's buffer cache</td>
</tr> </tr>
<tr> <tr>
<td>keep_cache_size = 5424880</td> <td><option>keep_cache_size</option> = <replaceable>5242880</replaceable></td>
<td>Largest object size to keep in buffer cache</td> <td>Largest object size to keep in buffer cache</td>
</tr> </tr>
<tr> <tr>
<td>max_upload_time = 86400</td> <td><option>max_upload_time</option> = <replaceable>86400</replaceable></td>
<td>Maximum time allowed to upload an object</td> <td>Maximum time allowed to upload an object</td>
</tr> </tr>
<tr> <tr>
<td>mb_per_sync = 512</td> <td><option>mb_per_sync</option> = <replaceable>512</replaceable></td>
<td>On PUT requests, sync file every n MB</td> <td>On PUT requests, sync file every n MB</td>
</tr> </tr>
<tr> <tr>
<td>replication_concurrency = 4</td> <td><option>replication_concurrency</option> = <replaceable>4</replaceable></td>
<td>Set to restrict the number of concurrent incoming REPLICATION requests; set to 0 for unlimited</td> <td>Set to restrict the number of concurrent incoming REPLICATION requests; set to 0 for unlimited</td>
</tr> </tr>
<tr> <tr>
<td>replication_failure_ratio = 1.0</td> <td><option>replication_failure_ratio</option> = <replaceable>1.0</replaceable></td>
<td>If the value of failures / successes of REPLICATION subrequests exceeds this ratio, the overall REPLICATION request will be aborted</td> <td>If the value of failures / successes of REPLICATION subrequests exceeds this ratio, the overall REPLICATION request will be aborted</td>
</tr> </tr>
<tr> <tr>
<td>replication_failure_threshold = 100</td> <td><option>replication_failure_threshold</option> = <replaceable>100</replaceable></td>
<td>The number of subrequest failures before the replication_failure_ratio is checked</td> <td>The number of subrequest failures before the replication_failure_ratio is checked</td>
</tr> </tr>
<tr> <tr>
<td>replication_lock_timeout = 15</td> <td><option>replication_lock_timeout</option> = <replaceable>15</replaceable></td>
<td>Number of seconds to wait for an existing replication device lock before giving up.</td> <td>Number of seconds to wait for an existing replication device lock before giving up.</td>
</tr> </tr>
<tr> <tr>
<td>replication_one_per_device = True</td> <td><option>replication_one_per_device</option> = <replaceable>True</replaceable></td>
<td>Restricts incoming REPLICATION requests to one per device, replication_currency above allowing. This can help control I/O to each device, but you may wish to set this to False to allow multiple REPLICATION requests (up to the above replication_concurrency setting) per device.</td> <td>Restricts incoming REPLICATION requests to one per device, replication_currency above allowing. This can help control I/O to each device, but you may wish to set this to False to allow multiple REPLICATION requests (up to the above replication_concurrency setting) per device.</td>
</tr> </tr>
<tr> <tr>
<td>replication_server = false</td> <td><option>replication_server</option> = <replaceable>false</replaceable></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>If defined, tells server how to handle replication verbs in requests. When set to True (or 1), only replication verbs will be accepted. When set to False, replication verbs will be rejected. When undefined, server will accept any verb in the request.</td>
</tr> </tr>
<tr> <tr>
<td>set log_address = /dev/log</td> <td><option>set log_address</option> = <replaceable>/dev/log</replaceable></td>
<td>Location where syslog sends the logs to</td> <td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>set log_facility = LOG_LOCAL0</td> <td><option>set log_facility</option> = <replaceable>LOG_LOCAL0</replaceable></td>
<td>Syslog log facility</td> <td>Syslog log facility</td>
</tr> </tr>
<tr> <tr>
<td>set log_level = INFO</td> <td><option>set log_level</option> = <replaceable>INFO</replaceable></td>
<td>Log level</td> <td>Log level</td>
</tr> </tr>
<tr> <tr>
<td>set log_name = object-server</td> <td><option>set log_name</option> = <replaceable>object-server</replaceable></td>
<td>Label to use when logging</td> <td>Label to use when logging</td>
</tr> </tr>
<tr> <tr>
<td>set log_requests = true</td> <td><option>set log_requests</option> = <replaceable>true</replaceable></td>
<td>Whether or not to log requests</td> <td>Whether or not to log requests</td>
</tr> </tr>
<tr> <tr>
<td>slow = 0</td> <td><option>slow</option> = <replaceable>0</replaceable></td>
<td>If &gt; 0, Minimum time in seconds for a PUT or DELETE request to complete</td> <td>If &gt; 0, Minimum time in seconds for a PUT or DELETE request to complete</td>
</tr> </tr>
<tr> <tr>
<td>splice = no</td> <td><option>splice</option> = <replaceable>no</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>threads_per_disk = 0</td> <td><option>threads_per_disk</option> = <replaceable>0</replaceable></td>
<td>Size of the per-disk thread pool used for performing disk I/O. The default of 0 means to not use a per-disk thread pool. It is recommended to keep this value small, as large values can result in high read latencies due to large queue depths. A good starting point is 4 threads per disk.</td> <td>Size of the per-disk thread pool used for performing disk I/O. The default of 0 means to not use a per-disk thread pool. It is recommended to keep this value small, as large values can result in high read latencies due to large queue depths. A good starting point is 4 threads per disk.</td>
</tr> </tr>
<tr> <tr>
<td>use = egg:swift#object</td> <td><option>use</option> = <replaceable>egg:swift#object</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

6
doc/common/tables/swift-object-server-filter-healthcheck.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-healthcheck]</literal> in <literal>object-server.conf</literal> <literal>[filter-healthcheck]</literal> in <filename>object-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,11 +17,11 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>disable_path = </td> <td><option>disable_path</option> = <replaceable></replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>use = egg:swift#healthcheck</td> <td><option>use</option> = <replaceable>egg:swift#healthcheck</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

8
doc/common/tables/swift-object-server-filter-recon.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-recon]</literal> in <literal>object-server.conf</literal> <literal>[filter-recon]</literal> in <filename>object-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,15 +17,15 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>recon_cache_path = /var/cache/swift</td> <td><option>recon_cache_path</option> = <replaceable>/var/cache/swift</replaceable></td>
<td>Directory where stats for a few items will be stored</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><option>recon_lock_path</option> = <replaceable>/var/lock</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>use = egg:swift#recon</td> <td><option>use</option> = <replaceable>egg:swift#recon</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

18
doc/common/tables/swift-object-server-filter-xprofile.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-xprofile]</literal> in <literal>object-server.conf</literal> <literal>[filter-xprofile]</literal> in <filename>object-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,35 +17,35 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>dump_interval = 5.0</td> <td><option>dump_interval</option> = <replaceable>5.0</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>dump_timestamp = false</td> <td><option>dump_timestamp</option> = <replaceable>false</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>flush_at_shutdown = false</td> <td><option>flush_at_shutdown</option> = <replaceable>false</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>log_filename_prefix = /tmp/log/swift/profile/default.profile</td> <td><option>log_filename_prefix</option> = <replaceable>/tmp/log/swift/profile/default.profile</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>path = /__profile__</td> <td><option>path</option> = <replaceable>/__profile__</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>profile_module = eventlet.green.profile</td> <td><option>profile_module</option> = <replaceable>eventlet.green.profile</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>unwind = false</td> <td><option>unwind</option> = <replaceable>false</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>use = egg:swift#xprofile</td> <td><option>use</option> = <replaceable>egg:swift#xprofile</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

26
doc/common/tables/swift-object-server-object-auditor.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[object-auditor]</literal> in <literal>object-server.conf</literal> <literal>[object-auditor]</literal> in <filename>object-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,51 +17,51 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>bytes_per_second = 10000000</td> <td><option>bytes_per_second</option> = <replaceable>10000000</replaceable></td>
<td>Maximum bytes audited per second. Should be tuned according to individual system specs. 0 is unlimited. mounted to prevent accidentally writing to the root device process simultaneously (it will actually accept(2) N + 1). Setting this to one (1) will only handle one request at a time, without accepting another request concurrently. By increasing the number of workers to a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests. underlying filesystem does not support it. to setup custom log handlers. bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. container server. For most cases, this should be `egg:swift#container`.</td> <td>Maximum bytes audited per second. Should be tuned according to individual system specs. 0 is unlimited. mounted to prevent accidentally writing to the root device process simultaneously (it will actually accept(2) N + 1). Setting this to one (1) will only handle one request at a time, without accepting another request concurrently. By increasing the number of workers to a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests. underlying filesystem does not support it. to setup custom log handlers. bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. container server. For most cases, this should be `egg:swift#container`.</td>
</tr> </tr>
<tr> <tr>
<td>concurrency = 1</td> <td><option>concurrency</option> = <replaceable>1</replaceable></td>
<td>Number of replication workers to spawn</td> <td>Number of replication workers to spawn</td>
</tr> </tr>
<tr> <tr>
<td>disk_chunk_size = 65536</td> <td><option>disk_chunk_size</option> = <replaceable>65536</replaceable></td>
<td>Size of chunks to read/write to disk</td> <td>Size of chunks to read/write to disk</td>
</tr> </tr>
<tr> <tr>
<td>files_per_second = 20</td> <td><option>files_per_second</option> = <replaceable>20</replaceable></td>
<td>Maximum files audited per second. Should be tuned according to individual system specs. 0 is unlimited.</td> <td>Maximum files audited per second. Should be tuned according to individual system specs. 0 is unlimited.</td>
</tr> </tr>
<tr> <tr>
<td>log_address = /dev/log</td> <td><option>log_address</option> = <replaceable>/dev/log</replaceable></td>
<td>Location where syslog sends the logs to</td> <td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>log_facility = LOG_LOCAL0</td> <td><option>log_facility</option> = <replaceable>LOG_LOCAL0</replaceable></td>
<td>Syslog log facility</td> <td>Syslog log facility</td>
</tr> </tr>
<tr> <tr>
<td>log_level = INFO</td> <td><option>log_level</option> = <replaceable>INFO</replaceable></td>
<td>Logging level</td> <td>Logging level</td>
</tr> </tr>
<tr> <tr>
<td>log_name = object-auditor</td> <td><option>log_name</option> = <replaceable>object-auditor</replaceable></td>
<td>Label used when logging</td> <td>Label used when logging</td>
</tr> </tr>
<tr> <tr>
<td>log_time = 3600</td> <td><option>log_time</option> = <replaceable>3600</replaceable></td>
<td>Frequency of status logs in seconds.</td> <td>Frequency of status logs in seconds.</td>
</tr> </tr>
<tr> <tr>
<td>object_size_stats = </td> <td><option>object_size_stats</option> = <replaceable></replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>recon_cache_path = /var/cache/swift</td> <td><option>recon_cache_path</option> = <replaceable>/var/cache/swift</replaceable></td>
<td>Directory where stats for a few items will be stored</td> <td>Directory where stats for a few items will be stored</td>
</tr> </tr>
<tr> <tr>
<td>zero_byte_files_per_second = 50</td> <td><option>zero_byte_files_per_second</option> = <replaceable>50</replaceable></td>
<td>Maximum zero byte files audited per second.</td> <td>Maximum zero byte files audited per second.</td>
</tr> </tr>
</tbody> </tbody>

46
doc/common/tables/swift-object-server-object-replicator.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[object-replicator]</literal> in <literal>object-server.conf</literal> <literal>[object-replicator]</literal> in <filename>object-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,91 +17,91 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>concurrency = 1</td> <td><option>concurrency</option> = <replaceable>1</replaceable></td>
<td>Number of replication workers to spawn</td> <td>Number of replication workers to spawn</td>
</tr> </tr>
<tr> <tr>
<td>daemonize = on</td> <td><option>daemonize</option> = <replaceable>on</replaceable></td>
<td>Whether or not to run replication as a daemon</td> <td>Whether or not to run replication as a daemon</td>
</tr> </tr>
<tr> <tr>
<td>handoff_delete = auto</td> <td><option>handoff_delete</option> = <replaceable>auto</replaceable></td>
<td>By default handoff partitions will be removed when it has successfully replicated to all the canonical nodes. If set to an integer n, it will remove the partition if it is successfully replicated to n nodes. The default setting should not be changed, except for extremem situations. This uses what's set here, or what's set in the DEFAULT section, or 10 (though other sections use 3 as the final default).</td> <td>By default handoff partitions will be removed when it has successfully replicated to all the canonical nodes. If set to an integer n, it will remove the partition if it is successfully replicated to n nodes. The default setting should not be changed, except for extremem situations. This uses what's set here, or what's set in the DEFAULT section, or 10 (though other sections use 3 as the final default).</td>
</tr> </tr>
<tr> <tr>
<td>handoffs_first = False</td> <td><option>handoffs_first</option> = <replaceable>False</replaceable></td>
<td>If set to True, partitions that are not supposed to be on the node will be replicated first. The default setting should not be changed, except for extreme situations.</td> <td>If set to True, partitions that are not supposed to be on the node will be replicated first. The default setting should not be changed, except for extreme situations.</td>
</tr> </tr>
<tr> <tr>
<td>http_timeout = 60</td> <td><option>http_timeout</option> = <replaceable>60</replaceable></td>
<td>Maximum duration for an HTTP request</td> <td>Maximum duration for an HTTP request</td>
</tr> </tr>
<tr> <tr>
<td>lockup_timeout = 1800</td> <td><option>lockup_timeout</option> = <replaceable>1800</replaceable></td>
<td>Attempts to kill all workers if nothing replications for lockup_timeout seconds</td> <td>Attempts to kill all workers if nothing replications for lockup_timeout seconds</td>
</tr> </tr>
<tr> <tr>
<td>log_address = /dev/log</td> <td><option>log_address</option> = <replaceable>/dev/log</replaceable></td>
<td>Location where syslog sends the logs to</td> <td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>log_facility = LOG_LOCAL0</td> <td><option>log_facility</option> = <replaceable>LOG_LOCAL0</replaceable></td>
<td>Syslog log facility</td> <td>Syslog log facility</td>
</tr> </tr>
<tr> <tr>
<td>log_level = INFO</td> <td><option>log_level</option> = <replaceable>INFO</replaceable></td>
<td>Logging level</td> <td>Logging level</td>
</tr> </tr>
<tr> <tr>
<td>log_name = object-replicator</td> <td><option>log_name</option> = <replaceable>object-replicator</replaceable></td>
<td>Label used when logging</td> <td>Label used when logging</td>
</tr> </tr>
<tr> <tr>
<td>node_timeout = &lt;whatever's in the DEFAULT section or 10&gt;</td> <td><option>node_timeout</option> = <replaceable>&lt;whatever's in the DEFAULT section or 10&gt;</replaceable></td>
<td>Request timeout to external services</td> <td>Request timeout to external services</td>
</tr> </tr>
<tr> <tr>
<td>reclaim_age = 604800</td> <td><option>reclaim_age</option> = <replaceable>604800</replaceable></td>
<td>Time elapsed in seconds before an object can be reclaimed</td> <td>Time elapsed in seconds before an object can be reclaimed</td>
</tr> </tr>
<tr> <tr>
<td>recon_cache_path = /var/cache/swift</td> <td><option>recon_cache_path</option> = <replaceable>/var/cache/swift</replaceable></td>
<td>Directory where stats for a few items will be stored</td> <td>Directory where stats for a few items will be stored</td>
</tr> </tr>
<tr> <tr>
<td>ring_check_interval = 15</td> <td><option>ring_check_interval</option> = <replaceable>15</replaceable></td>
<td>How often (in seconds) to check the ring</td> <td>How often (in seconds) to check the ring</td>
</tr> </tr>
<tr> <tr>
<td>rsync_bwlimit = 0</td> <td><option>rsync_bwlimit</option> = <replaceable>0</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>rsync_error_log_line_length = 0</td> <td><option>rsync_error_log_line_length</option> = <replaceable>0</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>rsync_io_timeout = 30</td> <td><option>rsync_io_timeout</option> = <replaceable>30</replaceable></td>
<td>Passed to rsync for a max duration (seconds) of an I/O op</td> <td>Passed to rsync for a max duration (seconds) of an I/O op</td>
</tr> </tr>
<tr> <tr>
<td>rsync_timeout = 900</td> <td><option>rsync_timeout</option> = <replaceable>900</replaceable></td>
<td>Max duration (seconds) of a partition rsync</td> <td>Max duration (seconds) of a partition rsync</td>
</tr> </tr>
<tr> <tr>
<td>run_pause = 30</td> <td><option>run_pause</option> = <replaceable>30</replaceable></td>
<td>Time in seconds to wait between replication passes</td> <td>Time in seconds to wait between replication passes</td>
</tr> </tr>
<tr> <tr>
<td>stats_interval = 300</td> <td><option>stats_interval</option> = <replaceable>300</replaceable></td>
<td>Interval in seconds between logging replication statistics</td> <td>Interval in seconds between logging replication statistics</td>
</tr> </tr>
<tr> <tr>
<td>sync_method = rsync</td> <td><option>sync_method</option> = <replaceable>rsync</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>vm_test_mode = no</td> <td><option>vm_test_mode</option> = <replaceable>no</replaceable></td>
<td>Indicates that you are using a VM environment</td> <td>Indicates that you are using a VM environment</td>
</tr> </tr>
</tbody> </tbody>

20
doc/common/tables/swift-object-server-object-updater.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[object-updater]</literal> in <literal>object-server.conf</literal> <literal>[object-updater]</literal> in <filename>object-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,39 +17,39 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>concurrency = 1</td> <td><option>concurrency</option> = <replaceable>1</replaceable></td>
<td>Number of replication workers to spawn</td> <td>Number of replication workers to spawn</td>
</tr> </tr>
<tr> <tr>
<td>interval = 300</td> <td><option>interval</option> = <replaceable>300</replaceable></td>
<td>Minimum time for a pass to take</td> <td>Minimum time for a pass to take</td>
</tr> </tr>
<tr> <tr>
<td>log_address = /dev/log</td> <td><option>log_address</option> = <replaceable>/dev/log</replaceable></td>
<td>Location where syslog sends the logs to</td> <td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>log_facility = LOG_LOCAL0</td> <td><option>log_facility</option> = <replaceable>LOG_LOCAL0</replaceable></td>
<td>Syslog log facility</td> <td>Syslog log facility</td>
</tr> </tr>
<tr> <tr>
<td>log_level = INFO</td> <td><option>log_level</option> = <replaceable>INFO</replaceable></td>
<td>Logging level</td> <td>Logging level</td>
</tr> </tr>
<tr> <tr>
<td>log_name = object-updater</td> <td><option>log_name</option> = <replaceable>object-updater</replaceable></td>
<td>Label used when logging</td> <td>Label used when logging</td>
</tr> </tr>
<tr> <tr>
<td>node_timeout = &lt;whatever's in the DEFAULT section or 10&gt;</td> <td><option>node_timeout</option> = <replaceable>&lt;whatever's in the DEFAULT section or 10&gt;</replaceable></td>
<td>Request timeout to external services</td> <td>Request timeout to external services</td>
</tr> </tr>
<tr> <tr>
<td>recon_cache_path = /var/cache/swift</td> <td><option>recon_cache_path</option> = <replaceable>/var/cache/swift</replaceable></td>
<td>Directory where stats for a few items will be stored</td> <td>Directory where stats for a few items will be stored</td>
</tr> </tr>
<tr> <tr>
<td>slowdown = 0.01</td> <td><option>slowdown</option> = <replaceable>0.01</replaceable></td>
<td>Time in seconds to wait between objects</td> <td>Time in seconds to wait between objects</td>
</tr> </tr>
</tbody> </tbody>

4
doc/common/tables/swift-object-server-pipeline-main.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[pipeline-main]</literal> in <literal>object-server.conf</literal> <literal>[pipeline-main]</literal> in <filename>object-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,7 +17,7 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>pipeline = healthcheck recon object-server</td> <td><option>pipeline</option> = <replaceable>healthcheck recon object-server</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
</tbody> </tbody>

70
doc/common/tables/swift-proxy-server-DEFAULT.xml
View File

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

66
doc/common/tables/swift-proxy-server-app-proxy-server.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[app-proxy-server]</literal> in <literal>proxy-server.conf</literal> <literal>[app-proxy-server]</literal> in <filename>proxy-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,131 +17,131 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>account_autocreate = false</td> <td><option>account_autocreate</option> = <replaceable>false</replaceable></td>
<td>If set to 'true' authorized accounts that do not yet exist within the Swift cluster will be automatically created.</td> <td>If set to 'true' authorized accounts that do not yet exist within the Swift cluster will be automatically created.</td>
</tr> </tr>
<tr> <tr>
<td>allow_account_management = false</td> <td><option>allow_account_management</option> = <replaceable>false</replaceable></td>
<td>Whether account PUTs and DELETEs are even callable</td> <td>Whether account PUTs and DELETEs are even callable</td>
</tr> </tr>
<tr> <tr>
<td>auto_create_account_prefix = .</td> <td><option>auto_create_account_prefix</option> = <replaceable>.</replaceable></td>
<td>Prefix to use when automatically creating accounts</td> <td>Prefix to use when automatically creating accounts</td>
</tr> </tr>
<tr> <tr>
<td>client_chunk_size = 65536</td> <td><option>client_chunk_size</option> = <replaceable>65536</replaceable></td>
<td>Chunk size to read from clients</td> <td>Chunk size to read from clients</td>
</tr> </tr>
<tr> <tr>
<td>conn_timeout = 0.5</td> <td><option>conn_timeout</option> = <replaceable>0.5</replaceable></td>
<td>Connection timeout to external services</td> <td>Connection timeout to external services</td>
</tr> </tr>
<tr> <tr>
<td>deny_host_headers = </td> <td><option>deny_host_headers</option> = <replaceable></replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>error_suppression_interval = 60</td> <td><option>error_suppression_interval</option> = <replaceable>60</replaceable></td>
<td>Time in seconds that must elapse since the last error for a node to be considered no longer error limited</td> <td>Time in seconds that must elapse since the last error for a node to be considered no longer error limited</td>
</tr> </tr>
<tr> <tr>
<td>error_suppression_limit = 10</td> <td><option>error_suppression_limit</option> = <replaceable>10</replaceable></td>
<td>Error count to consider a node error limited</td> <td>Error count to consider a node error limited</td>
</tr> </tr>
<tr> <tr>
<td>log_handoffs = true</td> <td><option>log_handoffs</option> = <replaceable>true</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>max_containers_per_account = 0</td> <td><option>max_containers_per_account</option> = <replaceable>0</replaceable></td>
<td>If set to a positive value, trying to create a container when the account already has at least this maximum containers will result in a 403 Forbidden. Note: This is a soft limit, meaning a user might exceed the cap for recheck_account_existence before the 403s kick in.</td> <td>If set to a positive value, trying to create a container when the account already has at least this maximum containers will result in a 403 Forbidden. Note: This is a soft limit, meaning a user might exceed the cap for recheck_account_existence before the 403s kick in.</td>
</tr> </tr>
<tr> <tr>
<td>max_containers_whitelist = </td> <td><option>max_containers_whitelist</option> = <replaceable></replaceable></td>
<td>is a comma separated list of account names that ignore the max_containers_per_account cap.</td> <td>is a comma separated list of account names that ignore the max_containers_per_account cap.</td>
</tr> </tr>
<tr> <tr>
<td>max_large_object_get_time = 86400</td> <td><option>max_large_object_get_time</option> = <replaceable>86400</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>node_timeout = 10</td> <td><option>node_timeout</option> = <replaceable>10</replaceable></td>
<td>Request timeout to external services</td> <td>Request timeout to external services</td>
</tr> </tr>
<tr> <tr>
<td>object_chunk_size = 65536</td> <td><option>object_chunk_size</option> = <replaceable>65536</replaceable></td>
<td>Chunk size to read from object servers</td> <td>Chunk size to read from object servers</td>
</tr> </tr>
<tr> <tr>
<td>object_post_as_copy = true</td> <td><option>object_post_as_copy</option> = <replaceable>true</replaceable></td>
<td>Set object_post_as_copy = false to turn on fast posts where only the metadata changes are stored anew and the original data file is kept in place. This makes for quicker posts; but since the container metadata isn't updated in this mode, features like container sync won't be able to sync posts.</td> <td>Set object_post_as_copy = false to turn on fast posts where only the metadata changes are stored anew and the original data file is kept in place. This makes for quicker posts; but since the container metadata isn't updated in this mode, features like container sync won't be able to sync posts.</td>
</tr> </tr>
<tr> <tr>
<td>post_quorum_timeout = 0.5</td> <td><option>post_quorum_timeout</option> = <replaceable>0.5</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>put_queue_depth = 10</td> <td><option>put_queue_depth</option> = <replaceable>10</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>read_affinity = r1z1=100, r1z2=200, r2=300</td> <td><option>read_affinity</option> = <replaceable>r1z1=100, r1z2=200, r2=300</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>recheck_account_existence = 60</td> <td><option>recheck_account_existence</option> = <replaceable>60</replaceable></td>
<td>Cache timeout in seconds to send memcached for account existence</td> <td>Cache timeout in seconds to send memcached for account existence</td>
</tr> </tr>
<tr> <tr>
<td>recheck_container_existence = 60</td> <td><option>recheck_container_existence</option> = <replaceable>60</replaceable></td>
<td>Cache timeout in seconds to send memcached for container existence</td> <td>Cache timeout in seconds to send memcached for container existence</td>
</tr> </tr>
<tr> <tr>
<td>recoverable_node_timeout = node_timeout</td> <td><option>recoverable_node_timeout</option> = <replaceable>node_timeout</replaceable></td>
<td>Request timeout to external services for requests that, on failure, can be recovered from. For example, object GET. from a client external services</td> <td>Request timeout to external services for requests that, on failure, can be recovered from. For example, object GET. from a client external services</td>
</tr> </tr>
<tr> <tr>
<td>request_node_count = 2 * replicas</td> <td><option>request_node_count</option> = <replaceable>2 * replicas</replaceable></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&gt; 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> <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&gt; 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>set log_address = /dev/log</td> <td><option>set log_address</option> = <replaceable>/dev/log</replaceable></td>
<td>Location where syslog sends the logs to</td> <td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>set log_facility = LOG_LOCAL0</td> <td><option>set log_facility</option> = <replaceable>LOG_LOCAL0</replaceable></td>
<td>Syslog log facility</td> <td>Syslog log facility</td>
</tr> </tr>
<tr> <tr>
<td>set log_level = INFO</td> <td><option>set log_level</option> = <replaceable>INFO</replaceable></td>
<td>Log level</td> <td>Log level</td>
</tr> </tr>
<tr> <tr>
<td>set log_name = proxy-server</td> <td><option>set log_name</option> = <replaceable>proxy-server</replaceable></td>
<td>Label to use when logging</td> <td>Label to use when logging</td>
</tr> </tr>
<tr> <tr>
<td>sorting_method = shuffle</td> <td><option>sorting_method</option> = <replaceable>shuffle</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>swift_owner_headers = x-container-read, x-container-write, x-container-sync-key, x-container-sync-to, x-account-meta-temp-url-key, x-account-meta-temp-url-key-2, x-account-access-control</td> <td><option>swift_owner_headers</option> = <replaceable>x-container-read, x-container-write, x-container-sync-key, x-container-sync-to, x-account-meta-temp-url-key, x-account-meta-temp-url-key-2, x-container-meta-temp-url-key, x-container-meta-temp-url-key-2, x-account-access-control</replaceable></td>
<td>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&gt; 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> <td>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&gt; 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>timing_expiry = 300</td> <td><option>timing_expiry</option> = <replaceable>300</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>use = egg:swift#proxy</td> <td><option>use</option> = <replaceable>egg:swift#proxy</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
<tr> <tr>
<td>write_affinity = </td> <td><option>write_affinity</option> = <replaceable>r1, r2</replaceable></td>
<td>This setting lets you trade data distribution for throughput. It makes the proxy server prefer local back-end servers for object PUT requests over non-local ones. Note that only object PUT requests are affected by the write_affinity setting; POST, GET, HEAD, DELETE, OPTIONS, and account/container PUT requests are not affected. The format is r&lt;N&gt; for region N or r&lt;N&gt;z&lt;M&gt; for region N, zone M. If this is set, then when handling an object PUT request, some number (see the write_affinity_node_count setting) of local backend servers will be tried before any nonlocal ones. Example: try to write to regions 1 and 2 before writing to any other nodes: write_affinity = r1, r2</td> <td>This setting lets you trade data distribution for throughput. It makes the proxy server prefer local back-end servers for object PUT requests over non-local ones. Note that only object PUT requests are affected by the write_affinity setting; POST, GET, HEAD, DELETE, OPTIONS, and account/container PUT requests are not affected. The format is r&lt;N&gt; for region N or r&lt;N&gt;z&lt;M&gt; for region N, zone M. If this is set, then when handling an object PUT request, some number (see the write_affinity_node_count setting) of local backend servers will be tried before any nonlocal ones. Example: try to write to regions 1 and 2 before writing to any other nodes: write_affinity = r1, r2</td>
</tr> </tr>
<tr> <tr>
<td>write_affinity_node_count = </td> <td><option>write_affinity_node_count</option> = <replaceable>2 * replicas</replaceable></td>
<td>This setting is only useful in conjunction with write_affinity; it governs how many local object servers will be tried before falling back to non-local ones. 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: write_affinity_node_count = 2 * replicas</td> <td>This setting is only useful in conjunction with write_affinity; it governs how many local object servers will be tried before falling back to non-local ones. 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: write_affinity_node_count = 2 * replicas</td>
</tr> </tr>
</tbody> </tbody>

4
doc/common/tables/swift-proxy-server-filter-account-quotas.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-account-quotas]</literal> in <literal>proxy-server.conf</literal> <literal>[filter-account-quotas]</literal> in <filename>proxy-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,7 +17,7 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>use = egg:swift#account_quotas</td> <td><option>use</option> = <replaceable>egg:swift#account_quotas</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

26
doc/common/tables/swift-proxy-server-filter-authtoken.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-authtoken]</literal> in <literal>proxy-server.conf</literal> <literal>[filter-authtoken]</literal> in <filename>proxy-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,43 +17,35 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>admin_password = password</td> <td><option>admin_password</option> = <replaceable>password</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>admin_tenant_name = service</td> <td><option>admin_tenant_name</option> = <replaceable>service</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>admin_user = swift</td> <td><option>admin_user</option> = <replaceable>swift</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>auth_host = keystonehost</td> <td><option>auth_uri</option> = <replaceable>http://keystonehost:5000/</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>auth_port = 35357</td> <td><option>cache</option> = <replaceable>swift.cache</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>auth_protocol = http</td> <td><option>delay_auth_decision</option> = <replaceable>False</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>auth_uri = http://keystonehost:5000/</td> <td><option>identity_uri</option> = <replaceable>http://keystonehost:35357/</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>cache = swift.cache</td> <td><option>include_service_catalog</option> = <replaceable>False</replaceable></td>
<td>No help text available for this option.</td>
</tr>
<tr>
<td>delay_auth_decision = 1</td>
<td>No help text available for this option.</td>
</tr>
<tr>
<td>include_service_catalog = False</td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
</tbody> </tbody>

16
doc/common/tables/swift-proxy-server-filter-bulk.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-bulk]</literal> in <literal>proxy-server.conf</literal> <literal>[filter-bulk]</literal> in <filename>proxy-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,31 +17,31 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>delete_container_retry_count = 0</td> <td><option>delete_container_retry_count</option> = <replaceable>0</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>max_containers_per_extraction = 10000</td> <td><option>max_containers_per_extraction</option> = <replaceable>10000</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>max_deletes_per_request = 10000</td> <td><option>max_deletes_per_request</option> = <replaceable>10000</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>max_failed_deletes = 1000</td> <td><option>max_failed_deletes</option> = <replaceable>1000</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>max_failed_extractions = 1000</td> <td><option>max_failed_extractions</option> = <replaceable>1000</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>use = egg:swift#bulk</td> <td><option>use</option> = <replaceable>egg:swift#bulk</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
<tr> <tr>
<td>yield_frequency = 10</td> <td><option>yield_frequency</option> = <replaceable>10</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
</tbody> </tbody>

20
doc/common/tables/swift-proxy-server-filter-cache.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-cache]</literal> in <literal>proxy-server.conf</literal> <literal>[filter-cache]</literal> in <filename>proxy-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,39 +17,39 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>memcache_max_connections = 2</td> <td><option>memcache_max_connections</option> = <replaceable>2</replaceable></td>
<td>Max number of connections to each memcached server per worker services</td> <td>Max number of connections to each memcached server per worker services</td>
</tr> </tr>
<tr> <tr>
<td>memcache_serialization_support = 2</td> <td><option>memcache_serialization_support</option> = <replaceable>2</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>memcache_servers = 127.0.0.1:11211</td> <td><option>memcache_servers</option> = <replaceable>127.0.0.1:11211</replaceable></td>
<td>Comma separated list of memcached servers ip:port services</td> <td>Comma separated list of memcached servers ip:port services</td>
</tr> </tr>
<tr> <tr>
<td>set log_address = /dev/log</td> <td><option>set log_address</option> = <replaceable>/dev/log</replaceable></td>
<td>Location where syslog sends the logs to</td> <td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>set log_facility = LOG_LOCAL0</td> <td><option>set log_facility</option> = <replaceable>LOG_LOCAL0</replaceable></td>
<td>Syslog log facility</td> <td>Syslog log facility</td>
</tr> </tr>
<tr> <tr>
<td>set log_headers = false</td> <td><option>set log_headers</option> = <replaceable>false</replaceable></td>
<td>If True, log headers in each request</td> <td>If True, log headers in each request</td>
</tr> </tr>
<tr> <tr>
<td>set log_level = INFO</td> <td><option>set log_level</option> = <replaceable>INFO</replaceable></td>
<td>Log level</td> <td>Log level</td>
</tr> </tr>
<tr> <tr>
<td>set log_name = cache</td> <td><option>set log_name</option> = <replaceable>cache</replaceable></td>
<td>Label to use when logging</td> <td>Label to use when logging</td>
</tr> </tr>
<tr> <tr>
<td>use = egg:swift#memcache</td> <td><option>use</option> = <replaceable>egg:swift#memcache</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

14
doc/common/tables/swift-proxy-server-filter-catch_errors.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-catch_errors]</literal> in <literal>proxy-server.conf</literal> <literal>[filter-catch_errors]</literal> in <filename>proxy-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,27 +17,27 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>set log_address = /dev/log</td> <td><option>set log_address</option> = <replaceable>/dev/log</replaceable></td>
<td>Location where syslog sends the logs to</td> <td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>set log_facility = LOG_LOCAL0</td> <td><option>set log_facility</option> = <replaceable>LOG_LOCAL0</replaceable></td>
<td>Syslog log facility</td> <td>Syslog log facility</td>
</tr> </tr>
<tr> <tr>
<td>set log_headers = false</td> <td><option>set log_headers</option> = <replaceable>false</replaceable></td>
<td>If True, log headers in each request</td> <td>If True, log headers in each request</td>
</tr> </tr>
<tr> <tr>
<td>set log_level = INFO</td> <td><option>set log_level</option> = <replaceable>INFO</replaceable></td>
<td>Log level</td> <td>Log level</td>
</tr> </tr>
<tr> <tr>
<td>set log_name = catch_errors</td> <td><option>set log_name</option> = <replaceable>catch_errors</replaceable></td>
<td>Label to use when logging</td> <td>Label to use when logging</td>
</tr> </tr>
<tr> <tr>
<td>use = egg:swift#catch_errors</td> <td><option>use</option> = <replaceable>egg:swift#catch_errors</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

18
doc/common/tables/swift-proxy-server-filter-cname_lookup.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-cname_lookup]</literal> in <literal>proxy-server.conf</literal> <literal>[filter-cname_lookup]</literal> in <filename>proxy-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,36 +17,36 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>lookup_depth = 1</td> <td><option>lookup_depth</option> = <replaceable>1</replaceable></td>
<td>Because CNAMES can be recursive, specifies the number of levels through which to search.</td> <td>Because CNAMES can be recursive, specifies the number of levels through which to search.</td>
</tr> </tr>
<tr> <tr>
<td>set log_address = /dev/log</td> <td><option>set log_address</option> = <replaceable>/dev/log</replaceable></td>
<td>Location where syslog sends the logs to</td> <td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>set log_facility = LOG_LOCAL0</td> <td><option>set log_facility</option> = <replaceable>LOG_LOCAL0</replaceable></td>
<td>Syslog log facility</td> <td>Syslog log facility</td>
</tr> </tr>
<tr> <tr>
<td>set log_headers = false</td> <td><option>set log_headers</option> = <replaceable>false</replaceable></td>
<td>If True, log headers in each request</td> <td>If True, log headers in each request</td>
</tr> </tr>
<tr> <tr>
<td>set log_level = INFO</td> <td><option>set log_level</option> = <replaceable>INFO</replaceable></td>
<td>Log level</td> <td>Log level</td>
</tr> </tr>
<tr> <tr>
<td>set log_name = cname_lookup</td> <td><option>set log_name</option> = <replaceable>cname_lookup</replaceable></td>
<td>Label to use when logging</td> <td>Label to use when logging</td>
</tr> </tr>
<tr> <tr>
<td>storage_domain = example.com</td> <td><option>storage_domain</option> = <replaceable>example.com</replaceable></td>
<td>Domain that matches your cloud. Multiple domains can be specified using a comma-separated <td>Domain that matches your cloud. Multiple domains can be specified using a comma-separated
list.</td> list.</td>
</tr> </tr>
<tr> <tr>
<td>use = egg:swift#cname_lookup</td> <td><option>use</option> = <replaceable>egg:swift#cname_lookup</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

4
doc/common/tables/swift-proxy-server-filter-container-quotas.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-container-quotas]</literal> in <literal>proxy-server.conf</literal> <literal>[filter-container-quotas]</literal> in <filename>proxy-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,7 +17,7 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>use = egg:swift#container_quotas</td> <td><option>use</option> = <replaceable>egg:swift#container_quotas</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

8
doc/common/tables/swift-proxy-server-filter-container_sync.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-container_sync]</literal> in <literal>proxy-server.conf</literal> <literal>[filter-container_sync]</literal> in <filename>proxy-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,15 +17,15 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>allow_full_urls = true</td> <td><option>allow_full_urls</option> = <replaceable>true</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>current = //REALM/CLUSTER</td> <td><option>current</option> = <replaceable>//REALM/CLUSTER</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>use = egg:swift#container_sync</td> <td><option>use</option> = <replaceable>egg:swift#container_sync</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

10
doc/common/tables/swift-proxy-server-filter-dlo.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-dlo]</literal> in <literal>proxy-server.conf</literal> <literal>[filter-dlo]</literal> in <filename>proxy-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,19 +17,19 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>max_get_time = 86400</td> <td><option>max_get_time</option> = <replaceable>86400</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>rate_limit_after_segment = 10</td> <td><option>rate_limit_after_segment</option> = <replaceable>10</replaceable></td>
<td>Rate limit the download of large object segments after this segment is downloaded.</td> <td>Rate limit the download of large object segments after this segment is downloaded.</td>
</tr> </tr>
<tr> <tr>
<td>rate_limit_segments_per_sec = 1</td> <td><option>rate_limit_segments_per_sec</option> = <replaceable>1</replaceable></td>
<td>Rate limit large object downloads at this rate. contact for a normal request. You can use '* replicas' at the end to have it use the number given times the number of replicas for the ring being used for the request. paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request</td> <td>Rate limit large object downloads at this rate. contact for a normal request. You can use '* replicas' at the end to have it use the number given times the number of replicas for the ring being used for the request. paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request</td>
</tr> </tr>
<tr> <tr>
<td>use = egg:swift#dlo</td> <td><option>use</option> = <replaceable>egg:swift#dlo</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

20
doc/common/tables/swift-proxy-server-filter-domain_remap.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-domain_remap]</literal> in <literal>proxy-server.conf</literal> <literal>[filter-domain_remap]</literal> in <filename>proxy-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,40 +17,40 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>path_root = v1</td> <td><option>path_root</option> = <replaceable>v1</replaceable></td>
<td>Root path</td> <td>Root path</td>
</tr> </tr>
<tr> <tr>
<td>reseller_prefixes = AUTH</td> <td><option>reseller_prefixes</option> = <replaceable>AUTH</replaceable></td>
<td>Reseller prefix</td> <td>Reseller prefix</td>
</tr> </tr>
<tr> <tr>
<td>set log_address = /dev/log</td> <td><option>set log_address</option> = <replaceable>/dev/log</replaceable></td>
<td>Location where syslog sends the logs to</td> <td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>set log_facility = LOG_LOCAL0</td> <td><option>set log_facility</option> = <replaceable>LOG_LOCAL0</replaceable></td>
<td>Syslog log facility</td> <td>Syslog log facility</td>
</tr> </tr>
<tr> <tr>
<td>set log_headers = false</td> <td><option>set log_headers</option> = <replaceable>false</replaceable></td>
<td>If True, log headers in each request</td> <td>If True, log headers in each request</td>
</tr> </tr>
<tr> <tr>
<td>set log_level = INFO</td> <td><option>set log_level</option> = <replaceable>INFO</replaceable></td>
<td>Log level</td> <td>Log level</td>
</tr> </tr>
<tr> <tr>
<td>set log_name = domain_remap</td> <td><option>set log_name</option> = <replaceable>domain_remap</replaceable></td>
<td>Label to use when logging</td> <td>Label to use when logging</td>
</tr> </tr>
<tr> <tr>
<td>storage_domain = example.com</td> <td><option>storage_domain</option> = <replaceable>example.com</replaceable></td>
<td>Domain that matches your cloud. Multiple domains can be specified using a comma-separated <td>Domain that matches your cloud. Multiple domains can be specified using a comma-separated
list.</td> list.</td>
</tr> </tr>
<tr> <tr>
<td>use = egg:swift#domain_remap</td> <td><option>use</option> = <replaceable>egg:swift#domain_remap</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

4
doc/common/tables/swift-proxy-server-filter-formpost.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-formpost]</literal> in <literal>proxy-server.conf</literal> <literal>[filter-formpost]</literal> in <filename>proxy-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,7 +17,7 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>use = egg:swift#formpost</td> <td><option>use</option> = <replaceable>egg:swift#formpost</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

14
doc/common/tables/swift-proxy-server-filter-gatekeeper.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-gatekeeper]</literal> in <literal>proxy-server.conf</literal> <literal>[filter-gatekeeper]</literal> in <filename>proxy-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,27 +17,27 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>set log_address = /dev/log</td> <td><option>set log_address</option> = <replaceable>/dev/log</replaceable></td>
<td>Location where syslog sends the logs to</td> <td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>set log_facility = LOG_LOCAL0</td> <td><option>set log_facility</option> = <replaceable>LOG_LOCAL0</replaceable></td>
<td>Syslog log facility</td> <td>Syslog log facility</td>
</tr> </tr>
<tr> <tr>
<td>set log_headers = false</td> <td><option>set log_headers</option> = <replaceable>false</replaceable></td>
<td>If True, log headers in each request</td> <td>If True, log headers in each request</td>
</tr> </tr>
<tr> <tr>
<td>set log_level = INFO</td> <td><option>set log_level</option> = <replaceable>INFO</replaceable></td>
<td>Log level</td> <td>Log level</td>
</tr> </tr>
<tr> <tr>
<td>set log_name = gatekeeper</td> <td><option>set log_name</option> = <replaceable>gatekeeper</replaceable></td>
<td>Label to use when logging</td> <td>Label to use when logging</td>
</tr> </tr>
<tr> <tr>
<td>use = egg:swift#gatekeeper</td> <td><option>use</option> = <replaceable>egg:swift#gatekeeper</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

6
doc/common/tables/swift-proxy-server-filter-healthcheck.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-healthcheck]</literal> in <literal>proxy-server.conf</literal> <literal>[filter-healthcheck]</literal> in <filename>proxy-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,11 +17,11 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>disable_path = </td> <td><option>disable_path</option> = <replaceable></replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>use = egg:swift#healthcheck</td> <td><option>use</option> = <replaceable>egg:swift#healthcheck</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

28
doc/common/tables/swift-proxy-server-filter-keystoneauth.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-keystoneauth]</literal> in <literal>proxy-server.conf</literal> <literal>[filter-keystoneauth]</literal> in <filename>proxy-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,23 +17,39 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>allow_names_in_acls = true</td> <td><option>allow_names_in_acls</option> = <replaceable>true</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>default_domain_id = default</td> <td><option>allow_overrides</option> = <replaceable>true</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>operator_roles = admin, swiftoperator</td> <td><option>default_domain_id</option> = <replaceable>default</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>reseller_admin_role = ResellerAdmin</td> <td><option>is_admin</option> = <replaceable>false</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>use = egg:swift#keystoneauth</td> <td><option>operator_roles</option> = <replaceable>admin, swiftoperator</replaceable></td>
<td>No help text available for this option.</td>
</tr>
<tr>
<td><option>reseller_admin_role</option> = <replaceable>ResellerAdmin</replaceable></td>
<td>No help text available for this option.</td>
</tr>
<tr>
<td><option>reseller_prefix</option> = <replaceable>AUTH</replaceable></td>
<td>The naming scope for the auth service. Swift</td>
</tr>
<tr>
<td><option>service_roles</option> = <replaceable></replaceable></td>
<td>No help text available for this option.</td>
</tr>
<tr>
<td><option>use</option> = <replaceable>egg:swift#keystoneauth</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

6
doc/common/tables/swift-proxy-server-filter-list-endpoints.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-list-endpoints]</literal> in <literal>proxy-server.conf</literal> <literal>[filter-list-endpoints]</literal> in <filename>proxy-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,11 +17,11 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>list_endpoints_path = /endpoints/</td> <td><option>list_endpoints_path</option> = <replaceable>/endpoints/</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>use = egg:swift#list_endpoints</td> <td><option>use</option> = <replaceable>egg:swift#list_endpoints</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

10
doc/common/tables/swift-proxy-server-filter-name_check.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-name_check]</literal> in <literal>proxy-server.conf</literal> <literal>[filter-name_check]</literal> in <filename>proxy-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,19 +17,19 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>forbidden_chars = '"`&lt;&gt;</td> <td><option>forbidden_chars</option> = <replaceable>'"`&lt;&gt;</replaceable></td>
<td>Characters that are not allowed in a name</td> <td>Characters that are not allowed in a name</td>
</tr> </tr>
<tr> <tr>
<td>forbidden_regexp = /\./|/\.\./|/\.$|/\.\.$</td> <td><option>forbidden_regexp</option> = <replaceable>/\./|/\.\./|/\.$|/\.\.$</replaceable></td>
<td>Substrings to forbid, using regular expression syntax</td> <td>Substrings to forbid, using regular expression syntax</td>
</tr> </tr>
<tr> <tr>
<td>maximum_length = 255</td> <td><option>maximum_length</option> = <replaceable>255</replaceable></td>
<td>Maximum length of a name</td> <td>Maximum length of a name</td>
</tr> </tr>
<tr> <tr>
<td>use = egg:swift#name_check</td> <td><option>use</option> = <replaceable>egg:swift#name_check</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

36
doc/common/tables/swift-proxy-server-filter-proxy-logging.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-proxy-logging]</literal> in <literal>proxy-server.conf</literal> <literal>[filter-proxy-logging]</literal> in <filename>proxy-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,69 +17,69 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>access_log_address = /dev/log</td> <td><option>access_log_address</option> = <replaceable>/dev/log</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>access_log_facility = LOG_LOCAL0</td> <td><option>access_log_facility</option> = <replaceable>LOG_LOCAL0</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>access_log_headers = false</td> <td><option>access_log_headers</option> = <replaceable>false</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>access_log_headers_only = </td> <td><option>access_log_headers_only</option> = <replaceable></replaceable></td>
<td>If access_log_headers is True and access_log_headers_only is set only <td>If access_log_headers is True and access_log_headers_only is set only
these headers are logged. Multiple headers can be defined as comma separated list like this: these headers are logged. Multiple headers can be defined as comma separated list like this:
access_log_headers_only = Host, X-Object-Meta-Mtime</td> access_log_headers_only = Host, X-Object-Meta-Mtime</td>
</tr> </tr>
<tr> <tr>
<td>access_log_level = INFO</td> <td><option>access_log_level</option> = <replaceable>INFO</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>access_log_name = swift</td> <td><option>access_log_name</option> = <replaceable>swift</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>access_log_statsd_default_sample_rate = 1.0</td> <td><option>access_log_statsd_default_sample_rate</option> = <replaceable>1.0</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>access_log_statsd_host = localhost</td> <td><option>access_log_statsd_host</option> = <replaceable>localhost</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>access_log_statsd_metric_prefix = </td> <td><option>access_log_statsd_metric_prefix</option> = <replaceable></replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>access_log_statsd_port = 8125</td> <td><option>access_log_statsd_port</option> = <replaceable>8125</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>access_log_statsd_sample_rate_factor = 1.0</td> <td><option>access_log_statsd_sample_rate_factor</option> = <replaceable>1.0</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>access_log_udp_host = </td> <td><option>access_log_udp_host</option> = <replaceable></replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>access_log_udp_port = 514</td> <td><option>access_log_udp_port</option> = <replaceable>514</replaceable></td>
<td>No help text available for this option.</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><option>log_statsd_valid_http_methods</option> = <replaceable>GET,HEAD,POST,PUT,DELETE,COPY,OPTIONS</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>logged with access_log_headers = True.</td> <td><option>logged with access_log_headers</option> = <replaceable>True.</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>reveal_sensitive_prefix = 16</td> <td><option>reveal_sensitive_prefix</option> = <replaceable>16</replaceable></td>
<td>The X-Auth-Token is sensitive data. If revealed to an unauthorised person, <td>The X-Auth-Token is sensitive data. If revealed to an unauthorised person,
they can now make requests against an account until the token expires. they can now make requests against an account until the token expires.
@ -88,7 +88,7 @@
Or, set to 0 to completely remove the token.</td> Or, set to 0 to completely remove the token.</td>
</tr> </tr>
<tr> <tr>
<td>use = egg:swift#proxy_logging</td> <td><option>use</option> = <replaceable>egg:swift#proxy_logging</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

42
doc/common/tables/swift-proxy-server-filter-ratelimit.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-ratelimit]</literal> in <literal>proxy-server.conf</literal> <literal>[filter-ratelimit]</literal> in <filename>proxy-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,83 +17,83 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>account_blacklist = c,d</td> <td><option>account_blacklist</option> = <replaceable>c,d</replaceable></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> <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>account_ratelimit = 0</td> <td><option>account_ratelimit</option> = <replaceable>0</replaceable></td>
<td>If set, will limit PUT and DELETE requests to /account_name/container_name. Number is in requests per second.</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><option>account_whitelist</option> = <replaceable>a,b</replaceable></td>
<td>Comma separated lists of account names that will not be rate limited.</td> <td>Comma separated lists of account names that will not be rate limited.</td>
</tr> </tr>
<tr> <tr>
<td>clock_accuracy = 1000</td> <td><option>clock_accuracy</option> = <replaceable>1000</replaceable></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> <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>container_listing_ratelimit_0 = 100</td> <td><option>container_listing_ratelimit_0</option> = <replaceable>100</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>container_listing_ratelimit_10 = 50</td> <td><option>container_listing_ratelimit_10</option> = <replaceable>50</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>container_listing_ratelimit_50 = 20</td> <td><option>container_listing_ratelimit_50</option> = <replaceable>20</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>container_ratelimit_0 = 100</td> <td><option>container_ratelimit_0</option> = <replaceable>100</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>container_ratelimit_10 = 50</td> <td><option>container_ratelimit_10</option> = <replaceable>50</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>container_ratelimit_50 = 20</td> <td><option>container_ratelimit_50</option> = <replaceable>20</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>log_sleep_time_seconds = 0</td> <td><option>log_sleep_time_seconds</option> = <replaceable>0</replaceable></td>
<td>To allow visibility into rate limiting set this value &gt; 0 and all sleeps greater than the number will be logged.</td> <td>To allow visibility into rate limiting set this value &gt; 0 and all sleeps greater than the number will be logged.</td>
</tr> </tr>
<tr> <tr>
<td>max_sleep_time_seconds = 60</td> <td><option>max_sleep_time_seconds</option> = <replaceable>60</replaceable></td>
<td>App will immediately return a 498 response if the necessary sleep time ever exceeds the given max_sleep_time_seconds.</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>rate_buffer_seconds = 5</td> <td><option>rate_buffer_seconds</option> = <replaceable>5</replaceable></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> <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>set log_address = /dev/log</td> <td><option>set log_address</option> = <replaceable>/dev/log</replaceable></td>
<td>Location where syslog sends the logs to</td> <td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>set log_facility = LOG_LOCAL0</td> <td><option>set log_facility</option> = <replaceable>LOG_LOCAL0</replaceable></td>
<td>Syslog log facility</td> <td>Syslog log facility</td>
</tr> </tr>
<tr> <tr>
<td>set log_headers = false</td> <td><option>set log_headers</option> = <replaceable>false</replaceable></td>
<td>If True, log headers in each request</td> <td>If True, log headers in each request</td>
</tr> </tr>
<tr> <tr>
<td>set log_level = INFO</td> <td><option>set log_level</option> = <replaceable>INFO</replaceable></td>
<td>Log level</td> <td>Log level</td>
</tr> </tr>
<tr> <tr>
<td>set log_name = ratelimit</td> <td><option>set log_name</option> = <replaceable>ratelimit</replaceable></td>
<td>Label to use when logging</td> <td>Label to use when logging</td>
</tr> </tr>
<tr> <tr>
<td>use = egg:swift#ratelimit</td> <td><option>use</option> = <replaceable>egg:swift#ratelimit</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
<tr> <tr>
<td>with container_limit_x = r</td> <td><option>with container_limit_x</option> = <replaceable>r</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
</tbody> </tbody>

16
doc/common/tables/swift-proxy-server-filter-slo.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-slo]</literal> in <literal>proxy-server.conf</literal> <literal>[filter-slo]</literal> in <filename>proxy-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,31 +17,31 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>max_get_time = 86400</td> <td><option>max_get_time</option> = <replaceable>86400</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>max_manifest_segments = 1000</td> <td><option>max_manifest_segments</option> = <replaceable>1000</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>max_manifest_size = 2097152</td> <td><option>max_manifest_size</option> = <replaceable>2097152</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>min_segment_size = 1048576</td> <td><option>min_segment_size</option> = <replaceable>1048576</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>rate_limit_after_segment = 10</td> <td><option>rate_limit_after_segment</option> = <replaceable>10</replaceable></td>
<td>Rate limit the download of large object segments after this segment is downloaded.</td> <td>Rate limit the download of large object segments after this segment is downloaded.</td>
</tr> </tr>
<tr> <tr>
<td>rate_limit_segments_per_sec = 0</td> <td><option>rate_limit_segments_per_sec</option> = <replaceable>0</replaceable></td>
<td>Rate limit large object downloads at this rate. contact for a normal request. You can use '* replicas' at the end to have it use the number given times the number of replicas for the ring being used for the request. paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request</td> <td>Rate limit large object downloads at this rate. contact for a normal request. You can use '* replicas' at the end to have it use the number given times the number of replicas for the ring being used for the request. paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request</td>
</tr> </tr>
<tr> <tr>
<td>use = egg:swift#slo</td> <td><option>use</option> = <replaceable>egg:swift#slo</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

4
doc/common/tables/swift-proxy-server-filter-staticweb.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-staticweb]</literal> in <literal>proxy-server.conf</literal> <literal>[filter-staticweb]</literal> in <filename>proxy-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,7 +17,7 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>use = egg:swift#staticweb</td> <td><option>use</option> = <replaceable>egg:swift#staticweb</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

40
doc/common/tables/swift-proxy-server-filter-tempauth.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-tempauth]</literal> in <literal>proxy-server.conf</literal> <literal>[filter-tempauth]</literal> in <filename>proxy-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,63 +17,71 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>allow_overrides = true</td> <td><option>allow_overrides</option> = <replaceable>true</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>auth_prefix = /auth/</td> <td><option>auth_prefix</option> = <replaceable>/auth/</replaceable></td>
<td>The HTTP request path prefix for the auth service. Swift itself reserves anything beginning with the letter `v`.</td> <td>The HTTP request path prefix for the auth service. Swift itself reserves anything beginning with the letter `v`.</td>
</tr> </tr>
<tr> <tr>
<td>reseller_prefix = AUTH</td> <td><option>require_group</option> = <replaceable></replaceable></td>
<td>No help text available for this option.</td>
</tr>
<tr>
<td><option>reseller_prefix</option> = <replaceable>AUTH</replaceable></td>
<td>The naming scope for the auth service. Swift</td> <td>The naming scope for the auth service. Swift</td>
</tr> </tr>
<tr> <tr>
<td>set log_address = /dev/log</td> <td><option>set log_address</option> = <replaceable>/dev/log</replaceable></td>
<td>Location where syslog sends the logs to</td> <td>Location where syslog sends the logs to</td>
</tr> </tr>
<tr> <tr>
<td>set log_facility = LOG_LOCAL0</td> <td><option>set log_facility</option> = <replaceable>LOG_LOCAL0</replaceable></td>
<td>Syslog log facility</td> <td>Syslog log facility</td>
</tr> </tr>
<tr> <tr>
<td>set log_headers = false</td> <td><option>set log_headers</option> = <replaceable>false</replaceable></td>
<td>If True, log headers in each request</td> <td>If True, log headers in each request</td>
</tr> </tr>
<tr> <tr>
<td>set log_level = INFO</td> <td><option>set log_level</option> = <replaceable>INFO</replaceable></td>
<td>Log level</td> <td>Log level</td>
</tr> </tr>
<tr> <tr>
<td>set log_name = tempauth</td> <td><option>set log_name</option> = <replaceable>tempauth</replaceable></td>
<td>Label to use when logging</td> <td>Label to use when logging</td>
</tr> </tr>
<tr> <tr>
<td>storage_url_scheme = default</td> <td><option>storage_url_scheme</option> = <replaceable>default</replaceable></td>
<td>Scheme to return with storage urls: http, https, or default (chooses based on what the server is running as) This can be useful with an SSL load balancer in front of a non-SSL server.</td> <td>Scheme to return with storage urls: http, https, or default (chooses based on what the server is running as) This can be useful with an SSL load balancer in front of a non-SSL server.</td>
</tr> </tr>
<tr> <tr>
<td>token_life = 86400</td> <td><option>token_life</option> = <replaceable>86400</replaceable></td>
<td>The number of seconds a token is valid.</td> <td>The number of seconds a token is valid.</td>
</tr> </tr>
<tr> <tr>
<td>use = egg:swift#tempauth</td> <td><option>use</option> = <replaceable>egg:swift#tempauth</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
<tr> <tr>
<td>user_admin_admin = admin .admin .reseller_admin</td> <td><option>user_admin_admin</option> = <replaceable>admin .admin .reseller_admin</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>user_test2_tester2 = testing2 .admin</td> <td><option>user_test2_tester2</option> = <replaceable>testing2 .admin</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>user_test_tester = testing .admin</td> <td><option>user_test5_tester5</option> = <replaceable>testing5 service</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>user_test_tester3 = testing3</td> <td><option>user_test_tester</option> = <replaceable>testing .admin</replaceable></td>
<td>No help text available for this option.</td>
</tr>
<tr>
<td><option>user_test_tester3</option> = <replaceable>testing3</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
</tbody> </tbody>

14
doc/common/tables/swift-proxy-server-filter-tempurl.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-tempurl]</literal> in <literal>proxy-server.conf</literal> <literal>[filter-tempurl]</literal> in <filename>proxy-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,33 +17,33 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>incoming_allow_headers = </td> <td><option>incoming_allow_headers</option> = <replaceable></replaceable></td>
<td>Headers allowed as exceptions to incoming_remove_headers. Simply a whitespace <td>Headers allowed as exceptions to incoming_remove_headers. Simply a whitespace
delimited list of header names and names can optionally end with '*' to indicate delimited list of header names and names can optionally end with '*' to indicate
a prefix match.</td> a prefix match.</td>
</tr> </tr>
<tr> <tr>
<td>incoming_remove_headers = x-timestamp</td> <td><option>incoming_remove_headers</option> = <replaceable>x-timestamp</replaceable></td>
<td>Headers to remove from incoming requests. Simply a whitespace delimited list of header names and <td>Headers to remove from incoming requests. Simply a whitespace delimited list of header names and
names can optionally end with '*' to indicate a prefix match.</td> names can optionally end with '*' to indicate a prefix match.</td>
</tr> </tr>
<tr> <tr>
<td>methods = GET HEAD PUT POST DELETE</td> <td><option>methods</option> = <replaceable>GET HEAD PUT POST DELETE</replaceable></td>
<td>HTTP methods allowed with Temporary URLs</td> <td>HTTP methods allowed with Temporary URLs</td>
</tr> </tr>
<tr> <tr>
<td>outgoing_allow_headers = x-object-meta-public-*</td> <td><option>outgoing_allow_headers</option> = <replaceable>x-object-meta-public-*</replaceable></td>
<td>Headers allowed as exceptions to outgoing_allow_headers. Simply a whitespace delimited list of <td>Headers allowed as exceptions to outgoing_allow_headers. Simply a whitespace delimited list of
header names and names can optionally end with '*' to indicate a prefix match.</td> header names and names can optionally end with '*' to indicate a prefix match.</td>
</tr> </tr>
<tr> <tr>
<td>outgoing_remove_headers = x-object-meta-*</td> <td><option>outgoing_remove_headers</option> = <replaceable>x-object-meta-*</replaceable></td>
<td>Headers to remove from outgoing responses. Simply a whitespace delimited list of <td>Headers to remove from outgoing responses. Simply a whitespace delimited list of
header names and names can optionally end with '*' to indicate a prefix header names and names can optionally end with '*' to indicate a prefix
match.</td> match.</td>
</tr> </tr>
<tr> <tr>
<td>use = egg:swift#tempurl</td> <td><option>use</option> = <replaceable>egg:swift#tempurl</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

18
doc/common/tables/swift-proxy-server-filter-xprofile.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[filter-xprofile]</literal> in <literal>proxy-server.conf</literal> <literal>[filter-xprofile]</literal> in <filename>proxy-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,35 +17,35 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>dump_interval = 5.0</td> <td><option>dump_interval</option> = <replaceable>5.0</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>dump_timestamp = false</td> <td><option>dump_timestamp</option> = <replaceable>false</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>flush_at_shutdown = false</td> <td><option>flush_at_shutdown</option> = <replaceable>false</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>log_filename_prefix = /tmp/log/swift/profile/default.profile</td> <td><option>log_filename_prefix</option> = <replaceable>/tmp/log/swift/profile/default.profile</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>path = /__profile__</td> <td><option>path</option> = <replaceable>/__profile__</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>profile_module = eventlet.green.profile</td> <td><option>profile_module</option> = <replaceable>eventlet.green.profile</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>unwind = false</td> <td><option>unwind</option> = <replaceable>false</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>use = egg:swift#xprofile</td> <td><option>use</option> = <replaceable>egg:swift#xprofile</replaceable></td>
<td>Entry point of paste.deploy in the server</td> <td>Entry point of paste.deploy in the server</td>
</tr> </tr>
</tbody> </tbody>

4
doc/common/tables/swift-proxy-server-pipeline-main.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[pipeline-main]</literal> in <literal>proxy-server.conf</literal> <literal>[pipeline-main]</literal> in <filename>proxy-server.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,7 +17,7 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>pipeline = catch_errors gatekeeper healthcheck proxy-logging cache container_sync bulk tempurl ratelimit tempauth container-quotas account-quotas slo dlo proxy-logging proxy-server</td> <td><option>pipeline</option> = <replaceable>catch_errors gatekeeper healthcheck proxy-logging cache container_sync bulk tempurl ratelimit tempauth container-quotas account-quotas slo dlo proxy-logging proxy-server</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
</tbody> </tbody>

10
doc/common/tables/swift-rsyncd-account.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[account]</literal> in <literal>rsyncd.conf</literal> <literal>[account]</literal> in <filename>rsyncd.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,19 +17,19 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>lock file = /var/lock/account.lock</td> <td><option>lock file</option> = <replaceable>/var/lock/account.lock</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>max connections = 2</td> <td><option>max connections</option> = <replaceable>2</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>path = /srv/node</td> <td><option>path</option> = <replaceable>/srv/node</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>read only = false</td> <td><option>read only</option> = <replaceable>false</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
</tbody> </tbody>

10
doc/common/tables/swift-rsyncd-container.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[container]</literal> in <literal>rsyncd.conf</literal> <literal>[container]</literal> in <filename>rsyncd.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,19 +17,19 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>lock file = /var/lock/container.lock</td> <td><option>lock file</option> = <replaceable>/var/lock/container.lock</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>max connections = 4</td> <td><option>max connections</option> = <replaceable>4</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>path = /srv/node</td> <td><option>path</option> = <replaceable>/srv/node</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>read only = false</td> <td><option>read only</option> = <replaceable>false</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
</tbody> </tbody>

10
doc/common/tables/swift-rsyncd-object.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[object]</literal> in <literal>rsyncd.conf</literal> <literal>[object]</literal> in <filename>rsyncd.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,19 +17,19 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>lock file = /var/lock/object.lock</td> <td><option>lock file</option> = <replaceable>/var/lock/object.lock</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>max connections = 8</td> <td><option>max connections</option> = <replaceable>8</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>path = /srv/node</td> <td><option>path</option> = <replaceable>/srv/node</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>read only = false</td> <td><option>read only</option> = <replaceable>false</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
</tbody> </tbody>

6
doc/common/tables/swift-swift-storage-policy-0.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[storage-policy-0]</literal> in <literal>swift.conf</literal> <literal>[storage-policy-0]</literal> in <filename>swift.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,11 +17,11 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>default = yes</td> <td><option>default</option> = <replaceable>yes</replaceable></td>
<td>0 means to not use a per-disk thread pool. It is recommended to keep this value small, as large values can result in high read latencies due to large queue depths. A good starting point is 4 threads per disk.</td> <td>0 means to not use a per-disk thread pool. It is recommended to keep this value small, as large values can result in high read latencies due to large queue depths. A good starting point is 4 threads per disk.</td>
</tr> </tr>
<tr> <tr>
<td>name = Policy-0</td> <td><option>name</option> = <replaceable>Policy-0</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
</tbody> </tbody>

4
doc/common/tables/swift-swift-storage-policy-1.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[storage-policy-1]</literal> in <literal>swift.conf</literal> <literal>[storage-policy-1]</literal> in <filename>swift.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,7 +17,7 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>name = silver</td> <td><option>name</option> = <replaceable>silver</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
</tbody> </tbody>

24
doc/common/tables/swift-swift-swift-constraints.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[swift-constraints]</literal> in <literal>swift.conf</literal> <literal>[swift-constraints]</literal> in <filename>swift.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,47 +17,47 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>account_listing_limit = 10000</td> <td><option>account_listing_limit</option> = <replaceable>10000</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>container_listing_limit = 10000</td> <td><option>container_listing_limit</option> = <replaceable>10000</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>max_account_name_length = 256</td> <td><option>max_account_name_length</option> = <replaceable>256</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>max_container_name_length = 256</td> <td><option>max_container_name_length</option> = <replaceable>256</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>max_file_size = 5368709122</td> <td><option>max_file_size</option> = <replaceable>5368709122</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>max_header_size = 8192</td> <td><option>max_header_size</option> = <replaceable>8192</replaceable></td>
<td>max_header_size is the max number of bytes in the utf8 encoding of each header. Using 8192 as default because eventlet use 8192 as max size of header line. This value may need to be increased when using identity v3 API tokens including more than 7 catalog entries. See also include_service_catalog in proxy-server.conf-sample (documented in overview_auth.rst)</td> <td>max_header_size is the max number of bytes in the utf8 encoding of each header. Using 8192 as default because eventlet use 8192 as max size of header line. This value may need to be increased when using identity v3 API tokens including more than 7 catalog entries. See also include_service_catalog in proxy-server.conf-sample (documented in overview_auth.rst)</td>
</tr> </tr>
<tr> <tr>
<td>max_meta_count = 90</td> <td><option>max_meta_count</option> = <replaceable>90</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>max_meta_name_length = 128</td> <td><option>max_meta_name_length</option> = <replaceable>128</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>max_meta_overall_size = 4096</td> <td><option>max_meta_overall_size</option> = <replaceable>4096</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>max_meta_value_length = 256</td> <td><option>max_meta_value_length</option> = <replaceable>256</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
<tr> <tr>
<td>max_object_name_length = 1024</td> <td><option>max_object_name_length</option> = <replaceable>1024</replaceable></td>
<td>No help text available for this option.</td> <td>No help text available for this option.</td>
</tr> </tr>
</tbody> </tbody>

6
doc/common/tables/swift-swift-swift-hash.xml
View File

@ -5,7 +5,7 @@
this file will *not* be lost if you run the script again. --> this file will *not* be lost if you run the script again. -->
<table rules="all"> <table rules="all">
<caption>Description of configuration options for <caption>Description of configuration options for
<literal>[swift-hash]</literal> in <literal>swift.conf</literal> <literal>[swift-hash]</literal> in <filename>swift.conf</filename>
</caption> </caption>
<col width="50%"/> <col width="50%"/>
<col width="50%"/> <col width="50%"/>
@ -17,7 +17,7 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>swift_hash_path_prefix = changeme</td> <td><option>swift_hash_path_prefix</option> = <replaceable>changeme</replaceable></td>
<td> <td>
A prefix used by hash_path to offer a bit more security when generating hashes for A prefix used by hash_path to offer a bit more security when generating hashes for
paths. It simply appends this value to all paths; if someone knows this suffix, paths. It simply appends this value to all paths; if someone knows this suffix,
@ -29,7 +29,7 @@
Existing installations should set this parameter to an empty string.</td> Existing installations should set this parameter to an empty string.</td>
</tr> </tr>
<tr> <tr>
<td>swift_hash_path_suffix = changeme</td> <td><option>swift_hash_path_suffix</option> = <replaceable>changeme</replaceable></td>
<td> <td>
A suffix used by hash_path to offer a bit more security when generating hashes for A suffix used by hash_path to offer a bit more security when generating hashes for
paths. It simply appends this value to all paths; if someone knows this suffix, paths. It simply appends this value to all paths; if someone knows this suffix,