From 9a8686aee042ba55155de224c4072ca511f92eca Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <tkajinam@redhat.com>
Date: Wed, 25 Aug 2021 10:58:54 +0900
Subject: [PATCH] Deprecate ineffective [memcache] options

These options were used by the memcache_pool backend for token
persistence, which was removed during Pike cycle.

Closes-Bug: #1941020
Change-Id: I2a0c2d46ebe81728f4ba0ff6d3072348e70f92dd
---
 keystone/conf/memcache.py                     | 26 ++++++++++++++++++-
 .../notes/bug-1941020-f694395a9bcea72f.yaml   | 11 ++++++++
 2 files changed, 36 insertions(+), 1 deletion(-)
 create mode 100644 releasenotes/notes/bug-1941020-f694395a9bcea72f.yaml

diff --git a/keystone/conf/memcache.py b/keystone/conf/memcache.py
index 97dc2c9e19..b4b8c8b069 100644
--- a/keystone/conf/memcache.py
+++ b/keystone/conf/memcache.py
@@ -19,6 +19,12 @@ from keystone.conf import utils
 dead_retry = cfg.IntOpt(
     'dead_retry',
     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("""
 Number of seconds memcached server is considered dead before it is tried again.
 This is used by the key value store system.
@@ -28,7 +34,7 @@ socket_timeout = cfg.IntOpt(
     'socket_timeout',
     default=3,
     deprecated_for_removal=True,
-    deprecated_reason='This option is duplicated with oslo.cache. '
+    deprecated_reason='This option has no effect. '
                       'Configure ``keystone.conf [cache] '
                       'memcache_socket_timeout`` option to set the '
                       'socket_timeout of memcached instead. ',
@@ -41,6 +47,12 @@ store system.
 pool_maxsize = cfg.IntOpt(
     'pool_maxsize',
     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("""
 Max total number of open connections to every memcached server. This is used by
 the key value store system.
@@ -49,6 +61,12 @@ the key value store system.
 pool_unused_timeout = cfg.IntOpt(
     'pool_unused_timeout',
     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("""
 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.
@@ -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',
     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("""
 Number of seconds that an operation will wait to get a memcache client
 connection. This is used by the key value store system.
diff --git a/releasenotes/notes/bug-1941020-f694395a9bcea72f.yaml b/releasenotes/notes/bug-1941020-f694395a9bcea72f.yaml
new file mode 100644
index 0000000000..179455225b
--- /dev/null
+++ b/releasenotes/notes/bug-1941020-f694395a9bcea72f.yaml
@@ -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``