openstack/openstack-manuals
Code Issues Proposed changes

[config-ref] update Object Storage proxy server config

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

backport: mitaka

Change-Id: I77876f55dacf4710e4475952f96736f121336c01
Closes-Bug: #1605040
This commit is contained in:
KATO Tomoyuki 2016-08-10 10:23:16 +09:00
parent a947f6adfe
commit 4b3807ce32
23 changed files with 205 additions and 202 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -13,7 +13,8 @@ Object Storage service
object-storage/container-sync-realms.rst
object-storage/container-reconciler.rst
object-storage/account-server.rst
object-storage/configure.rst
object-storage/proxy-server.rst
object-storage/memcache.rst
object-storage/rsyncd.rst
object-storage/features.rst
object-storage/configure-s3.rst

8
doc/config-reference/source/object-storage/general-service-conf.rst
View File

@ -2,11 +2,9 @@
Object Storage general service configuration
============================================
Most Object Storage services fall into two categories, Object Storage's WSGI
servers and background daemons.
Object Storage uses ``paste.deploy`` to manage server configurations.
Read more at `<http://pythonpaste.org/deploy/>`_.
Object Storage service uses multiple configuration files for multiple services
and background daemons, and ``paste.deploy`` to manage server configurations.
For more information about ``paste.deploy``, see: http://pythonpaste.org/deploy/.
Default configuration options are set in the ``[DEFAULT]`` section, and any
options specified there can be overridden in any of the other sections when the

10
doc/config-reference/source/object-storage/memcache.rst Normal file
View File

@ -0,0 +1,10 @@
===================================
Proxy server memcache configuration
===================================
You can find memcache configuration file examples for the proxy server
at ``etc/memcache.conf-sample`` in the source code repository.
The available configuration options are:
.. include:: ../tables/swift-memcache-memcache.rst

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

@ -1,15 +1,6 @@
========================
Configure Object Storage
========================
OpenStack Object Storage uses multiple configuration files for multiple
services and background daemons, and ``paste.deploy`` to manage server
configurations. Default configuration options appear in the ``[DEFAULT]``
section. You can override the default values by setting values in the other
sections.
==========================
Proxy server configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~
==========================
Find an example proxy server configuration at
``etc/proxy-server.conf-sample`` in the source code repository.
@ -34,18 +25,8 @@ The available configuration options are:
.. include:: ../tables/swift-proxy-server-filter-xprofile.rst
Sample proxy server configuration file
--------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/swift/plain/etc/proxy-server.conf-sample?h=stable/mitaka
Proxy server memcache configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Find an example memcache configuration for the proxy server at
``etc/memcache.conf-sample`` in the source code repository.
The available configuration options are:
.. include:: ../tables/swift-memcache-memcache.rst

14
doc/config-reference/source/tables/swift-memcache-memcache.rst
View File

@ -10,16 +10,16 @@
* - Configuration option = Default value
- Description
* - ``connect_timeout`` = ``0.3``
- Timeout in seconds (float) for connection
- Timeout in seconds (float) for connection.
* - ``io_timeout`` = ``2.0``
- Timeout in seconds (float) for read and write
- Timeout in seconds (float) for read and write.
* - ``memcache_max_connections`` = ``2``
- Max number of connections to each memcached server per worker services
- Max number of connections to each memcached server per worker services.
* - ``memcache_serialization_support`` = ``2``
- Sets how memcache values are serialized and deserialized
- Sets how memcache values are serialized and deserialized.
* - ``memcache_servers`` = ``127.0.0.1:11211``
- Comma-separated list of memcached servers ip:port services
- Comma-separated list of memcached servers ip:port services.
* - ``pool_timeout`` = ``1.0``
- Timeout in seconds (float) for pooled connection
- Timeout in seconds (float) for pooled connection.
* - ``tries`` = ``3``
- Number of servers to retry on failures getting a pooled connection
- Number of servers to retry on failures getting a pooled connection.

54
doc/config-reference/source/tables/swift-proxy-server-DEFAULT.rst
View File

@ -10,70 +10,72 @@
* - Configuration option = Default value
- Description
* - ``admin_key`` = ``secret_admin_key``
- to use for admin calls that are HMAC signed. Default is empty, which will disable admin calls to /info. the proxy server. For most cases, this should be
- To use for admin calls that are HMAC signed. Default is empty, which will disable admin calls to /info.
* - ``backlog`` = ``4096``
- Maximum number of allowed pending TCP connections
- Maximum number of allowed pending TCP connections.
* - ``bind_ip`` = ``0.0.0.0``
- IP Address for server to bind to
- IP Address for server to bind to.
* - ``bind_port`` = ``8080``
- Port for server to bind to
- Port for server to bind to.
* - ``bind_timeout`` = ``30``
- Seconds to attempt bind before giving up
- Seconds to attempt bind before giving up.
* - ``cert_file`` = ``/etc/swift/proxy.crt``
- to the ssl .crt. This should be enabled for testing purposes only.
- To the ssl .crt. This should be enabled for testing purposes only.
* - ``client_timeout`` = ``60``
- Timeout to read one chunk from a client external services
* - ``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
- Timeout to read one chunk from a client external services.
* - ``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.
* - ``disallowed_sections`` = ``swift.valid_api_versions, container_quotas, tempurl``
- No help text available for this option.
- Allows the ability to withhold sections from showing up in the public calls to /info. You can withhold subsections by separating the dict level with a ".". The following would cause the sections 'container_quotas' and 'tempurl' to not be listed, and the key max_failed_deletes would be removed from bulk_delete.
Default value is 'swift.valid_api_versions' which allows all registered features to be listed via HTTP GET /info except swift.valid_api_versions information.
* - ``eventlet_debug`` = ``false``
- If true, turn on debug logging for eventlet
- 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.
* - ``expose_info`` = ``true``
- Enables exposing configuration settings via HTTP GET /info.
* - ``key_file`` = ``/etc/swift/proxy.key``
- to the ssl .key. This should be enabled for testing purposes only.
* - ``log_address`` = ``/dev/log``
- Location where syslog sends the logs to
* - ``log_custom_handlers`` = `` ``
- Location where syslog sends the logs to.
* - ``log_custom_handlers`` =
- Comma-separated list of functions to call to setup custom log handlers.
* - ``log_facility`` = ``LOG_LOCAL0``
- Syslog log facility
- Syslog log facility.
* - ``log_headers`` = ``false``
- No help text available for this option.
- Enables the ability to log request headers.
* - ``log_level`` = ``INFO``
- Logging level
- Logging level.
* - ``log_max_line_length`` = ``0``
- Caps the length of log lines to the value given; no limit if set to 0, the default.
* - ``log_name`` = ``swift``
- Label used when logging
- Label used when logging.
* - ``log_statsd_default_sample_rate`` = ``1.0``
- 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.
* - ``max_clients`` = ``1024``
- Maximum 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.
* - ``strict_cors_mode`` = ``True``
- No help text available for this option.
- Enforce CORS.
* - ``swift_dir`` = ``/etc/swift``
- Swift configuration directory
* - ``trans_id_suffix`` = `` ``
- No help text available for this option.
- Swift configuration directory.
* - ``trans_id_suffix`` =
- This optional suffix (default is empty) that would be appended to the swift transaction id allows one to easily figure out from which cluster that X-Trans-Id belongs to. This is very useful when one is managing more than one swift cluster.
* - ``user`` = ``swift``
- User to run as
- User to run as.
* - ``workers`` = ``auto``
- a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.

60
doc/config-reference/source/tables/swift-proxy-server-app-proxy-server.rst
View File

