SONiC Port mirroring HLD #580

rupesh-k · 2020-03-23T08:13:53Z

SONiC Port Mirroring HLD

lguohan · 2020-03-24T17:35:33Z

doc/SONiC_Port_Mirroring_HLD.md

+
+2. Dynamic session management
+    - Allow multiple source to single destination.
+    - Each session supports mirroring from single port to single destination port.


do we allow one mirror session from multiple source port to single dest port?

Yes. we do allow multiple source to single destination with multiple sessions. This is currently planned as multiple sessions, we can also do it in single session with list of source interfaces. Please suggest.

Yes. we allow one mirror session from multiple source port to single destination port.

lguohan · 2020-03-24T18:22:40Z

doc/SONiC_Port_Mirroring_HLD.md

+
+
+## 1.3 Scalability Requirements
+- Up to max ASIC capable mirror sessions to be supported.


how do we know how many mirror session can be supported in the asic?

The SAI Attribute SAI_SWITCH_ATTR_MAX_MIRROR_SESSION can be used to support the max mirror sessinons. This is for both ERSPAN and SPAN and we don't have any mechanism in orchagent to retrieve this now.

Do we have a number based on TD3 and TH series?
Also how many sessions can be active at the same time. Is there any limitation

For TD3 and TH series, max 4 sessions can be active at same time. single session can be shared across multiple source ports.

lguohan · 2020-03-24T18:23:33Z

doc/SONiC_Port_Mirroring_HLD.md

+
+## 1.3 Scalability Requirements
+- Up to max ASIC capable mirror sessions to be supported.
+- Once max mirror sessions are created and user attempts to create new session, error will be logged in syslog.


it is not discussed in the design document how this is implemented. can you add a section to discuss how you are going to implement this?

When the user exceeds max mirror sessions then SAI returns SAI_STATUS_INSUFFICIENT_RESOURCES, This is similar behaviour as what is currently present in ERSPAN also. The error is logged to syslog from SyncD. OrchAgent treats the error as fatal, similar to the existing ERPSAN code.

lguohan · 2020-03-24T18:24:19Z

doc/SONiC_Port_Mirroring_HLD.md

+
+    ;Configure SPAN/ERSPAN mirror session.
+    ;storm control type - broadcast / unknown-unicast / unknown-multicast
+    key       = PORT_MIRROR_TABLE:mirror_session_name ; mirror_session_name is


PORT_MIRROR_TABLE -> PORT_MIRROR

Done. Updated the doc.

lguohan · 2020-03-24T18:24:59Z

doc/SONiC_Port_Mirroring_HLD.md

+                                                      ; unique session
+                                                      ; identifier
+    ;field  = value
+    destination_port = PORT_TABLE:ifname    ; ifname must be unique across PORT TABLE.


can dest port be lag?

No. Destination port cant be LAG. We are not supporting this now.

Can you update the Source-ip and destination-ip fields to the table

ERSPAN is already supported in community and we captured only new additions which are done as part of this PR.

lguohan · 2020-03-24T18:25:38Z

doc/SONiC_Port_Mirroring_HLD.md

+                                                      ; identifier
+    ;field  = value
+    destination_port = PORT_TABLE:ifname    ; ifname must be unique across PORT TABLE.
+    source_port = PORT_TABLE:ifname    ; ifname must be unique across PORT,INTF,LAG TABLES


what do you mean by INTF? INTF is layer 3 concept.

Doc is already updated. this is only port for destination port, port/LAG for src port.

lguohan · 2020-03-24T18:26:58Z

doc/SONiC_Port_Mirroring_HLD.md

+
+    mirror_session_name = 1*255VCHAR
+
+### 3.2.2 APP_DB


what is plan to support this feature in virtual switch, like sflow.

We dont have plan for this now. If u mean to handle specific flow to mirror, then ACL mirroring can be used. Can u please clarify on sflow part here.

lguohan · 2020-03-24T18:27:20Z

doc/SONiC_Port_Mirroring_HLD.md

+
+## 3.5 CLI
+### 3.5.1 Data Models
+Custom Yang model will be introduced for this feature.


can you add description for the yang model?

Sure. I will add and update the doc

Updated doc with both SONiC yang and openconfig extension model also

lguohan · 2020-03-24T18:28:23Z

doc/SONiC_Port_Mirroring_HLD.md

+    SPAN Sessions
+    ---------------------------------------------------------------------------------------------------------
+      Name Status         DST Port         SRC Port Direction
+     sess1 active        Ethernet4        Ethernet0     rx


what is the definition of active status? what is the criteria. can you make it clear in the document?

Port mirror session will be active in below cases.

When destination port only session is created, then once the session is created from SAI. the session becomes active. These sessions can be used in ACL mirroring.

When mirroring is enabled on the source ports, then the session will become active.

lguohan · 2020-03-24T18:29:13Z

