summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorZuul <zuul@review.openstack.org>2017-10-30 19:46:34 +0000
committerGerrit Code Review <review@openstack.org>2017-10-30 19:46:34 +0000
commit25db6f317de58a9da226f97f0e2eedac658a0042 (patch)
tree98a55a23ed90eafa71184c2f76a75b4db8f4ff17 /doc
parentff2acfe393afeb492ffa29f9d1c34c4589fd50fe (diff)
parente199192caefef068b5bf57da8b878e0bc82e3453 (diff)
downloadswift-25db6f317de58a9da226f97f0e2eedac658a0042.tar.gz
Merge "Replace replication_one_per_device by custom count"
Diffstat (limited to 'doc')
-rw-r--r--doc/manpages/object-server.conf.511
-rw-r--r--doc/source/deployment_guide.rst226
2 files changed, 119 insertions, 118 deletions
diff --git a/doc/manpages/object-server.conf.5 b/doc/manpages/object-server.conf.5
index 825e2d317..27b36a21f 100644
--- a/doc/manpages/object-server.conf.5
+++ b/doc/manpages/object-server.conf.5
@@ -225,11 +225,12 @@ should not specify any value for "replication_server".
Set to restrict the number of concurrent incoming SSYNC requests
Set to 0 for unlimited (the default is 4). Note that SSYNC requests are only used
by the object reconstructor or the object replicator when configured to use ssync.
-.IP "\fBreplication_one_per_device\fR"
-Restricts incoming SSYNC requests to one per device,
-replication_currency above allowing. This can help control I/O to each
-device, but you may wish to set this to False to allow multiple SSYNC
-requests (up to the above replication_concurrency setting) per device. The default is true.
+.IP "\fBreplication_concurrency_per_device\fR"
+Set to restrict the number of concurrent incoming SSYNC requests per device;
+set to 0 for unlimited requests per devices. This can help control I/O to each
+device. This does not override replication_concurrency described above, so you
+may need to adjust both parameters depending on your hardware or network
+capacity. Defaults to 1.
.IP "\fBreplication_lock_timeout\fR"
Number of seconds to wait for an existing replication device lock before
giving up. The default is 15.
diff --git a/doc/source/deployment_guide.rst b/doc/source/deployment_guide.rst
index 28df6cde0..4e2e79b55 100644
--- a/doc/source/deployment_guide.rst
+++ b/doc/source/deployment_guide.rst
@@ -563,119 +563,119 @@ ionice_priority None I/O scheduling priority of server
[object-server]
***************
-============================= ====================== ===============================================
-Option Default Description
------------------------------ ---------------------- -----------------------------------------------
-use paste.deploy entry point for the
- object server. For most cases,
- this should be
- `egg:swift#object`.
-set log_name object-server Label used when logging
-set log_facility LOG_LOCAL0 Syslog log facility
-set log_level INFO Logging level
-set log_requests True Whether or not to log each
- request
-set log_address /dev/log Logging directory
-user swift User to run as
-max_upload_time 86400 Maximum time allowed to upload an
- object
-slow 0 If > 0, Minimum time in seconds for a PUT or
- DELETE request to complete. This is only
- useful to simulate slow devices during testing
- and development.
-mb_per_sync 512 On PUT requests, sync file every
- n MB
-keep_cache_size 5242880 Largest object size to keep in
- buffer cache
-keep_cache_private false Allow non-public objects to stay
- in kernel's buffer cache
-allowed_headers Content-Disposition, Comma separated list of headers
- Content-Encoding, that can be set in metadata on an object.
- X-Delete-At, This list is in addition to
- X-Object-Manifest, X-Object-Meta-* headers and cannot include
- X-Static-Large-Object Content-Type, etag, Content-Length, or deleted
-auto_create_account_prefix . Prefix used when automatically
- creating accounts.
-replication_server Configure parameter for creating
- specific server. To handle all verbs,
- including replication verbs, do not
- specify "replication_server"
- (this is the default). To only
- handle replication, set to a True
- value (e.g. "True" or "1").
- To handle only non-replication
- verbs, set to "False". Unless you
- have a separate replication network, you
- should not specify any value for
- "replication_server".
-replication_concurrency 4 Set to restrict the number of
- concurrent incoming SSYNC
- requests; set to 0 for unlimited
-replication_one_per_device True Restricts incoming SSYNC
- requests to one per device,
- replication_currency above
- allowing. This can help control
- I/O to each device, but you may
- wish to set this to False to
- allow multiple SSYNC
- requests (up to the above
- replication_concurrency setting)
- per device.
-replication_lock_timeout 15 Number of seconds to wait for an
- existing replication device lock
- before giving up.
-replication_failure_threshold 100 The number of subrequest failures
- before the
- replication_failure_ratio is
- checked
-replication_failure_ratio 1.0 If the value of failures /
- successes of SSYNC
- subrequests exceeds this ratio,
- the overall SSYNC request
- will be aborted
-splice no Use splice() for zero-copy object
- GETs. This requires Linux kernel
- version 3.0 or greater. If you set
- "splice = yes" but the kernel
- does not support it, error messages
- will appear in the object server
- logs at startup, but your object
- servers should continue to function.
-nice_priority None Scheduling priority of server processes.
- Niceness values range from -20 (most
- favorable to the process) to 19 (least
- favorable to the process). The default
- does not modify priority.
-ionice_class None I/O scheduling class of server processes.
- I/O niceness class values are IOPRIO_CLASS_RT
- (realtime), IOPRIO_CLASS_BE (best-effort),
- and IOPRIO_CLASS_IDLE (idle).
- The default does not modify class and
- priority. Linux supports io scheduling
- priorities and classes since 2.6.13 with
- the CFQ io scheduler.
- Work only with ionice_priority.
-ionice_priority None I/O scheduling priority of server
- processes. I/O niceness priority is
- a number which goes from 0 to 7.
- The higher the value, the lower the I/O
- priority of the process. Work only with
- ionice_class.
- Ignored if IOPRIO_CLASS_IDLE is set.
-eventlet_tpool_num_threads auto The number of threads in eventlet's thread pool.
- Most IO will occur in the object server's main
- thread, but certain "heavy" IO operations will
- occur in separate IO threads, managed by
- eventlet.
- The default value is auto, whose actual value
- is dependent on the servers_per_port value.
- If servers_per_port is zero then it uses
- eventlet's default (currently 20 threads).
- If the servers_per_port is nonzero then it'll
- only use 1 thread per process.
- This value can be overridden with an integer
- value.
-============================= ====================== ===============================================
+================================== ====================== ===============================================
+Option Default Description
+---------------------------------- ---------------------- -----------------------------------------------
+use paste.deploy entry point for the
+ object server. For most cases,
+ this should be
+ `egg:swift#object`.
+set log_name object-server Label used when logging
+set log_facility LOG_LOCAL0 Syslog log facility
+set log_level INFO Logging level
+set log_requests True Whether or not to log each
+ request
+set log_address /dev/log Logging directory
+user swift User to run as
+max_upload_time 86400 Maximum time allowed to upload an
+ object
+slow 0 If > 0, Minimum time in seconds for a PUT or
+ DELETE request to complete. This is only
+ useful to simulate slow devices during testing
+ and development.
+mb_per_sync 512 On PUT requests, sync file every
+ n MB
+keep_cache_size 5242880 Largest object size to keep in
+ buffer cache
+keep_cache_private false Allow non-public objects to stay
+ in kernel's buffer cache
+allowed_headers Content-Disposition, Comma separated list of headers
+ Content-Encoding, that can be set in metadata on an object.
+ X-Delete-At, This list is in addition to
+ X-Object-Manifest, X-Object-Meta-* headers and cannot include
+ X-Static-Large-Object Content-Type, etag, Content-Length, or deleted
+auto_create_account_prefix . Prefix used when automatically
+ creating accounts.
+replication_server Configure parameter for creating
+ specific server. To handle all verbs,
+ including replication verbs, do not
+ specify "replication_server"
+ (this is the default). To only
+ handle replication, set to a True
+ value (e.g. "True" or "1").
+ To handle only non-replication
+ verbs, set to "False". Unless you
+ have a separate replication network, you
+ should not specify any value for
+ "replication_server".
+replication_concurrency 4 Set to restrict the number of
+ concurrent incoming SSYNC
+ requests; set to 0 for unlimited
+replication_concurrency_per_device 1 Set to restrict the number of
+ concurrent incoming SSYNC
+ requests per device; set to 0 for
+ unlimited requests per devices.
+ This can help control I/O to each
+ device. This does not override
+ replication_concurrency described
+ above, so you may need to adjust
+ both parameters depending on your
+ hardware or network capacity.
+replication_lock_timeout 15 Number of seconds to wait for an
+ existing replication device lock
+ before giving up.
+replication_failure_threshold 100 The number of subrequest failures
+ before the
+ replication_failure_ratio is
+ checked
+replication_failure_ratio 1.0 If the value of failures /
+ successes of SSYNC
+ subrequests exceeds this ratio,
+ the overall SSYNC request
+ will be aborted
+splice no Use splice() for zero-copy object
+ GETs. This requires Linux kernel
+ version 3.0 or greater. If you set
+ "splice = yes" but the kernel
+ does not support it, error messages
+ will appear in the object server
+ logs at startup, but your object
+ servers should continue to function.
+nice_priority None Scheduling priority of server processes.
+ Niceness values range from -20 (most
+ favorable to the process) to 19 (least
+ favorable to the process). The default
+ does not modify priority.
+ionice_class None I/O scheduling class of server processes.
+ I/O niceness class values are IOPRIO_CLASS_RT
+ (realtime), IOPRIO_CLASS_BE (best-effort),
+ and IOPRIO_CLASS_IDLE (idle).
+ The default does not modify class and
+ priority. Linux supports io scheduling
+ priorities and classes since 2.6.13 with
+ the CFQ io scheduler.
+ Work only with ionice_priority.
+ionice_priority None I/O scheduling priority of server
+ processes. I/O niceness priority is
+ a number which goes from 0 to 7.
+ The higher the value, the lower the I/O
+ priority of the process. Work only with
+ ionice_class.
+ Ignored if IOPRIO_CLASS_IDLE is set.
+eventlet_tpool_num_threads auto The number of threads in eventlet's thread pool.
+ Most IO will occur in the object server's main
+ thread, but certain "heavy" IO operations will
+ occur in separate IO threads, managed by
+ eventlet.
+ The default value is auto, whose actual value
+ is dependent on the servers_per_port value.
+ If servers_per_port is zero then it uses
+ eventlet's default (currently 20 threads).
+ If the servers_per_port is nonzero then it'll
+ only use 1 thread per process.
+ This value can be overridden with an integer
+ value.
+================================== ====================== ===============================================
*******************
[object-replicator]