openstack/openstack-manuals
Code Issues Proposed changes

[config-ref] update Object Storage object server configuration

Browse Source 
* Split object server configuration into a separate file
* Add description for no help options
* Remove unnecessary RST markup

backport: mitaka

Change-Id: I0f5e6cdd5804b6c4c05de53a69e7a11ae89ac394
Partial-Bug: #1605040
This commit is contained in:
KATO Tomoyuki 2016-07-25 20:11:55 +09:00
parent 3dfe2687e6
commit bc3a8ae2b2
11 changed files with 56 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/config-reference/source/object-storage.rst
View File

@ -7,6 +7,7 @@ Object Storage service
object-storage/about.rst
object-storage/general-service-conf.rst
object-storage/object-server.rst
object-storage/configure.rst
object-storage/features.rst
object-storage/configure-s3.rst

25
doc/config-reference/source/object-storage/configure.rst
View File

@ -8,31 +8,6 @@ configurations. Default configuration options appear in the ``[DEFAULT]``
section. You can override the default values by setting values in the other
sections.
Object server configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Find an example object server configuration at
``etc/object-server.conf-sample`` in the source code repository.
The available configuration options are:
.. include:: ../tables/swift-object-server-DEFAULT.rst
.. include:: ../tables/swift-object-server-app-object-server.rst
.. include:: ../tables/swift-object-server-pipeline-main.rst
.. include:: ../tables/swift-object-server-object-replicator.rst
.. include:: ../tables/swift-object-server-object-updater.rst
.. include:: ../tables/swift-object-server-object-auditor.rst
.. include:: ../tables/swift-object-server-filter-healthcheck.rst
.. include:: ../tables/swift-object-server-filter-recon.rst
.. include:: ../tables/swift-object-server-filter-xprofile.rst
Sample object server configuration file
---------------------------------------
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/swift/plain/etc/object-server.conf-sample?h=stable/mitaka
Object expirer configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

25
doc/config-reference/source/object-storage/object-server.rst Normal file
View File

@ -0,0 +1,25 @@
===========================
Object server configuration
===========================
Find an example object server configuration at
``etc/object-server.conf-sample`` in the source code repository.
The available configuration options are:
.. include:: ../tables/swift-object-server-DEFAULT.rst
.. include:: ../tables/swift-object-server-app-object-server.rst
.. include:: ../tables/swift-object-server-pipeline-main.rst
.. include:: ../tables/swift-object-server-object-replicator.rst
.. include:: ../tables/swift-object-server-object-updater.rst
.. include:: ../tables/swift-object-server-object-auditor.rst
.. include:: ../tables/swift-object-server-filter-healthcheck.rst
.. include:: ../tables/swift-object-server-filter-recon.rst
.. include:: ../tables/swift-object-server-filter-xprofile.rst
Sample object server configuration file
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/swift/plain/etc/object-server.conf-sample?h=stable/mitaka

5
doc/config-reference/source/tables/swift-object-server-DEFAULT.rst
View File

@ -2,6 +2,7 @@
Warning: Do not edit this file. It is automatically generated and your
changes will be overwritten. The tool to do so lives in the
openstack-doc-tools repository.
The tool cannot generate manually created options.
.. list-table:: Description of configuration options for ``[DEFAULT]`` in ``object-server.conf``
:header-rows: 1
@ -32,9 +33,9 @@
* - ``eventlet_debug`` = ``false``
- If true, turn on debug logging for eventlet
* - ``expiring_objects_account_name`` = ``expiring_objects``
- No help text available for this option.
- Account name for the expiring objects
* - ``expiring_objects_container_divisor`` = ``86400``
- No help text available for this option.
- Divisor for the expiring objects container
* - ``fallocate_reserve`` = ``0``
- You can set fallocate_reserve to the number of bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be
* - ``log_address`` = ``/dev/log``

3
doc/config-reference/source/tables/swift-object-server-app-object-server.rst
View File

@ -2,6 +2,7 @@
Warning: Do not edit this file. It is automatically generated and your
changes will be overwritten. The tool to do so lives in the
openstack-doc-tools repository.
The tool cannot generate manually created options.
.. list-table:: Description of configuration options for ``[app-object-server]`` in ``object-server.conf``
:header-rows: 1
@ -46,7 +47,7 @@
* - ``slow`` = ``0``
- If > 0, Minimum time in seconds for a PUT or DELETE request to complete
* - ``splice`` = ``no``
- No help text available for this option.
- Use splice() for zero-copy object GETs. This requires Linux kernel version 3.0 or greater. When 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.
* - ``threads_per_disk`` = ``0``
- Size of the per-disk thread pool used for performing disk I/O. The default of 0 means to not use a per-disk thread pool. It is recommended to keep this value small, as large values can result in high read latencies due to large queue depths. A good starting point is 4 threads per disk.
* - ``use`` = ``egg:swift#object``

5
doc/config-reference/source/tables/swift-object-server-filter-healthcheck.rst
View File

@ -2,6 +2,7 @@
Warning: Do not edit this file. It is automatically generated and your
changes will be overwritten. The tool to do so lives in the
openstack-doc-tools repository.
The tool cannot generate manually created options.
.. list-table:: Description of configuration options for ``[filter-healthcheck]`` in ``object-server.conf``
:header-rows: 1
@ -9,7 +10,7 @@
* - Configuration option = Default value
- Description
* - ``disable_path`` = `` ``
- No help text available for this option.
* - ``disable_path`` =
- An optional filesystem path, which if present, will cause the healthcheck URL to return "503 Service Unavailable" with a body of "DISABLED BY FILE"
* - ``use`` = ``egg:swift#healthcheck``
- Entry point of paste.deploy in the server

