[Yang] Add Yang Model and tests for VNET_ROUTE_TUNNEL table - v2 by miatttao · Pull Request #21939 · sonic-net/sonic-buildimage

miatttao · 2025-03-05T18:22:37Z

Why I did it

Added YANG model and tests for VNET_ROUTE_TUNNEL table to provide schema validation and testing capabilities for VNET route tunnel configurations.

Work item tracking

Microsoft ADO (number only): [yang] Need Yang for VNET table #14534

How I did it

Edit the existing sonic-vnet.yang model to define the VNET_ROUTE_TUNNEL table schema
Added comprehensive test cases covering both valid and invalid configurations
Implemented validation for:
- Mandatory endpoint field
- MAC address format
- VXLAN ID range
- Name format (vnet_name:prefix)

How to verify it

Review the YANG model against the config_db schema
cd src/sonic-yang-models && python3 setup.py test

Test Cases Validated

Yang Model Validated (assertionError can be ignored)

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

Tested branch (Please provide the tested image version)

master of 202411

Description for the changelog

Link to config_db schema for YANG module changes

https://github.com/Azure/sonic-buildimage/blob/master/src/sonic-yang-models/doc/Configuration.md/VNET_ROUTE_TUNNEL

Note Anish's note

Today, we do not use ipv6 prefixes so ipv4 only is fine, in the future if we need to support ipv6 prefix we will need to look into including ipv6 prefix stype here. Same comment on supporting ipv6 endpoints.

…st cases (2) Fix sample data name constraints

linux-foundation-easycla · 2025-03-05T18:22:42Z

The committers listed above are authorized under a signed CLA.

✅ login: miatttao (5e394d9, 06b9d19, 8367814, 163f363, 065726e, 9edb03d, c9f8488, bc04f3f, cebfe3c, 6db2d16, a650a9b, 0ea4746, ba92d31, f7e11e2, a68a9ab, 1c517ba, c1535ee, 048cc46, 09c7835, fec860e, 5de0aaa, a0be257, 0e0f21f, 770841c)

mssonicbld · 2025-03-05T18:30:22Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-03-05T18:30:35Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2025-03-05T18:57:34Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-03-05T18:57:45Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2025-03-05T22:07:10Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-03-05T22:07:21Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2025-03-06T06:02:21Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-03-06T06:02:32Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2025-03-06T20:20:39Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-03-06T20:20:50Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2025-03-06T21:00:11Z

/azp run Azure.sonic-buildimage

mssonicbld · 2025-03-07T22:10:02Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-03-07T22:10:13Z

Azure Pipelines successfully started running 1 pipeline(s).

miatttao · 2025-03-07T22:12:20Z

03/07 a0be257 passed all pipeline checks.
Changed ip_address type

anish-n · 2025-03-07T23:22:27Z

src/sonic-yang-models/yang-models/sonic-vnet.yang

