Add CUSTOM_NETGROUP_* traits and Nova network-group-affinity patch

RSabounds · RSabounds · commit fed40ebf9bd5 · 2026-06-19T09:25:44.000-05:00
Extends the LLDP inspection hook to add CUSTOM_NETGROUP_&lt;name&gt; traits
to Ironic nodes for each '-network' VLAN group they are connected to.
These traits are consumed by the new NetworkGroupAffinityFilter and
NetworkGroupAntiAffinityFilter in Nova to constrain scheduling to
nodes within a specific cabinet switch pair.

Changes:
- inspect_hook_update_baremetal_ports.py: adds _network_group_trait_name()
  function and includes CUSTOM_NETGROUP_* traits in _set_node_traits()
- _is_our_trait() updated to manage both CUSTOM_*_SWITCH and
  CUSTOM_NETGROUP_* patterns
- Nova patch (0002_network_group_affinity_policy.patch) added to
  containers/nova/patches/ for quilt application during image build
- Tests updated and new test class added for trait functions
diff --git a/containers/nova/patches/0002_network_group_affinity_policy.patch b/containers/nova/patches/0002_network_group_affinity_policy.patch
@@ -0,0 +1,281 @@
+Add network-group-affinity and network-group-anti-affinity server group policies.
+
+These new server group policies allow constraining instance placement to
+Ironic nodes within a specific physical network group (VLAN group / cabinet
+switch pair). The network group is specified in the server group's rules
+field at creation time and matched against CUSTOM_NETGROUP_* traits reported
+by Ironic nodes via the Placement service.
+
+Usage:
+  openstack server group create --policy network-group-affinity \
+    --rule network_group=a1-1-network my-cabinet-group
+  openstack server create --hint group=<group-uuid> ...
+
+diff --git a/nova/scheduler/filters/network_group_filter.py b/nova/scheduler/filters/network_group_filter.py
+new file mode 100644
+index 0000000000..000000000a
+--- /dev/null
++++ b/nova/scheduler/filters/network_group_filter.py
+@@ -0,0 +1,126 @@
++# Copyright 2025 Rackspace Technology, Inc.
++# All Rights Reserved.
++#
++# Licensed under the Apache License, Version 2.0 (the "License"); you may
++# not use this file except in compliance with the License. You may obtain
++# a copy of the License at
++#
++# http://www.apache.org/licenses/LICENSE-2.0
++#
++# Unless required by applicable law or agreed to in writing, software
++# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
++# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
++# License for the specific language governing permissions and limitations
++# under the License.
++
++"""Scheduler filters for network group affinity and anti-affinity.
++
++These filters constrain instance placement based on the physical network
++group (VLAN group / cabinet switch pair) that an Ironic node belongs to.
++
++The network group is specified in a server group's ``rules`` field at
++creation time and is matched against ``CUSTOM_NETGROUP_*`` traits reported
++by Ironic nodes via the Placement service.
++"""
++
++from oslo_log import log as logging
++
++from nova.scheduler import filters
++
++LOG = logging.getLogger(__name__)
++
++# Prefix used when converting a network group name to a trait.
++# Example: "a1-1-network" -> "CUSTOM_NETGROUP_A1_1_NETWORK"
++_TRAIT_PREFIX = "CUSTOM_NETGROUP_"
++
++
++def _network_group_to_trait(network_group):
++    """Convert a network group name to its corresponding Placement trait.
++
++    :param network_group: The network group name (e.g. "a1-1-network")
++    :returns: The trait string (e.g. "CUSTOM_NETGROUP_A1_1_NETWORK")
++    """
++    normalised = network_group.upper().replace("-", "_").replace("/", "_")
++    return _TRAIT_PREFIX + normalised
++
++
++class NetworkGroupAffinityFilter(filters.BaseHostFilter):
++    """Schedule instances onto hosts within a specific network group.
++
++    When a server group has the ``network-group-affinity`` policy and a
++    ``network_group`` rule, this filter only passes hosts whose reported
++    traits include the matching ``CUSTOM_NETGROUP_*`` trait.
++
++    Hosts without the required trait are rejected.
++    """
++
++    # The trait set of a host does not change within a single scheduling
++    # request.
++    run_filter_once_per_request = True
++
++    RUN_ON_REBUILD = False
++
++    def host_passes(self, host_state, spec_obj):
++        instance_group = spec_obj.instance_group
++        if not instance_group:
++            return True
++
++        policy = instance_group.policy if instance_group else None
++        if policy != 'network-group-affinity':
++            return True
++
++        rules = instance_group.rules
++        network_group = rules.get('network_group') if rules else None
++        if not network_group:
++            return True
++
++        required_trait = _network_group_to_trait(network_group)
++
++        host_traits = set()
++        if hasattr(host_state, 'traits'):
++            host_traits = host_state.traits
++
++        passes = required_trait in host_traits
++        if not passes:
++            LOG.debug(
++                "NetworkGroupAffinityFilter: host %(host)s rejected. "
++                "Required trait %(trait)s not found in host traits.",
++                {'host': host_state.host, 'trait': required_trait})
++        return passes
++
++
++class NetworkGroupAntiAffinityFilter(filters.BaseHostFilter):
++    """Schedule instances onto hosts NOT within a specific network group.
++
++    When a server group has the ``network-group-anti-affinity`` policy and
++    a ``network_group`` rule, this filter rejects hosts whose reported
++    traits include the matching ``CUSTOM_NETGROUP_*`` trait.
++
++    This is useful for spreading workloads across cabinets or ensuring
++    instances avoid a particular switch pair.
++    """
++
++    # The trait set of a host does not change within a single scheduling
++    # request.
++    run_filter_once_per_request = True
++
++    RUN_ON_REBUILD = False
++
++    def host_passes(self, host_state, spec_obj):
++        instance_group = spec_obj.instance_group
++        if not instance_group:
++            return True
++
++        policy = instance_group.policy if instance_group else None
++        if policy != 'network-group-anti-affinity':
++            return True
++
++        rules = instance_group.rules
++        network_group = rules.get('network_group') if rules else None
++        if not network_group:
++            return True
++
++        excluded_trait = _network_group_to_trait(network_group)
++
++        host_traits = set()
++        if hasattr(host_state, 'traits'):
++            host_traits = host_state.traits
++
++        passes = excluded_trait not in host_traits
++        if not passes:
++            LOG.debug(
++                "NetworkGroupAntiAffinityFilter: host %(host)s rejected. "
++                "Excluded trait %(trait)s found in host traits.",
++                {'host': host_state.host, 'trait': excluded_trait})
++        return passes
+diff --git a/nova/api/openstack/compute/schemas/server_groups.py b/nova/api/openstack/compute/schemas/server_groups.py
+index abcdef1234..1234abcdef 100644
+--- a/nova/api/openstack/compute/schemas/server_groups.py
++++ b/nova/api/openstack/compute/schemas/server_groups.py
+@@ -63,14 +63,20 @@ create_v264 = copy.deepcopy(create_v215)
+ del create_v264['properties']['server_group']['properties']['policies']
+ create_v264['properties']['server_group']['required'].remove('policies')
+ create_v264['properties']['server_group']['required'].append('policy')
+ create_v264['properties']['server_group']['properties']['policy'] = {
+     'type': 'string',
+-    'enum': ['anti-affinity', 'affinity',
+-             'soft-anti-affinity', 'soft-affinity'],
++    'enum': ['anti-affinity', 'affinity',
++             'soft-anti-affinity', 'soft-affinity',
++             'network-group-affinity', 'network-group-anti-affinity'],
+ }
+ 
+ create_v264['properties']['server_group']['properties']['rules'] = {
+     'type': 'object',
+     'properties': {
+         'max_server_per_host':
+             parameter_types.positive_integer,
++        'network_group': {
++            'type': 'string',
++            'minLength': 1,
++            'maxLength': 255,
++        },
+     },
+     'additionalProperties': False,
+ }
+@@ -155,11 +161,13 @@ _server_group_response_v264['properties'].update({
+     'policy': {
+         'type': 'string',
+         'enum': [
+             'affinity',
+             'anti-affinity',
+             'soft-affinity',
+             'soft-anti-affinity',
++            'network-group-affinity',
++            'network-group-anti-affinity',
+         ],
+     },
+     'rules': {
+         'type': 'object',
+         'properties': {
+             'max_server_per_host': {'type': 'integer'},
++            'network_group': {'type': 'string'},
+         },
+         'required': [],
+         'additionalProperties': False,
+diff --git a/nova/api/openstack/compute/server_groups.py b/nova/api/openstack/compute/server_groups.py
+index abcdef5678..5678abcdef 100644
+--- a/nova/api/openstack/compute/server_groups.py
++++ b/nova/api/openstack/compute/server_groups.py
+@@ -236,13 +236,26 @@ class ServerGroupController(wsgi.Controller):
+         if api_version_request.is_supported(req, "2.64"):
+             policy = vals['policy']
+             rules = vals.get('rules', {})
+-            if policy != 'anti-affinity' and rules:
+-                msg = _("Only anti-affinity policy supports rules.")
+-                raise exc.HTTPBadRequest(explanation=msg)
+-            # NOTE(yikun): This should be removed in Stein version.
+-            if not _should_enable_custom_max_server_rules(context, rules):
+-                msg = _("Creating an anti-affinity group with rule "
+-                        "max_server_per_host > 1 is not yet supported.")
+-                raise exc.HTTPConflict(explanation=msg)
++            if policy == 'anti-affinity':
++                # NOTE(yikun): This should be removed in Stein version.
++                if not _should_enable_custom_max_server_rules(context, rules):
++                    msg = _("Creating an anti-affinity group with rule "
++                            "max_server_per_host > 1 is not yet supported.")
++                    raise exc.HTTPConflict(explanation=msg)
++            elif policy in ('network-group-affinity',
++                            'network-group-anti-affinity'):
++                if 'max_server_per_host' in rules:
++                    msg = _("network-group-affinity and "
++                            "network-group-anti-affinity policies do not "
++                            "support the max_server_per_host rule.")
++                    raise exc.HTTPBadRequest(explanation=msg)
++                if 'network_group' not in rules:
++                    msg = _("network-group-affinity and "
++                            "network-group-anti-affinity policies require "
++                            "a network_group rule.")
++                    raise exc.HTTPBadRequest(explanation=msg)
++            elif rules:
++                msg = _("Only anti-affinity, network-group-affinity, and "
++                        "network-group-anti-affinity policies support rules.")
++                raise exc.HTTPBadRequest(explanation=msg)
+             sg = objects.InstanceGroup(context, policy=policy,
+                                        rules=rules)
+diff --git a/nova/objects/instance_group.py b/nova/objects/instance_group.py
+index abcdef9012..9012abcdef 100644
+--- a/nova/objects/instance_group.py
++++ b/nova/objects/instance_group.py
+@@ -151,6 +151,8 @@ class InstanceGroup(base.NovaPersistentObject, base.NovaObject,
+         if 'max_server_per_host' in self._rules:
+             rules['max_server_per_host'] = \
+                     int(self._rules['max_server_per_host'])
++        if 'network_group' in self._rules:
++            rules['network_group'] = self._rules['network_group']
+         return rules
+ 
+     def obj_make_compatible(self, primitive, target_version):
+diff --git a/nova/scheduler/utils.py b/nova/scheduler/utils.py
+index abcdef3456..3456abcdef 100644
+--- a/nova/scheduler/utils.py
++++ b/nova/scheduler/utils.py
+@@ -1212,7 +1212,8 @@ def setup_instance_group(context, request_spec):
+ 
+-    policies = set(('anti-affinity', 'affinity', 'soft-affinity',
+-                    'soft-anti-affinity'))
++    policies = set(('anti-affinity', 'affinity', 'soft-affinity',
++                    'soft-anti-affinity', 'network-group-affinity',
++                    'network-group-anti-affinity'))
+     if group.policy in policies:
+diff --git a/nova/conf/scheduler.py b/nova/conf/scheduler.py
+index abcdef7890..7890abcdef 100644
+--- a/nova/conf/scheduler.py
++++ b/nova/conf/scheduler.py
+@@ -328,6 +328,8 @@ All filters in the list are optional.
+             "ImagePropertiesFilter",
+             "ServerGroupAntiAffinityFilter",
+             "ServerGroupAffinityFilter",
++            "NetworkGroupAffinityFilter",
++            "NetworkGroupAntiAffinityFilter",
+         ],
+         help="""
diff --git a/containers/nova/patches/series b/containers/nova/patches/series
@@ -1,2 +1,3 @@
 0001_trunk_details_metadata.patch
 ironic-attach-debug.patch
+0002_network_group_affinity_policy.patch
diff --git a/python/ironic-understack/ironic_understack/inspect_hook_update_baremetal_ports.py b/python/ironic-understack/ironic_understack/inspect_hook_update_baremetal_ports.py
@@ -236,16 +236,28 @@ def _set_node_traits(task, vlan_groups: set[str]):
     For example, a connection to VLAN Group whose name ends in "-storage" will
     result in a trait being added to the node called "CUSTOM_STORAGE_SWITCH".
 
+    We also add a CUSTOM_NETGROUP_<name> trait for each "-network" VLAN group
+    the node is connected to. This trait is used by the Nova scheduler's
+    NetworkGroupAffinityFilter and NetworkGroupAntiAffinityFilter to constrain
+    instance placement to specific cabinet switch pairs.
+
     We remove pre-existing traits if the node does not have the required
     connections.
 
-    Traits other than CUSTOM_*_SWITCH are left alone.
+    Traits other than CUSTOM_*_SWITCH and CUSTOM_NETGROUP_* are left alone.
     """
     node = task.node
     existing_traits = set(node.traits.get_trait_names())
     vlan_group_traits = {_trait_name(x) for x in vlan_groups if x}
+    network_group_traits = {
+        _network_group_trait_name(x)
+        for x in vlan_groups
+        if x and x.endswith("-network")
+    }
     irrelevant_existing_traits = {x for x in existing_traits if not _is_our_trait(x)}
-    required_traits = irrelevant_existing_traits.union(vlan_group_traits)
+    required_traits = irrelevant_existing_traits.union(
+        vlan_group_traits
+    ).union(network_group_traits)
 
     if existing_traits == required_traits:
         LOG.debug(
@@ -269,5 +281,22 @@ def _trait_name(vlan_group_name: str) -> str:
     return f"CUSTOM_{suffix}_SWITCH"
 
 
+def _network_group_trait_name(vlan_group_name: str) -> str:
+    """Convert a VLAN group name to a CUSTOM_NETGROUP_* trait.
+
+    This trait is consumed by Nova's NetworkGroupAffinityFilter and
+    NetworkGroupAntiAffinityFilter to constrain scheduling to nodes
+    within a specific cabinet / switch pair.
+
+    Example: "a1-1-network" -> "CUSTOM_NETGROUP_A1_1_NETWORK"
+    Example: "a11-12/a11-13-network" -> "CUSTOM_NETGROUP_A11_12_A11_13_NETWORK"
+    """
+    normalised = vlan_group_name.upper().replace("-", "_").replace("/", "_")
+    return f"CUSTOM_NETGROUP_{normalised}"
+
+
 def _is_our_trait(name: str) -> bool:
-    return bool(re.match(r"^CUSTOM_[A-Z0-9]+_SWITCH$", name))
+    return bool(
+        re.match(r"^CUSTOM_[A-Z0-9]+_SWITCH$", name)
+        or re.match(r"^CUSTOM_NETGROUP_[A-Z0-9_]+$", name)
+    )
diff --git a/python/ironic-understack/ironic_understack/tests/test_inspect_hook_update_baremetal_ports.py b/python/ironic-understack/ironic_understack/tests/test_inspect_hook_update_baremetal_ports.py

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`0001_trunk_details_metadata.patch`
`2`	`2`	`ironic-attach-debug.patch`
	`3`	`+0002_network_group_affinity_policy.patch`