From 629248149d7bae280fefec29550b16b0ecc6facc Mon Sep 17 00:00:00 2001
From: Kailun Qin <kailun.qin@intel.com>
Date: Tue, 25 Dec 2018 23:23:44 +0800
Subject: [PATCH] Add `default` to network segment range resource

This patch is a follow-up to [1] to propose adding a new `read-only`
attribute `default` to the network segment range resource. It tracks
whether this is a range that is managed/loaded from the host ML2 config
file [2].

The attribute is proposed based on the following considerations:
1. We prefer the underlying network segment ranges to be exposed so that
   an admin can base on the info to make per-tenant range assignment;
2. We want the backward compatibility to be maintained, i.e. no work
   flow change with and without the extension is loaded;
3. We need to handle the range DB refresh/config repopulation when a
   Neutron server starts/restarts.

[1] https://review.openstack.org/599980
[2] /etc/neutron/plugins/ml2/ml2_conf.ini

Co-Authored-By: Matt Peters <matt.peters@windriver.com>

Partially-implements: blueprint network-segment-range-management
Change-Id: I8cc0ed77603a5d430c6d7b2b503c7b5a80ed0051
---
 .../network-segment-range-management.rst      | 28 +++++++++++++++----
 1 file changed, 23 insertions(+), 5 deletions(-)

diff --git a/specs/stein/network-segment-range-management.rst b/specs/stein/network-segment-range-management.rst
index c824f12fa..ef8743133 100644
--- a/specs/stein/network-segment-range-management.rst
+++ b/specs/stein/network-segment-range-management.rst
@@ -185,6 +185,7 @@ feature::
     CREATE TABLE network_segment_ranges (
       id CHAR(36) NOT NULL PRI KEY,
       name VARCHAR(255),
+      default BOOL NOT NULL,
       shared BOOL NOT NULL,
       project_id VARCHAR(255) NOT NULL,
       network_type ENUM('vlan', 'vxlan', 'gre', 'geneve') NOT NULL,
@@ -212,8 +213,9 @@ Mixin classes to add the network segment range management extension should be
 provided. The DB operation logic should be handled by the ML2 type manager and
 the type drivers. For the values present in the existing ML2 configuration
 options [1]_ (e.g. ml2_type_vlan, ml2_type_vxlan etc.), they will be loaded as
-`shared` segment ranges into segment_range DB in order to provide backward
-compatibility for initial deployment when this extension is present.
+`shared` and `default` segment ranges into network_segment_ranges DB in order
+to provide backward compatibility for initial deployment when this extension is
+present.
 
 Resource Extension
 ------------------
@@ -236,6 +238,10 @@ like:
                  'type:string': db_const.NAME_FIELD_SIZE},
                'default': '', 'is_visible': True, 'is_filter': True,
                'is_sort_key': True},
+      'default': {'allow_post': False, 'allow_put': False,
+                  'convert_to': converters.convert_to_boolean,
+                  'default': False,
+                  'is_visible': True},
       'shared': {'allow_post': True, 'allow_put': False,
                  'convert_to': converters.convert_to_boolean,
                  'is_visible': True, 'default': True},
@@ -285,6 +291,11 @@ Resource extension network_segment_ranges:
 | name            | String | No  |  CRU   | ''        | Name of network       |
 |                 |        |     |        |           | segment range         |
 +-----------------+--------+-----+--------+-----------+-----------------------+
+| default         | Bool   | No  |  R     | False     | Default network       |
+|                 |        |     |        |           | segment range that is |
+|                 |        |     |        |           | loaded from the host  |
+|                 |        |     |        |           | ML2 config file [1]_  |
++-----------------+--------+-----+--------+-----------+-----------------------+
 | shared          | Bool   | Yes |  CR    | False     | Shared with other     |
 |                 |        |     |        |           | projects              |
 +-----------------+--------+-----+--------+-----------+-----------------------+
@@ -333,6 +344,7 @@ line with the new resources previously introduced:
         {
           "id": "d23abc8d-2991-4a55-ba98-2aaea84cc72f",
           "name": "network_segment_range_physnet1",
+          "default": False,
           "shared": False,
           "project_id": "45977fa2dbd7482098dd68d0d8970117",
           "network_type": "vlan",
@@ -357,6 +369,7 @@ line with the new resources previously introduced:
       "network_segment_range": {
         "id": "d23abc8d-2991-4a55-ba98-2aaea84cc72f",
         "name": "network_segment_range_physnet1",
+        "default": False,
         "shared": False,
         "project_id": "45977fa2dbd7482098dd68d0d8970117",
         "network_type": "vlan",
@@ -460,9 +473,14 @@ Other Impact
 * ML2 plugin, plugin manager and type drivers will need to be refined and added
   with several new methods correspondingly in order to support this feature.
 
-* The existing ML2 configuration will populate the proposed
-  network_segment_ranges as a shared range. When this extension is loaded, a
-  change is expected in the processing of the ML2 configuration.
+* When this extension is loaded, the Neutron server will populate the proposed
+  network_segment_ranges DB table with the ranges defined within the existing
+  ML2 configuration as `default` and `shared` ranges. These `default` ranges
+  are read-only and an administrator can make per-tenant segment range
+  assignment based on this information. When a Neutron server starts/restarts,
+  the `default` segment ranges will be reloaded and be visible to all servers.
+  Interactions from the REST APIs will always operate based on the segment
+  ranges defined within the database.
 
 * Validation work is needed for quite a few cases, including but not limited
   to: