Refactor(eos_designs): Dedicated MLAG peer group for overlay tenants #4881

Vibhu-gslab · 2025-01-15T07:37:34Z

Change Summary

Currently MLAG-IPv4-UNDERLAY-PEER is used for the iBGP session between MLAG pairs in the underlay and overlay. This approach can be misleading due to the use of UNDERLAY word in the BGP peer group name.

The following is an example of the configuration that AVD generates today

router bgp xxxx 
   neighbor MLAG-IPv4-UNDERLAY-PEER peer group
   neighbor MLAG-IPv4-UNDERLAY-PEER remote-as 65000.1
   neighbor MLAG-IPv4-UNDERLAY-PEER next-hop-self
   neighbor MLAG-IPv4-UNDERLAY-PEER description DC1-CL2
   neighbor MLAG-IPv4-UNDERLAY-PEER password 7 xxxx
   neighbor MLAG-IPv4-UNDERLAY-PEER send-community
   neighbor MLAG-IPv4-UNDERLAY-PEER maximum-routes 12000
   neighbor MLAG-IPv4-UNDERLAY-PEER route-map RM-MLAG-PEER-IN in

   address-family ipv4
      neighbor MLAG-IPv4-UNDERLAY-PEER activate

   vrf BLUE
      rd 192.168.100.1:1002
      route-target import evpn 1002:1002
      route-target export evpn 1002:1002
      router-id 192.168.100.1
      neighbor 172.16.1.1 peer group MLAG-IPv4-UNDERLAY-PEER
      redistribute connected

Related Issue(s)

Fixes #4826

Component(s) name

arista.avd.eos_designs

Proposed changes

Plan for this issue to be non-breaking:
1/ introduce a new knob to use_separate_mlag_peer_group_for_overlay: with a default of false.
2/ add a peer_group in bgp_peer_groups for MLAG overlay to be used when the toggle from 1/ is true

How to test

Molecule testing

Checklist

Repository Checklist

My code has been rebased from devel before I start
I have read the CONTRIBUTING document.
My change requires a change to the documentation and documentation have been updated accordingly.
I have updated molecule CI testing accordingly. (check the box if not applicable)

github-actions · 2025-01-15T07:37:46Z

Review docs on Read the Docs

To test this pull request:

# Create virtual environment for this testing below the current directory
python -m venv test-avd-pr-4881
# Activate the virtual environment
source test-avd-pr-4881/bin/activate
# Install all requirements including PyAVD
pip install "pyavd[ansible] @ git+https://github.com/Vibhu-gslab/avd.git@mlag_peer_group_4826#subdirectory=python-avd" --force
# Point Ansible collections path to the Python virtual environment
export ANSIBLE_COLLECTIONS_PATH=$VIRTUAL_ENV/ansible_collections
# Install Ansible collection
ansible-galaxy collection install git+https://github.com/Vibhu-gslab/avd.git#/ansible_collections/arista/avd/,mlag_peer_group_4826 --force
# Optional: Install AVD examples
cd test-avd-pr-4881
ansible-playbook arista.avd.install_examples

python-avd/pyavd/_eos_designs/schema/schema_fragments/bgp_peer_groups.schema.yml

gmuloc · 2025-01-15T09:40:41Z

python-avd/pyavd/_eos_designs/structured_config/mlag/__init__.py

+        if (
+            self.inputs.bgp_peer_groups.use_separate_mlag_peer_group_for_overlay
+            and self.inputs.bgp_peer_groups.mlag_ipv4_underlay_peer.name == "MLAG-IPv4-UNDERLAY-PEER"
+        ):
+            peer_group_name = "MLAG-IPv4-OVERLAY-PEER"


this should not be changed here.
instead when this: self.inputs.bgp_peer_groups.use_separate_mlag_peer_group_for_overlay is true, the peer group used for MLAG overlay should be the one under bgp_peer_groups.mlag_ipv4_overlay_peer

…_groups.schema.yml Co-authored-by: Guillaume Mulocher <[email protected]>

for more information, see https://pre-commit.ci

gmuloc · 2025-01-20T15:35:48Z

...lections/arista/avd/molecule/eos_designs_unit_tests/inventory/group_vars/BGP_PEER_GROUPS.yml

@@ -29,6 +29,7 @@ node_type_keys:
    default_evpn_encapsulation: mpls

 bgp_peer_groups:
+  use_separate_mlag_peer_group_for_overlay: true


please add a test testing the mlag_ipv4_overlay_peer as well

gmuloc · 2025-01-20T15:39:06Z

...ollections/arista/avd/molecule/eos_designs_unit_tests/intended/configs/bgp-peer-groups-1.cfg

@@ -135,6 +142,7 @@ router bgp 65001
   address-family ipv4
      no neighbor EVPN-OVERLAY-PEERS activate
      neighbor IPv4-UNDERLAY-PEERS activate
+      neighbor MLAG-IPv4-OVERLAY-PEER activate


this should not be rendered.

gmuloc · 2025-01-20T15:40:30Z

python-avd/pyavd/_eos_designs/schema/schema_fragments/bgp_peer_groups.schema.yml

+        type: bool
+        default: false
+        description: Configure a different BGP peer group for MLAG for underlay and overlay.
+      mlag_ipv4_overlay_peer:


Suggested change

mlag_ipv4_overlay_peer:

mlag_ipv4_vrfs_peer:

rename the PR

gmuloc · 2025-01-20T15:46:53Z

python-avd/pyavd/_eos_designs/schema/schema_fragments/bgp_peer_groups.schema.yml

+      use_separate_mlag_peer_group_for_overlay:
+        type: bool
+        default: false
+        description: Configure a different BGP peer group for MLAG for underlay and overlay.


