Add VLAN Stacking HLD #915

pttch · 2021-12-20T04:56:48Z

SONiC: Add VLAN Stacking HLD

Adding the VLAN Stacking for the SONiC feature

Repo	PR title	State
sonic-swss-common	VLAN stacking implementation, add table name for VLAN stacking	Merged
sonic-swss	Vlan stacking implementation for sonic-swss	Open
sonic-sairedis	Add VLAN stacking on libvs	Open
sonic-utilities	Add CLI command for configure VLAN stacking and VLAN translation	Open
SAI	Add support for VLAN Stacking/Translation API	Approved

Signed-off-by: pttch@edge-core.com

ghost · 2021-12-20T04:56:59Z

All CLA requirements met.

sunesh · 2021-12-23T21:17:22Z

doc/vlan_stacking/vlan_stacking_HLD.md

+This document describes the design details of the VLAN stacking feature. VLAN stacking is a feature designed for service providers who carry traffic of multiple customers across  their networks and are required to maintain the VLAN and Layer 2 protocol configurations of each customer without impacting the traffic of other customers. VLAN stacking include QinQ feature and VLAN Translation feature.
+
+IEEE 802.1Q tunneling (QinQ tunneling) uses a single Service Provider VLAN (SPVLAN) for customers who have multiple VLANs. Customer VLAN IDs are preserved and traffic from different customers is segregated within the service provider’s network even when they use the same customer-specific VLAN IDs. QinQ tunneling expands VLAN space by using a VLAN-in-VLAN hierarchy, preserving the customer’s original tagged packets, and adding SPVLAN tags to each frame (also called double tagging).
+


Is MAC-learning targeted in this feature ? If yes, are MACs learned in context of C-VLAN or S-VLAN. If we are learning in S-VLAN context then MACs have to unique across C-VLANs.

Yes, MAC-learning works in this feature, when the feature is configured, the MAC will learn in S-VLAN. Will write new comments on this HLD.

@sunesh Is there any other comment there, ifnot, please help to approve to resolve this.

@pttch may be later in the doc u can clarify n:1 map for C-VLAN to S-VLAN requires macs to be unique across all C-VLANs since learning is happening only on S-VLAN.

sunesh · 2021-12-23T21:21:56Z

doc/vlan_stacking/vlan_stacking_HLD.md

+  * Direction - Traffic direction.
+  * Action - The rewrite action for the frames, support the following actions:
+    * push
+      * Apply for all tagged frames, single or double tagged frames, at ingress direction.


Is Native VLAN supported on ingress port. We should explicitly mention behavior for native VLAN case.

VLAN stacking will only effect the tagged packet, so un-tagged packet will be transmitted by native VLAN. Will write new comments on this HLD.

sunesh · 2021-12-23T21:22:25Z

doc/vlan_stacking/vlan_stacking_HLD.md

+  * Action - The rewrite action for the frames, support the following actions:
+    * push
+      * Apply for all tagged frames, single or double tagged frames, at ingress direction.
+      * Add an outer VLAN with TPID=8100, COS=0, VLAN=<specified-S-VLAN> (range 1 ~ 4094).


Any reason TPID=8100 was picked in place of IEEE defined 88a8. We should add details about CoS behavior. Is this always a fixed value or plan to support copy from inner etc..

Currently we use the TPID=8100 as many other product do. This value can changed by predefine value.

Will write the cos behavior in this HLD.

I assume we'll have an option to configure TPID value as 0x8100 (802.1Q) or 0x88a8 (802.1ad) or any non-standard value.

Currently, it do not have option for this, it's also can add this to the HLD.

The cos behavior
The TPID and COS behavior is already mentioned in "Requirements" section (TPID and COS are fixed to 0x8100 and 0, and they are not configurable by now). These parameters are possible be configured but not plan to support for now. Shall we place this function requirement into the future work section?

Add it will to the future work, below will add to the commit.