3
doc/config-reference/source/tables/swift-object-server-filter-recon.rst
View File

@ -2,6 +2,7 @@
Warning: Do not edit this file. It is automatically generated and your
changes will be overwritten. The tool to do so lives in the
openstack-doc-tools repository.
The tool cannot generate manually created options.
.. list-table:: Description of configuration options for ``[filter-recon]`` in ``object-server.conf``
:header-rows: 1
@ -12,6 +13,6 @@
* - ``recon_cache_path`` = ``/var/cache/swift``
- Directory where stats for a few items will be stored
* - ``recon_lock_path`` = ``/var/lock``
- No help text available for this option.
- Directory where lock files will be stored
* - ``use`` = ``egg:swift#recon``
- Entry point of paste.deploy in the server

15
doc/config-reference/source/tables/swift-object-server-filter-xprofile.rst
View File

@ -2,6 +2,7 @@
Warning: Do not edit this file. It is automatically generated and your
changes will be overwritten. The tool to do so lives in the
openstack-doc-tools repository.
The tool cannot generate manually created options.
.. list-table:: Description of configuration options for ``[filter-xprofile]`` in ``object-server.conf``
:header-rows: 1
@ -10,18 +11,18 @@
* - Configuration option = Default value
- Description
* - ``dump_interval`` = ``5.0``
- No help text available for this option.
- the profile data will be dumped to local disk based on above naming rule in this interval (seconds).
* - ``dump_timestamp`` = ``false``
- No help text available for this option.
- Be careful, this option will enable the profiler to dump data into the file with a time stamp which means that there will be lots of files piled up in the directory.
* - ``flush_at_shutdown`` = ``false``
- No help text available for this option.
- Clears the data when the wsgi server shutdowns.
* - ``log_filename_prefix`` = ``/tmp/log/swift/profile/default.profile``
- No help text available for this option.
- This prefix is used to combine the process ID and timestamp to name the profile data file. Make sure the executing user has permission to write into this path. Any missing path segments will be created, if necessary. When you enable profiling in more than one type of daemon, you must override it with a unique value like: /var/log/swift/profile/object.profile
* - ``path`` = ``/__profile__``
- No help text available for this option.
- This is the path of the URL to access the mini web UI.
* - ``profile_module`` = ``eventlet.green.profile``
- No help text available for this option.
- This option enables you to switch profilers which inherit from the Python standard profiler. Currently, the supported value can be 'cProfile', 'eventlet.green.profile', etc.
* - ``unwind`` = ``false``
- No help text available for this option.
- unwind the iterator of applications
* - ``use`` = ``egg:swift#xprofile``
- Entry point of paste.deploy in the server

5
doc/config-reference/source/tables/swift-object-server-object-auditor.rst
View File

@ -2,6 +2,7 @@
Warning: Do not edit this file. It is automatically generated and your
changes will be overwritten. The tool to do so lives in the
openstack-doc-tools repository.
The tool cannot generate manually created options.
.. list-table:: Description of configuration options for ``[object-auditor]`` in ``object-server.conf``
:header-rows: 1
@ -27,8 +28,8 @@
- Label used when logging
* - ``log_time`` = ``3600``
- Frequency of status logs in seconds.
* - ``object_size_stats`` = `` ``
- No help text available for this option.
* - ``object_size_stats`` =
- Takes a comma-separated list of ints. When set, the object auditor will increment a counter for every object whose size is greater or equal to the given breaking points and reports the result after a full scan.
* - ``recon_cache_path`` = ``/var/cache/swift``
- Directory where stats for a few items will be stored
* - ``zero_byte_files_per_second`` = ``50``

11
doc/config-reference/source/tables/swift-object-server-object-replicator.rst
View File

@ -2,6 +2,7 @@
Warning: Do not edit this file. It is automatically generated and your
changes will be overwritten. The tool to do so lives in the
openstack-doc-tools repository.
The tool cannot generate manually created options.
.. list-table:: Description of configuration options for ``[object-replicator]`` in ``object-server.conf``
:header-rows: 1
@ -40,11 +41,13 @@
* - ``ring_check_interval`` = ``15``
- How often (in seconds) to check the ring
* - ``rsync_bwlimit`` = ``0``
- No help text available for this option.
- bandwidth limit for rsync in kB/s. 0 means unlimited
* - ``rsync_compress`` = ``no``
- No help text available for this option.
- Allows rsync to compress data which is transmitted to the destination node during sync. However, this applies only when the destination node is in a different region than the local one.
.. note:: Objects that are already compressed (for example: .tar.gz, .mp3) might slow down the syncing process.
* - ``rsync_error_log_line_length`` = ``0``
- No help text available for this option.
- Limits the length of the rsync error log lines. 0 will log the entire line.
* - ``rsync_io_timeout`` = ``30``
- Passed to rsync for a max duration (seconds) of an I/O op
* - ``rsync_module`` = ``{replication_ip}::object``
@ -56,4 +59,4 @@
* - ``stats_interval`` = ``300``
- Interval in seconds between logging replication statistics
* - ``sync_method`` = ``rsync``
- No help text available for this option.
- default is rsync, alternative is ssync

3
doc/config-reference/source/tables/swift-object-server-pipeline-main.rst
View File

@ -2,6 +2,7 @@
Warning: Do not edit this file. It is automatically generated and your
changes will be overwritten. The tool to do so lives in the
openstack-doc-tools repository.
The tool cannot generate manually created options.
.. list-table:: Description of configuration options for ``[pipeline-main]`` in ``object-server.conf``
:header-rows: 1
@ -10,4 +11,4 @@
* - Configuration option = Default value
- Description
* - ``pipeline`` = ``healthcheck recon object-server``
- No help text available for this option.
- Pipeline to use for processing operations.