openstack/oslo.cache
Code Issues Proposed changes

Fix description of memcache_servers

Browse Source 
Current description says the option is used by only two backends but
in fact this option is used by all backends dependent on memcached.

Note that the inet6 prefix is specific to the python-memcached library
and should not be used if a backend dependent on different libraries
(eg. pymemcache) is used. This change describes that point, too.

Change-Id: I3c967841c94b9409096c9b9591f9fb162db7a1ac
This commit is contained in:
Takashi Kajinami 2022-03-18 22:58:56 +09:00
parent d75020b335
commit 557d4a2295
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
oslo_cache/_opts.py
View File

@ -76,17 +76,18 @@ FILE_OPTIONS = {
'to false.'),
cfg.ListOpt('memcache_servers', default=['localhost:11211'],
help='Memcache servers in the format of "host:port". '
'(dogpile.cache.memcached and '
'oslo_cache.memcache_pool backends only). '
'If a given host refer to an IPv6 or a given domain '
'refer to IPv6 then you should prefix the given '
'address with the address family (``inet6``) '
'This is used by backends dependent on Memcached.'
'If ``dogpile.cache.memcached`` or '
'``oslo_cache.memcache_pool`` is used and a given '
'host refer to an IPv6 or a given domain refer to '
'IPv6 then you should prefix the given address with'
'the address family (``inet6``) '
'(e.g ``inet6[::1]:11211``, '
'``inet6:[fd12:3456:789a:1::1]:11211``, '
'``inet6:[controller-0.internalapi]:11211``). '
'If the address family is not given then default '
'address family used will be ``inet`` which '
'correspond to IPv4'),
'If the address family is not given then these '
'backends will use the default ``inet`` address '
'family which corresponds to IPv4'),
cfg.IntOpt('memcache_dead_retry',
default=5 * 60,
help='Number of seconds memcached server is considered dead'