+                    type yang:mac-address;
+                }
+
+                leaf vxlanid {


could you change this to vni. Upon checking sonic-swss I see that this should be called vni:
https://github.com/sonic-net/sonic-swss/blob/master/orchagent/vnetorch.cpp#L2733

@prsunny should we update the HLD https://github.com/sonic-net/SONiC/blob/gh-pages/doc/vxlan/Vxlan_hld.md to say that the tunnel route field is vni vs vxlandid?

Hi Anish, for a specific vnet_route_tunnel, can the vni in VNET_ROUTE_TABLE overwrite the base vni in VNET_TABLE? Or do they have to be the same? See below for reference. Thanks!

The vni in VNET_ROUTE_TUNNEL_TABLE overrides the base vni in VNET_TABLE for any traffic destined to the IP of prefix in VNET_ROUTE_TUNNEL_TABLE. It is also an optional field, so if none is provided the default VNET_TABLE vni is used for the traffic.

agree Anish. good to update HLD

Sounds good, will raise a PR!

…buildimage into mia-add-yang-new

mssonicbld · 2025-03-10T15:08:47Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-03-10T15:09:00Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2025-03-10T18:54:53Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-03-10T18:55:07Z

Azure Pipelines successfully started running 1 pipeline(s).

prsunny

lgtm

anish-n · 2025-03-10T21:57:10Z

src/sonic-yang-models/yang-models/sonic-vnet.yang

+
+                leaf prefix {
+                    description "IPv4 prefix in CIDR format";
+                    type stypes:sonic-ip4-prefix;


Today, we do not use ipv6 prefixes so ipv4 only is fine, in the future if we need to support ipv6 prefix we will need to look into including ipv6 prefix stype here. Same comment on supporting ipv6 endpoints.

Thank you Anish! I will make a note of this.

miatttao · 2025-03-11T01:39:19Z

Checked the testbed failures due to infra issue, not related to code.

mssonicbld · 2025-03-11T01:42:05Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-03-11T01:42:16Z

Azure Pipelines successfully started running 1 pipeline(s).

Follow manager's suggestion mentioned during the VNET_ROUTE_TUNNEL PR review. See: sonic-net/sonic-buildimage#21939 (comment)

liuh-80 · 2025-04-09T08:19:45Z

@miatttao , https://github.com/sonic-net/sonic-gnmi repo PR validation break after March 14, seems related with change in this PR, can you check?

HEAD is now at 4607fd1 Merge pull request #54 from openconfig/fix-lists-no-sibling-check
touch ../../build/oc-community-linter/.done
Writing sonic-acl.yang
Writing sonic-show-techsupport.yang

Copy sonic yangs specified in SONICYANG_IMPORTS, from SONICYANG_IMPORT_DIR

../../tools/pyang/import_yang.py
--from=/usr/local/cvlyang-models --from common
--to=../../build/yang/sonic

sonic-interface.yang sonic-port.yang sonic-portchannel.yang sonic-sflow.yang
error: sonic-interface:29: module "sonic-vnet" not found in search path
make[2]: *** [Makefile:187: ../../build/yang/.sync_sonic_yangs] Error 1
make[2]: Leaving directory '/__w/1/s/sonic-mgmt-common/models/yang'
make[1]: *** [Makefile:70: models] Error 2

miatttao · 2025-04-09T22:34:17Z

@miatttao , https://github.com/sonic-net/sonic-gnmi repo PR validation break after March 14, seems related with change in this PR, can you check?

HEAD is now at 4607fd1 Merge pull request #54 from openconfig/fix-lists-no-sibling-check touch ../../build/oc-community-linter/.done Writing sonic-acl.yang Writing sonic-show-techsupport.yang

Copy sonic yangs specified in SONICYANG_IMPORTS, from SONICYANG_IMPORT_DIR

../../tools/pyang/import_yang.py --from=/usr/local/cvlyang-models --from common --to=../../build/yang/sonic sonic-interface.yang sonic-port.yang sonic-portchannel.yang sonic-sflow.yang error: sonic-interface:29: module "sonic-vnet" not found in search path make[2]: *** [Makefile:187: ../../build/yang/.sync_sonic_yangs] Error 1 make[2]: Leaving directory '/__w/1/s/sonic-mgmt-common/models/yang' make[1]: *** [Makefile:70: models] Error 2

Hi @liuh-80,

Thanks for pointing this out!

Could you please clarify the exact commands used for your build? Are they run within the sonic-gnmi repo or the sonic-buildimage repo?

Also, if possible, could you share a link to the relevant pipeline or job?
I’m asking because my changes passed all validations in the sonic-buildimage repo, so I’d like to better understand the environment where it’s failing.

miatttao · 2025-04-10T04:26:33Z

@miatttao , https://github.com/sonic-net/sonic-gnmi repo PR validation break after March 14, seems related with change in this PR, can you check?
HEAD is now at 4607fd1 Merge pull request #54 from openconfig/fix-lists-no-sibling-check touch ../../build/oc-community-linter/.done Writing sonic-acl.yang Writing sonic-show-techsupport.yang

Copy sonic yangs specified in SONICYANG_IMPORTS, from SONICYANG_IMPORT_DIR

../../tools/pyang/import_yang.py --from=/usr/local/cvlyang-models --from common --to=../../build/yang/sonic sonic-interface.yang sonic-port.yang sonic-portchannel.yang sonic-sflow.yang error: sonic-interface:29: module "sonic-vnet" not found in search path make[2]: *** [Makefile:187: ../../build/yang/.sync_sonic_yangs] Error 1 make[2]: Leaving directory '/__w/1/s/sonic-mgmt-common/models/yang' make[1]: *** [Makefile:70: models] Error 2

Hi @liuh-80,

Thanks for pointing this out!

Could you please clarify the exact commands used for your build? Are they run within the sonic-gnmi repo or the sonic-buildimage repo?

Also, if possible, could you share a link to the relevant pipeline or job? I’m asking because my changes passed all validations in the sonic-buildimage repo, so I’d like to better understand the environment where it’s failing.

I have some clues now.

I found a file here: https://github.com/sonic-net/sonic-mgmt-common/blob/master/cvl/testdata/schema/sonic-interface.yang. May I kindly ask whether I need to update the sonic-interface.yang file here based on this PR's changes? Do the new changes for YANG model in sonic-buildimage always have to be synchronous with the yang models in sonic-mgmt-common/cvl/testdata/schema/?
The missing import of sonic-vnet in sonic-mgmt-common/models/yang/sonic/import.mk might be the root cause.

wen587 · 2025-09-26T07:47:01Z

Hi @miatttao , seems VNET_ROUTE table is also missing YANG could you help?
#24136

miatttao added 12 commits February 20, 2025 13:38

[Yang Models] Add Young Model and tests for VNET_ROUTE_TUNNEL table

a68a9ab

Fix error messages

5e394d9

Fix eStr

8367814

Enforce uniqueness on vxlanid

a650a9b

Fix name format

163f363

Add unique for vxlanid

9edb03d

Fix error messages match issue

bc04f3f

Fix error messages match issue after experiment

6db2d16

Fix error messages match issue after experiment

06b9d19

Fix

065726e

Fix sample data

ba92d31

(1) Insert VNET_ROUTE_TUNNEL table in sonic-vnet.yang file and fix te…

fec860e

…st cases (2) Fix sample data name constraints

miatttao requested a review from qiluo-msft as a code owner March 5, 2025 18:22

Fix for sample data

f7e11e2

miatttao force-pushed the mia-add-yang-new branch from d85d0a9 to f7e11e2 Compare March 5, 2025 18:45

Fix merge issue

770841c

fix for test in sample.config

cebfe3c

Fix

c9f8488

miatttao requested a review from anish-n March 7, 2025 22:10

anish-n reviewed Mar 7, 2025

View reviewed changes

miatttao added 3 commits March 7, 2025 17:15

Merge branch 'sonic-net:master' into mia-add-yang-new

1c517ba

Change vxlanid to vni based on sonic-swss vnetorch.cpp

048cc46

Merge branch 'mia-add-yang-new' of https://github.com/miatttao/sonic-…

0e0f21f

…buildimage into mia-add-yang-new

miatttao requested a review from anish-n March 10, 2025 15:11

Merge branch 'sonic-net:master' into mia-add-yang-new

09c7835

prsunny approved these changes Mar 10, 2025

View reviewed changes

anish-n reviewed Mar 10, 2025

View reviewed changes

anish-n approved these changes Mar 10, 2025

View reviewed changes

qiluo-msft approved these changes Mar 10, 2025

View reviewed changes

Merge branch 'sonic-net:master' into mia-add-yang-new

5de0aaa

qiluo-msft merged commit c0c89c4 into sonic-net:master Mar 11, 2025
21 checks passed

miatttao added a commit to miatttao/SONiC that referenced this pull request Mar 18, 2025

Update Vxlanid to Vni

8865dc8

Follow manager's suggestion mentioned during the VNET_ROUTE_TUNNEL PR review. See: sonic-net/sonic-buildimage#21939 (comment)

miatttao mentioned this pull request Mar 18, 2025

Update Vxlanid to Vni in VNET_ROUTE_TUNNEL Table sonic-net/SONiC#1947

Merged

Conversation

miatttao commented Mar 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Why I did it

Work item tracking

How I did it

How to verify it

Test Cases Validated

Yang Model Validated (assertionError can be ignored)

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

Tested branch (Please provide the tested image version)

Description for the changelog

Link to config_db schema for YANG module changes

Note Anish's note

Uh oh!

linux-foundation-easycla bot commented Mar 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mssonicbld commented Mar 5, 2025

Uh oh!

azure-pipelines bot commented Mar 5, 2025

Uh oh!

mssonicbld commented Mar 5, 2025

Uh oh!

azure-pipelines bot commented Mar 5, 2025

Uh oh!

mssonicbld commented Mar 5, 2025

Uh oh!

azure-pipelines bot commented Mar 5, 2025

Uh oh!

mssonicbld commented Mar 6, 2025

Uh oh!

azure-pipelines bot commented Mar 6, 2025

Uh oh!

mssonicbld commented Mar 6, 2025

Uh oh!

azure-pipelines bot commented Mar 6, 2025

Uh oh!

mssonicbld commented Mar 6, 2025

Uh oh!

mssonicbld commented Mar 7, 2025

Uh oh!

azure-pipelines bot commented Mar 7, 2025

Uh oh!

miatttao commented Mar 7, 2025

Uh oh!

anish-n Mar 7, 2025

Choose a reason for hiding this comment

Uh oh!

miatttao Mar 7, 2025

Choose a reason for hiding this comment

Uh oh!

anish-n Mar 7, 2025

Choose a reason for hiding this comment

Uh oh!

prsunny Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

anish-n Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

mssonicbld commented Mar 10, 2025

Uh oh!

azure-pipelines bot commented Mar 10, 2025

Uh oh!

mssonicbld commented Mar 10, 2025

Uh oh!

azure-pipelines bot commented Mar 10, 2025

Uh oh!

prsunny left a comment

Choose a reason for hiding this comment

Uh oh!

anish-n Mar 10, 2025 • 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!

miatttao Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

miatttao commented Mar 11, 2025

miatttao commented Mar 5, 2025 •

edited

Loading

linux-foundation-easycla bot commented Mar 5, 2025 •

edited

Loading

anish-n Mar 10, 2025 •

edited

Loading