@ -12,63 +12,69 @@
* - ``account_autocreate`` = ``false``
- If set to 'true' authorized accounts that do not yet exist within the Swift cluster will be automatically created.
* - ``allow_account_management`` = ``false``
- Whether account PUTs and DELETEs are even callable
- Whether account PUTs and DELETEs are even callable.
* - ``auto_create_account_prefix`` = ``.``
- Prefix to use when automatically creating accounts
- Prefix to use when automatically creating accounts.
* - ``client_chunk_size`` = ``65536``
- Chunk size to read from clients
- Chunk size to read from clients.
* - ``conn_timeout`` = ``0.5``
- Connection timeout to external services
* - ``deny_host_headers`` = `` ``
- No help text available for this option.
- Connection timeout to external services.
* - ``deny_host_headers`` =
- Comma separated list of Host headers to which the proxy will deny requests.
* - ``error_suppression_interval`` = ``60``
- Time in seconds that must elapse since the last error for a node to be considered no longer error limited
- Time in seconds that must elapse since the last error for a node to be considered no longer error limited.
* - ``error_suppression_limit`` = ``10``
- Error count to consider a node error limited
- Error count to consider a node error limited.
* - ``log_handoffs`` = ``true``
- No help text available for this option.
- Log handoff requests if handoff logging is enabled and the handoff was not expected.
We only log handoffs when we've pushed the handoff count further than we would normally have expected under normal circumstances, that is (request_node_count - num_primaries), when handoffs goes higher than that it means one of the primaries must have been skipped because of error limiting before we consumed all of our nodes_left.
* - ``max_containers_per_account`` = ``0``
- If 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`` = `` ``
* - ``max_containers_whitelist`` =
- is a comma separated list of account names that ignore the max_containers_per_account cap.
* - ``max_large_object_get_time`` = ``86400``
- No help text available for this option.
* - ``node_timeout`` = ``10``
- Request timeout to external services
- Request timeout to external services.
* - ``object_chunk_size`` = ``65536``
- Chunk size to read from object servers
- Chunk size to read from object servers.
* - ``object_post_as_copy`` = ``true``
- Set 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.
* - ``post_quorum_timeout`` = ``0.5``
- No help text available for this option.
- How long to wait for requests to finish after a quorum has been established.
* - ``put_queue_depth`` = ``10``
- No help text available for this option.
- Depth of the proxy put queue.
* - ``read_affinity`` = ``r1z1=100, r1z2=200, r2=300``
- No help text available for this option.
- Which backend servers to prefer on reads. Format is r<N> for region N or r<N>z<M> for region N, zone M. The value after the equals is the priority; lower numbers are higher priority.
Example: first read from region 1 zone 1, then region 1 zone 2, then anything in region 2, then everything else: read_affinity = r1z1=100, r1z2=200, r2=300
Default is empty, meaning no preference.
* - ``recheck_account_existence`` = ``60``
- Cache timeout in seconds to send memcached for account existence
- Cache timeout in seconds to send memcached for account existence.
* - ``recheck_container_existence`` = ``60``
- Cache timeout in seconds to send memcached for container existence
- Cache timeout in seconds to send memcached for container existence.
* - ``recoverable_node_timeout`` = ``node_timeout``
- Request timeout to external services for requests that, on failure, can be recovered from. For example, object GET. from a client external services
- Request timeout to external services for requests that, on failure, can be recovered from. For example, object GET. from a client external services.
* - ``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:
* - ``set log_address`` = ``/dev/log``
- Location where syslog sends the logs to
- Location where syslog sends the logs to.
* - ``set log_facility`` = ``LOG_LOCAL0``
- Syslog log facility
- Syslog log facility.
* - ``set log_level`` = ``INFO``
- Log level
- Log level.
* - ``set log_name`` = ``proxy-server``
- Label to use when logging
- Label to use when logging.
* - ``sorting_method`` = ``shuffle``
- No help text available for this option.
- Storage nodes can be chosen at random (shuffle), by using timing measurements (timing), or by using an explicit match (affinity). Using timing measurements may allow for lower overall latency, while using affinity allows for finer control. In both the timing and affinity cases, equally-sorting nodes are still randomly chosen to spread load.
The valid values for sorting_method are "affinity", "shuffle", or "timing".
* - ``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-2, x-container-meta-temp-url-key, x-container-meta-temp-url-key-2, x-account-access-control``
- 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:
* - ``timing_expiry`` = ``300``
- No help text available for this option.
- If the "timing" sorting_method is used, the timings will only be valid for the number of seconds configured by timing_expiry.
* - ``use`` = ``egg:swift#proxy``
- Entry point of paste.deploy in the server
- Entry point of paste.deploy in the server.
* - ``write_affinity`` = ``r1, r2``
- This setting lets you trade data distribution for throughput. It makes the proxy server prefer local back-end servers for object PUT requests over non-local ones. Note that only object PUT requests are affected by the write_affinity setting; POST, GET, HEAD, DELETE, OPTIONS, and account/container PUT requests are not affected. The format is r<N> for region N or r<N>z<M> for region N, zone M. If this is set, then when handling an object PUT request, some number (see the write_affinity_node_count setting) of local backend servers will be tried before any nonlocal ones. Example: try to write to regions 1 and 2 before writing to any other nodes: write_affinity = r1, r2
* - ``write_affinity_node_count`` = ``2 * replicas``

