openstack/openstack-manuals
Code Issues Proposed changes

[config-ref] update Object Storage object expirer configuration

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

backport: mitaka

Change-Id: Ib4baca27de92e7e119025f6d0298b87b4acedd5b
Partial-Bug: #1605040
This commit is contained in:
KATO Tomoyuki 2016-08-02 23:39:00 +09:00
parent cb7466f384
commit 5c49d3a45d
7 changed files with 50 additions and 49 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

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

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

@ -8,29 +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 expirer configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Find an example object expirer configuration at
``etc/object-expirer.conf-sample`` in the source code repository.
The available configuration options are:
.. include:: ../tables/swift-object-expirer-DEFAULT.rst
.. include:: ../tables/swift-object-expirer-app-proxy-server.rst
.. include:: ../tables/swift-object-expirer-filter-cache.rst
.. include:: ../tables/swift-object-expirer-filter-catch_errors.rst
.. include:: ../tables/swift-object-expirer-filter-proxy-logging.rst
.. include:: ../tables/swift-object-expirer-object-expirer.rst
.. include:: ../tables/swift-object-expirer-pipeline-main.rst
Sample object expirer configuration file
----------------------------------------
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/swift/plain/etc/object-expirer.conf-sample?h=stable/mitaka
Container server configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

23
doc/config-reference/source/object-storage/object-expirer.rst Normal file
View File

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

6
doc/config-reference/source/tables/swift-object-expirer-DEFAULT.rst
View File

@ -11,7 +11,7 @@
- Description
* - ``log_address`` = ``/dev/log``
- Location where syslog sends the logs to
* - ``log_custom_handlers`` = `` ``
* - ``log_custom_handlers`` =
- Comma-separated list of functions to call to setup custom log handlers.
* - ``log_facility`` = ``LOG_LOCAL0``
- Syslog log facility
@ -25,13 +25,13 @@
- Defines the probability of sending a sample for any given event or timing measurement.
* - ``log_statsd_host`` = ``localhost``
- If not set, the StatsD feature is disabled.
* - ``log_statsd_metric_prefix`` = `` ``
* - ``log_statsd_metric_prefix`` =
- Value will be prepended to every metric sent to the StatsD server.
* - ``log_statsd_port`` = ``8125``
- Port value for the StatsD server.
* - ``log_statsd_sample_rate_factor`` = ``1.0``
- Not recommended to set this to a value less than 1.0, if frequency of logging is too high, tune the log_statsd_default_sample_rate instead.
* - ``log_udp_host`` = `` ``
* - ``log_udp_host`` =
- If not set, the UDP receiver for syslog is disabled.
* - ``log_udp_port`` = ``514``
- Port value for UDP receiver, if enabled.

38
doc/config-reference/source/tables/swift-object-expirer-filter-proxy-logging.rst
View File

@ -10,36 +10,36 @@
* - Configuration option = Default value
- Description
* - ``access_log_address`` = ``/dev/log``
- No help text available for this option.
- Location where syslog sends the logs to. If not set, logging directives from [DEFAULT] without "access\_" will be used.
* - ``access_log_facility`` = ``LOG_LOCAL0``
- No help text available for this option.
- Syslog facility to receive log lines. If not set, logging directives from [DEFAULT] without "access\_" will be used.
* - ``access_log_headers`` = ``false``
- No help text available for this option.
* - ``access_log_headers_only`` = `` ``
- Header to receive log lines. If not set, logging directives from [DEFAULT] without "access\_" will be used.
* - ``access_log_headers_only`` =
- If access_log_headers is True and access_log_headers_only is set only these headers are logged. Multiple headers can be defined as comma separated list like this: access_log_headers_only = Host, X-Object-Meta-Mtime
* - ``access_log_level`` = ``INFO``
- No help text available for this option.
- Syslog logging level to receive log lines. If not set, logging directives from [DEFAULT] without "access\_" will be used.
* - ``access_log_name`` = ``swift``
- No help text available for this option.
- Label used when logging. If not set, logging directives from [DEFAULT] without "access\_" will be used.
* - ``access_log_statsd_default_sample_rate`` = ``1.0``
- No help text available for this option.
- Defines the probability of sending a sample for any given event or timing measurement. If not set, logging directives from [DEFAULT] without "access\_" will be used.
* - ``access_log_statsd_host`` = ``localhost``
- No help text available for this option.
* - ``access_log_statsd_metric_prefix`` = `` ``
- No help text available for this option.
- You can use log_statsd_* from [DEFAULT], or override them here. StatsD server. IPv4/IPv6 addresses and hostnames are supported. If a hostname resolves to an IPv4 and IPv6 address, the IPv4 address will be used.
* - ``access_log_statsd_metric_prefix`` =
- Value will be prepended to every metric sent to the StatsD server. If not set, logging directives from [DEFAULT] without "access\_" will be used.
* - ``access_log_statsd_port`` = ``8125``
- No help text available for this option.
- Port value for the StatsD server. If not set, logging directives from [DEFAULT] without "access\_" will be used.
* - ``access_log_statsd_sample_rate_factor`` = ``1.0``
- No help text available for this option.
* - ``access_log_udp_host`` = `` ``
- No help text available for this option.
- Not recommended to set this to a value less than 1.0, if frequency of logging is too high, tune the log_statsd_default_sample_rate instead. If not set, logging directives from [DEFAULT] without "access\_" will be used.
* - ``access_log_udp_host`` =
- If not set, the UDP receiver for syslog is disabled. If not set, logging directives from [DEFAULT] without "access\_" will be used.
* - ``access_log_udp_port`` = ``514``
- No help text available for this option.
- Port value for UDP receiver, if enabled. If not set, logging directives from [DEFAULT] without "access\_" will be used.
* - ``log_statsd_valid_http_methods`` = ``GET,HEAD,POST,PUT,DELETE,COPY,OPTIONS``
- No help text available for this option.
* - ``logged with access_log_headers`` = ``True.``
- No help text available for this option.
- What HTTP methods are allowed for StatsD logging (comma-sep). request methods not in this list will have "BAD_METHOD" for the <verb> portion of the metric.
* - ``reveal_sensitive_prefix`` = ``16``
- The X-Auth-Token is sensitive data. If revealed to an unauthorised person, they can now make requests against an account until the token expires. Set reveal_sensitive_prefix to the number of characters of the token that are logged. For example reveal_sensitive_prefix = 12 so only first 12 characters of the token are logged. Or, set to 0 to completely remove the token.
- By default, the X-Auth-Token is logged. To obscure the value, set reveal_sensitive_prefix to the number of characters to log. For example, if set to 12, only the first 12 characters of the token appear in the log. An unauthorized access of the log file won't allow unauthorized usage of the token. However, the first 12 or so characters is unique enough that you can trace/debug token usage. Set to 0 to suppress the token completely (replaced by '...' in the log).
.. note:: reveal_sensitive_prefix will not affect the value logged with access_log_headers=True.
* - ``use`` = ``egg:swift#proxy_logging``
- Entry point of paste.deploy in the server

6
doc/config-reference/source/tables/swift-object-expirer-object-expirer.rst
View File

@ -14,16 +14,16 @@
* - ``concurrency`` = ``1``
- Number of replication workers to spawn
* - ``expiring_objects_account_name`` = ``expiring_objects``
- No help text available for this option.
- Account name for expiring objects.
* - ``interval`` = ``300``
- Minimum time for a pass to take
* - ``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.
* - ``processes`` = ``0``
- for each port (disk) in the ring. If you have 24 disks per server, and this setting is 4, then each storage node will have 1 + (24 * 4) = 97 total object-server processes running. This gives complete I/O isolation, drastically reducing the impact of slow disks on storage node performance. The object-replicator and object-reconstructor need to see this setting too, so it must be in the [DEFAULT] section. See
- for each port (disk) in the ring. If you have 24 disks per server, and this setting is 4, then each storage node will have 1 + (24 * 4) = 97 total object-server processes running. This gives complete I/O isolation, drastically reducing the impact of slow disks on storage node performance. The object-replicator and object-reconstructor need to see this setting too, so it must be in the [DEFAULT] section.
* - ``reclaim_age`` = ``604800``
- Time elapsed in seconds before an object can be reclaimed
* - ``recon_cache_path`` = ``/var/cache/swift``
- Directory where stats for a few items will be stored
* - ``report_interval`` = ``300``
- No help text available for this option.
- Interval in seconds between reports.

2
doc/config-reference/source/tables/swift-object-expirer-pipeline-main.rst
View File

@ -10,4 +10,4 @@
* - Configuration option = Default value
- Description
* - ``pipeline`` = ``catch_errors proxy-logging cache proxy-server``
- No help text available for this option.
- Pipeline to use for processing operations.