Merge "Deprecate ineffective [memcache] options"

This commit is contained in:
Zuul 2021-12-21 04:13:03 +00:00 committed by Gerrit Code Review
commit 3cf93deac0
2 changed files with 36 additions and 1 deletions

View File

@ -19,6 +19,12 @@ from keystone.conf import utils
dead_retry = cfg.IntOpt( dead_retry = cfg.IntOpt(
'dead_retry', 'dead_retry',
default=5 * 60, default=5 * 60,
deprecated_for_removal=True,
deprecated_reason='This option has no effect. '
'Configure ``keystone.conf [cache] '
'memcache_dead_retry`` option to set the '
'dead_retry of memcached instead. ',
deprecated_since='Y',
help=utils.fmt(""" help=utils.fmt("""
Number of seconds memcached server is considered dead before it is tried again. Number of seconds memcached server is considered dead before it is tried again.
This is used by the key value store system. This is used by the key value store system.
@ -28,7 +34,7 @@ socket_timeout = cfg.IntOpt(
'socket_timeout', 'socket_timeout',
default=3, default=3,
deprecated_for_removal=True, deprecated_for_removal=True,
deprecated_reason='This option is duplicated with oslo.cache. ' deprecated_reason='This option has no effect. '
'Configure ``keystone.conf [cache] ' 'Configure ``keystone.conf [cache] '
'memcache_socket_timeout`` option to set the ' 'memcache_socket_timeout`` option to set the '
'socket_timeout of memcached instead. ', 'socket_timeout of memcached instead. ',
@ -41,6 +47,12 @@ store system.
pool_maxsize = cfg.IntOpt( pool_maxsize = cfg.IntOpt(
'pool_maxsize', 'pool_maxsize',
default=10, default=10,
deprecated_for_removal=True,
deprecated_reason='This option has no effect. '
'Configure ``keystone.conf [cache] '
'memcache_pool_maxsize`` option to set the '
'pool_maxsize of memcached instead. ',
deprecated_since='Y',
help=utils.fmt(""" help=utils.fmt("""
Max total number of open connections to every memcached server. This is used by Max total number of open connections to every memcached server. This is used by
the key value store system. the key value store system.
@ -49,6 +61,12 @@ the key value store system.
pool_unused_timeout = cfg.IntOpt( pool_unused_timeout = cfg.IntOpt(
'pool_unused_timeout', 'pool_unused_timeout',
default=60, default=60,
deprecated_for_removal=True,
deprecated_reason='This option has no effect. '
'Configure ``keystone.conf [cache] '
'memcache_pool_unused_timeout`` option to set the '
'pool_unused_timeout of memcached instead. ',
deprecated_since='Y',
help=utils.fmt(""" help=utils.fmt("""
Number of seconds a connection to memcached is held unused in the pool before Number of seconds a connection to memcached is held unused in the pool before
it is closed. This is used by the key value store system. it is closed. This is used by the key value store system.
@ -57,6 +75,12 @@ it is closed. This is used by the key value store system.
pool_connection_get_timeout = cfg.IntOpt( pool_connection_get_timeout = cfg.IntOpt(
'pool_connection_get_timeout', 'pool_connection_get_timeout',
default=10, default=10,
deprecated_for_removal=True,
deprecated_reason='This option has no effect. '
'Configure ``keystone.conf [cache] '
'memcache_pool_connection_get_timeout`` option to set '
'the connection_get_timeout of memcached instead. ',
deprecated_since='Y',
help=utils.fmt(""" help=utils.fmt("""
Number of seconds that an operation will wait to get a memcache client Number of seconds that an operation will wait to get a memcache client
connection. This is used by the key value store system. connection. This is used by the key value store system.

View File

@ -0,0 +1,11 @@
---
deprecations:
- |
The following options in the ``[memcache]`` section have been deprecated
because these options have had no effect since Pike. Please use
``memcache_*`` options in the ``[cache]`` section instead.
- ``dead_retry``
- ``pool_maxsize``
- ``pool_unused_timeout``
- ``pool_connection_get_timeout``