Deprecate l3-agent router_id option

L3-agent router_id option has been defined in order to associate a
l3-agent to a specific router when use_namespaces=False. The option
use_namespaces has been removed in Mitaka, so router_id option is no
longer needed and can be deprecated in order to prepare its removal in N
cycle.

Closes-Bug: #1518776
Change-Id: Id79499ccbf3ea69ca4cd7e4b2f812f6dbc0406e0

diff --git a/etc/l3_agent.ini b/etc/l3_agent.ini
index be0ab852bb5e89c71c5bdc72f1161b0e319219f2..a8efb63d222e66777681ed05a98e9d8bd10ee39e 100644 (file)
--- a/etc/l3_agent.ini
+++ b/etc/l3_agent.ini
@@ -20,6 +20,7 @@
 
 # If non-empty, the l3 agent can only configure a router that has the matching
 # router ID.
+# This option is deprecated and will be removed in the N release.
 # router_id =
 
 # When external_network_bridge is set, each L3 agent can be associated

diff --git a/neutron/agent/l3/config.py b/neutron/agent/l3/config.py
index 856ddecc2fa31139e29b0095543349a1be2f56e8..78cd6eb3b3c75124a603c370ef98d01b068bde3f 100644 (file)
--- a/neutron/agent/l3/config.py
+++ b/neutron/agent/l3/config.py
@@ -49,6 +49,7 @@ OPTS = [
                help=_("Send this many gratuitous ARPs for HA setup, if "
                       "less than or equal to 0, the feature is disabled")),
     cfg.StrOpt('router_id', default='',
+               deprecated_for_removal=True,
                help=_("If non-empty, the l3 agent can only configure a router "
                       "that has the matching router ID.")),
     cfg.BoolOpt('handle_internal_only_routers',

diff --git a/releasenotes/notes/deprecate-router_id-34aca9ea5ee9e789.yaml b/releasenotes/notes/deprecate-router_id-34aca9ea5ee9e789.yaml
new file mode 100644 (file)
index 0000000..389ef87
--- /dev/null
+++ b/releasenotes/notes/deprecate-router_id-34aca9ea5ee9e789.yaml
@@ -0,0 +1,5 @@
+---
+prelude: >
+    Deprecate router_id option in order to prepare its removal in N cycle.
+upgrade:
+  - router_id option deprecation