Deprecate the config option default_neutron_networks

Use `management_networks` instead. `management_networks`will be used
as admin networks which will be attached to Trove instance
automatically.

Change-Id: I5c6004b568c3a428bc0f0a8b0e36665d3c5b3087

devstack/plugin.sh

@@ -524,16 +524,16 @@ function finalize_trove_network {
     iniset $TROVE_CONF DEFAULT ip_regex ""
     iniset $TROVE_CONF DEFAULT black_list_regex ""
     # Don't use a default network for now, until the neutron issues are figured out
-    #iniset $TROVE_CONF DEFAULT default_neutron_networks "${ALT_MGMT_ID}"
+    #iniset $TROVE_CONF DEFAULT management_networks "${ALT_MGMT_ID}"
-    iniset $TROVE_CONF DEFAULT default_neutron_networks ""
+    iniset $TROVE_CONF DEFAULT management_networks ""
     iniset $TROVE_CONF DEFAULT network_driver trove.network.neutron.NeutronDriver
 
     iniset $TROVE_TASKMANAGER_CONF DEFAULT network_label_regex "${ALT_PRIVATE_NETWORK_NAME}"
     iniset $TROVE_TASKMANAGER_CONF DEFAULT ip_regex ""
     iniset $TROVE_TASKMANAGER_CONF DEFAULT black_list_regex ""
     # Don't use a default network for now, until the neutron issues are figured out
-    #iniset $TROVE_TASKMANAGER_CONF DEFAULT default_neutron_networks "${ALT_MGMT_ID}"
+    #iniset $TROVE_TASKMANAGER_CONF DEFAULT management_networks "${ALT_MGMT_ID}"
-    iniset $TROVE_CONF DEFAULT default_neutron_networks ""
+    iniset $TROVE_CONF DEFAULT management_networks ""
     iniset $TROVE_TASKMANAGER_CONF DEFAULT network_driver trove.network.neutron.NeutronDriver
 }
 

etc/trove/trove-taskmanager.conf.sample

@@ -92,7 +92,7 @@ dns_service_type = dns
 
 # Neutron
 network_driver = trove.network.nova.NovaNetwork
-default_neutron_networks =
+management_networks =
 
 # Trove Security Groups for Instances
 trove_security_groups_support = True

etc/trove/trove.conf.sample

@@ -103,7 +103,7 @@ dns_service_type = dns
 
 # Neutron
 network_driver = trove.network.nova.NovaNetwork
-default_neutron_networks =
+management_networks =
 
 
 # Taskmanager queue name

releasenotes/notes/releasenotes/deprecate-default_neutron_networks-84cd00224d6b7bc1.yaml

@@ -0,0 +1,4 @@
+---
+deprecations:
+  - The config option ``default_neutron_networks`` is deprecated and will be
+    removed in the future release, use ``management_networks`` instead.

trove/common/cfg.py

@@ -413,7 +413,8 @@ common_opts = [
     cfg.ListOpt('expected_filetype_suffixes', default=['json'],
                 help='Filetype endings not to be reattached to an ID '
                      'by the utils method correct_id_with_req.'),
-    cfg.ListOpt('default_neutron_networks', default=[],
+    cfg.ListOpt('management_networks', default=[],
+                deprecated_name='default_neutron_networks',
                 help='List of IDs for management networks which should be '
                      'attached to the instance regardless of what NICs '
                      'are specified in the create API call.'),

trove/common/neutron.py

@@ -22,7 +22,7 @@ MGMT_NETWORKS = None
 def get_management_networks(context):
     """Cache the management network names.
 
-    When CONF.default_neutron_networks is changed, the Trove service needs to
+    When CONF.management_networks is changed, the Trove service needs to
     restart so the global cache will be refreshed.
     """
     global MGMT_NETWORKS
@@ -31,10 +31,10 @@ def get_management_networks(context):
         return MGMT_NETWORKS
 
     MGMT_NETWORKS = []
-    if len(CONF.default_neutron_networks) > 0:
+    if len(CONF.management_networks) > 0:
         neutron_client = remote.create_neutron_client(context)
 
-        for net_id in CONF.default_neutron_networks:
+        for net_id in CONF.management_networks:
             MGMT_NETWORKS.append(
                 neutron_client.show_network(net_id)['network']['name']
             )

trove/instance/models.py

@@ -1014,9 +1014,9 @@ class Instance(BuiltInstance):
 
         if not nics:
             nics = []
-        if CONF.default_neutron_networks:
+        if CONF.management_networks:
             nics = [{"net-id": net_id}
-                    for net_id in CONF.default_neutron_networks] + nics
+                    for net_id in CONF.management_networks] + nics
         if nics:
             call_args['nics'] = nics
         if cluster_config:

trove/tests/unittests/instance/test_instance_models.py

@@ -61,7 +61,7 @@ class SimpleInstanceTest(trove_testtools.TestCase):
         super(SimpleInstanceTest, self).tearDown()
         CONF.network_label_regex = self.orig_conf
         CONF.ip_start = None
-        CONF.default_neutron_networks = []
+        CONF.management_networks = []
         CONF.ip_regex = self.orig_ip_regex
         CONF.black_list_regex = self.orig_black_list_regex
 
@@ -116,7 +116,7 @@ class SimpleInstanceTest(trove_testtools.TestCase):
     @patch('trove.common.remote.create_neutron_client')
     def test_filter_management_ip_addresses(self, mock_neutron_client):
         CONF.network_label_regex = ''
-        CONF.default_neutron_networks = ['fake-net-id']
+        CONF.management_networks = ['fake-net-id']
 
         neutron_client = Mock()
         neutron_client.show_network.return_value = {