after discussion let's remove this boolean and rely on the name of mlag_ipv4_vrfs_peer being set different from the mlag_ipv4_underlay_peer

gmuloc · 2025-01-20T15:48:08Z

python-avd/pyavd/_eos_designs/schema/schema_fragments/bgp_peer_groups.schema.yml

+        keys:
+          name:
+            type: str
+            default: MLAG-IPv4-OVERLAY-PEER


let's remove this default value and in the code:
1/ default it to the value of mlag_ipv4_underlay_peer.name
2/ the code will need to check whether mlag_ipv4_underlay_peer.name and mlag_ipv4_vrfs_peer.name are equal or not.

Create a shared_utils to get the name based on thta
if the names are the same (either because default or being set to the same name as underlay one), then the password, bfd, .. under this key will be ignored. Make a note of this behavior in the description of the key.

gmuloc · 2025-01-20T15:49:48Z

python-avd/pyavd/_eos_designs/structured_config/overlay/router_bgp.py

+        # To configure a different BGP peer group for mlag_ipv4_overlay_peer
+        if self.inputs.bgp_peer_groups.use_separate_mlag_peer_group_for_overlay is True:
+            peer_groups.append(
+                {
+                    **self._generate_base_peer_group("ipv4", "mlag_ipv4_overlay_peer"),
+                    "remote_as": self.shared_utils.bgp_as,
+                    "next_hop_self": True,
+                    "maximum_routes": 12000,
+                    "route_map_in": "RM-MLAG-PEER-IN",
+                },
+            )


this should be in MLAG module

gmuloc · 2025-01-20T15:49:59Z

python-avd/pyavd/_eos_designs/structured_config/overlay/router_bgp.py

+        if self.inputs.bgp_peer_groups.use_separate_mlag_peer_group_for_overlay is True:
+            peer_groups.append({"name": self.inputs.bgp_peer_groups.mlag_ipv4_overlay_peer.name, "activate": True})
+


this should be removed

gmuloc · 2025-01-20T15:50:32Z

python-avd/pyavd/_eos_designs/structured_config/network_services/router_bgp.py

+        peer_group_name = self.inputs.bgp_peer_groups.mlag_ipv4_underlay_peer.name
+        if self.inputs.bgp_peer_groups.use_separate_mlag_peer_group_for_overlay:
+            peer_group_name = self.inputs.bgp_peer_groups.mlag_ipv4_overlay_peer.name


create a shared_utils to get this name with the logic defined in the schema comment

github-actions bot added state: CI Updated CI scenario have been updated in the PR state: Documentation role Updated role: eos_designs issue related to eos_designs role labels Jan 15, 2025

github-actions bot assigned Vibhu-gslab Jan 15, 2025

Vibhu-gslab force-pushed the mlag_peer_group_4826 branch from 1748a4c to ca1ab75 Compare January 15, 2025 07:37

gmuloc requested changes Jan 15, 2025

View reviewed changes

github-actions bot added state: CI Updated CI scenario have been updated in the PR and removed state: CI Updated CI scenario have been updated in the PR labels Jan 16, 2025

Vibhu-gslab force-pushed the mlag_peer_group_4826 branch from d7f9533 to 072841d Compare January 16, 2025 14:12

Vibhu-gslab and others added 5 commits January 17, 2025 16:07

Refactor(eos_designs): Dedicated MLAG peer group for overlay tenants

f987acd

Update python-avd/pyavd/_eos_designs/schema/schema_fragments/bgp_peer…

1b6d5f1

…_groups.schema.yml Co-authored-by: Guillaume Mulocher <[email protected]>

[pre-commit.ci] auto fixes from pre-commit.com hooks

6cd0c4b

for more information, see https://pre-commit.ci

reverting changes and adding new schema

9fd8b29

Made changes in overlay.router_bgp and vrf peer_group

4c2087d

Vibhu-gslab force-pushed the mlag_peer_group_4826 branch from 072841d to 4c2087d Compare January 17, 2025 10:37

Vibhu-gslab marked this pull request as ready for review January 17, 2025 11:24

Vibhu-gslab requested review from a team as code owners January 17, 2025 11:24

Vibhu-gslab requested a review from gmuloc January 17, 2025 11:24

Merge branch 'devel' into mlag_peer_group_4826

c5c5a2b

gmuloc requested changes Jan 20, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor(eos_designs): Dedicated MLAG peer group for overlay tenants #4881

Refactor(eos_designs): Dedicated MLAG peer group for overlay tenants #4881

Vibhu-gslab commented Jan 15, 2025

github-actions bot commented Jan 15, 2025

gmuloc Jan 15, 2025

Vibhu-gslab Jan 17, 2025

gmuloc Jan 20, 2025

gmuloc Jan 20, 2025

gmuloc Jan 20, 2025

gmuloc Jan 20, 2025

gmuloc Jan 20, 2025

gmuloc Jan 20, 2025

gmuloc Jan 20, 2025

gmuloc Jan 20, 2025

		if self.inputs.bgp_peer_groups.use_separate_mlag_peer_group_for_overlay is True:
		peer_groups.append({"name": self.inputs.bgp_peer_groups.mlag_ipv4_overlay_peer.name, "activate": True})

Refactor(eos_designs): Dedicated MLAG peer group for overlay tenants #4881

Are you sure you want to change the base?

Refactor(eos_designs): Dedicated MLAG peer group for overlay tenants #4881

Conversation

Vibhu-gslab commented Jan 15, 2025

Change Summary

Related Issue(s)

Component(s) name

Proposed changes

How to test

Checklist

Repository Checklist

github-actions bot commented Jan 15, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment