[bgpcfgd] ECMP overlay VxLan with BGP support by StormLiangMS · Pull Request #10716 · sonic-net/sonic-buildimage

StormLiangMS · 2022-04-29T13:05:03Z

Why I did it

https://github.com/Azure/SONiC/blob/master/doc/vxlan/Overlay%20ECMP%20with%20BFD.md
From the design, need to advertise the route with community string, the PR is to implement this.

How I did it

To use the route-map as the profile for the community string, all advertised routes can be associated with one route-map.
Add one file, mangers_rm.py, which is to add/update/del the route-map. Modified the managers_advertise_rt.py file to associate profile with IP route.

The route-map usage is very flexible, by this PR, we only support one fixed usage to add community string for route to simplify this design.

How to verify it

Implement new unit tests for mangers_rm.py and updated unit test for managers_advertise_rt.py.
Manually verified the test case in the test plan section, will add testcase in sonic-mgmt later. sonic-net/sonic-mgmt#5581

2.8.3 BGP advertising

The below cases are executed first for IPv4 and repeat the same for IPv6.

Step	Goal	Expected results
Create a tunnel route and advertise the tunnel route to all neighbor without community id	BGP	ALL BGP neighbors can recieve the advertised BGP routes
Create a tunnel route and advertise the tunnel route to all neighbor with community id	BGP	ALL BGP neighbors can recieve the advertised BGP routes with community id
Update a tunnel route and advertise the tunnel route to all neighbor with new community id	BGP	ALL BGP neighbors can recieve the advertised BGP routes with new community id
Create a tunnel route and advertise the tunnel route to all neighbor with BGP profile, but create the profile later	BGP	ALL BGP neighbors can recieve the advertised BGP routes without community id first, after the profile table created, the community id would be added and all BGP neighbors can recieve this update and associate the community id with the route
Delete a tunnel route	BGP	ALL BGP neighbors can remove the previously advertised BGP routes
Create 4k tunnel routes and advertise all tunnel routes to all neighbor with community id	BGP scale	ALL BGP neighbors can recieve 4k advertised BGP routes with community id and record the time
Updat BGP_PROFILE_TABLE with new community id for 4k tunnel routes and advertise all tunnel routes to all neighbor with new community id	BGP scale	ALL BGP neighbors can recieve 4k advertised BGP routes with new community id and record the time

Description for the changelog

Link to config_db schema for YANG module changes

A picture of a cute animal (not mandatory but encouraged)

prsunny · 2022-05-05T15:23:00Z

src/sonic-bgpcfgd/bgpcfgd/managers_advertise_rt.py