doc/SONiC_Port_Mirroring_HLD.md

+
+## 9.1 CLI Test Cases
+
+    1. Configure ERSPAN mirror session and verify all parameters are updated properly in CONFIG_DB 


please describe where the tests are going to be contributed to? which repo?

Some of the tests will be contributed to swss and others will be contributed to spytest. I will update in the doc.

lguohan · 2020-03-24T18:29:54Z

doc/SONiC_Port_Mirroring_HLD.md

+    config mirror_session add erspan <session-name> <src_ip> <dst_ip> <gre> <dscp>  [ttl] [queue] [src_port] [rx/tx/both]
+
+    #Configure Port mirror span mirror session.
+    config mirror_session add span <session-name> <destination_ifName> <source_ifName> <rx/tx/both>


is policer going to supported in span session?

Yes. Policer is supported.

lguohan

as comments

rupesh-k · 2020-06-04T19:16:11Z

Thanks Guohan for review comments.
I have updated the document with details.
I will be updating more on unittests in next commit.

Thanks

rupesh-k · 2020-06-16T16:34:05Z

Hi @lguohan ,

Can u please review the HLD and I have raised initial code PR along with pytest UT
Following are code PR links.
sonic-net/sonic-swss#1314
sonic-net/sonic-utilities#936

Can u please help review .

Thanks
Rupesh Kumar

ben-gale · 2020-06-19T14:13:43Z

@lguohan, @xinliu-seattle - can we merge this now please?

dev-aviz · 2020-06-26T14:29:50Z

doc/SONiC_Port_Mirroring_HLD.md

+
+
+## 1.3 Scalability Requirements
+- Up to max ASIC capable mirror sessions to be supported.


Do we have a number based on TD3 and TH series?
Also how many sessions can be active at the same time. Is there any limitation

dev-aviz · 2020-06-26T14:31:38Z

doc/SONiC_Port_Mirroring_HLD.md

+                                                      ; unique session
+                                                      ; identifier
+    ;field  = value
+    destination_port = PORT_TABLE:ifname    ; ifname must be unique across PORT TABLE.


Can you update the Source-ip and destination-ip fields to the table

dev-aviz · 2020-06-26T14:34:03Z

doc/SONiC_Port_Mirroring_HLD.md

+
+    # Modify existing ERSPAN configuration to accept source port and direction
+    config mirror_session add erspan <session-name> <src_ip> <dst_ip> <gre> <dscp>  [ttl] [queue] [src_port] [rx/tx/both] --policer <policer>
+


Why do we have dscp here? Is it for any prioritization of ERSPAN traffic mirrored across the devices?

Yes ERSPAN tunnel header will have this dscp, This is already supported in current community code and this PR doesnt modify any behaviour of this field.

dev-aviz · 2020-06-26T14:36:24Z

doc/SONiC_Port_Mirroring_HLD.md

+|Name                      |   Scaling value    |
+|--------------------------|--------------------|
+| Max mirror sessions      | silicon specific   |
+


Do you have any scaling numbers?

For TD3, TH series max 4 sessions can be supported.

SONiC Port mirroring HLD

e8c86d1

rupesh-k force-pushed the port_mirroring_hld branch from c66f25d to e8c86d1 Compare March 23, 2020 17:55

lguohan reviewed Mar 24, 2020

View reviewed changes

lguohan requested changes Mar 24, 2020

View reviewed changes

Updated as per review comments

f57f3e1

rupesh-k mentioned this pull request Jun 4, 2020

[mirrororch] Port Mirroring implementation sonic-net/sonic-swss#1314

Merged

Updated UT details and sample pytest outputs

c563ace

Updated openconfig yang model also

685879e

dev-aviz reviewed Jun 26, 2020

View reviewed changes

rupesh-k requested a review from lguohan June 26, 2020 14:49

xinliu-seattle merged commit aad6a1f into sonic-net:master Oct 30, 2020



		## 1.3 Scalability Requirements
		- Up to max ASIC capable mirror sessions to be supported.


		## 9.1 CLI Test Cases

		1. Configure ERSPAN mirror session and verify all parameters are updated properly in CONFIG_DB


		# Modify existing ERSPAN configuration to accept source port and direction
		config mirror_session add erspan <session-name> <src_ip> <dst_ip> <gre> <dscp> [ttl] [queue] [src_port] [rx/tx/both] --policer <policer>

SONiC Port mirroring HLD #580

SONiC Port mirroring HLD #580

Conversation

rupesh-k commented Mar 23, 2020

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

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

lguohan left a comment

Choose a reason for hiding this comment

rupesh-k commented Jun 4, 2020

rupesh-k commented Jun 16, 2020

ben-gale commented Jun 19, 2020

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

rupesh-k Jun 26, 2020 • edited

Choose a reason for hiding this comment

rupesh-k Jun 26, 2020 •

edited