[YANG MODEL] SONiC Yang support for VXLAN #7294

srj102 · 2021-04-12T11:45:19Z

Why I did it

SONiC Yang support for VXLAN

How I did it

Added a new sonic-vxlan.yang file.
Please refer to EVPN VXLAN HLD for DB details
https://github.com/Azure/SONiC/tree/master/doc/vxlan/EVPN

How to verify it

Added tests for sonic vxlan yang.

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

201811
201911
202006
202012

Description for the changelog

Added yang file for VXLAN
Added tests for sonic-vxlan.yang

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

Added tests for sonic-vxlan.yang

srj102 · 2021-04-12T12:51:55Z

Dependent on #6861 for build to go through

zhangyanzhao · 2021-11-18T18:28:26Z

@srj102 please help to address the conflict and build failure

zhangyanzhao · 2021-12-02T07:07:13Z

What is the specific table name for this YANG model? vxlan?

srj102 · 2021-12-02T09:15:30Z

config db - VXLAN_TUNNEL, VXLAN_TUNNEL_MAP, VXLAN_EVPN_NVO
app db - VXLAN_REMOTE_VNI_TABLE, VXLAN_FDB_TABLE
state db - VXLAN_TUNNEL_TABLE

zhangyanzhao · 2021-12-09T18:13:24Z

enhancement for previous vxlan YANG tables
config db - VXLAN_TUNNEL, VXLAN_TUNNEL_MAP, VXLAN_EVPN_NVO
app db - VXLAN_REMOTE_VNI_TABLE, VXLAN_FDB_TABLE
state db - VXLAN_TUNNEL_TABLE

qiluo-msft · 2021-12-09T23:33:38Z

src/sonic-yang-models/yang-models/sonic-vxlan.yang