22
doc/config-reference/source/tables/swift-proxy-server-filter-authtoken.rst
View File

@ -10,26 +10,26 @@
* - Configuration option = Default value
- Description
* - ``auth_plugin`` = ``password``
- No help text available for this option.
- Authentication module to use.
* - ``auth_uri`` = ``http://keystonehost:5000``
- No help text available for this option.
- auth_uri should point to a Keystone service from which users may retrieve tokens. This value is used in the WWW-Authenticate header that auth_token sends with any denial response.
* - ``auth_url`` = ``http://keystonehost:35357``
- No help text available for this option.
- auth_url points to the Keystone Admin service. This information is used by the middleware to actually query Keystone about the validity of the authentication tokens. It is not necessary to append any Keystone API version number to this URI.
* - ``cache`` = ``swift.cache``
- No help text available for this option.
- ``cache`` is set to ``swift.cache``. This means that the middleware will get the Swift memcache from the request environment.
* - ``delay_auth_decision`` = ``False``
- delay_auth_decision defaults to False, but leaving it as false will prevent other auth systems, staticweb, tempurl, formpost, and ACLs from working. This value must be explicitly set to True.
* - ``include_service_catalog`` = ``False``
- No help text available for this option.
- include_service_catalog defaults to True if not set. This means that when validating a token, the service catalog is retrieved and stored in the X-Service-Catalog header. Since Swift does not use the X-Service-Catalog header, there is no point in getting the service catalog. We recommend you set include_service_catalog to False.
* - ``password`` = ``password``
- No help text available for this option.
- Password for service user.
* - ``paste.filter_factory`` = ``keystonemiddleware.auth_token:filter_factory``
- No help text available for this option.
- Entry point of paste.filter_factory in the server.
* - ``project_domain_id`` = ``default``
- No help text available for this option.
- Service project domain.
* - ``project_name`` = ``service``
- No help text available for this option.
- Service project name.
* - ``user_domain_id`` = ``default``
- No help text available for this option.
- Service user domain.
* - ``username`` = ``swift``
- No help text available for this option.
- Service user name.

14
doc/config-reference/source/tables/swift-proxy-server-filter-bulk.rst
View File

@ -10,16 +10,16 @@
* - Configuration option = Default value
- Description
* - ``delete_container_retry_count`` = ``0``
- No help text available for this option.
- The parameter is used during a bulk delete of objects and their container. This would frequently fail because it is very likely that all replicated objects have not been deleted by the time the middleware got a successful response. It can be configured the number of retries. And the number of seconds to wait between each retry will be 1.5**retry.
* - ``max_containers_per_extraction`` = ``10000``
- No help text available for this option.
- The maximum numbers of containers per extraction.
* - ``max_deletes_per_request`` = ``10000``
- No help text available for this option.
- The maximum numbers of deletion per request.
* - ``max_failed_deletes`` = ``1000``
- No help text available for this option.
- The maximum number of tries to delete before failure.
* - ``max_failed_extractions`` = ``1000``
- No help text available for this option.
- The maximum number of tries to extract before failure.
* - ``use`` = ``egg:swift#bulk``
- Entry point of paste.deploy in the server
- Entry point of paste.deploy in the server.
* - ``yield_frequency`` = ``10``
- No help text available for this option.
- In order to keep a connection active during a potentially long bulk request, Swift may return whitespace prepended to the actual response body. This whitespace will be yielded no more than every yield_frequency seconds.

6
doc/config-reference/source/tables/swift-proxy-server-filter-container_sync.rst
View File

@ -10,8 +10,8 @@
* - Configuration option = Default value
- Description
* - ``allow_full_urls`` = ``true``
- No help text available for this option.
- Set this to false if you want to disallow any full URL values to be set for any new X-Container-Sync-To headers. This will keep any new full URLs from coming in, but won't change any existing values already in the cluster. Updating those will have to be done manually, as knowing what the true realm endpoint should be cannot always be guessed.
* - ``current`` = ``//REALM/CLUSTER``
- No help text available for this option.
- Set this to specify this cluster //realm/cluster as "current" in /info.
* - ``use`` = ``egg:swift#container_sync``
- Entry point of paste.deploy in the server
- Entry point of paste.deploy in the server.

