Add Consistent ECMP for vxlan tunnel HLD#2099

Merged

prsunny merged 9 commits into

sonic-net:masterfrom

anish-n:tunnelNhFgEcmp

May 22, 2026

Contributor

anish-n commented Nov 7, 2025 •

edited

Loading

This PR introduces the design to add support for consistent hashing for VXLAN tunnel endpoints, such that routes destined to tunnel endpoints can make use of consistent hashing to limit flow rehashing upon nexthop addition/removal. This will help significantly reduce protocol connection restarts as a result of nexthop changes, when tunnel endpoints have flow state

Repo	PR title	State
sonic-swss	Fine Grained ECMP for Vnet Tunnel Routes
sonic-buildimage	VNET_ROUTE_TUNNEL yang model support for consistent hashing
sonic-mgmt	Consistent Hashing for VXLAN tunnel routes
sonic-utilities	Enhance FGNHG CLI to filter by and show vnet + prefix

Collaborator

mssonicbld commented Nov 7, 2025

/azp run

azure-pipelines Bot commented Nov 7, 2025

No pipelines are associated with this pull request.

Collaborator

mssonicbld commented Nov 16, 2025

/azp run

azure-pipelines Bot commented Nov 16, 2025

No pipelines are associated with this pull request.

Collaborator

mssonicbld commented Nov 16, 2025

/azp run

azure-pipelines Bot commented Nov 16, 2025

No pipelines are associated with this pull request.

Collaborator

mssonicbld commented Nov 24, 2025

/azp run

azure-pipelines Bot commented Nov 24, 2025

No pipelines are associated with this pull request.

Collaborator

mssonicbld commented Nov 24, 2025

/azp run

azure-pipelines Bot commented Nov 24, 2025

No pipelines are associated with this pull request.

Collaborator

mssonicbld commented Dec 2, 2025

/azp run

azure-pipelines Bot commented Dec 2, 2025

No pipelines are associated with this pull request.

This was referenced Dec 2, 2025

[Yang] VNET_ROUTE_TUNNEL YANG model support for consistent hashing sonic-net/sonic-buildimage#24579

Closed

[yang] VNET_ROUTE_TUNNEL yang model support for consistent hashing sonic-net/sonic-buildimage#24684

Merged

ashutosh-agrawal reviewed

View reviewed changes

doc/vxlan/Consistent_ecmp_for_Vxlan_tunnel.md Outdated

ashutosh-agrawal reviewed

View reviewed changes

doc/vxlan/Consistent_ecmp_for_Vxlan_tunnel.md Outdated

ashutosh-agrawal reviewed

View reviewed changes

doc/ecmp/fine_grained_next_hop_hld.md

ashutosh-agrawal reviewed

View reviewed changes

doc/vxlan/Consistent_ecmp_for_Vxlan_tunnel.md

Collaborator

mssonicbld commented Dec 3, 2025

/azp run

azure-pipelines Bot commented Dec 3, 2025

No pipelines are associated with this pull request.

prsunny reviewed

View reviewed changes

Contributor

prsunny left a comment

@anish-n , can you add a link to this document from Vxlan hld so that it can cross reference for consistent hashing scenarios

Collaborator

mssonicbld commented Dec 4, 2025

/azp run

azure-pipelines Bot commented Dec 4, 2025

No pipelines are associated with this pull request.

Collaborator

mssonicbld commented Dec 4, 2025

/azp run

azure-pipelines Bot commented Dec 4, 2025

No pipelines are associated with this pull request.

anish-n added 5 commits

December 3, 2025 17:31


          Add Consistent ECMP for vxlan tunnel HLD

11f7842

Signed-off-by: Anish Narsian (from Dev Box) <annarsia@microsoft.com>


          Add images for programming flow

2c0021c

Signed-off-by: Anish Narsian (from Dev Box) <annarsia@microsoft.com>


          Add scale details

7cf01a1

Signed-off-by: Anish Narsian (from Dev Box) <annarsia@microsoft.com>


          Add yang model

00bb843

Added YANG model enhancements for VNET_ROUTE_TUNNEL, including modifications for endpoints, MAC addresses, VNIs, and new field consistent hashing buckets.

Signed-off-by: Anish Narsian (from Dev Box) <annarsia@microsoft.com>


          Update fine_grained_next_hop_hld

82940a2

Signed-off-by: Anish Narsian (from Dev Box) <annarsia@microsoft.com>

azure-pipelines Bot commented Dec 4, 2025

No pipelines are associated with this pull request.

Contributor Author

anish-n commented Dec 4, 2025

@anish-n , can you add a link to this document from Vxlan hld so that it can cross reference for consistent hashing scenarios

