diff --git a/doc/src/docbkx/common/tables/swift-account-server-DEFAULT.xml b/doc/src/docbkx/common/tables/swift-account-server-DEFAULT.xml index 4ef0f11bc0..f981247b22 100644 --- a/doc/src/docbkx/common/tables/swift-account-server-DEFAULT.xml +++ b/doc/src/docbkx/common/tables/swift-account-server-DEFAULT.xml @@ -1,8 +1,7 @@ - + @@ -17,79 +16,92 @@ - + - + - + - - - - + - + - + - + - + - + + + + + + + - + - + - + - - + + - + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - + - + - +
Description of configuration options for [DEFAULT] in account-server.conf-sample
bind_ip=0.0.0.0IP Address for server to bind to
bind_port=6002Port for server to bind to
bind_timeout=30Seconds to attempt bind before giving up
backlog=4096Maximum number of allowed pending TCP connections
workers=1a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.
user=swiftUser to run as
swift_dir=/etc/swiftSwift configuration directory
devices=/srv/nodeParent directory of where devices are mounted
mount_check=trueWhether or not check if the devices are mounted to prevent accidentally writing to the root device
disable_fallocate=falseDisable "fast fail" fallocate checks if the underlying filesystem does not support it.
workers=autoa much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.
max_clients=1024Maximum number of clients one worker can process simultaneously +Lowering the number of clients handled per worker, and raising the +number of workers can lessen the impact that a CPU intensive, or +blocking, request can have on other requests served by the same +worker. If the maximum number of clients is set to one, then a given worker +will not perform another call while processing, allowing +other workers a chance to process it. +
log_name=swiftLabel used when logging
log_facility=LOG_LOCAL0Syslog log facility
log_level=INFOLogging level
log_address=/dev/logNo help text available for this option
log_address=/dev/logLocation where syslog sends the logs to
log_custom_handlers=Comma-separated list of functions to call to setup custom log handlers.
log_udp_host=No help text available for this option
log_udp_host=If not set, the UDB receiver for syslog is disabled.
log_udp_port=514No help text available for this option
log_udp_port=514Port value for UDB receiver, if enabled.
log_statsd_host=localhostNo help text available for this option
log_statsd_host=localhostIf not set, the StatsD feature is disabled.
log_statsd_port=8125No help text available for this option
log_statsd_port=8125Port value for the StatsD server.
log_statsd_default_sample_rate=1.0No help text available for this option
log_statsd_default_sample_rate=1.0Defines the probability of sending a sample for any given event or + timing measurement.
log_statsd_sample_rate_factor=1.0No help text available for this option
log_statsd_sample_rate_factor=1.0Not recommended to set this to a value less than 1.0, if frequency + of logging is too high, tune the + log_statsd_default_sample_rate instead.
log_statsd_metric_prefix=No help text available for this option
log_statsd_metric_prefix=Value will be prepended to every metric sent to the StatsD server.
db_preallocation=offIf 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
eventlet_debug=falseIf true, turn on debug logging for eventlet
fallocate_reserve=0You 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`.
-
+ \ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-account-server-account-auditor.xml b/doc/src/docbkx/common/tables/swift-account-server-account-auditor.xml index ee3658eced..8902f41da7 100644 --- a/doc/src/docbkx/common/tables/swift-account-server-account-auditor.xml +++ b/doc/src/docbkx/common/tables/swift-account-server-account-auditor.xml @@ -1,8 +1,7 @@ - + @@ -17,32 +16,31 @@ - + - + - + - - + + - + - + - + - + - - + +
Description of configuration options for [account-auditor] in account-server.conf-sample
log_name=account-auditorLabel used when logging
log_facility=LOG_LOCAL0Syslog log facility
log_level=INFOLogging level
log_address=/dev/logNo help text available for this option
log_address=/dev/logLocation where syslog sends the logs to
interval=1800Minimum time for a pass to take
log_facility=LOG_LOCAL0Syslog log facility
log_level=INFOLogging level
accounts_per_second=200Maximum accounts audited per second. Should be tuned according to individual system specs. 0 is unlimited.
recon_cache_path=/var/cache/swiftDirectory where stats for a - few items will be stored
recon_cache_path=/var/cache/swiftDirectory where stats for a few items will be stored
-
+ \ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-account-server-account-reaper.xml b/doc/src/docbkx/common/tables/swift-account-server-account-reaper.xml index 1ba911dcc2..75aaa4979d 100644 --- a/doc/src/docbkx/common/tables/swift-account-server-account-reaper.xml +++ b/doc/src/docbkx/common/tables/swift-account-server-account-reaper.xml @@ -1,8 +1,7 @@ - + @@ -17,34 +16,34 @@ - + - + - + - - + + - + - + - + - + - + - +
Description of configuration options for [account-reaper] in account-server.conf-sample
log_name=account-reaperLabel used when logging
log_facility=LOG_LOCAL0Syslog log facility
log_level=INFOLogging level
log_address=/dev/logNo help text available for this option
log_address=/dev/logLocation where syslog sends the logs to
concurrency=25Number of replication workers to spawn
interval=3600Minimum time for a pass to take
node_timeout=10Request timeout to external services
conn_timeout=0.5Connection timeout to external services
delay_reaping=0Normally, 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.
reap_warn_after=2592000No help text available for this option
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-account-server-account-replicator.xml b/doc/src/docbkx/common/tables/swift-account-server-account-replicator.xml index e6889e7da1..1251c839b7 100644 --- a/doc/src/docbkx/common/tables/swift-account-server-account-replicator.xml +++ b/doc/src/docbkx/common/tables/swift-account-server-account-replicator.xml @@ -1,8 +1,7 @@ - + @@ -17,52 +16,52 @@ - + - + - + - - + + - + - + - - + + - + - + - + - + - + - + - + - + - - + +
Description of configuration options for [account-replicator] in account-server.conf-sample
log_name=account-replicatorLabel used when logging
log_facility=LOG_LOCAL0Syslog log facility
log_level=INFOLogging level
log_address=/dev/logNo help text available for this option
log_address=/dev/logLocation where syslog sends the logs to
vm_test_mode=noIndicates that you are using a VM environment
per_diff=1000Limit number of items to get per diff
max_diffs=100Caps how long the replicator tries to spend syncing a database per pass
max_diffs=100Caps how long the replicator spends trying to sync a database per pass
concurrency=8Number of replication workers to spawn
interval=30Minimum time for a pass to take
error_suppression_interval=60Time in seconds that must elapse since the last error for a node to be considered no longer error limited
error_suppression_limit=10Error count to consider a node error limited
node_timeout=10Request timeout to external services
conn_timeout=0.5Connection timeout to external services
reclaim_age=604800Time elapsed in seconds before an object can be reclaimed
run_pause=30Time in seconds to wait between replication passes
recon_cache_path=/var/cache/swiftNo help text available for this option
recon_cache_path=/var/cache/swiftDirectory where stats for a few items will be stored
-
+ \ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-account-server-app-account-server.xml b/doc/src/docbkx/common/tables/swift-account-server-app-account-server.xml index 70907d95ba..f778811804 100644 --- a/doc/src/docbkx/common/tables/swift-account-server-app-account-server.xml +++ b/doc/src/docbkx/common/tables/swift-account-server-app-account-server.xml @@ -1,8 +1,7 @@ - + @@ -16,35 +15,29 @@ - - + + - - + + - + - - + + - - + + - + - - + + - - - - - + +
Description of configuration options for [app:account-server] in account-server.conf-sample
use=egg:swift#accountEntry point for paste.deploy for the server
use=egg:swift#accountEntry point of paste.deploy in the server
set log_name=account-serverLabel used when logging
set log_name=account-serverLabel to use when logging
set log_facility=LOG_LOCAL0Syslog log facility
set log_level=INFOLogging level
set log_level=INFOLog level
set log_requests=trueWhether or not to log each requests
set log_requests=trueWhether or not to log requests
set log_address=/dev/logNo help text available for this option
auto_create_account_prefix=.Prefix used when automatically creating accounts
auto_create_account_prefix=.Prefix to use when automatically creating accounts
max_clients=1024Maximum number of clients one worker can process simultaneously (it will actually
replication_server=falseIf defined, tells server how to handle - replication verbs in requests. When set to True (or 1), only replication verbs will be accepted. - When set to False, replication verbs will be rejected. When undefined, server will accept any verb - in request.
replication_server=falseIf 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.
-
+ \ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-account-server-filter-healthcheck.xml b/doc/src/docbkx/common/tables/swift-account-server-filter-healthcheck.xml index ffa9892462..75e1d406ab 100644 --- a/doc/src/docbkx/common/tables/swift-account-server-filter-healthcheck.xml +++ b/doc/src/docbkx/common/tables/swift-account-server-filter-healthcheck.xml @@ -1,8 +1,7 @@ - + @@ -16,11 +15,11 @@ - - + + - +
Description of configuration options for [filter:healthcheck] in account-server.conf-sample
use=egg:swift#healthcheckNo help text available for this option
use=egg:swift#healthcheckEntry point of paste.deploy in the server
disable_path=No help text available for this option
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-account-server-filter-recon.xml b/doc/src/docbkx/common/tables/swift-account-server-filter-recon.xml index dcbc9c5613..5aed59eb70 100644 --- a/doc/src/docbkx/common/tables/swift-account-server-filter-recon.xml +++ b/doc/src/docbkx/common/tables/swift-account-server-filter-recon.xml @@ -1,8 +1,7 @@ - + @@ -16,11 +15,11 @@ - - + + - - + +
Description of configuration options for [filter:recon] in account-server.conf-sample
use=egg:swift#reconNo help text available for this option
use=egg:swift#reconEntry point of paste.deploy in the server
recon_cache_path=/var/cache/swiftNo help text available for this option
recon_cache_path=/var/cache/swiftDirectory where stats for a few items will be stored
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-account-server-pipeline-main.xml b/doc/src/docbkx/common/tables/swift-account-server-pipeline-main.xml index 5836f31cf7..e02fbe9e31 100644 --- a/doc/src/docbkx/common/tables/swift-account-server-pipeline-main.xml +++ b/doc/src/docbkx/common/tables/swift-account-server-pipeline-main.xml @@ -1,8 +1,7 @@ - + @@ -17,7 +16,7 @@ - +
Description of configuration options for [pipeline:main] in account-server.conf-sample
pipeline=healthcheck recon account-serverNo help text available for this option
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-container-server-DEFAULT.xml b/doc/src/docbkx/common/tables/swift-container-server-DEFAULT.xml index 17be81266e..df42a2f684 100644 --- a/doc/src/docbkx/common/tables/swift-container-server-DEFAULT.xml +++ b/doc/src/docbkx/common/tables/swift-container-server-DEFAULT.xml @@ -1,8 +1,7 @@ - + @@ -17,82 +16,95 @@ - + - + - + - - - - + - + - + - + - + - + + + + + + + - + - + - + - + - - + + - + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - + - + - +
Description of configuration options for [DEFAULT] in container-server.conf-sample
bind_ip=0.0.0.0IP Address for server to bind to
bind_port=6001Port for server to bind to
bind_timeout=30Seconds to attempt bind before giving up
backlog=4096Maximum number of allowed pending TCP connections
workers=1a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.
user=swiftUser to run as
swift_dir=/etc/swiftSwift configuration directory
devices=/srv/nodeParent directory of where devices are mounted
mount_check=trueWhether or not check if the devices are mounted to prevent accidentally writing to the root device
disable_fallocate=falseDisable "fast fail" fallocate checks if the underlying filesystem does not support it.
workers=autoa much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.
max_clients=1024Maximum number of clients one worker can process simultaneously +Lowering the number of clients handled per worker, and raising the +number of workers can lessen the impact that a CPU intensive, or +blocking, request can have on other requests served by the same +worker. If the maximum number of clients is set to one, then a given worker +will not perform another call while processing, allowing +other workers a chance to process it. +
allowed_sync_hosts=127.0.0.1No help text available for this option
log_name=swiftLabel used when logging
log_facility=LOG_LOCAL0Syslog log facility
log_level=INFOLogging level
log_address=/dev/logNo help text available for this option
log_address=/dev/logLocation where syslog sends the logs to
log_custom_handlers=Comma-separated list of functions to call to setup custom log handlers.
log_udp_host=No help text available for this option
log_udp_host=If not set, the UDB receiver for syslog is disabled.
log_udp_port=514No help text available for this option
log_udp_port=514Port value for UDB receiver, if enabled.
log_statsd_host=localhostNo help text available for this option
log_statsd_host=localhostIf not set, the StatsD feature is disabled.
log_statsd_port=8125No help text available for this option
log_statsd_port=8125Port value for the StatsD server.
log_statsd_default_sample_rate=1.0No help text available for this option
log_statsd_default_sample_rate=1.0Defines the probability of sending a sample for any given event or + timing measurement.
log_statsd_sample_rate_factor=1.0No help text available for this option
log_statsd_sample_rate_factor=1.0Not recommended to set this to a value less than 1.0, if frequency + of logging is too high, tune the + log_statsd_default_sample_rate instead.
log_statsd_metric_prefix=No help text available for this option
log_statsd_metric_prefix=Value will be prepended to every metric sent to the StatsD server.
db_preallocation=offIf 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
eventlet_debug=falseIf true, turn on debug logging for eventlet
fallocate_reserve=0You 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`.
-
+ \ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-container-server-app-container-server.xml b/doc/src/docbkx/common/tables/swift-container-server-app-container-server.xml index 5a4d680590..dfc8787b06 100644 --- a/doc/src/docbkx/common/tables/swift-container-server-app-container-server.xml +++ b/doc/src/docbkx/common/tables/swift-container-server-app-container-server.xml @@ -1,8 +1,7 @@ - + @@ -16,38 +15,38 @@ - - + + - - + + - + - + - - + + - + - + - + - - + + - - + + - - + +
Description of configuration options for [app:container-server] in container-server.conf-sample
use=egg:swift#containerNo help text available for this option
use=egg:swift#containerEntry point of paste.deploy in the server
set log_name=container-serverLabel used when logging
set log_name=container-serverLabel to use when logging
set log_facility=LOG_LOCAL0Syslog log facility
set log_level=INFOLog level
set log_requests=trueNo help text available for this option
set log_requests=trueWhether or not to log requests
set log_address=/dev/logNo help text available for this option
node_timeout=3Request timeout to external services
conn_timeout=0.5Connection timeout to external services
allow_versions=falseNo help text available for this option
allow_versions=falseEnable/Disable object versioning feature
auto_create_account_prefix=.Prefix used when automatically creating accounts
auto_create_account_prefix=.Prefix to use when automatically creating accounts
replication_server=falseNo help text available for this option
replication_server=falseIf 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.
-
+ \ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-container-server-container-auditor.xml b/doc/src/docbkx/common/tables/swift-container-server-container-auditor.xml index 795a4c6634..4fa558a838 100644 --- a/doc/src/docbkx/common/tables/swift-container-server-container-auditor.xml +++ b/doc/src/docbkx/common/tables/swift-container-server-container-auditor.xml @@ -1,8 +1,7 @@ - + @@ -17,25 +16,25 @@ - + - + - + - - + + - + - + - +
Description of configuration options for [container-auditor] in container-server.conf-sample
log_name=container-auditorLabel used when logging
log_facility=LOG_LOCAL0Syslog log facility
log_level=INFOLogging level
log_address=/dev/logNo help text available for this option
log_address=/dev/logLocation where syslog sends the logs to
interval=1800Minimum time for a pass to take
containers_per_second=200Maximum 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.
recon_cache_path=/var/cache/swiftDirectory where stats for a few items will be stored
-
+ \ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-container-server-container-replicator.xml b/doc/src/docbkx/common/tables/swift-container-server-container-replicator.xml index dd9e79888e..fd7d04c450 100644 --- a/doc/src/docbkx/common/tables/swift-container-server-container-replicator.xml +++ b/doc/src/docbkx/common/tables/swift-container-server-container-replicator.xml @@ -1,8 +1,7 @@ - + @@ -17,46 +16,46 @@ - + - + - + - - + + - + - + - + - + - + - + - + - + - + - +
Description of configuration options for [container-replicator] in container-server.conf-sample
log_name=container-replicatorLabel used when logging
log_facility=LOG_LOCAL0Syslog log facility
log_level=INFOLogging level
log_address=/dev/logNo help text available for this option
log_address=/dev/logLocation where syslog sends the logs to
vm_test_mode=noIndicates that you are using a VM environment
per_diff=1000Limit number of items to get per diff
max_diffs=100Caps how long the replicator spends trying to sync a database per pass
concurrency=8Number of replication workers to spawn
interval=30Minimum time for a pass to take
node_timeout=10Request timeout to external services
conn_timeout=0.5Connection timeout to external services
reclaim_age=604800Time elapsed in seconds before an object can be reclaimed
run_pause=30Time in seconds to wait between replication passes
recon_cache_path=/var/cache/swiftDirectory where stats for a few items will be stored
-
+ \ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-container-server-container-sync.xml b/doc/src/docbkx/common/tables/swift-container-server-container-sync.xml index 0872231c01..077818fc39 100644 --- a/doc/src/docbkx/common/tables/swift-container-server-container-sync.xml +++ b/doc/src/docbkx/common/tables/swift-container-server-container-sync.xml @@ -1,8 +1,7 @@ - + @@ -17,25 +16,25 @@ - + - + - + - - + + - + - + - +
Description of configuration options for [container-sync] in container-server.conf-sample
log_name=container-syncLabel used when logging
log_facility=LOG_LOCAL0Syslog log facility
log_level=INFOLogging level
log_address=/dev/logNo help text available for this option
log_address=/dev/logLocation where syslog sends the logs to
sync_proxy=http://127.0.0.1:8888If you need to use an HTTP proxy, set it here. Defaults to no proxy.
interval=300Minimum time for a pass to take
container_time=60Maximum amount of time to spend syncing each container
-
+ \ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-container-server-container-updater.xml b/doc/src/docbkx/common/tables/swift-container-server-container-updater.xml index a77b06aa8b..b059c7f6f5 100644 --- a/doc/src/docbkx/common/tables/swift-container-server-container-updater.xml +++ b/doc/src/docbkx/common/tables/swift-container-server-container-updater.xml @@ -1,8 +1,7 @@ - + @@ -17,37 +16,38 @@ - + - + - + - - + + - + - + - + - + - + - - + + - +
Description of configuration options for [container-updater] in container-server.conf-sample
log_name=container-updaterLabel used when logging
log_facility=LOG_LOCAL0Syslog log facility
log_level=INFOLogging level
log_address=/dev/logNo help text available for this option
log_address=/dev/logLocation where syslog sends the logs to
interval=300Minimum time for a pass to take
concurrency=4Number of replication workers to spawn
node_timeout=3Request timeout to external services
conn_timeout=0.5Connection timeout to external services
slowdown=0.01Time in seconds to wait between objects
account_suppression_time=60Seconds to suppress updating an account that has generated an
account_suppression_time=60Seconds to suppress updating an account that has generated an + error (timeout, not yet found, etc.)
recon_cache_path=/var/cache/swiftDirectory where stats for a few items will be stored
-
+ \ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-container-server-filter-healthcheck.xml b/doc/src/docbkx/common/tables/swift-container-server-filter-healthcheck.xml index d9358baa3d..ae97f2441c 100644 --- a/doc/src/docbkx/common/tables/swift-container-server-filter-healthcheck.xml +++ b/doc/src/docbkx/common/tables/swift-container-server-filter-healthcheck.xml @@ -1,8 +1,7 @@ - + @@ -16,11 +15,11 @@ - - + + - +
Description of configuration options for [filter:healthcheck] in container-server.conf-sample
use=egg:swift#healthcheckNo help text available for this option
use=egg:swift#healthcheckEntry point of paste.deploy in the server
disable_path=No help text available for this option
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-container-server-filter-recon.xml b/doc/src/docbkx/common/tables/swift-container-server-filter-recon.xml index f413ad63f2..29fd2c49c1 100644 --- a/doc/src/docbkx/common/tables/swift-container-server-filter-recon.xml +++ b/doc/src/docbkx/common/tables/swift-container-server-filter-recon.xml @@ -1,8 +1,7 @@ - + @@ -16,11 +15,11 @@ - - + + - - + +
Description of configuration options for [filter:recon] in container-server.conf-sample
use=egg:swift#reconNo help text available for this option
use=egg:swift#reconEntry point of paste.deploy in the server
recon_cache_path=/var/cache/swiftNo help text available for this option
recon_cache_path=/var/cache/swiftDirectory where stats for a few items will be stored
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-container-server-pipeline-main.xml b/doc/src/docbkx/common/tables/swift-container-server-pipeline-main.xml index 408b3871a9..534182aae9 100644 --- a/doc/src/docbkx/common/tables/swift-container-server-pipeline-main.xml +++ b/doc/src/docbkx/common/tables/swift-container-server-pipeline-main.xml @@ -1,8 +1,7 @@ - + @@ -17,7 +16,7 @@ - +
Description of configuration options for [pipeline:main] in container-server.conf-sample
pipeline=healthcheck recon container-serverNo help text available for this option
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-dispersion-dispersion.xml b/doc/src/docbkx/common/tables/swift-dispersion-dispersion.xml index 9c88614556..6ea5490f3f 100644 --- a/doc/src/docbkx/common/tables/swift-dispersion-dispersion.xml +++ b/doc/src/docbkx/common/tables/swift-dispersion-dispersion.xml @@ -1,8 +1,7 @@ - + @@ -16,50 +15,53 @@ - - + + - - + + - + - - + + - - + + - + - - + + - - + + + + + - + - - + + - + - + - + - + - +
Description of configuration options for [dispersion] in dispersion.conf-sample
auth_url=http://localhost:8080/auth/v1.0No help text available for this option
auth_url=http://localhost:8080/auth/v1.0Endpoint for auth server, such as keystone
auth_user=test:testerNo help text available for this option
auth_user=test:testerDefault user for dispersion in this context
auth_key=testingNo help text available for this option
auth_url=http://saio:5000/v2.0/No help text available for this option
auth_url=http://saio:5000/v2.0/Endpoint for auth server, such as keystone
auth_user=test:testerNo help text available for this option
auth_user=test:testerDefault user for dispersion in this context
auth_key=testingNo help text available for this option
auth_version=2.0No help text available for this option
auth_version=2.0Indicates which version of auth
endpoint_type=publicURLNo help text available for this option
endpoint_type=publicURLIndicates whether endpoint for auth is public or internal
keystone_api_insecure=noNo help text available for this option
swift_dir=/etc/swiftSwift configuration directory
dispersion_coverage=1No help text available for this option
dispersion_coverage=1.0No help text available for this option
retries=5No help text available for this option
concurrency=25Number of replication workers to spawn
container_report=yesNo help text available for this option
object_report=yesNo help text available for this option
dump_json=noNo help text available for this option
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-drive-audit-drive-audit.xml b/doc/src/docbkx/common/tables/swift-drive-audit-drive-audit.xml index 6df7b506b5..fd339149c2 100644 --- a/doc/src/docbkx/common/tables/swift-drive-audit-drive-audit.xml +++ b/doc/src/docbkx/common/tables/swift-drive-audit-drive-audit.xml @@ -1,8 +1,7 @@ - + @@ -17,22 +16,28 @@ - + - + - + - - + + - + - + + + + + + +
Description of configuration options for [drive-audit] in drive-audit.conf-sample
device_dir=/srv/nodeDirectory devices are mounted under
log_facility=LOG_LOCAL0Syslog log facility
log_level=INFOLogging level
log_address=/dev/logNo help text available for this option
log_address=/dev/logLocation where syslog sends the logs to
minutes=60Number of minutes to look back in `/var/log/kern.log`
error_limit=1Number of errors to find before a device is unmounted
log_file_pattern=/var/log/kern*Location of the log file with globbing pattern to check against device errors locate device blocks with errors in the log file
regex_pattern_1=\berror\b.*\b(dm-[0-9]{1,2}\d?)\bNo help text available for this option
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-memcache-memcache.xml b/doc/src/docbkx/common/tables/swift-memcache-memcache.xml index a0aa303f92..b4176a9ae0 100644 --- a/doc/src/docbkx/common/tables/swift-memcache-memcache.xml +++ b/doc/src/docbkx/common/tables/swift-memcache-memcache.xml @@ -1,8 +1,7 @@ - + @@ -17,10 +16,10 @@ - + - +
Description of configuration options for [memcache] in memcache.conf-sample
memcache_servers=127.0.0.1:11211Comma separated list of memcached servers ip:port services
memcache_serialization_support=2No help text available for this option
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-object-expirer-DEFAULT.xml b/doc/src/docbkx/common/tables/swift-object-expirer-DEFAULT.xml index 6f669ee0f0..972e4c4dbe 100644 --- a/doc/src/docbkx/common/tables/swift-object-expirer-DEFAULT.xml +++ b/doc/src/docbkx/common/tables/swift-object-expirer-DEFAULT.xml @@ -1,8 +1,7 @@ - + @@ -17,46 +16,49 @@ - + - + - + - + - + - - + + - + - - + + - - + + - - + + - - + + - - + + - - + + - - + +
Description of configuration options for [DEFAULT] in object-expirer.conf-sample
swift_dir=/etc/swiftSwift configuration directory
user=swiftUser to run as
log_name=swiftLabel used when logging
log_facility=LOG_LOCAL0Syslog log facility
log_level=INFOLogging level
log_address=/dev/logNo help text available for this option
log_address=/dev/logLocation where syslog sends the logs to
log_custom_handlers=Comma-separated list of functions to call to setup custom log handlers.
log_udp_host=No help text available for this option
log_udp_host=If not set, the UDB receiver for syslog is disabled.
log_udp_port=514No help text available for this option
log_udp_port=514Port value for UDB receiver, if enabled.
log_statsd_host=localhostNo help text available for this option
log_statsd_host=localhostIf not set, the StatsD feature is disabled.
log_statsd_port=8125No help text available for this option
log_statsd_port=8125Port value for the StatsD server.
log_statsd_default_sample_rate=1.0No help text available for this option
log_statsd_default_sample_rate=1.0Defines the probability of sending a sample for any given event or + timing measurement.
log_statsd_sample_rate_factor=1.0No help text available for this option
log_statsd_sample_rate_factor=1.0Not recommended to set this to a value less than 1.0, if frequency + of logging is too high, tune the + log_statsd_default_sample_rate instead.
log_statsd_metric_prefix=No help text available for this option
log_statsd_metric_prefix=Value will be prepended to every metric sent to the StatsD server.
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-object-expirer-app-proxy-server.xml b/doc/src/docbkx/common/tables/swift-object-expirer-app-proxy-server.xml index 5bbdf58140..7ed63c85fc 100644 --- a/doc/src/docbkx/common/tables/swift-object-expirer-app-proxy-server.xml +++ b/doc/src/docbkx/common/tables/swift-object-expirer-app-proxy-server.xml @@ -1,8 +1,7 @@ - + @@ -16,8 +15,8 @@ - - + +
Description of configuration options for [app:proxy-server] in object-expirer.conf-sample
use=egg:swift#proxyNo help text available for this option
use=egg:swift#proxyEntry point of paste.deploy in the server
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-object-expirer-filter-cache.xml b/doc/src/docbkx/common/tables/swift-object-expirer-filter-cache.xml index 1e4e83b95f..22d841c3b1 100644 --- a/doc/src/docbkx/common/tables/swift-object-expirer-filter-cache.xml +++ b/doc/src/docbkx/common/tables/swift-object-expirer-filter-cache.xml @@ -1,8 +1,7 @@ - + @@ -16,8 +15,8 @@ - - + +
Description of configuration options for [filter:cache] in object-expirer.conf-sample
use=egg:swift#memcacheNo help text available for this option
use=egg:swift#memcacheEntry point of paste.deploy in the server
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-object-expirer-filter-catch_errors.xml b/doc/src/docbkx/common/tables/swift-object-expirer-filter-catch_errors.xml index 37dac29163..c373d863fa 100644 --- a/doc/src/docbkx/common/tables/swift-object-expirer-filter-catch_errors.xml +++ b/doc/src/docbkx/common/tables/swift-object-expirer-filter-catch_errors.xml @@ -1,8 +1,7 @@ - + @@ -16,8 +15,8 @@ - - + +
Description of configuration options for [filter:catch_errors] in object-expirer.conf-sample
use=egg:swift#catch_errorsNo help text available for this option
use=egg:swift#catch_errorsEntry point of paste.deploy in the server
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-object-expirer-object-expirer.xml b/doc/src/docbkx/common/tables/swift-object-expirer-object-expirer.xml index e9b5380c0a..3214e5321e 100644 --- a/doc/src/docbkx/common/tables/swift-object-expirer-object-expirer.xml +++ b/doc/src/docbkx/common/tables/swift-object-expirer-object-expirer.xml @@ -1,8 +1,7 @@ - + @@ -17,22 +16,24 @@ - + - - + + - + - + - + - - + +
Description of configuration options for [object-expirer] in object-expirer.conf-sample
interval=300Minimum time for a pass to take
auto_create_account_prefix=.No help text available for this option
auto_create_account_prefix=.Prefix to use when automatically creating accounts
report_interval=300No help text available for this option
concurrency=1Number of replication workers to spawn
processes=0No help text available for this option
process=0(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
process=0(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.
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-object-expirer-pipeline-main.xml b/doc/src/docbkx/common/tables/swift-object-expirer-pipeline-main.xml index e6ed80ef6d..60e0e1adcb 100644 --- a/doc/src/docbkx/common/tables/swift-object-expirer-pipeline-main.xml +++ b/doc/src/docbkx/common/tables/swift-object-expirer-pipeline-main.xml @@ -1,8 +1,7 @@ - + @@ -17,7 +16,7 @@ - +
Description of configuration options for [pipeline:main] in object-expirer.conf-sample
pipeline=catch_errors cache proxy-serverNo help text available for this option
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-object-server-DEFAULT.xml b/doc/src/docbkx/common/tables/swift-object-server-DEFAULT.xml index c637f97180..a85de14ba7 100644 --- a/doc/src/docbkx/common/tables/swift-object-server-DEFAULT.xml +++ b/doc/src/docbkx/common/tables/swift-object-server-DEFAULT.xml @@ -1,8 +1,7 @@ - + @@ -17,79 +16,92 @@ - + - + - + - - - - + - + - + - + - + - + - + + + + + + + - + - + - + - - + + - + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - + - +
Description of configuration options for [DEFAULT] in object-server.conf-sample
bind_ip=0.0.0.0IP Address for server to bind to
bind_port=6000Port for server to bind to
bind_timeout=30Seconds to attempt bind before giving up
backlog=4096Maximum number of allowed pending TCP connections
workers=1a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.
user=swiftUser to run as
swift_dir=/etc/swiftSwift configuration directory
devices=/srv/nodeParent directory of where devices are mounted
mount_check=trueWhether or not check if the devices are mounted to prevent accidentally writing to the root device
disable_fallocate=falseDisable "fast fail" fallocate checks if the underlying filesystem does not support it.
expiring_objects_container_divisor=86400No help text available for this option
workers=autoa much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.
max_clients=1024Maximum number of clients one worker can process simultaneously +Lowering the number of clients handled per worker, and raising the +number of workers can lessen the impact that a CPU intensive, or +blocking, request can have on other requests served by the same +worker. If the maximum number of clients is set to one, then a given worker +will not perform another call while processing, allowing +other workers a chance to process it. +
log_name=swiftLabel used when logging
log_facility=LOG_LOCAL0Syslog log facility
log_level=INFOLogging level
log_address=/dev/logNo help text available for this option
log_address=/dev/logLocation where syslog sends the logs to
log_custom_handlers=Comma-separated list of functions to call to setup custom log handlers.
log_udp_host=No help text available for this option
log_udp_host=If not set, the UDB receiver for syslog is disabled.
log_udp_port=514No help text available for this option
log_udp_port=514Port value for UDB receiver, if enabled.
log_statsd_host=localhostNo help text available for this option
log_statsd_host=localhostIf not set, the StatsD feature is disabled.
log_statsd_port=8125No help text available for this option
log_statsd_port=8125Port value for the StatsD server.
log_statsd_default_sample_rate=1.0No help text available for this option
log_statsd_default_sample_rate=1.0Defines the probability of sending a sample for any given event or + timing measurement.
log_statsd_sample_rate_factor=1.0No help text available for this option
log_statsd_sample_rate_factor=1.0Not recommended to set this to a value less than 1.0, if frequency + of logging is too high, tune the + log_statsd_default_sample_rate instead.
log_statsd_metric_prefix=No help text available for this option
log_statsd_metric_prefix=Value will be prepended to every metric sent to the StatsD server.
eventlet_debug=falseIf true, turn on debug logging for eventlet
fallocate_reserve=0You 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`.
-
+ \ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-object-server-app-object-server.xml b/doc/src/docbkx/common/tables/swift-object-server-app-object-server.xml index 4e185392f7..6f765aaa52 100644 --- a/doc/src/docbkx/common/tables/swift-object-server-app-object-server.xml +++ b/doc/src/docbkx/common/tables/swift-object-server-app-object-server.xml @@ -1,8 +1,7 @@ - + @@ -17,64 +16,61 @@ - + - - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - - - - + + - + - +
Description of configuration options for [app:object-server] in object-server.conf-sample
use=egg:swift#objectEntry point of paste.deploy in the server
set log_name=object-serverLabel used when logging
set log_name=object-serverLabel to use when logging
set log_facility=LOG_LOCAL0Syslog log facility
set log_level=INFOLog level
set log_requests=trueWhether or not to log requests
set log_address=/dev/logNo help text available for this option
node_timeout=3Request timeout to external services
conn_timeout=0.5Connection timeout to external services
network_chunk_size=65536Size of chunks to read/write over the network
disk_chunk_size=65536Size of chunks to read/write to disk
max_upload_time=86400Maximum time allowed to upload an object
slow=0If > 0, Minimum time in seconds for a PUT or DELETE request to complete
keep_cache_size=5424880Largest object size to keep in buffer cache
keep_cache_private=falseAllow non-public objects to stay in kernel's buffer cache
mb_per_sync=512On PUT requests, sync file every n MB
allowed_headers=Content-Disposition, Content-Encoding, X-Delete-At, X-Object-Manifest, X-Static-Large-ObjectComma-separated list of headers that can be set in metadata of an object
auto_create_account_prefix=.Prefix used when automatically creating accounts
max_clients=1024Maximum number of clients one worker can process simultaneously (it will actually
auto_create_account_prefix=.Prefix to use when automatically creating accounts
replication_server=falseIf 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.
threads_per_disk=0Size 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.
-
+ \ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-object-server-filter-healthcheck.xml b/doc/src/docbkx/common/tables/swift-object-server-filter-healthcheck.xml index 31a08c2847..05bdc33e8e 100644 --- a/doc/src/docbkx/common/tables/swift-object-server-filter-healthcheck.xml +++ b/doc/src/docbkx/common/tables/swift-object-server-filter-healthcheck.xml @@ -1,8 +1,7 @@ - + @@ -16,11 +15,11 @@ - - + + - +
Description of configuration options for [filter:healthcheck] in object-server.conf-sample
use=egg:swift#healthcheckNo help text available for this option
use=egg:swift#healthcheckEntry point of paste.deploy in the server
disable_path=No help text available for this option
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-object-server-filter-recon.xml b/doc/src/docbkx/common/tables/swift-object-server-filter-recon.xml index 0e54700fb4..0986a21e5b 100644 --- a/doc/src/docbkx/common/tables/swift-object-server-filter-recon.xml +++ b/doc/src/docbkx/common/tables/swift-object-server-filter-recon.xml @@ -1,8 +1,7 @@ - + @@ -16,14 +15,14 @@ - - + + - - + + - +
Description of configuration options for [filter:recon] in object-server.conf-sample
use=egg:swift#reconNo help text available for this option
use=egg:swift#reconEntry point of paste.deploy in the server
recon_cache_path=/var/cache/swiftNo help text available for this option
recon_cache_path=/var/cache/swiftDirectory where stats for a few items will be stored
recon_lock_path=/var/lockNo help text available for this option
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-object-server-object-auditor.xml b/doc/src/docbkx/common/tables/swift-object-server-object-auditor.xml index 2465cf7221..061e404480 100644 --- a/doc/src/docbkx/common/tables/swift-object-server-object-auditor.xml +++ b/doc/src/docbkx/common/tables/swift-object-server-object-auditor.xml @@ -1,8 +1,7 @@ - + @@ -17,34 +16,34 @@ - + - + - + - - + + - + - + - + - + - - + + - +
Description of configuration options for [object-auditor] in object-server.conf-sample
log_name=object-auditorLabel used when logging
log_facility=LOG_LOCAL0Syslog log facility
log_level=INFOLogging level
log_address=/dev/logNo help text available for this option
log_address=/dev/logLocation where syslog sends the logs to
files_per_second=20Maximum files audited per second. Should be tuned according to individual system specs. 0 is unlimited.
bytes_per_second=10000000Maximum 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`.
log_time=3600Frequency of status logs in seconds.
zero_byte_files_per_second=50Maximum zero byte files audited per second.
recon_cache_path=/var/cache/swiftNo help text available for this option
recon_cache_path=/var/cache/swiftDirectory where stats for a few items will be stored
object_size_stats=No help text available for this option
-
+ \ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-object-server-object-replicator.xml b/doc/src/docbkx/common/tables/swift-object-server-object-replicator.xml index f860eb394e..cba8d2c8d4 100644 --- a/doc/src/docbkx/common/tables/swift-object-server-object-replicator.xml +++ b/doc/src/docbkx/common/tables/swift-object-server-object-replicator.xml @@ -1,8 +1,7 @@ - + @@ -17,55 +16,58 @@ - + - + - + - - + + - + - + - + - + - + - + - + - + - + - + - + - + - + + + +
Description of configuration options for [object-replicator] in object-server.conf-sample
log_name=object-replicatorLabel used when logging
log_facility=LOG_LOCAL0Syslog log facility
log_level=INFOLogging level
log_address=/dev/logNo help text available for this option
log_address=/dev/logLocation where syslog sends the logs to
vm_test_mode=noIndicates that you are using a VM environment
daemonize=onWhether or not to run replication as a daemon
run_pause=30Time in seconds to wait between replication passes
concurrency=1Number of replication workers to spawn
stats_interval=300Interval in seconds between logging replication statistics
rsync_timeout=900Max duration (seconds) of a partition rsync
rsync_bwlimit=0No help text available for this option
rsync_io_timeout=30Passed to rsync for a max duration (seconds) of an I/O op
http_timeout=60Maximum duration for an HTTP request
lockup_timeout=1800Attempts to kill all workers if nothing replications for lockup_timeout seconds
reclaim_age=604800Time elapsed in seconds before an object can be reclaimed
ring_check_interval=15How often (in seconds) to check the ring
recon_cache_path=/var/cache/swiftDirectory where stats for a few items will be stored
rsync_error_log_line_length=0No help text available for this option
-
+ \ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-object-server-object-updater.xml b/doc/src/docbkx/common/tables/swift-object-server-object-updater.xml index d57a1deaf6..f9656417e7 100644 --- a/doc/src/docbkx/common/tables/swift-object-server-object-updater.xml +++ b/doc/src/docbkx/common/tables/swift-object-server-object-updater.xml @@ -1,8 +1,7 @@ - + @@ -17,34 +16,34 @@ - + - + - + - - + + - + - + - + - + - + - +
Description of configuration options for [object-updater] in object-server.conf-sample
log_name=object-updaterLabel used when logging
log_facility=LOG_LOCAL0Syslog log facility
log_level=INFOLogging level
log_address=/dev/logNo help text available for this option
log_address=/dev/logLocation where syslog sends the logs to
interval=300Minimum time for a pass to take
concurrency=1Number of replication workers to spawn
node_timeout=10Request timeout to external services
conn_timeout=0.5Connection timeout to external services
slowdown=0.01Time in seconds to wait between objects
recon_cache_path=/var/cache/swiftDirectory where stats for a few items will be stored
-
+ \ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-object-server-pipeline-main.xml b/doc/src/docbkx/common/tables/swift-object-server-pipeline-main.xml index b4160056fe..f5bd890a4a 100644 --- a/doc/src/docbkx/common/tables/swift-object-server-pipeline-main.xml +++ b/doc/src/docbkx/common/tables/swift-object-server-pipeline-main.xml @@ -1,8 +1,7 @@ - + @@ -17,7 +16,7 @@ - +
Description of configuration options for [pipeline:main] in object-server.conf-sample
pipeline=healthcheck recon object-serverNo help text available for this option
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-proxy-server-DEFAULT.xml b/doc/src/docbkx/common/tables/swift-proxy-server-DEFAULT.xml index 819e5c184c..5858a483ce 100644 --- a/doc/src/docbkx/common/tables/swift-proxy-server-DEFAULT.xml +++ b/doc/src/docbkx/common/tables/swift-proxy-server-DEFAULT.xml @@ -1,8 +1,7 @@ - + @@ -17,88 +16,98 @@ - + - + - + - + - - - - + - + + + + + + + - + - + - + - + - + - + - + - - + + - + - + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - + - + - - - - +
Description of configuration options for [DEFAULT] in proxy-server.conf-sample
bind_ip=0.0.0.0IP Address for server to bind to
bind_port=80Port for server to bind to
bind_timeout=30Seconds to attempt bind before giving up
backlog=4096Maximum number of allowed pending TCP connections
swift_dir=/etc/swiftSwift configuration directory
workers=1a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.
user=swiftUser to run as
workers=autoa much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.
max_clients=1024Maximum number of clients one worker can process simultaneously +Lowering the number of clients handled per worker, and raising the +number of workers can lessen the impact that a CPU intensive, or +blocking, request can have on other requests served by the same +worker. If the maximum number of clients is set to one, then a given worker +will not perform another call while processing, allowing +other workers a chance to process it. +
cert_file=/etc/swift/proxy.crtto the ssl .crt. This should be enabled for testing purposes only.
key_file=/etc/swift/proxy.keyto the ssl .key. This should be enabled for testing purposes only.
expiring_objects_container_divisor=86400No help text available for this option
log_name=swiftLabel used when logging
log_facility=LOG_LOCAL0Syslog log facility
log_level=INFOLogging level
log_headers=falseNo help text available for this option
log_address=/dev/logNo help text available for this option
log_address=/dev/logLocation where syslog sends the logs to
trans_id_suffix=No help text available for this option
log_custom_handlers=Comma-separated list of functions to call to setup custom log handlers.
log_udp_host=No help text available for this option
log_udp_host=If not set, the UDB receiver for syslog is disabled.
log_udp_port=514No help text available for this option
log_udp_port=514Port value for UDB receiver, if enabled.
log_statsd_host=localhostNo help text available for this option
log_statsd_host=localhostIf not set, the StatsD feature is disabled.
log_statsd_port=8125No help text available for this option
log_statsd_port=8125Port value for the StatsD server.
log_statsd_default_sample_rate=1.0No help text available for this option
log_statsd_default_sample_rate=1.0Defines the probability of sending a sample for any given event or + timing measurement.
log_statsd_sample_rate_factor=1.0No help text available for this option
log_statsd_sample_rate_factor=1.0Not recommended to set this to a value less than 1.0, if frequency + of logging is too high, tune the + log_statsd_default_sample_rate instead.
log_statsd_metric_prefix=No help text available for this option
log_statsd_metric_prefix=Value will be prepended to every metric sent to the StatsD server.
cors_allow_origin=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
client_timeout=60Timeout to read one chunk from a client external services
eventlet_debug=falseIf true, turn on debug logging for eventlet
max_clients=1024Maximum number of clients one worker can process simultaneously (it will actually
-
+ \ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-proxy-server-app-proxy-server.xml b/doc/src/docbkx/common/tables/swift-proxy-server-app-proxy-server.xml index 3a93951e55..dd208f9533 100644 --- a/doc/src/docbkx/common/tables/swift-proxy-server-app-proxy-server.xml +++ b/doc/src/docbkx/common/tables/swift-proxy-server-app-proxy-server.xml @@ -1,8 +1,7 @@ - + @@ -16,107 +15,110 @@ - - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - + + - + - + - + - + - + + + +
Description of configuration options for [app:proxy-server] in proxy-server.conf-sample
use=egg:swift#proxyNo help text available for this option
use=egg:swift#proxyEntry point of paste.deploy in the server
set log_name=proxy-serverLabel to use when logging
set log_facility=LOG_LOCAL0Syslog log facility
set log_level=INFOLog level
set log_address=/dev/logNo help text available for this option
log_handoffs=trueNo help text available for this option
recheck_account_existence=60Cache timeout in seconds to send memcached for account existence
recheck_container_existence=60Cache timeout in seconds to send memcached for container existence
object_chunk_size=8192Chunk size to read from object servers
client_chunk_size=8192Chunk size to read from clients
node_timeout=10Request timeout to external services
conn_timeout=0.5Connection timeout to external services
error_suppression_interval=60Time in seconds that must elapse since the last error for a node to be considered no longer error limited
error_suppression_limit=10Error count to consider a node error limited
allow_account_management=falseWhether account PUTs and DELETEs are even callable
object_post_as_copy=trueSet 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.
account_autocreate=falseIf set to 'true' authorized accounts that do not yet exist within the Swift cluster will be automatically created.
max_containers_per_account=0If 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.
max_containers_whitelist=is a comma separated list of account names that ignore the max_containers_per_account cap.
deny_host_headers=No help text available for this option
auto_create_account_prefix=.Prefix to use when automatically creating accounts
put_queue_depth=10No help text available for this option
rate_limit_after_segment=10Rate limit the download of large object segments after this segment is downloaded.
rate_limit_segments_per_sec=1Rate 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
sorting_method=shuffleNo help text available for this option
timing_expiry=300No help text available for this option
allow_static_large_object=trueNo help text available for this option
max_large_object_get_time=86400No help text available for this option
request_node_count=2 * replicasNo help text available for this option
request_node_count=2 * replicas* replicas Set to the number of nodes to contact for a normal request. You can use '* replicas' at the end to have it use the number given times the number of replicas for the ring being used for the request. conf file for values will only be shown to the list of swift_owners. The exact default definition of a swift_owner is headers> up to the auth system in use, but usually indicates administrative responsibilities. paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request
read_affinity=r1z1=100, r1z2=200, r2=300No help text available for this option
read_affinity=No help text available for this option
write_affinity=r1, r2No help text available for this option
write_affinity=No help text available for this option
write_affinity_node_count=2 * replicasNo help text available for this option
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-2the sample These are the headers whose conf file for values will only be shown to the list of swift_owners. The exact default definition of a swift_owner is headers> up to the auth system in use, but usually indicates administrative responsibilities. paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request
-
+ \ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-proxy-server-filter-account-quotas.xml b/doc/src/docbkx/common/tables/swift-proxy-server-filter-account-quotas.xml index 12814ef6f7..b835cc0e3d 100644 --- a/doc/src/docbkx/common/tables/swift-proxy-server-filter-account-quotas.xml +++ b/doc/src/docbkx/common/tables/swift-proxy-server-filter-account-quotas.xml @@ -1,8 +1,7 @@ - + @@ -16,8 +15,8 @@ - - + +
Description of configuration options for [filter:account-quotas] in proxy-server.conf-sample
use=egg:swift#account_quotasNo help text available for this option
use=egg:swift#account_quotasEntry point of paste.deploy in the server
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-proxy-server-filter-authtoken.xml b/doc/src/docbkx/common/tables/swift-proxy-server-filter-authtoken.xml index 6028e0f2c1..e49fa6e2a5 100644 --- a/doc/src/docbkx/common/tables/swift-proxy-server-filter-authtoken.xml +++ b/doc/src/docbkx/common/tables/swift-proxy-server-filter-authtoken.xml @@ -1,8 +1,7 @@ - + @@ -17,31 +16,31 @@ - + - + - + - + - + - + - + - + - +
Description of configuration options for [filter:authtoken] in proxy-server.conf-sample
auth_host=keystonehostNo help text available for this option
auth_port=35357No help text available for this option
auth_protocol=httpNo help text available for this option
auth_uri=http://keystonehost:5000/No help text available for this option
admin_tenant_name=serviceNo help text available for this option
admin_user=swiftNo help text available for this option
admin_password=passwordNo help text available for this option
delay_auth_decision=1No help text available for this option
cache=swift.cacheNo help text available for this option
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-proxy-server-filter-bulk.xml b/doc/src/docbkx/common/tables/swift-proxy-server-filter-bulk.xml index 64502181d8..5954fb7f35 100644 --- a/doc/src/docbkx/common/tables/swift-proxy-server-filter-bulk.xml +++ b/doc/src/docbkx/common/tables/swift-proxy-server-filter-bulk.xml @@ -1,8 +1,7 @@ - + @@ -16,20 +15,20 @@ - - + + - + - + - + - +
Description of configuration options for [filter:bulk] in proxy-server.conf-sample
use=egg:swift#bulkNo help text available for this option
use=egg:swift#bulkEntry point of paste.deploy in the server
max_containers_per_extraction=10000No help text available for this option
max_failed_extractions=1000No help text available for this option
max_deletes_per_request=10000No help text available for this option
yield_frequency=60No help text available for this option
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-proxy-server-filter-cache.xml b/doc/src/docbkx/common/tables/swift-proxy-server-filter-cache.xml index 6921d3f59b..c4dbb5fa19 100644 --- a/doc/src/docbkx/common/tables/swift-proxy-server-filter-cache.xml +++ b/doc/src/docbkx/common/tables/swift-proxy-server-filter-cache.xml @@ -1,8 +1,7 @@ - + @@ -16,29 +15,29 @@ - - + + - - + + - - + + - - + + - - + + - + - + - +
Description of configuration options for [filter:cache] in proxy-server.conf-sample
use=egg:swift#memcacheNo help text available for this option
use=egg:swift#memcacheEntry point of paste.deploy in the server
set log_name=cacheNo help text available for this option
set log_name=cacheLabel to use when logging
set log_facility=LOG_LOCAL0No help text available for this option
set log_facility=LOG_LOCAL0Syslog log facility
set log_level=INFONo help text available for this option
set log_level=INFOLog level
set log_headers=falseNo help text available for this option
set log_headers=falseIf True, log headers in each request
set log_address=/dev/logNo help text available for this option
memcache_servers=127.0.0.1:11211Comma separated list of memcached servers ip:port services
memcache_serialization_support=2No help text available for this option
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-proxy-server-filter-catch_errors.xml b/doc/src/docbkx/common/tables/swift-proxy-server-filter-catch_errors.xml index 2b193899f4..f0fce75843 100644 --- a/doc/src/docbkx/common/tables/swift-proxy-server-filter-catch_errors.xml +++ b/doc/src/docbkx/common/tables/swift-proxy-server-filter-catch_errors.xml @@ -1,8 +1,7 @@ - + @@ -16,23 +15,23 @@ - - + + - - + + - - + + - - + + - - + + - +
Description of configuration options for [filter:catch_errors] in proxy-server.conf-sample
use=egg:swift#catch_errorsNo help text available for this option
use=egg:swift#catch_errorsEntry point of paste.deploy in the server
set log_name=catch_errorsNo help text available for this option
set log_name=catch_errorsLabel to use when logging
set log_facility=LOG_LOCAL0No help text available for this option
set log_facility=LOG_LOCAL0Syslog log facility
set log_level=INFONo help text available for this option
set log_level=INFOLog level
set log_headers=falseNo help text available for this option
set log_headers=falseIf True, log headers in each request
set log_address=/dev/logNo help text available for this option
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-proxy-server-filter-cname_lookup.xml b/doc/src/docbkx/common/tables/swift-proxy-server-filter-cname_lookup.xml index a4c35cac12..8ef13954d1 100644 --- a/doc/src/docbkx/common/tables/swift-proxy-server-filter-cname_lookup.xml +++ b/doc/src/docbkx/common/tables/swift-proxy-server-filter-cname_lookup.xml @@ -1,8 +1,7 @@ - + @@ -16,29 +15,29 @@ - - + + - - + + - + - + - + - + - - + + - +
Description of configuration options for [filter:cname_lookup] in proxy-server.conf-sample
use=egg:swift#cname_lookupNo help text available for this option
use=egg:swift#cname_lookupEntry point of paste.deploy in the server
set log_name=cname_lookupLabel used when logging
set log_name=cname_lookupLabel to use when logging
set log_facility=LOG_LOCAL0Syslog log facility
set log_level=INFOLog level
set log_headers=falseIf True, log headers in each request
set log_address=/dev/logNo help text available for this option
storage_domain=example.comNo help text available for this option
storage_domain=example.comDomain to use for remap
lookup_depth=1As CNAMES can be recursive, how many levels to search through
-
+ \ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-proxy-server-filter-container-quotas.xml b/doc/src/docbkx/common/tables/swift-proxy-server-filter-container-quotas.xml index e6138aa10d..7249c0652f 100644 --- a/doc/src/docbkx/common/tables/swift-proxy-server-filter-container-quotas.xml +++ b/doc/src/docbkx/common/tables/swift-proxy-server-filter-container-quotas.xml @@ -1,8 +1,7 @@ - + @@ -16,8 +15,8 @@ - - + +
Description of configuration options for [filter:container-quotas] in proxy-server.conf-sample
use=egg:swift#container_quotasNo help text available for this option
use=egg:swift#container_quotasEntry point of paste.deploy in the server
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-proxy-server-filter-domain_remap.xml b/doc/src/docbkx/common/tables/swift-proxy-server-filter-domain_remap.xml index 5170fde2cd..4665da968e 100644 --- a/doc/src/docbkx/common/tables/swift-proxy-server-filter-domain_remap.xml +++ b/doc/src/docbkx/common/tables/swift-proxy-server-filter-domain_remap.xml @@ -1,8 +1,7 @@ - + @@ -16,32 +15,32 @@ - - + + - - + + - + - + - - + + - + - + - + - +
Description of configuration options for [filter:domain_remap] in proxy-server.conf-sample
use=egg:swift#domain_remapNo help text available for this option
use=egg:swift#domain_remapEntry point of paste.deploy in the server
set log_name=domain_remapLabel used when logging
set log_name=domain_remapLabel to use when logging
set log_facility=LOG_LOCAL0Syslog log facility
set log_level=INFOLog level
set log_headers=falseIf True, log headers with each request
set log_headers=falseIf True, log headers in each request
set log_address=/dev/logNo help text available for this option
storage_domain=example.comDomain to use for remap
path_root=v1Root path
reseller_prefixes=AUTHReseller prefix
-
+ \ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-proxy-server-filter-formpost.xml b/doc/src/docbkx/common/tables/swift-proxy-server-filter-formpost.xml index 4510cade84..85487edc73 100644 --- a/doc/src/docbkx/common/tables/swift-proxy-server-filter-formpost.xml +++ b/doc/src/docbkx/common/tables/swift-proxy-server-filter-formpost.xml @@ -1,8 +1,7 @@ - + @@ -16,8 +15,8 @@ - - + +
Description of configuration options for [filter:formpost] in proxy-server.conf-sample
use=egg:swift#formpostNo help text available for this option
use=egg:swift#formpostEntry point of paste.deploy in the server
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-proxy-server-filter-healthcheck.xml b/doc/src/docbkx/common/tables/swift-proxy-server-filter-healthcheck.xml index 1b16b0e265..8659a8d87f 100644 --- a/doc/src/docbkx/common/tables/swift-proxy-server-filter-healthcheck.xml +++ b/doc/src/docbkx/common/tables/swift-proxy-server-filter-healthcheck.xml @@ -1,8 +1,7 @@ - + @@ -16,11 +15,11 @@ - - + + - +
Description of configuration options for [filter:healthcheck] in proxy-server.conf-sample
use=egg:swift#healthcheckNo help text available for this option
use=egg:swift#healthcheckEntry point of paste.deploy in the server
disable_path=No help text available for this option
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-proxy-server-filter-keystoneauth.xml b/doc/src/docbkx/common/tables/swift-proxy-server-filter-keystoneauth.xml index 03433caf1b..f7711e70ad 100644 --- a/doc/src/docbkx/common/tables/swift-proxy-server-filter-keystoneauth.xml +++ b/doc/src/docbkx/common/tables/swift-proxy-server-filter-keystoneauth.xml @@ -1,8 +1,7 @@ - + @@ -16,11 +15,11 @@ - - + + - +
Description of configuration options for [filter:keystoneauth] in proxy-server.conf-sample
use=egg:swift#keystoneauthNo help text available for this option
use=egg:swift#keystoneauthEntry point of paste.deploy in the server
operator_roles=admin, swiftoperatorNo help text available for this option
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-proxy-server-filter-list-endpoints.xml b/doc/src/docbkx/common/tables/swift-proxy-server-filter-list-endpoints.xml index cfaa7ae8cb..0ada2a9032 100644 --- a/doc/src/docbkx/common/tables/swift-proxy-server-filter-list-endpoints.xml +++ b/doc/src/docbkx/common/tables/swift-proxy-server-filter-list-endpoints.xml @@ -1,8 +1,7 @@ - + @@ -16,11 +15,11 @@ - - + + - +
Description of configuration options for [filter:list-endpoints] in proxy-server.conf-sample
use=egg:swift#list_endpointsNo help text available for this option
use=egg:swift#list_endpointsEntry point of paste.deploy in the server
list_endpoints_path=/endpoints/No help text available for this option
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-proxy-server-filter-name_check.xml b/doc/src/docbkx/common/tables/swift-proxy-server-filter-name_check.xml index 0c3811e895..6ff8d53359 100644 --- a/doc/src/docbkx/common/tables/swift-proxy-server-filter-name_check.xml +++ b/doc/src/docbkx/common/tables/swift-proxy-server-filter-name_check.xml @@ -1,8 +1,7 @@ - + @@ -16,17 +15,17 @@ - - + + - + - + - +
Description of configuration options for [filter:name_check] in proxy-server.conf-sample
use=egg:swift#name_checkNo help text available for this option
use=egg:swift#name_checkEntry point of paste.deploy in the server
forbidden_chars='"`<>Characters that are not allowed in a name
maximum_length=255Maximum length of a name
forbidden_regexp=/\./|/\.\./|/\.$|/\.\.$Substrings to forbid, using regular expression syntax
-
+ \ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-proxy-server-filter-proxy-logging.xml b/doc/src/docbkx/common/tables/swift-proxy-server-filter-proxy-logging.xml index 25d41c64be..729f0197ce 100644 --- a/doc/src/docbkx/common/tables/swift-proxy-server-filter-proxy-logging.xml +++ b/doc/src/docbkx/common/tables/swift-proxy-server-filter-proxy-logging.xml @@ -1,8 +1,7 @@ - + @@ -16,47 +15,53 @@ - - + + - + - + - + - + - + - + - + - + - + - + - + - + + + + + + + - +
Description of configuration options for [filter:proxy-logging] in proxy-server.conf-sample
use=egg:swift#proxy_loggingNo help text available for this option
use=egg:swift#proxy_loggingEntry point of paste.deploy in the server
access_log_name=swiftNo help text available for this option
access_log_facility=LOG_LOCAL0No help text available for this option
access_log_level=INFONo help text available for this option
access_log_address=/dev/logNo help text available for this option
access_log_udp_host=No help text available for this option
access_log_udp_port=514No help text available for this option
access_log_statsd_host=localhostNo help text available for this option
access_log_statsd_port=8125No help text available for this option
access_log_statsd_default_sample_rate=1.0No help text available for this option
access_log_statsd_sample_rate_factor=1.0No help text available for this option
access_log_statsd_metric_prefix=No help text available for this option
access_log_headers=falseNo help text available for this option
logged with access_log_headers=True.No help text available for this option
reveal_sensitive_prefix=8192No help text available for this option
log_statsd_valid_http_methods=GET,HEAD,POST,PUT,DELETE,COPY,OPTIONSNo help text available for this option
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-proxy-server-filter-ratelimit.xml b/doc/src/docbkx/common/tables/swift-proxy-server-filter-ratelimit.xml index f40f398793..0b92968b33 100644 --- a/doc/src/docbkx/common/tables/swift-proxy-server-filter-ratelimit.xml +++ b/doc/src/docbkx/common/tables/swift-proxy-server-filter-ratelimit.xml @@ -1,8 +1,7 @@ - + @@ -16,65 +15,65 @@ - - + + - - + + - - + + - - + + - - + + - + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - + - + - + - + - + - + - +
Description of configuration options for [filter:ratelimit] in proxy-server.conf-sample
use=egg:swift#ratelimitNo help text available for this option
use=egg:swift#ratelimitEntry point of paste.deploy in the server
set log_name=ratelimitNo help text available for this option
set log_name=ratelimitLabel to use when logging
set log_facility=LOG_LOCAL0No help text available for this option
set log_facility=LOG_LOCAL0Syslog log facility
set log_level=INFONo help text available for this option
set log_level=INFOLog level
set log_headers=falseNo help text available for this option
set log_headers=falseIf True, log headers in each request
set log_address=/dev/logNo help text available for this option
clock_accuracy=1000No help text available for this option
clock_accuracy=1000Represents 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.
max_sleep_time_seconds=60No help text available for this option
max_sleep_time_seconds=60App will immediately return a 498 response if the necessary sleep time ever exceeds the given max_sleep_time_seconds.
log_sleep_time_seconds=0No help text available for this option
log_sleep_time_seconds=0To allow visibility into rate limiting set this value > 0 and all sleeps greater than the number will be logged.
rate_buffer_seconds=5No help text available for this option
rate_buffer_seconds=5Number 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.
account_ratelimit=0No help text available for this option
account_ratelimit=0If set, will limit PUT and DELETE requests to /account_name/container_name. Number is in requests per second.
account_whitelist=a,bNo help text available for this option
account_whitelist=a,bComma separated lists of account names that will not be rate limited.
account_blacklist=c,dNo help text available for this option
account_blacklist=c,dComma 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.
with container_limit_x=rNo help text available for this option
container_ratelimit_0=100No help text available for this option
container_ratelimit_10=50No help text available for this option
container_ratelimit_50=20No help text available for this option
container_listing_ratelimit_0=100No help text available for this option
container_listing_ratelimit_10=50No help text available for this option
container_listing_ratelimit_50=20No help text available for this option
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-proxy-server-filter-slo.xml b/doc/src/docbkx/common/tables/swift-proxy-server-filter-slo.xml index 4fc13c7045..7b04049744 100644 --- a/doc/src/docbkx/common/tables/swift-proxy-server-filter-slo.xml +++ b/doc/src/docbkx/common/tables/swift-proxy-server-filter-slo.xml @@ -1,8 +1,7 @@ - + @@ -16,17 +15,17 @@ - - + + - + - + - +
Description of configuration options for [filter:slo] in proxy-server.conf-sample
use=egg:swift#sloNo help text available for this option
use=egg:swift#sloEntry point of paste.deploy in the server
max_manifest_segments=1000No help text available for this option
max_manifest_size=2097152No help text available for this option
min_segment_size=1048576No help text available for this option
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-proxy-server-filter-staticweb.xml b/doc/src/docbkx/common/tables/swift-proxy-server-filter-staticweb.xml index fe178f1479..1fcecd3440 100644 --- a/doc/src/docbkx/common/tables/swift-proxy-server-filter-staticweb.xml +++ b/doc/src/docbkx/common/tables/swift-proxy-server-filter-staticweb.xml @@ -1,8 +1,7 @@ - + @@ -16,8 +15,8 @@ - - + +
Description of configuration options for [filter:staticweb] in proxy-server.conf-sample
use=egg:swift#staticwebNo help text available for this option
use=egg:swift#staticwebEntry point of paste.deploy in the server
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-proxy-server-filter-tempauth.xml b/doc/src/docbkx/common/tables/swift-proxy-server-filter-tempauth.xml index 8c0121457e..cf08543665 100644 --- a/doc/src/docbkx/common/tables/swift-proxy-server-filter-tempauth.xml +++ b/doc/src/docbkx/common/tables/swift-proxy-server-filter-tempauth.xml @@ -1,8 +1,7 @@ - + @@ -16,50 +15,50 @@ - - + + - - + + - - + + - - + + - - + + - + - + - + - + - + - + - + - + - + - +
Description of configuration options for [filter:tempauth] in proxy-server.conf-sample
use=egg:swift#tempauthNo help text available for this option
use=egg:swift#tempauthEntry point of paste.deploy in the server
set log_name=tempauthNo help text available for this option
set log_name=tempauthLabel to use when logging
set log_facility=LOG_LOCAL0No help text available for this option
set log_facility=LOG_LOCAL0Syslog log facility
set log_level=INFONo help text available for this option
set log_level=INFOLog level
set log_headers=falseNo help text available for this option
set log_headers=falseIf True, log headers in each request
set log_address=/dev/logNo help text available for this option
reseller_prefix=AUTHThe naming scope for the auth service. Swift
auth_prefix=/auth/The HTTP request path prefix for the auth service. Swift itself reserves anything beginning with the letter `v`.
token_life=86400The number of seconds a token is valid.
allow_overrides=trueNo help text available for this option
storage_url_scheme=defaultScheme 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.
user_admin_admin=admin .admin .reseller_adminNo help text available for this option
user_test_tester=testing .adminNo help text available for this option
user_test2_tester2=testing2 .adminNo help text available for this option
user_test_tester3=testing3No help text available for this option
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-proxy-server-filter-tempurl.xml b/doc/src/docbkx/common/tables/swift-proxy-server-filter-tempurl.xml index d23c423fe9..634835c0ae 100644 --- a/doc/src/docbkx/common/tables/swift-proxy-server-filter-tempurl.xml +++ b/doc/src/docbkx/common/tables/swift-proxy-server-filter-tempurl.xml @@ -1,8 +1,7 @@ - + @@ -16,23 +15,23 @@ - - + + - + - + - + - + - +
Description of configuration options for [filter:tempurl] in proxy-server.conf-sample
use=egg:swift#tempurlNo help text available for this option
use=egg:swift#tempurlEntry point of paste.deploy in the server
methods=GET HEAD PUTNo help text available for this option
incoming_remove_headers=x-timestampNo help text available for this option
incoming_allow_headers=No help text available for this option
outgoing_remove_headers=x-object-meta-*No help text available for this option
outgoing_allow_headers=x-object-meta-public-*No help text available for this option
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-proxy-server-pipeline-main.xml b/doc/src/docbkx/common/tables/swift-proxy-server-pipeline-main.xml index f811c0db20..6c4587dfda 100644 --- a/doc/src/docbkx/common/tables/swift-proxy-server-pipeline-main.xml +++ b/doc/src/docbkx/common/tables/swift-proxy-server-pipeline-main.xml @@ -1,8 +1,7 @@ - + @@ -17,7 +16,7 @@ - +
Description of configuration options for [pipeline:main] in proxy-server.conf-sample
pipeline=catch_errors healthcheck proxy-logging cache bulk slo ratelimit tempauth container-quotas account-quotas proxy-logging proxy-serverNo help text available for this option
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-rsyncd-account.xml b/doc/src/docbkx/common/tables/swift-rsyncd-account.xml index 410835c10a..d76a47fc2f 100644 --- a/doc/src/docbkx/common/tables/swift-rsyncd-account.xml +++ b/doc/src/docbkx/common/tables/swift-rsyncd-account.xml @@ -1,8 +1,7 @@ - + @@ -17,16 +16,16 @@ - + - + - + - +
Description of configuration options for [account] in rsyncd.conf-sample
max connections=2No help text available for this option
path=/srv/nodeNo help text available for this option
read only=falseNo help text available for this option
lock file=/var/lock/account.lockNo help text available for this option
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-rsyncd-container.xml b/doc/src/docbkx/common/tables/swift-rsyncd-container.xml index 5efc550602..33e22c4184 100644 --- a/doc/src/docbkx/common/tables/swift-rsyncd-container.xml +++ b/doc/src/docbkx/common/tables/swift-rsyncd-container.xml @@ -1,8 +1,7 @@ - + @@ -17,16 +16,16 @@ - + - + - + - +
Description of configuration options for [container] in rsyncd.conf-sample
max connections=4No help text available for this option
path=/srv/nodeNo help text available for this option
read only=falseNo help text available for this option
lock file=/var/lock/container.lockNo help text available for this option
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-rsyncd-object.xml b/doc/src/docbkx/common/tables/swift-rsyncd-object.xml index 85877658d1..6fea3bf67d 100644 --- a/doc/src/docbkx/common/tables/swift-rsyncd-object.xml +++ b/doc/src/docbkx/common/tables/swift-rsyncd-object.xml @@ -1,8 +1,7 @@ - + @@ -17,16 +16,16 @@ - + - + - + - +
Description of configuration options for [object] in rsyncd.conf-sample
max connections=8No help text available for this option
path=/srv/nodeNo help text available for this option
read only=falseNo help text available for this option
lock file=/var/lock/object.lockNo help text available for this option
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-swift-bench-bench.xml b/doc/src/docbkx/common/tables/swift-swift-bench-bench.xml index 61acec5e0b..199b550867 100644 --- a/doc/src/docbkx/common/tables/swift-swift-bench-bench.xml +++ b/doc/src/docbkx/common/tables/swift-swift-bench-bench.xml @@ -1,8 +1,7 @@ - + @@ -17,79 +16,79 @@ - + - + - + - - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - +
Description of configuration options for [bench] in swift-bench.conf-sample
auth=http://localhost:8080/auth/v1.0Swift storage accounts and auth tokens will begin with this prefix.
user=test:testerUser to run as
key=testingNo help text available for this option
auth_version=1.0No help text available for this option
auth_version=1.0Indicates which version of auth
log-level=INFONo help text available for this option
timeout=10Timeout value sent to rsync --timeout and --contimeout options
put_concurrency=10No help text available for this option
get_concurrency=10No help text available for this option
del_concurrency=10No help text available for this option
concurrency=Number of replication workers to spawn
object_sources=No help text available for this option
lower_object_size=10No help text available for this option
upper_object_size=10No help text available for this option
object_size=1No help text available for this option
num_objects=1000No help text available for this option
num_gets=10000No help text available for this option
num_containers=20No help text available for this option
container_name=(randomly-chosen uuid4)No help text available for this option
delete=yesNo help text available for this option
use_proxy=yesNo help text available for this option
use_proxy=no, this setting is required and used as the X-Storage-Url whenNo help text available for this option
url=No help text available for this option
account=has generated an error (timeout, not yet found, etc.)
use_proxy=no.No help text available for this option
devices=sdb1Parent directory of where devices are mounted
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-swift-swift-constraints.xml b/doc/src/docbkx/common/tables/swift-swift-swift-constraints.xml index 895522a2c7..7f5a51495c 100644 --- a/doc/src/docbkx/common/tables/swift-swift-swift-constraints.xml +++ b/doc/src/docbkx/common/tables/swift-swift-swift-constraints.xml @@ -1,8 +1,7 @@ - + @@ -17,37 +16,37 @@ - + - + - + - + - + - + - + - + - + - + - +
Description of configuration options for [swift-constraints] in swift.conf-sample
max_file_size=5368709122No help text available for this option
max_meta_name_length=128No help text available for this option
max_meta_value_length=256No help text available for this option
max_meta_count=90No help text available for this option
max_meta_overall_size=4096No help text available for this option
max_header_size=8192No help text available for this option
max_object_name_length=1024No help text available for this option
container_listing_limit=10000No help text available for this option
account_listing_limit=10000No help text available for this option
max_account_name_length=256No help text available for this option
max_container_name_length=256No help text available for this option
\ No newline at end of file diff --git a/doc/src/docbkx/common/tables/swift-swift-swift-hash.xml b/doc/src/docbkx/common/tables/swift-swift-swift-hash.xml index ec534aaee1..265b7bff08 100644 --- a/doc/src/docbkx/common/tables/swift-swift-swift-hash.xml +++ b/doc/src/docbkx/common/tables/swift-swift-swift-hash.xml @@ -1,8 +1,7 @@ - + @@ -17,10 +16,10 @@ - + - +
Description of configuration options for [swift-hash] in swift.conf-sample
swift_hash_path_suffix=changemeNo help text available for this option
swift_hash_path_prefix=changemeNo help text available for this option
\ No newline at end of file diff --git a/tools/autogenerate-config-docs/extract_swift_flags.py b/tools/autogenerate-config-docs/extract_swift_flags.py index 6082c13eb6..5a72683fec 100644 --- a/tools/autogenerate-config-docs/extract_swift_flags.py +++ b/tools/autogenerate-config-docs/extract_swift_flags.py @@ -12,6 +12,7 @@ from xml.sax.saxutils import escape # and generally only having a single entry # after the equals (the default value) + def parse_line(line): """ takes a line from a swift sample configuration file and attempts @@ -32,26 +33,33 @@ def parse_line(line): return None return config, default.strip() -def get_existing_options(optfile): + +def get_existing_options(optfiles): """ parses an existing XML table to compile a list of existing options """ - options = [] - xmldoc = minidom.parse(optfile) - tdlist = xmldoc.getElementsByTagName('td') - for td in tdlist: - try: - tdvalue = td.childNodes[0].nodeValue - except IndexError: - continue - if '=' in tdvalue and ' ' not in tdvalue: - options.append(tdvalue.split('=',1)[0]) + options = {} + for optfile in optfiles: + xmldoc = minidom.parse(optfile) + tbody = xmldoc.getElementsByTagName('tbody')[0] + trlist = tbody.getElementsByTagName('tr') + for tr in trlist: + try: + optentry = tr.childNodes[1].childNodes[0] + option, default = optentry.nodeValue.split('=', 1) + helptext = tr.childNodes[2].childNodes[0].nodeValue + except IndexError: + continue + if option not in options or 'No help text' in options[option]: + #options[option.split('=',1)[0]] = helptext + options[option] = helptext return options + def extract_descriptions_from_devref(repo, options): """ loop through the devref RST files, looking for lines formatted - such that they might contain a description of a particular + such that they might contain a description of a particular option """ option_descs = {} @@ -68,29 +76,31 @@ def extract_descriptions_from_devref(repo, options): in_option_block = False continue if line[0] == ' ' and prev_option is not None: - option_descs[prev_option] = option_descs[prev_option] + ' ' + line.strip() + option_descs[prev_option] = (option_descs[prev_option] + + ' ' + line.strip()) for option in options: line_parts = line.strip().split(None, 2) if (' ' in line and len(line_parts) == 3 and option == line_parts[0] and line_parts[1] != '=' and option != 'use' - and (option not in option_descs or + and (option not in option_descs or len(option_descs[option]) < len(line_parts[2]))): option_descs[option] = line_parts[2] prev_option = option return option_descs + def new_section_file(sample, current_section): section_filename = ('swift-' + path.basename(sample).split('.conf')[0] - + '-' + current_section.replace('[','').replace(']','').replace(':','-') + + '-' + + current_section.replace('[', '').replace(']', '').replace(':', '-') + '.xml') section_file = open(section_filename, 'w') section_file.write('\n\ - \n\ + \n\ \n\ \n\ ') return section_file -def create_new_tables(repo, vebose, existing_options=None): + +def create_new_tables(repo, verbose): + """ + writes a set of docbook-formatted tables, one per section in swift + configuration files. Uses existing tables and swift devref as a source + of truth in that order to determine helptext for options found in + sample config files + """ existing_tables = glob.glob('../../doc/src/docbkx/common/tables/swift*xml') - options = [] - for table in existing_tables: - options.extend(get_existing_options(table)) + options = {} + #use the existing tables to get a list of option names + options = get_existing_options(existing_tables) option_descs = extract_descriptions_from_devref(repo, options) - conf_samples = glob.glob(repo + '/etc/*conf-sample') + conf_samples = glob.glob(repo + '/etc/*conf-sample') for sample in conf_samples: current_section = None section_file = None - sample_file = open(sample,'r') + sample_file = open(sample, 'r') for line in sample_file: if '[' in line and ']\n' in line and '=' not in line: - #header line + """ + it's a header line in the conf file, open a new table file + for this section and close any existing one + """ if current_section != line.strip('#').strip(): if section_file is not None: section_file.write('\n \n\
Description of configuration options for ' @@ -107,66 +117,75 @@ def new_section_file(sample, current_section):
\n\
') section_file.close() - current_section = line.strip('#').strip() + current_section = line.strip('#').strip() section_file = new_section_file(sample, current_section) elif section_file is not None: - #config option line + """ + it's a config option line in the conf file, find out the + help text and write to the table file. + """ parsed_line = parse_line(line) if parsed_line is not None: - if parsed_line[0] in option_descs: - option_desc = option_descs[parsed_line[0]] + if (parsed_line[0] in options.keys() + and 'No help text' not in options[parsed_line[0]]): + # use the help text from existing tables + option_desc = options[parsed_line[0]].replace(u'\xa0', u' ') + elif parsed_line[0] in option_descs: + # use the help text from the devref + option_desc = option_descs[parsed_line[0]].replace(u'\xa0', u' ') else: option_desc = 'No help text available for this option' - #if (existing_options is not None - # and parsed_line[0] not in existing_options): - # print "New Option: " + parsed_line[0] - #elif existing_options is not None: - # existing_options.remove(parsed_line[0]) + if verbose > 0: + print parsed_line[0] + "has no help text" section_file.write('\n \n\ - ' + parsed_line[0] + '=' + escape(str(parsed_line[1])) + - ''+ option_desc + '\n' + ' ') + ' + parsed_line[0] + '=' + + escape(str(parsed_line[1])) + + '' + option_desc + '\n' + + ' ') if section_file is not None: section_file.write('\n \n\ \n\ ') section_file.close() - #print "Removed: " + str(existing_options) + def main(repo, verbose=0): """ writes a set of docbook-formatted files, based on configuration sections in swift sample configuration files - actions: new - creates blank configuration files - update - creates updated configuration files based on existing ones """ - action = 'create' - #action = 'update' - if action == "create": - create_new_tables(repo, verbose) - elif action == "update": - options = get_existing_options('/home/fifieldt/temp/os-doc-on-a-plane-2/doc/src/docbkx/common/tables/swift-object-server-[DEFAULT].xml') - create_new_tables(repo, verbose, options) + create_new_tables(repo, verbose) if __name__ == "__main__": main(sys.argv[1])