+                        error-app-tag invalid-vtep-name;
+                    }
+                    type string {
+                        length 1..10;


1..10

Where is the limitation from? #Closed

for every vlan vni map a vni netdevice of form - is created.
The kernel devices can have a max length of 15 characters.
Keeping aside 5 characters for the "-" we are left with 10.

Thanks for the detailed explanation! Could you also add it as code comment? the 10 is magic number here.

Using "-" is a must or the user can choose any letter after "vtep" prefix? if any character, please put max 15 chars.

The vni device format is -
Max vid is 4 characters and 1 for hyphen leaving us
with 10 characters for tunnelname.

Added a comment in the yang file for the same.

ganglyu · 2021-12-10T02:31:10Z

src/sonic-yang-models/yang-models/sonic-vxlan.yang

+                }
+            }
+        }
+        container VXLAN_FDB_TABLE{


I can't find UT for this table

Do we have any infra support for this ? I see a sample_config_db.json but not a sample_app_db or sample_state_db..

No support yet. Could you add this support?

I have removed the APP and STATE DB table changes and kept only the CONFIG DB changes. Will add the remaining once the support for these tables comes in in the framework.

ganglyu · 2021-12-10T02:31:58Z

src/sonic-yang-models/yang-models/sonic-vxlan.yang

+                }
+
+                leaf type {
+                    type string;


Does this type has any pattern?

ganglyu · 2021-12-10T02:37:00Z

src/sonic-yang-models/yang-models/sonic-vxlan.yang

+
+                }
+
+                leaf vni {


should we add a common type?

Added a common type

ganglyu · 2021-12-10T02:37:42Z

src/sonic-yang-models/yang-models/sonic-vxlan.yang

+                }
+            }
+        }
+        container VXLAN_TUNNEL_TABLE { 


Can't find UT for this

Removed APP and STATE DB related containers and will support later.

src/sonic-yang-models/yang-models/sonic-vxlan.yang

ganglyu · 2021-12-10T02:40:10Z

src/sonic-yang-models/yang-models/sonic-vxlan.yang

+                }
+            }
+        }
+        container VXLAN_REMOTE_VNI_TABLE {


Can't find UT?

Removed APP and STATE DB related containers and will support later.

ganglyu · 2021-12-10T02:41:43Z

src/sonic-yang-models/yang-models/sonic-vxlan.yang

+                }
+
+                leaf vni {
+                    type string;


VXLAN_TUNNEL_MAP defines vni before, same pattern?

Removed APP and STATE DB related containers and will support later.

srj102 · 2021-12-14T04:57:18Z

/azpw run

mssonicbld · 2021-12-14T04:57:20Z

/AzurePipelines run

azure-pipelines · 2021-12-14T04:57:25Z

You have several pipelines (over 10) configured to build pull requests in this repository. Specify which pipelines you would like to run by using /azp run [pipelines] command. You can specify multiple pipelines using a comma separated list.

dgsudharsan · 2022-01-08T04:42:23Z

src/sonic-yang-models/yang-models/sonic-vxlan.yang

+    import sonic-vlan {
+        prefix svlan;
+    }
+	import sonic-types {


Please correct alignment #Closed

The reason is mixing tab and spaces. So it seems aligned in some editor.

Removed a few tabs which were present.

dgsudharsan · 2022-01-08T04:45:25Z

src/sonic-yang-models/yang-models/sonic-vxlan.yang

+                max-elements 1;
+
+                leaf name {
+                    must "(starts-with(../name, 'vtep'))"


I don't think this restriction exists today. Please remove this. Might break backward compatibility

Sure. Have removed the same.

dgsudharsan · 2022-01-08T04:48:32Z

src/sonic-yang-models/yang-models/sonic-vxlan.yang

+                leaf src_ip {
+                    type inet:ipv4-address;
+                }
+            }


I believe we also have "dst_ip" in vxlan tunnel. Please update
VXLAN_TUNNEL|{{tunnel_name}}
"src_ip": {{ip_address}}
"dst_ip": {{ip_address}} (OPTIONAL)

I dont think, we support static vxlan tunnel yet, so dst_ip is not required.

The dst_ip is not handled here.
Even for non BGP P2P tunnel support the configuration will continue to have only the src_ip.

dgsudharsan · 2022-01-08T04:56:14Z

src/sonic-yang-models/yang-models/sonic-vxlan.yang

+            }
+        }
+        container VXLAN_REMOTE_VNI_TABLE {
+            sonic-ext:db-name "APPL_DB";


If i am not wrong currently we define yang models only for config_db and no other DBs. @praveen-li have we decided to use yang in other DBs?

Removed APP and STATE DB related containers and will support later.

venkatmahalingam · 2022-01-13T07:19:19Z

src/sonic-yang-models/yang-models/sonic-vxlan.yang

+                max-elements 1;
+
+                leaf name {
+                    must "(starts-with(../name, 'vtep'))"


Please use the string pattern to enforce this.

Why do we need a list if the number of entries itself is one?

Removed this restriction of having to start with vtep.

zhangyanzhao · 2022-05-19T15:48:54Z

@qiluo-msft would you please help to merge this PR? Thanks.

srj102 · 2022-06-09T06:21:42Z

/azpw run Azure.sonic-buildimage

mssonicbld · 2022-06-09T06:21:43Z

/AzurePipelines run Azure.sonic-buildimage

azure-pipelines · 2022-06-09T06:21:56Z

Azure Pipelines successfully started running 1 pipeline(s).

ghooo · 2022-06-09T22:19:44Z

src/sonic-yang-models/yang-models/sonic-vxlan.yang

+    import sonic-extension {
+        prefix sonic-ext;
+    }
+    import sonic-vlan {


The tests are failing in Sonic-utils specifically GCU because of yang known issue: #9312

Please comment out sonic-vlan import and add a note

// Comment sonic-vlan import here until libyang back-links issue is resolved for VLAN leaf reference. //import sonic-vlan { // prefix vlan; //}

@qiluo-msft for viz

Remove vlan leafref test

qiluo-msft · 2022-06-24T17:58:39Z

@dgsudharsan Please review again.

qiluo-msft · 2022-06-24T18:00:27Z

@srj102 @venkatmahalingam would you like to review again? any more comments?

dgsudharsan

Can you please update the schema in configuration doc?
https://github.com/Azure/sonic-buildimage/blob/master/src/sonic-yang-models/doc/Configuration.md

src/sonic-yang-models/tests/yang_model_tests/tests_config/vxlan.json

dgsudharsan · 2022-06-26T04:52:16Z

src/sonic-yang-models/tests/yang_model_tests/tests_config/vxlan.json

+             }
+         }
+    },
+    "VXLAN_MAP_WITHOUT_VLAN": {


I don't see corresponding key in tests/vxlan.json. Can you please check and update?

This was removed in the last commit as the reference to vlan (import vlan) was failing the builds.
The intent is that this be re-added later once the import vlan is fixed. Hence it is being removed only in the
tests and not the tests_config.

srj102 · 2022-06-27T11:58:06Z

Can you please update the schema in configuration doc? https://github.com/Azure/sonic-buildimage/blob/master/src/sonic-yang-models/doc/Configuration.md

done.

src/sonic-yang-models/doc/Configuration.md

mssonicbld · 2023-07-06T19:05:06Z

@srj102 PR conflicts with 202205 branch

yxieca · 2023-07-06T19:05:36Z

@srj102 there is cherry-picking conflict, can you help manually cherry-pick this one?

qiluo-msft · 2024-01-25T18:29:19Z

@adyeung Could you help ping @srj102 to backport this PR to 202205?

srj102 · 2024-02-13T09:16:29Z

Will backport by Feb 23.

Added yang file for VXLAN

7370fa8

Added tests for sonic-vxlan.yang

srj102 requested a review from lguohan as a code owner April 12, 2021 11:45

srj102 added 2 commits April 12, 2021 05:02

Fix delimiter issue in json file

87ce7d0

Fix delimiter

ac2c5ac

lguohan added the YANG YANG model related changes label Apr 15, 2021

lguohan requested a review from prsunny April 15, 2021 01:26

Merge remote-tracking branch 'upstream/master'

17dad3c

srj102 requested a review from qiluo-msft as a code owner December 2, 2021 09:04

zhangyanzhao requested a review from dgsudharsan December 9, 2021 18:14

qiluo-msft requested a review from ganglyu December 9, 2021 23:31

qiluo-msft reviewed Dec 9, 2021

View reviewed changes

ganglyu reviewed Dec 10, 2021

View reviewed changes

srj102 requested a review from xumia as a code owner December 13, 2021 10:57

srj102 force-pushed the master branch from 9ab7f7f to 17dad3c Compare December 13, 2021 14:39

srj102 added 2 commits December 13, 2021 07:47

incorporated comments

7680ff8

Post sucessful test run for sonic-vxlan yang

9f88f96

dgsudharsan suggested changes Jan 8, 2022

View reviewed changes

venkatmahalingam reviewed Jan 13, 2022

View reviewed changes

qiluo-msft approved these changes May 19, 2022

View reviewed changes

Merge branch 'Azure:master' into master

3bedcb4

ghooo reviewed Jun 9, 2022

View reviewed changes

srj102 and others added 2 commits June 23, 2022 21:10

Remove references to sonic-vlan

68d3c4b

Update vxlan.json

461b045

Remove vlan leafref test

qiluo-msft approved these changes Jun 24, 2022

View reviewed changes

dgsudharsan suggested changes Jun 26, 2022

View reviewed changes

Incorporate comments

ca9b3bf

dgsudharsan suggested changes Jun 27, 2022

View reviewed changes

src/sonic-yang-models/doc/Configuration.md Show resolved Hide resolved

Update Configuration.md

5a1a626

dgsudharsan approved these changes Jun 28, 2022

View reviewed changes

ganglyu merged commit 3ba5cdc into sonic-net:master Jul 8, 2022

robertvolkmann mentioned this pull request Jul 14, 2022

SONiC Support metal-stack/releases#76

Closed

5 tasks

siqbal1986 added the Request for 202205 Branch label Jul 3, 2023

yxieca added the Approved for 202205 Branch label Jul 6, 2023

mssonicbld added the Cherry Pick Conflict_202205 label Jul 6, 2023

[YANG MODEL] SONiC Yang support for VXLAN #7294

[YANG MODEL] SONiC Yang support for VXLAN #7294

Conversation

srj102 commented Apr 12, 2021

Why I did it

How I did it

How to verify it

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

Description for the changelog

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

srj102 commented Apr 12, 2021

zhangyanzhao commented Nov 18, 2021

zhangyanzhao commented Dec 2, 2021

srj102 commented Dec 2, 2021

zhangyanzhao commented Dec 9, 2021

qiluo-msft Dec 9, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

venkatmahalingam Jan 13, 2022 • edited Loading

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

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

srj102 commented Dec 14, 2021

mssonicbld commented Dec 14, 2021

azure-pipelines bot commented Dec 14, 2021

dgsudharsan Jan 8, 2022 • edited by qiluo-msft Loading

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zhangyanzhao commented May 19, 2022

srj102 commented Jun 9, 2022

mssonicbld commented Jun 9, 2022

azure-pipelines bot commented Jun 9, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

qiluo-msft commented Jun 24, 2022

qiluo-msft commented Jun 24, 2022

dgsudharsan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

srj102 commented Jun 27, 2022

mssonicbld commented Jul 6, 2023

yxieca commented Jul 6, 2023

qiluo-msft commented Jan 25, 2024

srj102 commented Feb 13, 2024

qiluo-msft Dec 9, 2021 •

edited

Loading

venkatmahalingam Jan 13, 2022 •

edited

Loading

dgsudharsan Jan 8, 2022 •

edited by qiluo-msft

Loading