Merge "[config-ref] update Object Storage container server configuration"
This commit is contained in:
Jenkins
Gerrit Code Review
commit
193f49ddd6
@ -9,6 +9,7 @@ Object Storage service
|
||||
object-storage/general-service-conf.rst
|
||||
object-storage/object-server.rst
|
||||
object-storage/object-expirer.rst
|
||||
object-storage/container-server.rst
|
||||
object-storage/configure.rst
|
||||
object-storage/features.rst
|
||||
object-storage/configure-s3.rst
|
||||
|
||||
@ -8,32 +8,6 @@ configurations. Default configuration options appear in the ``[DEFAULT]``
|
||||
section. You can override the default values by setting values in the other
|
||||
sections.
|
||||
|
||||
Container server configuration
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Find an example container server configuration at
|
||||
``etc/container-server.conf-sample`` in the source code repository.
|
||||
|
||||
The available configuration options are:
|
||||
|
||||
.. include:: ../tables/swift-container-server-DEFAULT.rst
|
||||
.. include:: ../tables/swift-container-server-app-container-server.rst
|
||||
.. include:: ../tables/swift-container-server-pipeline-main.rst
|
||||
.. include:: ../tables/swift-container-server-container-replicator.rst
|
||||
.. include:: ../tables/swift-container-server-container-updater.rst
|
||||
.. include:: ../tables/swift-container-server-container-auditor.rst
|
||||
.. include:: ../tables/swift-container-server-container-sync.rst
|
||||
.. include:: ../tables/swift-container-server-filter-healthcheck.rst
|
||||
.. include:: ../tables/swift-container-server-filter-recon.rst
|
||||
.. include:: ../tables/swift-container-server-filter-xprofile.rst
|
||||
|
||||
Sample container server configuration file
|
||||
------------------------------------------
|
||||
|
||||
.. remote-code-block:: ini
|
||||
|
||||
https://git.openstack.org/cgit/openstack/swift/plain/etc/container-server.conf-sample?h=stable/mitaka
|
||||
|
||||
Container sync realms configuration
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
|
||||
@ -0,0 +1,26 @@
|
||||
==============================
|
||||
Container server configuration
|
||||
==============================
|
||||
|
||||
Find an example container server configuration at
|
||||
``etc/container-server.conf-sample`` in the source code repository.
|
||||
|
||||
The available configuration options are:
|
||||
|
||||
.. include:: ../tables/swift-container-server-DEFAULT.rst
|
||||
.. include:: ../tables/swift-container-server-app-container-server.rst
|
||||
.. include:: ../tables/swift-container-server-pipeline-main.rst
|
||||
.. include:: ../tables/swift-container-server-container-replicator.rst
|
||||
.. include:: ../tables/swift-container-server-container-updater.rst
|
||||
.. include:: ../tables/swift-container-server-container-auditor.rst
|
||||
.. include:: ../tables/swift-container-server-container-sync.rst
|
||||
.. include:: ../tables/swift-container-server-filter-healthcheck.rst
|
||||
.. include:: ../tables/swift-container-server-filter-recon.rst
|
||||
.. include:: ../tables/swift-container-server-filter-xprofile.rst
|
||||
|
||||
Sample container server configuration file
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. remote-code-block:: ini
|
||||
|
||||
https://git.openstack.org/cgit/openstack/swift/plain/etc/container-server.conf-sample?h=stable/mitaka
|
||||
@ -10,7 +10,7 @@
|
||||
* - Configuration option = Default value
|
||||
- Description
|
||||
* - ``allowed_sync_hosts`` = ``127.0.0.1``
|
||||
- No help text available for this option.
|
||||
- The list of hosts that are allowed to send syncs to.
|
||||
* - ``backlog`` = ``4096``
|
||||
- Maximum number of allowed pending TCP connections
|
||||
* - ``bind_ip`` = ``0.0.0.0``
|
||||
@ -31,7 +31,7 @@
|
||||
- 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``
|
||||
- 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
|
||||
@ -45,13 +45,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.
|
||||
|
||||
@ -34,7 +34,7 @@
|
||||
* - ``recon_cache_path`` = ``/var/cache/swift``
|
||||
- Directory where stats for a few items will be stored
|
||||
* - ``rsync_compress`` = ``no``
|
||||
- No help text available for this option.
|
||||
- Allow rsync to compress data which is transmitted to destination node during sync. However, this is applicable only when destination node is in a different region than the local one.
|
||||
* - ``rsync_module`` = ``{replication_ip}::container``
|
||||
- Format of the rsync module where the replicator will send data. The configuration value can include some variables that will be extracted from the ring. Variables must follow the format {NAME} where NAME is one of: ip, port, replication_ip, replication_port, region, zone, device, meta. See etc/rsyncd.conf-sample for some examples. uses what's set here, or what's set in the DEFAULT section, or 10 (though other sections use 3 as the final default).
|
||||
* - ``run_pause`` = ``30``
|
||||
|
||||
@ -14,7 +14,7 @@
|
||||
* - ``container_time`` = ``60``
|
||||
- Maximum amount of time to spend syncing each container
|
||||
* - ``internal_client_conf_path`` = ``/etc/swift/internal-client.conf``
|
||||
- No help text available for this option.
|
||||
- Internal client config file path
|
||||
* - ``interval`` = ``300``
|
||||
- Minimum time for a pass to take
|
||||
* - ``log_address`` = ``/dev/log``
|
||||
@ -26,6 +26,6 @@
|
||||
* - ``log_name`` = ``container-sync``
|
||||
- Label used when logging
|
||||
* - ``request_tries`` = ``3``
|
||||
- No help text available for this option.
|
||||
- Server errors from requests will be retried by default
|
||||
* - ``sync_proxy`` = ``http://10.1.1.1:8888,http://10.1.1.2:8888``
|
||||
- If you need to use an HTTP proxy, set it here. Defaults to no proxy.
|
||||
|
||||
@ -9,7 +9,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
|
||||
|
||||
@ -10,18 +10,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
|
||||
|
||||
@ -10,4 +10,4 @@
|
||||
* - Configuration option = Default value
|
||||
- Description
|
||||
* - ``pipeline`` = ``healthcheck recon container-server``
|
||||
- No help text available for this option.
|
||||
- Pipeline to use for processing operations.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user