diff options
| author | Zuul <zuul@review.opendev.org> | 2023-02-28 22:44:07 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2023-02-28 22:44:07 +0000 |
| commit | 2a90eadc0d20cef9833a0e7737f5c36becf46b3b (patch) | |
| tree | fbc41e81674d772f1d61a661d6943d5300aebb72 /doc | |
| parent | 5a1464c2df262052afa64ef6ff51719b07232cf4 (diff) | |
| parent | 2edd3e65dadcdc4e39d127ac9f6495473512cb29 (diff) | |
| download | swift-2a90eadc0d20cef9833a0e7737f5c36becf46b3b.tar.gz | |
Merge "docs: Add memcache.conf config doc"
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/config/global_memcache_config.rst | 73 | ||||
| -rw-r--r-- | doc/source/config/index.rst | 1 | ||||
| -rw-r--r-- | doc/source/config/proxy_server_config.rst | 5 |
3 files changed, 78 insertions, 1 deletions
diff --git a/doc/source/config/global_memcache_config.rst b/doc/source/config/global_memcache_config.rst new file mode 100644 index 000000000..21ef6c43a --- /dev/null +++ b/doc/source/config/global_memcache_config.rst @@ -0,0 +1,73 @@ +.. _memcache-config: + +----------------------------- +Global Memcache Configuration +----------------------------- + +This document describes the configuration options available for the global swift memcache configuration +which usually lives under /etc/swift/memcache.conf. +Documentation for other swift configuration options can be found at +:doc:`index`. + +An example memcache.conf configuration can be found at +etc/memcache.conf-sample in the source code repository. + +There is only 1 configuration section available: + +* :ref:`[memcache] <memcache_conf_memcache_section>` + + +.. _memcache_conf_memcache_section: + +********** +[memcache] +********** + +=========================== =============== ============================================= +Option Default Description +--------------------------- --------------- --------------------------------------------- +memcache_servers 127.0.0.1:11211 Comma separated list of memcached servers + ip:port or [ipv6addr]:port +memcache_max_connections 2 Max number of connections to each memcached + server per worker +connect_timeout 0.3 Timeout for connection +pool_timeout 1.0 Timeout for pooled connection +tries 3 Number of servers to retry on failures + getting a pooled connection +io_timeout 2.0 Timeout for read and writes +error_suppression_interval 60.0 How long without an error before a server's + error count is reset. This will also be how + long before a server is reenabled after + suppression is triggered. + Set to 0 to disable error-limiting. +error_suppression_limit 10 How many errors can accumulate before a + server is temporarily ignored +item_size_warning_threshold -1 If an item size ever gets above + item_size_warning_threshold then a warning + will be logged. This can be used to alert + when memcache item sizes are getting to + their limit. + It's an absolute size in bytes. Setting the + value to 0 will warn on every memcache set. + A value of -1 disables the warning +tls_enabled False (Optional) Global toggle for TLS usage + when comunicating with the caching servers +tls_cafile (Optional) Path to a file of concatenated + CA certificates in PEM format necessary to + establish the caching server's authenticity. + If tls_enabled is False, this option is + ignored. +tls_certfile (Optional) Path to a single file in PEM + format containing the client's certificate + as well as any number of CA certificates + needed to establish the certificate's + authenticity. This file is only required + when client side authentication is + necessary. If tls_enabled is False, + this option is ignored +tls_keyfile (Optional) Path to a single file containing + the client's private key in. Otherwhise the + private key will be taken from the file + specified in tls_certfile. If tls_enabled + is False, this option is ignored +=========================== =============== =============================================
\ No newline at end of file diff --git a/doc/source/config/index.rst b/doc/source/config/index.rst index bb2752b53..bfec36b78 100644 --- a/doc/source/config/index.rst +++ b/doc/source/config/index.rst @@ -10,6 +10,7 @@ Configuration Documentation account_server_config.rst container_server_config.rst object_server_config.rst + global_memcache_config.rst Configuration options for middleware can be found at: diff --git a/doc/source/config/proxy_server_config.rst b/doc/source/config/proxy_server_config.rst index 6e87228ca..d8f3e3eef 100644 --- a/doc/source/config/proxy_server_config.rst +++ b/doc/source/config/proxy_server_config.rst @@ -211,7 +211,10 @@ client_chunk_size 65536 Chunk size to r clients memcache_servers 127.0.0.1:11211 Comma separated list of memcached servers - ip:port or [ipv6addr]:port + ip:port or [ipv6addr]:port, + if this value is + empty, the memcache client will look + for a :ref:`[memcache.conf] <memcache-config>` memcache_max_connections 2 Max number of connections to each memcached server per worker |