Added, thanks

qiluo-msft pushed a commit to sonic-net/sonic-buildimage that referenced this pull request


          [yang] VNET_ROUTE_TUNNEL yang model support for consistent hashing (#…

77d1fdf

…24684)

Why I did it
To support consistent ECMP for vxlan tunnels, according to specifications in sonic-net/SONiC#2099

Work item tracking
Microsoft ADO (number only):
How I did it
Added multi-value support for endpoint, mac and vni. Added consistent_hashing_buckets.

How to verify it
Run the tests added in this PR or build image with these changes and set the new attributes.

mssonicbld added a commit to mssonicbld/sonic-buildimage that referenced this pull request


          [yang] VNET_ROUTE_TUNNEL yang model support for consistent hashing

a6a3004

<!--
     Please make sure you've read and understood our contributing guidelines:
     https://github.com/Azure/SONiC/blob/gh-pages/CONTRIBUTING.md

     ** Make sure all your commits include a signature generated with `git commit -s` **

     If this is a bug fix, make sure your description includes "fixes #xxxx", or
     "closes #xxxx" or "resolves #xxxx"

     Please provide the following information:
-->

#### Why I did it
To support consistent ECMP for vxlan tunnels, according to specifications in sonic-net/SONiC#2099

##### Work item tracking
- Microsoft ADO **(number only)**:

#### How I did it
Added multi-value support for endpoint, mac and vni. Added consistent_hashing_buckets.

#### How to verify it
Run the tests added in this PR or build image with these changes and set the new attributes.

<!--
If PR needs to be backported, then the PR must be tested against the base branch and the earliest backport release branch and provide tested image version on these two branches. For example, if the PR is requested for master, 202211 and 202012, then the requester needs to provide test results on master and 202012.
-->

#### Which release branch to backport (provide reason below if selected)

<!--
- Note we only backport fixes to a release branch, *not* features!
- Please also provide a reason for the backporting below.
- e.g.
- [x] 202006
-->

- [ ] 202205
- [ ] 202211
- [ ] 202305
- [ ] 202311
- [ ] 202405
- [ ] 202411
- [ ] 202505

#### Tested branch (Please provide the tested image version)

<!--
- Please provide tested image version
- e.g.
- [x] 20201231.100
-->

- [ ] <!-- image version 1 -->master
- [ ] <!-- image version 2 -->

#### Description for the changelog
<!--
Write a short (one line) summary that describes the changes in this
pull request for inclusion in the changelog:
--> add consistent_hashing_buckets and multi-value endpoint, vni and mac for consistent hashing support.

<!--
 Ensure to add label/tag for the feature raised. example - PR#2174 under sonic-utilities repo. where, Generic Config and Update feature has been labelled as GCU.
-->

#### Link to config_db schema for YANG module changes
<!--
Provide a link to config_db schema for the table for which YANG model
is defined
Link should point to correct section on https://github.com/Azure/sonic-buildimage/blob/master/src/sonic-yang-models/doc/Configuration.md
-->
https://github.com/sonic-net/sonic-buildimage/blob/master/src/sonic-yang-models/doc/Configuration.md#vnet_route_tunnel

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

mssonicbld mentioned this pull request

[action] [PR:24684] [yang] VNET_ROUTE_TUNNEL yang model support for consistent hashing sonic-net/sonic-buildimage#24858

Merged

9 tasks

mssonicbld added a commit to sonic-net/sonic-buildimage that referenced this pull request


          [yang] VNET_ROUTE_TUNNEL yang model support for consistent hashing (#…

2a7804b

…24858)

<!--
 Please make sure you've read and understood our contributing guidelines:
 https://github.com/Azure/SONiC/blob/gh-pages/CONTRIBUTING.md

 failure_prs.log skip_prs.log Make sure all your commits include a signature generated with `git commit -s` **

 If this is a bug fix, make sure your description includes "fixes #xxxx", or
 "closes #xxxx" or "resolves #xxxx"

 Please provide the following information:
-->

#### Why I did it
To support consistent ECMP for vxlan tunnels, according to specifications in sonic-net/SONiC#2099

##### Work item tracking
- Microsoft ADO **(number only)**:

#### How I did it
Added multi-value support for endpoint, mac and vni. Added consistent_hashing_buckets.

#### How to verify it
Run the tests added in this PR or build image with these changes and set the new attributes.

<!--
If PR needs to be backported, then the PR must be tested against the base branch and the earliest backport release branch and provide tested image version on these two branches. For example, if the PR is requested for master, 202211 and 202012, then the requester needs to provide test results on master and 202012.
-->

#### Which release branch to backport (provide reason below if selected)

