Merge pull request #2109 from rackerlabs/vrf-router-evpn-vni

feat: Implement vrf router with auto-allocating evpn_vni attribute

Author: cardoe

.typos.toml

@@ -36,3 +36,5 @@ retreive = "retreive"
 metadat = "metadat"
 # operators/rook/values-cluster.yaml mentions "ceph-blockpool-ecoded"
 ecoded = "ecoded"
+# lazy option is not a typo
+selectin = "selectin"

python/neutron-understack/neutron_understack/__init__.py

@@ -1 +1,5 @@
 __version__ = "0.1"
+
+# Neutron's extension loader looks for ``<service_plugin_root>.extensions`` as
+# an attribute on the imported top-level package.
+from neutron_understack import extensions  # noqa: F401

python/neutron-understack/neutron_understack/api/__init__.py

@@ -0,0 +1,37 @@
+from neutron_lib import constants
+from neutron_lib.api import converters
+from neutron_lib.api.definitions import l3
+
+ALIAS = "understack_vni"
+IS_SHIM_EXTENSION = False
+IS_STANDARD_ATTR_EXTENSION = False
+NAME = "Understack Router VNI"
+API_PREFIX = ""
+DESCRIPTION = "Router extension for Understack hardware VRF VNI allocation"
+UPDATED_TIMESTAMP = "2026-07-01T00:00:00-00:00"
+RESOURCE_NAME = l3.ROUTER
+COLLECTION_NAME = l3.ROUTERS
+
+EVPN_VNI = "evpn_vni"
+
+RESOURCE_ATTRIBUTE_MAP = {
+    COLLECTION_NAME: {
+        EVPN_VNI: {
+            "allow_post": True,
+            "allow_put": False,
+            "convert_to": converters.convert_to_int_if_not_none,
+            "default": 0,
+            "is_visible": True,
+            "is_filter": True,
+            "is_sort_key": True,
+            "enforce_policy": True,
+            "validate": {"type:range_or_none": [0, constants.MAX_VXLAN_VNI]},
+        },
+    },
+}
+
+SUB_RESOURCE_ATTRIBUTE_MAP = {}
+ACTION_MAP = {}
+REQUIRED_EXTENSIONS = [l3.ALIAS]
+OPTIONAL_EXTENSIONS = []
+ACTION_STATUS = {}

python/neutron-understack/neutron_understack/api/definitions/__init__.py

@@ -0,0 +1,9 @@
+import itertools
+
+from neutron_understack.conf.policies import evpn
+
+
+def list_rules():
+    return itertools.chain(
+        evpn.list_rules(),
+    )

python/neutron-understack/neutron_understack/api/definitions/understack_vni.py

@@ -0,0 +1,34 @@
+from neutron.conf.policies import base
+from oslo_policy import policy
+
+COLLECTION_PATH = "/routers"
+RESOURCE_PATH = "/routers/{id}"
+
+ACTION_POST = [
+    {"method": "POST", "path": COLLECTION_PATH},
+]
+ACTION_GET = [
+    {"method": "GET", "path": COLLECTION_PATH},
+    {"method": "GET", "path": RESOURCE_PATH},
+]
+
+rules = [
+    policy.DocumentedRuleDefault(
+        name="create_router:evpn_vni",
+        check_str=base.ADMIN,
+        scope_types=["project"],
+        description="Specify ``evpn_vni`` attribute when creating a router",
+        operations=ACTION_POST,
+    ),
+    policy.DocumentedRuleDefault(
+        name="get_router:evpn_vni",
+        check_str=base.ADMIN_OR_PROJECT_READER,
+        scope_types=["project"],
+        description="Get ``evpn_vni`` attribute of a router",
+        operations=ACTION_GET,
+    ),
+]
+
+
+def list_rules():
+    return rules

python/neutron-understack/neutron_understack/conf/__init__.py

@@ -5,6 +5,7 @@
 _OPT_GRP_ML2_UNDERSTACK = "ml2_understack"
 _OPT_GRP_IRONIC = "ironic"
 _OPT_GRP_L3_SVC_CISCO_ASA = "l3_service_cisco_asa"
+_OPT_GRP_UNDERSTACK_VNI = "understack_vni"
 
 _mech_understack_opts = [
     cfg.StrOpt(
@@ -99,6 +100,19 @@
     ),
 ]
 
+_understack_vni_opts = [
+    cfg.ListOpt(
+        "vni_ranges",
+        default=["1:16777215"],
+        item_type=cfg.types.String(),
+        help=(
+            "Comma-separated list of VNI ranges available for automatic "
+            "Understack VRF router VNI allocation. Each entry is either a "
+            "single VNI or an inclusive start:end range."
+        ),
+    ),
+]
+
 
 def list_understack_opts():
     return [
@@ -125,6 +139,12 @@ def list_cisco_asa_opts():
     ]
 
 
+def list_understack_vni_opts():
+    return [
+        (_OPT_GRP_UNDERSTACK_VNI, _understack_vni_opts),
+    ]
+
+
 def register_ml2_understack_opts(config):
     config.register_opts(_mech_understack_opts, _OPT_GRP_ML2_UNDERSTACK)
 
@@ -139,6 +159,10 @@ def register_l3_svc_cisco_asa_opts(config):
     config.register_opts(_l3_svc_cisco_asa_opts, _OPT_GRP_L3_SVC_CISCO_ASA)
 
 
+def register_understack_vni_opts(config):
+    config.register_opts(_understack_vni_opts, _OPT_GRP_UNDERSTACK_VNI)
+
+
 def get_session(group: str) -> ks_session.Session:
     auth = ks_loading.load_auth_from_conf_options(cfg.CONF, group)
     session = ks_loading.load_session_from_conf_options(cfg.CONF, group, auth=auth)