-    OP_DELETE = 'DELETE'
-    OP_ADD = 'ADD'
+        self.directory.subscribe(


Can we retain the original code as-is if its not related to this PR. This will help in reviewing just the changes.

Sure, will keep original code as much as possible. Only change is to use " instead of ' to keep the style consistent.

prsunny · 2022-05-05T15:23:13Z

src/sonic-bgpcfgd/bgpcfgd/main.py

        StaticRouteMgr(common_objs, "CONFIG_DB", "STATIC_ROUTE"),
        # Route Advertisement Managers
        AdvertiseRouteMgr(common_objs, "STATE_DB", swsscommon.STATE_ADVERTISE_NETWORK_TABLE_NAME),
+        # TBD, Change to schema name from swsscommon (swsscommon.APP_BGP_PROFILE_TABLE_NAME) when the submodule is advanced.


Fix TBD before merge

I checked, the code is already advanced in the master branch. Will make sure which is advanced before cherry pick to 202012 branch.

prsunny · 2022-05-05T15:25:39Z

src/sonic-bgpcfgd/bgpcfgd/managers_advertise_rt.py

        vrf, ip_prefix = self.split_key(key)
        self.remove_route_advertisement(vrf, ip_prefix)

+    def _ip_addr_validate(self, key):


Is this mandatory? I mean APP_DB entries shall be already validated by the producer. So may be this is redundant.

Good one, add one comment in the code.

prsunny · 2022-05-05T15:26:39Z

src/sonic-bgpcfgd/bgpcfgd/managers_advertise_rt.py

+    def _set_handler_validate(self, key, data):
+        if data:
+            if ("profile" in data and data["profile"] in ROUTE_MAPS) or data == {"":""}:
+                return self._ip_addr_validate(key)


I think, this could be just returning 'true' here. IP prefix should already be validated, and we may just be adding extra delay here.

prsunny · 2022-05-05T15:29:59Z

src/sonic-bgpcfgd/bgpcfgd/managers_advertise_rt.py

+        return False

-    def add_route_advertisement(self, vrf, ip_prefix):
+    def _del_handler_validate(self, key):


This can be removed as well

prsunny · 2022-05-05T15:41:17Z

src/sonic-bgpcfgd/bgpcfgd/managers_advertise_rt.py

+        if data and "profile" in data:
+            cmd_list.append("  network %s route-map %s" % (ip_prefix, "%s_RM" % data["profile"]))
+            log_info(
+                "BGPAdvertiseRouteMgr:: Update bgp %s network %s with route-map %s"


Based on scale, there could be significant number of route updates. So please reduce the log-level and ensure it won't show up in regular flow unless explicitly enabled

Good one, change to debug.

prsunny · 2022-05-05T15:45:46Z

src/sonic-bgpcfgd/bgpcfgd/managers_rm.py

+        self.cfg_mgr.push_list(cmds)
+        log_info("BGPRouteMapMgr::Done")
+
+    def _set_handler_validate(self, key, data):


Lets use consistent formatting for names. Can you check if its "__" vs "_" ?

Sure, changed all internal function to "__"

lgtm-com · 2022-05-14T04:48:29Z

This pull request introduces 1 alert when merging fb605a1 into 4a1e7d8 - view on LGTM.com

new alerts:

1 for Unused import

prsunny

lgtm, minor comments

prsunny · 2022-05-16T19:18:03Z

src/sonic-bgpcfgd/bgpcfgd/managers_advertise_rt.py

-
-    def add_route_advertisement(self, vrf, ip_prefix):
+    def __set_handler_validate(self, key, data):
+        if data:


If data is not present, we need to advertise without a community string (for backward compatibility). Can you please confirm.?

@prsunny confirmed, the check after the 'or' is for the case which doesn't have the community string.
if ("profile" in data and data["profile"] in ROUTE_MAPS) or data == {"":""}:

prsunny · 2022-05-16T19:19:20Z

src/sonic-bgpcfgd/tests/test_advertise_rt.py

    set_del_test(
        mgr,
        "SET",
-        ("fc00:10::/64", {}),


Can we retain this case to cover empty data?

@prsunny I think the old unit test is inaccurate, from existing code of VNetRouteOrch, it send out {key:{"":""}} to the bgpcfgd for empty case as below. And also by manually testing, can't insert a key with a "empty" data to the redis.
void VNetRouteOrch::addRouteAdvertisement(IpPrefix& ipPrefix)
{
const string key = ipPrefix.to_string();
vector fvs;
fvs.push_back(FieldValueTuple("", ""));
state_vnet_rt_adv_table_->set(key, fvs);
}

Why I did it https://github.com/Azure/SONiC/blob/master/doc/vxlan/Overlay%20ECMP%20with%20BFD.md From the design, need to advertise the route with community string, the PR is to implement this. How I did it To use the route-map as the profile for the community string, all advertised routes can be associated with one route-map. Add one file, mangers_rm.py, which is to add/update/del the route-map. Modified the managers_advertise_rt.py file to associate profile with IP route. The route-map usage is very flexible, by this PR, we only support one fixed usage to add community string for route to simplify this design. How to verify it Implement new unit tests for mangers_rm.py and updated unit test for managers_advertise_rt.py. Manually verified the test case in the test plan section, will add testcase in sonic-mgmt later. sonic-net/sonic-mgmt#5581

This reverts commit 35c9bec.

…11079) Why I did it This is a cherry-pick PR from master to 202012 branch below is the original PR which merged to master. #10716 How I did it How to verify it

…anch Related work items: #52, #71, #73, #75, #77, sonic-net#1306, sonic-net#1588, sonic-net#1991, sonic-net#2031, sonic-net#2040, sonic-net#2053, sonic-net#2066, sonic-net#2069, sonic-net#2087, sonic-net#2107, sonic-net#2110, sonic-net#2112, sonic-net#2113, sonic-net#2117, sonic-net#2124, sonic-net#2125, sonic-net#2126, sonic-net#2128, sonic-net#2130, sonic-net#2131, sonic-net#2132, sonic-net#2133, sonic-net#2134, sonic-net#2135, sonic-net#2136, sonic-net#2137, sonic-net#2138, sonic-net#2139, sonic-net#2140, sonic-net#2143, sonic-net#2158, sonic-net#2161, sonic-net#2233, sonic-net#2243, sonic-net#2250, sonic-net#2254, sonic-net#2260, sonic-net#2261, sonic-net#2267, sonic-net#2278, sonic-net#2282, sonic-net#2285, sonic-net#2288, sonic-net#2289, sonic-net#2292, sonic-net#2294, sonic-net#8887, sonic-net#9279, sonic-net#9390, sonic-net#9511, sonic-net#9700, sonic-net#10025, sonic-net#10322, sonic-net#10479, sonic-net#10484, sonic-net#10493, sonic-net#10500, sonic-net#10580, sonic-net#10595, sonic-net#10628, sonic-net#10634, sonic-net#10635, sonic-net#10644, sonic-net#10670, sonic-net#10691, sonic-net#10716, sonic-net#10731, sonic-net#10750, sonic-net#10751, sonic-net#10752, sonic-net#10761, sonic-net#10769, sonic-net#10775, sonic-net#10776, sonic-net#10779, sonic-net#10786, sonic-net#10792, sonic-net#10793, sonic-net#10800, sonic-net#10806, sonic-net#10826, sonic-net#10839, sonic-net#10840, sonic-net#10842, sonic-net#10844, sonic-net#10847, sonic-net#10849, sonic-net#10852, sonic-net#10865, sonic-net#10872, sonic-net#10877, sonic-net#10886, sonic-net#10889, sonic-net#10903, sonic-net#10904, sonic-net#10905, sonic-net#10913, sonic-net#10914, sonic-net#10916, sonic-net#10919, sonic-net#10925, sonic-net#10926, sonic-net#10929, sonic-net#10933, sonic-net#10934, sonic-net#10937, sonic-net#10941, sonic-net#10947, sonic-net#10952, sonic-net#10953, sonic-net#10957, sonic-net#10959, sonic-net#10971, sonic-net#10972, sonic-net#10980

StormLiangMS added 12 commits April 5, 2022 16:15

support router advertise with community id

543dbf2

work at 7th Apr

ea3cc7a

work on rm

3e19a2c

fix ut issues

70e6902

address comments

504d564

refine comments

2bd2611

fix issues

6956eb7

to take empty data as valid input

361053c

refine code and format

ec8f3f3

refine code

bb2911e

fix ut bug

ec15a26

fix bug

f7ffa6c

StormLiangMS requested a review from lguohan as a code owner April 29, 2022 13:05

StormLiangMS requested a review from prsunny April 29, 2022 13:06

StormLiangMS added the Request for 202012 Branch label Apr 29, 2022

StormLiangMS changed the title ~~[bgpcfgd] VxLan ECMP overlay BGP support~~ [bgpcfgd] ECMP overlay VxLan with BGP support Apr 29, 2022

prsunny reviewed May 5, 2022

View reviewed changes

address comments

fb605a1

prsunny reviewed May 16, 2022

View reviewed changes

prsunny approved these changes May 18, 2022

View reviewed changes

StormLiangMS merged commit 0cc9fdc into sonic-net:master May 19, 2022

qiluo-msft added the Included in 202012 Branch label May 24, 2022

lguohan added a commit that referenced this pull request May 26, 2022

Revert "[bgpcfgd] ECMP overlay VxLan with BGP support (#10716)"

9b84294

This reverts commit 35c9bec.

StormLiangMS removed Request for 202012 Branch Included in 202012 Branch labels May 26, 2022

StormLiangMS mentioned this pull request Jun 8, 2022

cherry-pick [bgpcfgd] ECMP overlay VxLan with BGP support to 202012 #11079

Merged

6 tasks

Conversation

StormLiangMS commented Apr 29, 2022

Why I did it

How I did it

How to verify it

2.8.3 BGP advertising

Description for the changelog

Link to config_db schema for YANG module changes

A picture of a cute animal (not mandatory but encouraged)

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lgtm-com bot commented May 14, 2022

Uh oh!

prsunny left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

StormLiangMS May 18, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

StormLiangMS May 18, 2022 •

edited

Loading