Future Work
The values of TPID and COS in the adding outer VLAN are configurable. For example, TPID may be configured as 0x88a8 which is defined in IEEE or other values. For the COS value, it may be able to configure to extract from the COS value of the original VLAN.

Ok, thanks!

doc/vlan_stacking/vlan_stacking_HLD.md

venkatmahalingam · 2022-01-05T02:59:50Z

doc/vlan_stacking/vlan_stacking_HLD.md

+                }
+
+                leaf action {
+                    type string {


Is this an optional field? if yes, what's default action?

No, the action is mandatory. Will to add mandatory attribute in here

venkatmahalingam · 2022-01-05T03:00:39Z

doc/vlan_stacking/vlan_stacking_HLD.md

+
+                leaf s_vlanid {
+                    type leafref {
+                        path /vlan:sonic-vlan/vlan:VLAN/vlan:VLAN_LIST/vlan:vlanid;


Not sure how this s_vlanid is being used for various actions in different stages, please add description.

Provided only if action is push or swap. Will to add comment in here.

…option

akokhan · 2022-01-14T14:35:59Z

doc/vlan_stacking/vlan_stacking_HLD.md

+
+# Overview
+
+This document describes the design details of the VLAN stacking feature. VLAN stacking is a feature designed for service providers who carry traffic of multiple customers across  their networks and are required to maintain the VLAN and Layer 2 protocol configurations of each customer without impacting the traffic of other customers. VLAN stacking include QinQ feature and VLAN Translation feature.


Does this HLD cover all-to-one mapping (tunneling)? How to configure many-to-one (selective Q-in-Q)? Thanks

It support. The below example show how to configure many-to-one as matching C-VLAN 10, 20 to S-VLAN 300.

{"VLAN_STACKING": {"Ethernet52|INGRESS|10": {"action": "PUSH","s_vlanid": "30"},"Ethernet52|INGRESS|20": {"action": "PUSH","s_vlanid": "30"},"Ethernet52|INGRESS|40": {"action": "PUSH","s_vlanid": "30"},"Ethernet52|EGRESS|30": {"action": "POP"}}}

Does it mean that each and every C-VLANs must be defined explicitly? Possibly hundreds of them... How about all-to-one mode?

Yes, it need to define the C-VLANs. Regarding to all-to-one. It's hardware dependent. If the entry has enough vlan ids, it can do the configuration. For the future work, it can change new schema to support range format for VLAN ids.

@akokhan Is there any other comment there, ifnot, please help to approve to resolve this

pttch · 2022-01-26T09:36:19Z

Regarding to SAI, my colleague alredy has a PR and got approve, waiting for Merge now.
opencomputeproject/SAI#1400

venkatmahalingam · 2022-01-27T07:12:24Z

doc/vlan_stacking/vlan_stacking_HLD.md

+QinQ tunneling uses double tagging to preserve the customer’s VLAN tags on traffic crossing the service provider’s network. However, if any switch in the path crossing the service provider’s network does not support this feature, then the switches directly connected to that device can be configured to swap the customer’s VLAN ID with the service provider’s VLAN ID for upstream traffic, or the service provider’s VLAN ID with the customer’s VLAN ID for downstream traffic.
+
+## VLAN Stacking Deployment Use Cases
+


Hello @pttch
Here are our comments from Dell team (@skg-net Senthil Kumar Ganesan, @avinothcgl Vinoth Kumar Arumugam, and myself)

Changes in the config-DB:

Enhance PORT & PORTCHANNEL table to include the fields
a) customer edge port (true/false)
b) SVID field (valid only if a) is set)
c) SVID override priority (valid only if a) is set) -> (if this field is not configured, the default behavior is to
inherit priority from C-tag)
-> Upon getting any C-tag on this port/port-channel, SVID should be pushed on the ingress stage and the same should be popped on the egress stage.

VLAN_STACKING -> Keys: a) Port/Portchannel b) SVID
fields: cvid leaf-list
-> This table config would be used when there is a need for explicit CVID to SVID and vice-versa mapping

VLAN_XLATE -> This table will be used to translate from one VLAN to another, there can be a field to indicate whether the translation is expected on the inner or outer VLAN tag and another field to set the priority after translation.

@venkatmahalingam Thanks for your suggestion, Could you share the mib files to me ?

Sure, I sent it to your email.

@venkatmahalingam
After internal discuss, we have the questions,

a) customer edge port (true/false) --> does this only use in VLAN_Stacking, because VLAN_XLATE is in another table.

b) SVID field (valid only if a) is set) --> what's use for ? It shall cover in VLAN_STACKING table.

c) SVID override priority (valid only if a) is set) --> what's use for ? It shall cover in VLAN_STACKING table.

@venkatmahalingam After internal discuss, we have the questions,

a) customer edge port (true/false) --> does this only use in VLAN_Stacking, because VLAN_XLATE is in another table.

b) SVID field (valid only if a) is set) --> what's use for ? It shall cover in VLAN_STACKING table.

c) SVID override priority (valid only if a) is set) --> what's use for ? It shall cover in VLAN_STACKING table.

VLAN stacking can be done in two ways,

Upon getting traffic with any CVID on the port/port-channel (customer edge port), push SVID in the ingress stage, and on the egress stage, SVID should be popped, if we don't want to inherit CVID prioirty, SVID priority should be configured explicitly.

VLAN_STACKING is an alternative method to do the SVID mapping for a given [cvid list, port/port-channel]
VLAN_STACKING -> Keys: 1) Port/Portchannel 2) SVID
fields: cvid leaf-list

If you have any further questions, we can discuss in the meeting.

Yes, please go ahead and update the HLD for review again.

@venkatmahalingam
Regarding to the VLAN_Transition we will use the following table.
VLAN_TRANSLATION:
key: port + svid
cvid: int
If you feel well for this, we will also re-define the db.

@venkatmahalingam Hi, I'm update the DB schema, please have a look for this. If this is ok, please also help to approve this.

@pttch I don't see the below config option in the HLD, this will satisfy the requirement for adding a s-tag for traffic with any c-tag coming on the port/port-channel. Please let us know if you have any plan to take care of this as well in this HLD.

Enhance PORT & PORTCHANNEL table to include the fields
a) customer edge port (true/false)
b) SVID field (valid only if a) is set)
c) SVID override priority (valid only if a) is set) -> (if this field is not configured, the default behavior is to
inherit priority from C-tag)
-> Upon getting any C-tag on this port/port-channel, SVID should be pushed on the ingress stage and the same should be popped on the egress stage.

@venkatmahalingam
a) customer edge port (true/false)
b) SVID field (valid only if a) is set)
--> It can use vlan range setting for all c-vlan, this example show all c-vlan will push s-vlan 100 in Ethernet1 and strips S-VLAN 100 in egress side.
"VLAN_STACKING": {
"Ethernet1|100": {
"c_vlanids": ["1..4095"],
"s_vlan_priority": "0"
}
}
c) SVID override priority (valid only if a) is set) -> (if this field is not configured, the default behavior is to
inherit priority from C-tag)
--> Yes, the sai do not implement this, we will do this in the future.

venkatmahalingam · 2022-03-03T05:55:48Z

doc/vlan_stacking/vlan_stacking_HLD.md

+; field           = value
+c_vlanids         = vlan_id-or-range[,vlan_id-or-range]*  ; list of VLAN IDs
+s_vlan_priority   = %x30-37                               ; a number between 0 and 7
+vlan_id           = %x31-39                               ; 1-9


vlan_id is not a field, please align accordingly.

venkatmahalingam · 2022-03-03T05:56:13Z

doc/vlan_stacking/vlan_stacking_HLD.md