<!--
- Note we only backport fixes to a release branch, *not* features!
- Please also provide a reason for the backporting below.
- e.g.
- [x] 202006
-->

- [ ] 202205
- [ ] 202211
- [ ] 202305
- [ ] 202311
- [ ] 202405
- [ ] 202411
- [ ] 202505

#### Tested branch (Please provide the tested image version)

<!--
- Please provide tested image version
- e.g.
- [x] 20201231.100
-->

- [ ] <!-- image version 1 -->master
- [ ] <!-- image version 2 -->

#### Description for the changelog
<!--
Write a short (one line) summary that describes the changes in this
pull request for inclusion in the changelog:
--> add consistent_hashing_buckets and multi-value endpoint, vni and mac for consistent hashing support.

<!--
 Ensure to add label/tag for the feature raised. example - PR#2174 under sonic-utilities repo. where, Generic Config and Update feature has been labelled as GCU.
-->

#### Link to config_db schema for YANG module changes
<!--
Provide a link to config_db schema for the table for which YANG model
is defined
Link should point to correct section on https://github.com/Azure/sonic-buildimage/blob/master/src/sonic-yang-models/doc/Configuration.md
-->
https://github.com/sonic-net/sonic-buildimage/blob/master/src/sonic-yang-models/doc/Configuration.md#vnet_route_tunnel

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

NavdhaJindal added a commit to NavdhaJindal/sonic-buildimage-msft that referenced this pull request


          [yang] VNET_ROUTE_TUNNEL yang model support for consistent hashing (#…

660c5df

…24684)

Why I did it
To support consistent ECMP for vxlan tunnels, according to specifications in sonic-net/SONiC#2099

Work item tracking
Microsoft ADO (number only):
How I did it
Added multi-value support for endpoint, mac and vni. Added consistent_hashing_buckets.

How to verify it
Run the tests added in this PR or build image with these changes and set the new attributes.

NavdhaJindal mentioned this pull request