4
doc/config-reference/source/tables/swift-proxy-server-filter-dlo.rst
View File

@ -10,10 +10,10 @@
* - Configuration option = Default value
- Description
* - ``max_get_time`` = ``86400``
- No help text available for this option.
- Time limit on GET requests (seconds).
* - ``rate_limit_after_segment`` = ``10``
- Rate limit the download of large object segments after this segment is downloaded.
* - ``rate_limit_segments_per_sec`` = ``1``
- Rate 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:
* - ``use`` = ``egg:swift#dlo``
- Entry point of paste.deploy in the server
- Entry point of paste.deploy in the server.

20
doc/config-reference/source/tables/swift-proxy-server-filter-domain_remap.rst
View File

@ -9,23 +9,23 @@
* - Configuration option = Default value
- Description
* - ``default_reseller_prefix`` = `` ``
- No help text available for this option.
* - ``default_reseller_prefix`` =
- If the reseller prefixes do not match, the default reseller prefix is used. When no default reseller prefix is configured, any request with an account prefix not in that list will be ignored by this middleware.
* - ``path_root`` = ``v1``
- Root path
- Root path.
* - ``reseller_prefixes`` = ``AUTH``
- Reseller prefix
- Browsers can convert a host header to lowercase, so check that reseller prefix on the account is the correct case. This is done by comparing the items in the reseller_prefixes config option to the found prefix. If they match except for case, the item from reseller_prefixes will be used instead of the found reseller prefix.
* - ``set log_address`` = ``/dev/log``
- Location where syslog sends the logs to
- Location where syslog sends the logs to.
* - ``set log_facility`` = ``LOG_LOCAL0``
- Syslog log facility
- Syslog log facility.
* - ``set log_headers`` = ``false``
- If True, log headers in each request
- If True, log headers in each request.
* - ``set log_level`` = ``INFO``
- Log level
- Log level.
* - ``set log_name`` = ``domain_remap``
- Label to use when logging
- Label to use when logging.
* - ``storage_domain`` = ``example.com``
- Domain that matches your cloud. Multiple domains can be specified using a comma-separated list.
* - ``use`` = ``egg:swift#domain_remap``
- Entry point of paste.deploy in the server
- Entry point of paste.deploy in the server.

6
doc/config-reference/source/tables/swift-proxy-server-filter-healthcheck.rst
View File

@ -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
- Entry point of paste.deploy in the server.

6
doc/config-reference/source/tables/swift-proxy-server-filter-keystoneauth.rst
View File

@ -22,8 +22,8 @@
* - ``reseller_admin_role`` = ``ResellerAdmin``
- The reseller admin role gives the ability to create and delete accounts.
* - ``reseller_prefix`` = ``AUTH``
- The naming scope for the auth service. Swift
* - ``service_roles`` = `` ``
- The naming scope for the auth service.
* - ``service_roles`` =
- When present, this option requires that the X-Service-Token header supplies a token from a user who has a role listed in service_roles. This parameter may be prefixed with an appropriate prefix.
* - ``use`` = ``egg:swift#keystoneauth``
- Entry point of paste.deploy in the server
- Entry point of paste.deploy in the server.

4
doc/config-reference/source/tables/swift-proxy-server-filter-list-endpoints.rst
View File

@ -10,6 +10,6 @@
* - Configuration option = Default value
- Description
* - ``list_endpoints_path`` = ``/endpoints/``
- No help text available for this option.
- Path to list endpoints for an object, account or container.
* - ``use`` = ``egg:swift#list_endpoints``
- Entry point of paste.deploy in the server
- Entry point of paste.deploy in the server.

40
doc/config-reference/source/tables/swift-proxy-server-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`` = `` ``
- 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
- 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.
.. 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
- Entry point of paste.deploy in the server.

26
doc/config-reference/source/tables/swift-proxy-server-filter-ratelimit.rst
View File

@ -18,17 +18,17 @@
* - ``clock_accuracy`` = ``1000``
- Represents 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.
* - ``container_listing_ratelimit_0`` = ``100``
- No help text available for this option.
- with container_listing_ratelimit_x = r, for containers of size x, limit container GET (listing) requests per second to r. The container rate will be linearly interpolated from the values given. With the default values, a container of size 5 will get a rate of 75.
* - ``container_listing_ratelimit_10`` = ``50``
- No help text available for this option.
- with container_listing_ratelimit_x = r, for containers of size x, limit container GET (listing) requests per second to r. The container rate will be linearly interpolated from the values given. With the default values, a container of size 5 will get a rate of 75.
* - ``container_listing_ratelimit_50`` = ``20``
- No help text available for this option.
- with container_listing_ratelimit_x = r, for containers of size x, limit container GET (listing) requests per second to r. The container rate will be linearly interpolated from the values given. With the default values, a container of size 5 will get a rate of 75.
* - ``container_ratelimit_0`` = ``100``
- No help text available for this option.
- with container_ratelimit_x = r, for containers of size x, limit write requests per second to r. The container rate will be linearly interpolated from the values given. With the default values, a container of size 5 will get a rate of 75.
* - ``container_ratelimit_10`` = ``50``
- No help text available for this option.
- with container_ratelimit_x = r, for containers of size x, limit write requests per second to r. The container rate will be linearly interpolated from the values given. With the default values, a container of size 5 will get a rate of 75.
* - ``container_ratelimit_50`` = ``20``
- No help text available for this option.
- with container_ratelimit_x = r, for containers of size x, limit write requests per second to r. The container rate will be linearly interpolated from the values given. With the default values, a container of size 5 will get a rate of 75.
* - ``log_sleep_time_seconds`` = ``0``
- To allow visibility into rate limiting set this value > 0 and all sleeps greater than the number will be logged.
* - ``max_sleep_time_seconds`` = ``60``
@ -36,16 +36,14 @@
* - ``rate_buffer_seconds`` = ``5``
- Number 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.
* - ``set log_address`` = ``/dev/log``
- Location where syslog sends the logs to
- Location where syslog sends the logs to.
* - ``set log_facility`` = ``LOG_LOCAL0``
- Syslog log facility
- Syslog log facility.
* - ``set log_headers`` = ``false``
- If True, log headers in each request
- If True, log headers in each request.
* - ``set log_level`` = ``INFO``
- Log level
- Log level.
* - ``set log_name`` = ``ratelimit``
- Label to use when logging
- Label to use when logging.
* - ``use`` = ``egg:swift#ratelimit``
- Entry point of paste.deploy in the server
* - ``with container_limit_x`` = ``r``
- No help text available for this option.
- Entry point of paste.deploy in the server.

10
doc/config-reference/source/tables/swift-proxy-server-filter-slo.rst
View File

@ -10,16 +10,16 @@
* - Configuration option = Default value
- Description
* - ``max_get_time`` = ``86400``
- No help text available for this option.
- Time limit on GET requests (seconds)
* - ``max_manifest_segments`` = ``1000``
- No help text available for this option.
- Maximum number of segments.
* - ``max_manifest_size`` = ``2097152``
- No help text available for this option.
- Maximum size of segments.
* - ``min_segment_size`` = ``1048576``
- No help text available for this option.
- Minimum size of segments.
* - ``rate_limit_after_segment`` = ``10``
- Rate limit the download of large object segments after this segment is downloaded.
* - ``rate_limit_segments_per_sec`` = ``0``
- Rate 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:
* - ``use`` = ``egg:swift#slo``
- Entry point of paste.deploy in the server
- Entry point of paste.deploy in the server.

40
doc/config-reference/source/tables/swift-proxy-server-filter-tempauth.rst
View File

@ -12,34 +12,34 @@
* - ``allow_overrides`` = ``true``
- This option allows middleware higher in the WSGI pipeline to override auth processing, useful for middleware such as tempurl and formpost. If you know you are not going to use such middleware and you want a bit of extra security, you can set this to False.
* - ``auth_prefix`` = ``/auth/``
- The HTTP request path prefix for the auth service. Swift itself reserves anything beginning with the letter
* - ``require_group`` = `` ``
- No help text available for this option.
- The HTTP request path prefix for the auth service. Swift itself reserves anything beginning with the letter.
* - ``require_group`` =
- The require_group parameter names a group that must be presented by either X-Auth-Token or X-Service-Token. Usually this parameter is used only with multiple reseller prefixes (for example, SERVICE_require_group=blah). By default, no group is needed. Do not use .admin.
* - ``reseller_prefix`` = ``AUTH``
- The naming scope for the auth service. Swift
- The naming scope for the auth service.
* - ``set log_address`` = ``/dev/log``
- Location where syslog sends the logs to
- Location where syslog sends the logs to.
* - ``set log_facility`` = ``LOG_LOCAL0``
- Syslog log facility
- Syslog log facility.
* - ``set log_headers`` = ``false``
- If True, log headers in each request
- If True, log headers in each request.
* - ``set log_level`` = ``INFO``
- Log level
- Log level.
* - ``set log_name`` = ``tempauth``
- Label to use when logging
- Label to use when logging.
* - ``storage_url_scheme`` = ``default``
- Scheme 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.
* - ``token_life`` = ``86400``
- The number of seconds a token is valid.
* - ``use`` = ``egg:swift#tempauth``
- Entry point of paste.deploy in the server
* - ``user_admin_admin`` = ``admin .admin .reseller_admin``
- No help text available for this option.
* - ``user_test2_tester2`` = ``testing2 .admin``
- No help text available for this option.
* - ``user_test5_tester5`` = ``testing5 service``
- No help text available for this option.
* - ``user_test_tester`` = ``testing .admin``
- No help text available for this option.
* - ``user_test_tester3`` = ``testing3``
- No help text available for this option.
- Entry point of paste.deploy in the server.
* - ``user_<account>_<user>`` = ``<key> [group] [group] [...] [storage_url]``
- List of all the accounts and user you want.
The following are example entries required for running the tests:
* ``user_admin_admin`` = ``admin .admin .reseller_admin``
* ``user_test2_tester2`` = ``testing2 .admin``
* ``user_test5_tester5`` = ``testing5 service``
* ``user_test_tester`` = ``testing .admin``
* ``user_test_tester3`` = ``testing3``

6
doc/config-reference/source/tables/swift-proxy-server-filter-tempurl.rst
View File

@ -9,15 +9,15 @@
* - Configuration option = Default value
- Description
* - ``incoming_allow_headers`` = `` ``
* - ``incoming_allow_headers`` =
- Headers allowed as exceptions to incoming_remove_headers. Simply a whitespace delimited list of header names and names can optionally end with '*' to indicate a prefix match.
* - ``incoming_remove_headers`` = ``x-timestamp``
- Headers to remove from incoming requests. Simply a whitespace delimited list of header names and names can optionally end with '*' to indicate a prefix match.
* - ``methods`` = ``GET HEAD PUT POST DELETE``
- HTTP methods allowed with Temporary URLs
- HTTP methods allowed with Temporary URLs.
* - ``outgoing_allow_headers`` = ``x-object-meta-public-*``
- Headers allowed as exceptions to outgoing_allow_headers. Simply a whitespace delimited list of header names and names can optionally end with '*' to indicate a prefix match.
* - ``outgoing_remove_headers`` = ``x-object-meta-*``
- Headers to remove from outgoing responses. Simply a whitespace delimited list of header names and names can optionally end with '*' to indicate a prefix match.
* - ``use`` = ``egg:swift#tempurl``
- Entry point of paste.deploy in the server
- Entry point of paste.deploy in the server.

11
doc/config-reference/source/tables/swift-proxy-server-filter-versioned_writes.rst
View File

@ -10,6 +10,13 @@
* - Configuration option = Default value
- Description
* - ``allow_versioned_writes`` = ``false``
- No help text available for this option.
- Enables using versioned writes middleware and exposing configuration settings via HTTP GET /info.
.. warning::
Setting this option bypasses the ``allow_versions`` option in the
container configuration file, which will be eventually deprecated.
For more details, see `Object Versioning
<http://docs.openstack.org/developer/swift/overview_object_versioning.html>`_.
* - ``use`` = ``egg:swift#versioned_writes``
- Entry point of paste.deploy in the server
- Entry point of paste.deploy in the server.

16
doc/config-reference/source/tables/swift-proxy-server-filter-xprofile.rst
View File

@ -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/accoutn.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
- Entry point of paste.deploy in the server.

2
doc/config-reference/source/tables/swift-proxy-server-pipeline-main.rst
View File

@ -10,4 +10,4 @@
* - Configuration option = Default value
- Description
* - ``pipeline`` = ``catch_errors gatekeeper healthcheck proxy-logging cache container_sync bulk tempurl ratelimit tempauth container-quotas account-quotas slo dlo versioned_writes proxy-logging proxy-server``
- No help text available for this option.
- Pipeline to use for processing operations.