+A new table `VLAN_STACKING` is added in APP DB.
+
+```
+VLAN_STACKING_TABLE:{{interface-name}}:{{s_vlanid}}


APP DB should use "|" key separator.

venkatmahalingam · 2022-03-03T05:58:31Z

doc/vlan_stacking/vlan_stacking_HLD.md

+admin@root:~# show vlan-stacking
+Interface    s_vlanid   c_vlanids    s_vlan_priority
+-----------  --------  -----------  ----------------
+Ethernet0         200          100                 0


If we expect to inherit the C-VLAN priority to S-VLAN as well, how do we show it in the output?

@venkatmahalingam The value is must the behavior is override, you can read in cli spec
Usage: config vlan-stacking add [OPTIONS] <interface_name> <s_vlanid> <c_vlanids> <s_vlan_priority>

venkatmahalingam · 2022-03-03T06:35:58Z

doc/vlan_stacking/vlan_stacking_HLD.md

+
+    import sonic-port {
+        prefix port;
+        revision-date 2019-07-01;


Please remove revision-date from YANG.

venkatmahalingam · 2022-03-03T06:37:00Z

doc/vlan_stacking/vlan_stacking_HLD.md

+                leaf s_vlan_priority {
+                    type uint8 {
+                         range 0..7;
+                    }


default behaviour?

@venkatmahalingam The default behavior is override.

venkatmahalingam · 2022-03-03T06:37:24Z

doc/vlan_stacking/vlan_stacking_HLD.md

+
+                ext:key-regex-configdb-to-yang "^([a-zA-Z0-9_-]+)|([a-zA-Z0-9_-]+)|([0-9]+)$";
+
+                ext:key-regex-yang-to-configdb "<interface_name>|<s_vlanid>";


I dont think we need this, please check in the existing SONiC YANG models.

venkatmahalingam · 2022-03-03T06:38:54Z

doc/vlan_stacking/vlan_stacking_HLD.md

+                            path /port:sonic-port/port:PORT/port:PORT_LIST/port:port_name;
+                        }
+                        type leafref {
+                            path /lag:sonic-portchannel/lag:PORTCHANNEL/lag:PORTCHANNEL_LIST/lag:portchannel_name;


Please add description for all fields.

@venkatmahalingam Will update format issue in next commit.

reshmaintel · 2022-03-21T06:26:38Z

All feedback from the community review has been incorporated by EdgeCore.
Ok to merge from Intel side.

Thanks,
Reshma

venkatmahalingam · 2022-04-13T23:17:26Z

doc/vlan_stacking/vlan_stacking_HLD.md

+
+This document describes the design details of the VLAN stacking feature. VLAN stacking is a feature designed for service providers who carry traffic of multiple customers across  their networks and are required to maintain the VLAN and Layer 2 protocol configurations of each customer without impacting the traffic of other customers. VLAN stacking include QinQ feature and VLAN Translation feature.
+
+IEEE 802.1Q tunneling (QinQ tunneling) uses a single Service Provider VLAN (SPVLAN) for customers who have multiple VLANs. Customer VLAN IDs are preserved and traffic from different customers is segregated within the service provider’s network even when they use the same customer-specific VLAN IDs. QinQ tunneling expands VLAN space by using a VLAN-in-VLAN hierarchy, preserving the customer’s original tagged packets, and adding SPVLAN tags to each frame (also called double tagging).


Are we planning to make any changes in the kernel for VLAN stacking/translation?

Currently, no, is there any concern for change the kernel code ?

Generally, we create an entry in the kernel for things we program in the HW e.g VLAN, in this case, we assume that we don't need VLAN stacking support for CPU originated traffic, correct?

@venkatmahalingam Yes, VLAN stacking do not need for CPU traffic.

zhangyanzhao · 2022-06-02T00:41:54Z

@pttch would you please add the code PRs by referring to EVPN VxLAN update for platforms using P2MP tunnel based L2 forwarding by dgsudharsan · Pull Request #806 · Azure/SONiC (github.com) as an example

prvattem · 2022-07-05T19:31:08Z

doc/vlan_stacking/vlan_stacking_HLD.md

+                }
+
+                leaf c_vlanid {
+                    type leafref {


What is expected out of leafref here? Are you referring to the vlan id syntax or the existence of c_vlanid at /vlan:sonic-vlan/vlan:VLAN/vlan:VLAN_LIST/vlan:vlanid; ?
c_vlanid will not be known to the system.. and leafref should point to a key.. im not sure, if vlanid is a key here.

pttch · 2022-07-06T01:25:12Z

Hi Yanzhao: Yes, I will follow the #806 for the code PR... But it still wait the sai part merged. (opencomputeproject/SAI#1400, already approved), anyway, I will add coe PR first.. Regards Yanzhao Zhang ***@***.***> 於 2022年6月2日週四上午8:42寫道：

…

@pttch <https://github.com/pttch> would you please add the code PRs by referring to EVPN VxLAN update for platforms using P2MP tunnel based L2 forwarding by dgsudharsan · Pull Request #806 · Azure/SONiC (github.com) <https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgit.luolix.top%2FAzure%2FSONiC%2Fpull%2F806&data=04%7C01%7Cyanzhaoz%40microsoft.com%7Cb7bf31851aa34f478ef408d976917b9f%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637671189556870047%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=bFjXS9CxpwRpFXW%2BtilEcrhq3KrZ8Ba2kXOfrVuSZ9E%3D&reserved=0> as an example — Reply to this email directly, view it on GitHub <#915 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AESPSYANTJKS3OSEVDE2KDDVM77N5ANCNFSM5KMZH6DQ> . You are receiving this because you were mentioned.Message ID: ***@***.***>

prvattem · 2022-08-22T16:11:19Z

doc/vlan_stacking/vlan_stacking_HLD.md

+A new table `VLAN_TRANSLATION` is added in Config DB.
+
+```
+VLAN_TRANSLATION|{{interface_name}}|{{s_vlanid}}


Can we include Direction as the key in both VLAN_TRANSLATION & VALN_STACKING tables ? SAI proposal has the support for this via the attribute SAI_VLAN_STACK_ATTR_STAGE.
Some of the vendors support the partial translation rules, where the rule applies for Ingress direction only or for Egress direction only.

sebageek · 2023-12-13T17:30:16Z

Regarding PR tracking for sonic-sairedis it looks like sonic-net/sonic-sairedis#1076 has been closed in favor of sonic-net/sonic-sairedis#1103

Add VLAN Stacking HLD

8dcd743

sunesh reviewed Dec 23, 2021

View reviewed changes

venkatmahalingam reviewed Jan 5, 2022

View reviewed changes

doc/vlan_stacking/vlan_stacking_HLD.md Show resolved Hide resolved

venkatmahalingam reviewed Jan 5, 2022

View reviewed changes

modify the yang field to lower case and add the future work for tpid …

f792060

…option

akokhan reviewed Jan 14, 2022

View reviewed changes

kuanyu99 mentioned this pull request Jan 21, 2022

SAI vlan translation/ vlan tunneling opencomputeproject/SAI#1337

Open

Update the Connamd Line interface for VLAN Stacking feature

9b7d258

venkatmahalingam reviewed Jan 27, 2022

View reviewed changes

pttch and others added 2 commits February 23, 2022 13:32

Modify the DB schema for VLAN Stacking feature

d37c61d

Update example, Yang model and CLI.

2c419e1

venkatmahalingam reviewed Mar 3, 2022

View reviewed changes

ecsonic added 2 commits March 9, 2022 09:57

update the yang model and spec

74e55e4

remove unnessery statement

656ce8e

venkatmahalingam approved these changes Mar 15, 2022

View reviewed changes

reshmaintel approved these changes Mar 21, 2022

View reviewed changes

venkatmahalingam reviewed Apr 13, 2022

View reviewed changes

yxieca force-pushed the master branch from 3107d9b to 77c9171 Compare April 15, 2022 16:40

yxieca force-pushed the master branch from 8498931 to 8837dc2 Compare April 15, 2022 16:51

prvattem reviewed Jul 5, 2022

View reviewed changes

mdanish-kh mentioned this pull request Jul 25, 2022

Incorrect HLD Review Meeting URL in OCP Website #1038

Open

prvattem reviewed Aug 22, 2022

View reviewed changes

prvattem approved these changes Jul 30, 2024

View reviewed changes

		This document describes the design details of the VLAN stacking feature. VLAN stacking is a feature designed for service providers who carry traffic of multiple customers across their networks and are required to maintain the VLAN and Layer 2 protocol configurations of each customer without impacting the traffic of other customers. VLAN stacking include QinQ feature and VLAN Translation feature.

		IEEE 802.1Q tunneling (QinQ tunneling) uses a single Service Provider VLAN (SPVLAN) for customers who have multiple VLANs. Customer VLAN IDs are preserved and traffic from different customers is segregated within the service provider’s network even when they use the same customer-specific VLAN IDs. QinQ tunneling expands VLAN space by using a VLAN-in-VLAN hierarchy, preserving the customer’s original tagged packets, and adding SPVLAN tags to each frame (also called double tagging).


		# Overview

		This document describes the design details of the VLAN stacking feature. VLAN stacking is a feature designed for service providers who carry traffic of multiple customers across their networks and are required to maintain the VLAN and Layer 2 protocol configurations of each customer without impacting the traffic of other customers. VLAN stacking include QinQ feature and VLAN Translation feature.

		QinQ tunneling uses double tagging to preserve the customer’s VLAN tags on traffic crossing the service provider’s network. However, if any switch in the path crossing the service provider’s network does not support this feature, then the switches directly connected to that device can be configured to swap the customer’s VLAN ID with the service provider’s VLAN ID for upstream traffic, or the service provider’s VLAN ID with the customer’s VLAN ID for downstream traffic.

		## VLAN Stacking Deployment Use Cases


		ext:key-regex-configdb-to-yang "^([a-zA-Z0-9_-]+)\|([a-zA-Z0-9_-]+)\|([0-9]+)$";

		ext:key-regex-yang-to-configdb "<interface_name>\|<s_vlanid>";

Add VLAN Stacking HLD #915

Are you sure you want to change the base?

Add VLAN Stacking HLD #915

Conversation

pttch commented Dec 20, 2021 • edited Loading

ghost commented Dec 20, 2021 • edited by ghost 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

venkatmahalingam Jan 5, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pttch Jan 12, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

venkatmahalingam Jan 5, 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

pttch commented Jan 26, 2022

venkatmahalingam Jan 27, 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

venkatmahalingam Feb 9, 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

venkatmahalingam Mar 14, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

venkatmahalingam Mar 3, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pttch Mar 3, 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

reshmaintel commented Mar 21, 2022

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 Jun 2, 2022

Choose a reason for hiding this comment

pttch commented Jul 6, 2022 via email

Choose a reason for hiding this comment

sebageek commented Dec 13, 2023

pttch commented Dec 20, 2021 •

edited

Loading

ghost commented Dec 20, 2021 •

edited by ghost

Loading

venkatmahalingam Jan 5, 2022 •

edited

Loading

pttch Jan 12, 2022 •

edited

Loading

venkatmahalingam Jan 5, 2022 •

edited

Loading

venkatmahalingam Jan 27, 2022 •

edited

Loading

venkatmahalingam Feb 9, 2022 •

edited

Loading

venkatmahalingam Mar 14, 2022 •

edited

Loading

venkatmahalingam Mar 3, 2022 •

edited

Loading

pttch Mar 3, 2022 •

edited

Loading