Deprecate the agent framework and drivers

This patch marks the agent framework and drivers as deprecated in the Antelope release for removal in the "C" release.

Please see the announcement on the OpenStack discuss mailing list for more information about the deprecation:
https://lists.openstack.org/pipermail/openstack-discuss/2023-January/031803.html

Change-Id: I3a90243dc323a2815ce7d973a5e52248ed1c2ad6

1 files changed, 40 insertions, 10 deletions

diff --git a/designate/conf/agent.py b/designate/conf/agent.py
index 16f5b47b..faa846ff 100644
--- a/designate/conf/agent.py
+++ b/designate/conf/agent.py
@@ -24,27 +24,57 @@ AGENT_GROUP = cfg.OptGroup(
 
 AGENT_OPTS = [
     cfg.IntOpt('workers',
-               help='Number of agent worker processes to spawn'),
+               help='Number of agent worker processes to spawn',
+               deprecated_for_removal=True,
+               deprecated_since='Antelope(2023.1)',
+               deprecated_reason='The agent framework is deprecated.'),
     cfg.IntOpt('threads', default=1000,
-               help='Number of agent greenthreads to spawn'),
+               help='Number of agent greenthreads to spawn',
+               deprecated_for_removal=True,
+               deprecated_since='Antelope(2023.1)',
+               deprecated_reason='The agent framework is deprecated.'),
     cfg.ListOpt('listen',
                 default=['0.0.0.0:%d' % DEFAULT_AGENT_PORT],
-                help='Agent host:port pairs to listen on'),
+                help='Agent host:port pairs to listen on',
+                deprecated_for_removal=True,
+                deprecated_since='Antelope(2023.1)',
+                deprecated_reason='The agent framework is deprecated.'),
     cfg.IntOpt('tcp_backlog', default=100,
-               help='The Agent TCP Backlog'),
+               help='The Agent TCP Backlog',
+               deprecated_for_removal=True,
+               deprecated_since='Antelope(2023.1)',
+               deprecated_reason='The agent framework is deprecated.'),
     cfg.FloatOpt('tcp_recv_timeout', default=0.5,
-                 help='Agent TCP Receive Timeout'),
+                 help='Agent TCP Receive Timeout',
+                 deprecated_for_removal=True,
+                 deprecated_since='Antelope(2023.1)',
+                 deprecated_reason='The agent framework is deprecated.'),
     cfg.ListOpt('allow_notify', default=[],
-                help='List of IP addresses allowed to NOTIFY The Agent'),
+                help='List of IP addresses allowed to NOTIFY The Agent',
+                deprecated_for_removal=True,
+                deprecated_since='Antelope(2023.1)',
+                deprecated_reason='The agent framework is deprecated.'),
     cfg.ListOpt('masters', default=[],
-                help='List of masters for the Agent, format ip:port'),
+                help='List of masters for the Agent, format ip:port',
+                deprecated_for_removal=True,
+                deprecated_since='Antelope(2023.1)',
+                deprecated_reason='The agent framework is deprecated.'),
     cfg.StrOpt('backend_driver', default='bind9',
-               help='The backend driver to use, e.g. bind9, djbdns, knot2'),
+               help='The backend driver to use, e.g. bind9, djbdns, knot2',
+               deprecated_for_removal=True,
+               deprecated_since='Antelope(2023.1)',
+               deprecated_reason='The agent framework is deprecated.'),
     cfg.StrOpt('transfer_source',
-               help='An IP address to be used to fetch zones transferred in'),
+               help='An IP address to be used to fetch zones transferred in',
+               deprecated_for_removal=True,
+               deprecated_since='Antelope(2023.1)',
+               deprecated_reason='The agent framework is deprecated.'),
     cfg.FloatOpt('notify_delay', default=0.0,
                  help='Delay after a NOTIFY arrives for a zone that the Agent '
-                      'will pause and drop subsequent NOTIFYs for that zone'),
+                      'will pause and drop subsequent NOTIFYs for that zone',
+                 deprecated_for_removal=True,
+                 deprecated_since='Antelope(2023.1)',
+                 deprecated_reason='The agent framework is deprecated.'),
 ]