[202506] [yang] VNET_ROUTE_TUNNEL yang model support for consistent hashing (#24684) Azure/sonic-buildimage-msft#1900

Merged

10 tasks

hdwhdw pushed a commit to hdwhdw/sonic-buildimage that referenced this pull request


          [yang] VNET_ROUTE_TUNNEL yang model support for consistent hashing (s…

49b3fef

…onic-net#24684)

Why I did it
To support consistent ECMP for vxlan tunnels, according to specifications in sonic-net/SONiC#2099

Work item tracking
Microsoft ADO (number only):
How I did it
Added multi-value support for endpoint, mac and vni. Added consistent_hashing_buckets.

How to verify it
Run the tests added in this PR or build image with these changes and set the new attributes.

Signed-off-by: Dawei Huang <daweihuang@microsoft.com>

zjswhhh added a commit to Azure/sonic-buildimage-msft that referenced this pull request


          [202506] [yang] VNET_ROUTE_TUNNEL yang model support for consistent h…

97433f5

…ashing (#24684) (#1900)

Master PR: sonic-net/sonic-buildimage#24684

Why I did it
To support consistent ECMP for vxlan tunnels, according to
specifications in sonic-net/SONiC#2099

Work item tracking
Microsoft ADO (number only):
How I did it
Added multi-value support for endpoint, mac and vni. Added
consistent_hashing_buckets.

How to verify it
Run the tests added in this PR or build image with these changes and set
the new attributes.

<!--
Please make sure you've read and understood our contributing guidelines:
     https://github.com/Azure/SONiC/blob/gh-pages/CONTRIBUTING.md

** Make sure all your commits include a signature generated with `git
commit -s` **

If this is a bug fix, make sure your description includes "fixes #xxxx",
or
     "closes #xxxx" or "resolves #xxxx"

     Please provide the following information:
-->

#### Why I did it

##### Work item tracking
- Microsoft ADO **(number only)**:

#### How I did it

#### How to verify it

<!--
If PR needs to be backported, then the PR must be tested against the
base branch and the earliest backport release branch and provide tested
image version on these two branches. For example, if the PR is requested
for master, 202211 and 202012, then the requester needs to provide test
results on master and 202012.
-->

#### Which release branch to backport (provide reason below if selected)

<!--
- Note we only backport fixes to a release branch, *not* features!
- Please also provide a reason for the backporting below.
- e.g.
- [x] 202006
-->

- [ ] 201811
- [ ] 201911
- [ ] 202006
- [ ] 202012
- [ ] 202106
- [ ] 202111
- [ ] 202205
- [ ] 202211

#### Tested branch (Please provide the tested image version)

<!--
- Please provide tested image version
- e.g.
- [x] 20201231.100
-->

- [ ] <!-- image version 1 -->
- [ ] <!-- image version 2 -->

#### Description for the changelog
<!--
Write a short (one line) summary that describes the changes in this
pull request for inclusion in the changelog:
-->

<!--
Ensure to add label/tag for the feature raised. example - PR#2174 under
sonic-utilities repo. where, Generic Config and Update feature has been
labelled as GCU.
-->

#### Link to config_db schema for YANG module changes
<!--
Provide a link to config_db schema for the table for which YANG model
is defined
Link should point to correct section on
https://github.com/Azure/sonic-buildimage/blob/master/src/sonic-yang-models/doc/Configuration.md
-->

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

xwjiang-ms pushed a commit to xwjiang-ms/sonic-buildimage that referenced this pull request


          [yang] VNET_ROUTE_TUNNEL yang model support for consistent hashing (s…

223ad5f

…onic-net#24684)

Why I did it
To support consistent ECMP for vxlan tunnels, according to specifications in sonic-net/SONiC#2099

Work item tracking
Microsoft ADO (number only):
How I did it
Added multi-value support for endpoint, mac and vni. Added consistent_hashing_buckets.

How to verify it
Run the tests added in this PR or build image with these changes and set the new attributes.

Signed-off-by: xiaweijiang <xiaweijiang@microsoft.com>

prsunny approved these changes

View reviewed changes

jasonbridges pushed a commit to jasonbridges/sonic-buildimage that referenced this pull request


          [yang] VNET_ROUTE_TUNNEL yang model support for consistent hashing (s…

ec7dac1

…onic-net#24684)

Why I did it
To support consistent ECMP for vxlan tunnels, according to specifications in sonic-net/SONiC#2099

Work item tracking
Microsoft ADO (number only):
How I did it
Added multi-value support for endpoint, mac and vni. Added consistent_hashing_buckets.

How to verify it
Run the tests added in this PR or build image with these changes and set the new attributes.

NavdhaJindal mentioned this pull request

Fine Grained ECMP for Vnet Tunnel Routes sonic-net/sonic-swss#4158

Open

Contributor

prsunny commented Feb 11, 2026

@anish-n , can you update description with associated PRs following the HLD PR template?

Contributor Author

anish-n commented Feb 19, 2026

@anish-n , can you update description with associated PRs following the HLD PR template?

Updated @prsunny

Contributor

prsunny commented Feb 23, 2026

@anish-n , can you update description with associated PRs following the HLD PR template?

Updated @prsunny

thanks, please add one for sonic-mgmt as well.

zhangyanzhao added this to SONiC 202605 Release

github-project-automation Bot moved this to Todo in SONiC 202605 Release

FengPan-Frank pushed a commit to FengPan-Frank/sonic-buildimage that referenced this pull request


          [yang] VNET_ROUTE_TUNNEL yang model support for consistent hashing (s…

ba45b83

…onic-net#24684)

Why I did it
To support consistent ECMP for vxlan tunnels, according to specifications in sonic-net/SONiC#2099

Work item tracking
Microsoft ADO (number only):
How I did it
Added multi-value support for endpoint, mac and vni. Added consistent_hashing_buckets.

How to verify it
Run the tests added in this PR or build image with these changes and set the new attributes.

Signed-off-by: Feng Pan <fenpan@microsoft.com>

prsunny self-assigned this

mhchann pushed a commit to mhchann/sonic-buildimage that referenced this pull request


          [yang] VNET_ROUTE_TUNNEL yang model support for consistent hashing (s…

b6797cf

…onic-net#24684)

Why I did it
To support consistent ECMP for vxlan tunnels, according to specifications in sonic-net/SONiC#2099

Work item tracking
Microsoft ADO (number only):
How I did it
Added multi-value support for endpoint, mac and vni. Added consistent_hashing_buckets.

How to verify it
Run the tests added in this PR or build image with these changes and set the new attributes.

Signed-off-by: mhchann <mhchann082@gmail.com>

rookie-who commented May 19, 2026

Hi @anish-n — this is approved by @prsunny. Is there anything blocking the merge? 202605 branch cut is at end of May.

CC: @vaibhavhd @radha-danda (branch managers)

Contributor Author

anish-n commented May 19, 2026

This PR introduces the design to add support for

This is ready to merge, nothing blocking the merge, I do not have permission to merge it, if one of the branch maintainers would please help with merging?

prsunny merged commit c263790 into sonic-net:master

2 checks passed

github-project-automation Bot moved this from Todo to Done in SONiC 202605 Release

delnas moved this from Done to In Progress in SONiC 202605 Release

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet