[bgp] Add support to explicitly specify bgp router id for single asic…

…e device (#18727) HLD: sonic-net/SONiC#1643 Add support to explictly specify bgp router id for single asic device Microsoft ADO (number only): 27674485 How I did it 1. When bgp_router_id configured in DEVICE_METADATA, use it as bgp router-id. 2. Remove the hard dependency on loopback0 ipv4 address when adding bgp peer. 3. Add UTs. Behavior of set bgp router-id To be clarified that when bgp router-id hasn't been explicitly set, bgp actions would totally like previous Loopback0 IPv4 address exists Loopback0 IPv4 address doesn't exist bgp_router_id configured Honor bgp_router_id Honor bgp_router_id bgp_router_id not confgd Honor Loopback0 IPv4 address FRR default router ID value is selected as the largest IP address of the device. When router zebra is not enabled bgpd can’t get interface information, so router-id is set to 0.0.0.0 Behavior of add bgp peer To be clarified that when bgp router-id hasn't been explicitly set, bgp actions would totally like previous Loopback0 IPv4 address exists Loopback0 IPv4 address doesn't exist bgp_router_id configured Add BGP peer Add BGP peer bgp_router_id not configured Add BGP peer Do not add BGP peer
sonic-net · May 13, 2024 · 3c1e31b · 3c1e31b
1 parent c2e249a
commit 3c1e31b
Show file tree

Hide file tree

Showing 13 changed files with 425 additions and 11 deletions.
diff --git a/dockers/docker-fpm-frr/frr/bgpd/bgpd.main.conf.j2 b/dockers/docker-fpm-frr/frr/bgpd/bgpd.main.conf.j2
@@ -8,7 +8,10 @@
 !
 ! TSA configuration
 !
-ip prefix-list PL_LoopbackV4 permit {{ get_ipv4_loopback_address(LOOPBACK_INTERFACE, "Loopback0") | ip }}/32
+{% set lo0_ipv4 = get_ipv4_loopback_address(LOOPBACK_INTERFACE, "Loopback0") | ip %}
+{% if lo0_ipv4 is not none %}
+ip prefix-list PL_LoopbackV4 permit {{ lo0_ipv4 }}/32
+{% endif %}
 !
 {% if get_ipv6_loopback_address(LOOPBACK_INTERFACE, "Loopback0") != 'None' %}
 {% if ( ('localhost' in DEVICE_METADATA) and ('bgp_adv_lo_prefix_as_128' in  DEVICE_METADATA['localhost']) and
@@ -88,11 +91,17 @@ router bgp {{ DEVICE_METADATA['localhost']['bgp_asn'] }}
 {% if DEVICE_METADATA['localhost']['sub_role'] == 'BackEnd' or DEVICE_METADATA['localhost']['switch_type'] == 'voq' or DEVICE_METADATA['localhost']['switch_type'] == 'chassis-packet' %}
   bgp router-id {{ get_ipv4_loopback_address(LOOPBACK_INTERFACE, "Loopback4096") | ip }}
 {% else %}
-  bgp router-id {{ get_ipv4_loopback_address(LOOPBACK_INTERFACE, "Loopback0") | ip }}
+{% if "localhost" in DEVICE_METADATA and "bgp_router_id" in DEVICE_METADATA["localhost"] %}
+  bgp router-id {{ DEVICE_METADATA["localhost"]["bgp_router_id"] }}
+{% elif lo0_ipv4 is not none%}
+  bgp router-id {{ lo0_ipv4 }}
+{% endif %}
 {% endif %}
 !
 {# advertise loopback #}
-  network {{ get_ipv4_loopback_address(LOOPBACK_INTERFACE, "Loopback0") | ip }}/32
+{% if lo0_ipv4 is not none %}
+  network {{ lo0_ipv4 }}/32
+{% endif %}
 {% if ((multi_asic is defined and DEVICE_METADATA['localhost']['switch_type'] != 'chassis-packet') or (DEVICE_METADATA['localhost']['switch_type'] == 'voq')) %}
   network {{ get_ipv4_loopback_address(LOOPBACK_INTERFACE, "Loopback4096") | ip }}/32 route-map HIDE_INTERNAL
 {% endif %}

diff --git a/dockers/docker-fpm-frr/frr/bgpd/templates/monitors/peer-group.conf.j2 b/dockers/docker-fpm-frr/frr/bgpd/templates/monitors/peer-group.conf.j2
@@ -4,7 +4,7 @@
   neighbor BGPMON peer-group
 {% if CONFIG_DB__DEVICE_METADATA['localhost']['type'] == 'SpineRouter' %}
   neighbor BGPMON update-source Loopback4096
-{% else %}
+{% elif loopback0_ipv4 %}
   neighbor BGPMON update-source {{ loopback0_ipv4 | ip }}
 {% endif %}
 

diff --git a/src/sonic-bgpcfgd/bgpcfgd/managers_bgp.py b/src/sonic-bgpcfgd/bgpcfgd/managers_bgp.py
@@ -106,7 +106,6 @@ def __init__(self, common_objs, db_name, table_name, peer_type, check_neig_meta)
 
         deps = [
             ("CONFIG_DB", swsscommon.CFG_DEVICE_METADATA_TABLE_NAME, "localhost/bgp_asn"),
-            ("CONFIG_DB", swsscommon.CFG_LOOPBACK_INTERFACE_TABLE_NAME, "Loopback0"),
             ("CONFIG_DB", swsscommon.CFG_BGP_DEVICE_GLOBAL_TABLE_NAME, "tsa_enabled"),
             ("LOCAL", "local_addresses", ""),
             ("LOCAL", "interfaces", ""),
@@ -168,9 +167,11 @@ def add_peer(self, vrf, nbr, data):
         bgp_asn = self.directory.get_slot("CONFIG_DB", swsscommon.CFG_DEVICE_METADATA_TABLE_NAME)["localhost"]["bgp_asn"]
         #
         lo0_ipv4 = self.get_lo_ipv4("Loopback0|")
-        if lo0_ipv4 is None:
-            log_warn("Loopback0 ipv4 address is not presented yet")
+        if (lo0_ipv4 is None and "bgp_router_id"
+            not in self.directory.get_slot("CONFIG_DB", swsscommon.CFG_DEVICE_METADATA_TABLE_NAME)["localhost"]):
+            log_warn("Loopback0 ipv4 address is not presented yet and bgp_router_id not configured")
             return False
+
         #
         if self.peer_type == 'internal':
             lo4096_ipv4 = self.get_lo_ipv4("Loopback4096|")
@@ -203,10 +204,11 @@ def add_peer(self, vrf, nbr, data):
             'vrf': vrf,
             'neighbor_addr': nbr,
             'bgp_session': data,
-            'loopback0_ipv4': lo0_ipv4,
             'CONFIG_DB__LOOPBACK_INTERFACE':{ tuple(key.split('|')) : {} for key in self.directory.get_slot("CONFIG_DB", swsscommon.CFG_LOOPBACK_INTERFACE_TABLE_NAME)
                                                                          if '|' in key }
         }
+        if lo0_ipv4 is not None:
+            kwargs['loopback0_ipv4'] = lo0_ipv4
         if self.check_neig_meta:
             neigmeta = self.directory.get_slot("CONFIG_DB", swsscommon.CFG_DEVICE_NEIGHBOR_METADATA_TABLE_NAME)
             if 'name' in data and data["name"] not in neigmeta:

diff --git a/src/sonic-bgpcfgd/tests/data/monitors/peer-group.conf/param_without_lo0_ipv4.json b/src/sonic-bgpcfgd/tests/data/monitors/peer-group.conf/param_without_lo0_ipv4.json
@@ -0,0 +1,7 @@
+{
+    "CONFIG_DB__DEVICE_METADATA": {
+        "localhost": {
+            "type": "LeafRouter"
+        }
+    }
+}
diff --git a/src/sonic-bgpcfgd/tests/data/monitors/peer-group.conf/result_without_lo0_ipv4.conf b/src/sonic-bgpcfgd/tests/data/monitors/peer-group.conf/result_without_lo0_ipv4.conf
@@ -0,0 +1,15 @@
+!
+! template: bgpd/templates/BGPMON/peer-group.conf.j2
+!
+  neighbor BGPMON peer-group
+  address-family ipv4
+    neighbor BGPMON activate
+    neighbor BGPMON route-map FROM_BGPMON in
+    neighbor BGPMON route-map TO_BGPMON out
+    neighbor BGPMON send-community
+    neighbor BGPMON maximum-prefix 1
+  exit-address-family
+!
+! end of template: bgpd/templates/BGPMON/peer-group.conf.j2
+!
+
diff --git a/src/sonic-bgpcfgd/tests/data/sonic-cfggen/bgpd.main.conf.j2/defaults_router_id.conf b/src/sonic-bgpcfgd/tests/data/sonic-cfggen/bgpd.main.conf.j2/defaults_router_id.conf
@@ -0,0 +1,80 @@
+!
+! template: bgpd/bgpd.main.conf.j2
+!
+! bgp multiple-instance
+!
+! BGP configuration
+!
+! TSA configuration
+!
+ip prefix-list PL_LoopbackV4 permit 55.55.55.55/32
+!
+ipv6 prefix-list PL_LoopbackV6 permit fc00::/64
+!
+ip prefix-list LOCAL_VLAN_IPV4_PREFIX seq 5 permit 10.10.10.0/24
+!
+ipv6 prefix-list LOCAL_VLAN_IPV6_PREFIX seq 10 permit fc01::/64
+!
+ip prefix-list V4_P2P_IP permit 0.0.0.0/0 ge 31 le 31
+!
+ipv6 prefix-list V6_P2P_IP permit ::/0 ge 126 le 126
+!
+route-map V4_CONNECTED_ROUTES permit 10
+  match ip address prefix-list V4_P2P_IP
+  call HIDE_INTERNAL
+!
+route-map V6_CONNECTED_ROUTES permit 10
+  match ipv6 address prefix-list V6_P2P_IP
+  call HIDE_INTERNAL
+!
+route-map HIDE_INTERNAL permit 10
+  set community no-export
+!
+!
+router bgp 55555
+!
+  bgp log-neighbor-changes
+  bgp suppress-fib-pending
+  no bgp default ipv4-unicast
+  no bgp ebgp-requires-policy
+!
+  bgp bestpath as-path multipath-relax
+!
+  bgp graceful-restart restart-time 240
+  bgp graceful-restart
+  bgp graceful-restart preserve-fw-state
+  bgp graceful-restart select-defer-time 45
+!
+  bgp router-id 8.8.8.8
+!
+  network 55.55.55.55/32
+  network 55.55.55.56/32 route-map HIDE_INTERNAL
+!
+  address-family ipv6
+    network fc00::1/64
+  exit-address-family
+  address-family ipv6
+    network fc00::2/128 route-map HIDE_INTERNAL
+  exit-address-family
+!
+  network 10.10.10.1/24
+  address-family ipv6
+   network fc01::1/64
+  exit-address-family
+!
+  address-family ipv4
+    redistribute connected route-map V4_CONNECTED_ROUTES
+  exit-address-family
+  address-family ipv6
+    redistribute connected route-map V6_CONNECTED_ROUTES
+  exit-address-family
+!
+  address-family ipv4
+    maximum-paths 64
+  exit-address-family
+  address-family ipv6
+    maximum-paths 64
+  exit-address-family
+!
+! end of template: bgpd/bgpd.main.conf.j2
+!
diff --git a/src/sonic-bgpcfgd/tests/data/sonic-cfggen/bgpd.main.conf.j2/defaults_router_id.json b/src/sonic-bgpcfgd/tests/data/sonic-cfggen/bgpd.main.conf.j2/defaults_router_id.json
@@ -0,0 +1,36 @@
+{
+    "DEVICE_METADATA": {
+        "localhost": {
+            "bgp_asn": "55555",
+            "sub_role": "FrontEnd",
+            "type": "ToRRouter",
+            "bgp_router_id": "8.8.8.8"
+        }
+    },
+    "LOOPBACK_INTERFACE": {
+        "Loopback0|55.55.55.55/32": {},
+        "Loopback0|fc00::1/128": {},
+        "Loopback4096|55.55.55.56/32": {},
+        "Loopback4096|fc00::2/128": {}
+    },
+    "VLAN_INTERFACE": {
+        "Vlan10|10.10.10.1/24": {},
+        "Vlan10|fc01::1/64": {},
+        "Vlan20": {"vnet_name": "Vnet1"},
+        "Vlan20|20.20.20.1/24": {},
+        "Vlan20|fd01::1/64": {}
+    },
+    "constants": {
+        "bgp": {
+            "multipath_relax": {
+                "enabled": true
+            },
+            "graceful_restart": {
+                "enabled": true
+            },
+            "maximum_paths": {
+                "enabled": true
+            }
+        }
+    }
+}
diff --git a/src/sonic-bgpcfgd/tests/data/sonic-cfggen/bgpd.main.conf.j2/lo0_ipv6_only.conf b/src/sonic-bgpcfgd/tests/data/sonic-cfggen/bgpd.main.conf.j2/lo0_ipv6_only.conf
@@ -0,0 +1,75 @@
+!
+! template: bgpd/bgpd.main.conf.j2
+!
+! bgp multiple-instance
+!
+! BGP configuration
+!
+! TSA configuration
+!
+ipv6 prefix-list PL_LoopbackV6 permit fc00::/64
+!
+ip prefix-list LOCAL_VLAN_IPV4_PREFIX seq 5 permit 10.10.10.0/24
+!
+ipv6 prefix-list LOCAL_VLAN_IPV6_PREFIX seq 10 permit fc01::/64
+!
+ip prefix-list V4_P2P_IP permit 0.0.0.0/0 ge 31 le 31
+!
+ipv6 prefix-list V6_P2P_IP permit ::/0 ge 126 le 126
+!
+route-map V4_CONNECTED_ROUTES permit 10
+  match ip address prefix-list V4_P2P_IP
+  call HIDE_INTERNAL
+!
+route-map V6_CONNECTED_ROUTES permit 10
+  match ipv6 address prefix-list V6_P2P_IP
+  call HIDE_INTERNAL
+!
+route-map HIDE_INTERNAL permit 10
+  set community no-export
+!
+!
+router bgp 55555
+!
+  bgp log-neighbor-changes
+  bgp suppress-fib-pending
+  no bgp default ipv4-unicast
+  no bgp ebgp-requires-policy
+!
+  bgp bestpath as-path multipath-relax
+!
+  bgp graceful-restart restart-time 480
+  bgp graceful-restart
+  bgp graceful-restart preserve-fw-state
+  bgp graceful-restart select-defer-time 45
+!
+  network 55.55.55.56/32 route-map HIDE_INTERNAL
+!
+  address-family ipv6
+    network fc00::1/64
+  exit-address-family
+  address-family ipv6
+    network fc00::2/128 route-map HIDE_INTERNAL
+  exit-address-family
+!
+  network 10.10.10.1/24
+  address-family ipv6
+   network fc01::1/64
+  exit-address-family
+!
+  address-family ipv4
+    redistribute connected route-map V4_CONNECTED_ROUTES
+  exit-address-family
+  address-family ipv6
+    redistribute connected route-map V6_CONNECTED_ROUTES
+  exit-address-family
+!
+  address-family ipv4
+    maximum-paths 32
+  exit-address-family
+  address-family ipv6
+    maximum-paths 32
+  exit-address-family
+!
+! end of template: bgpd/bgpd.main.conf.j2
+!
diff --git a/src/sonic-bgpcfgd/tests/data/sonic-cfggen/bgpd.main.conf.j2/lo0_ipv6_only.json b/src/sonic-bgpcfgd/tests/data/sonic-cfggen/bgpd.main.conf.j2/lo0_ipv6_only.json
@@ -0,0 +1,37 @@
+{
+    "DEVICE_METADATA": {
+        "localhost": {
+            "bgp_asn": "55555",
+            "sub_role": "FrontEnd",
+            "type": "ToRRouter"
+        }
+    },
+    "LOOPBACK_INTERFACE": {
+        "Loopback0|fc00::1/128": {},
+        "Loopback4096|55.55.55.56/32": {},
+        "Loopback4096|fc00::2/128": {}
+    },
+    "VLAN_INTERFACE": {
+        "Vlan10|10.10.10.1/24": {},
+        "Vlan10|fc01::1/64": {},
+        "Vlan20": {"vnet_name": "Vnet1"},
+        "Vlan20|20.20.20.1/24": {},
+        "Vlan20|fd01::1/64": {}
+    },
+    "constants": {
+        "bgp": {
+            "multipath_relax": {
+                "enabled": true
+            },
+            "graceful_restart": {
+                "enabled": true,
+                "restart_time": 480
+            },
+            "maximum_paths": {
+                "enabled": true,
+                "ipv4": 32,
+                "ipv6": 32
+            }
+        }
+    }
+}