sonic-net · yxieca · Feb 17, 2021 · Feb 4, 2021 · Feb 4, 2021 · Feb 8, 2021
diff --git a/docs/testplan/BGP Convergence Testplan for single DUT.md b/docs/testplan/BGP Convergence Testplan for single DUT.md
@@ -0,0 +1,124 @@
+# BGP convergence test plan for benchmark performance
+
+- [BGP convergence test plan for benchmark performance](#bgp-convergence-test-plan-for-benchmark-performance)
+  - [Overview](#Overview)
+    - [Scope](#Scope)
+    - [Testbed](#Keysight-Testbed)
+  - [Topology](#Topology)
+    - [SONiC switch as ToR](#SONiC-switch-as-ToR)
+    - [SONiC switch as Leaf](#SONiC-switch-as-Leaf)
+  - [Setup configuration](#Setup-configuration)
+  - [Test methodology](#Test-methodology)
+  - [Test cases](#Test-cases)
+    - [Test case # 1 – Convergence performance when remote link fails (route withdraw)](#test-case--1--convergence-performance-when-remote-link-fails-route-withdraw)
+      - [Test objective](#Test-objective)
+      - [Test steps](#Test-steps)
+      - [Test results](#Test-results)
+    - [Test case # 2 – RIB-IN Convergence](#Test-case--2--RIB-IN-Convergence)
+      - [Test objective](#Test-objective-1)
+      - [Test steps](#Test-steps-1)
+      - [Test results](#Test-results-1)
+    - [Call for action](#Call-for-action)
+
+## Overview
+The purpose of these tests is to test the overall convergence of a data center network by simulating multiple network devices such as ToR/Leafs and using SONiC switch DUT as one of the ToR/Leaf, closely resembling production environment.
+
+### Scope
+These tests are targeted on fully functioning SONiC system. The purpose of these tests are to measure convergence when some unexpected failures such as remote link failure, local link failure, node failure or link faults etc occur and some expected failures such as maintenance or upgrade of devices occur in the SONiC system.
+
+### Keysight Testbed
+The tests will run on following testbeds:
+* t0
+
+![Single DUT Topology ](Img/Single_DUT_Topology.png)
+
+## Topology
+### SONiC switch as ToR
+
+![SONiC DUT as ToR ](Img/Switch_as_ToR.png)
+
+### SONiC switch as Leaf
+
+![SONiC DUT as ToR ](Img/Switch_acting_as_leaf.png)
+
+## Setup configuration
+IPv4 EBGP neighborship will be configured between SONiC DUT and directly connected test ports. Test ports inturn will simulate the ToR's and Leafs by advertising IPv4/IPv6, dual-stack routes.
+
+## Test Methodology
+Following test methodologies will be used for measuring convergence. 
+* Traffic generator will be used to configure ebgp peering between chassis ports and SONiC DUT by advertising IPv4/IPv6, dual-stack routes. 
+* Receiving ports will be advertising the same VIP(virtual IP) addresses. 
+* Data traffic will be sent from  server to these VIP addresses. 
+* Depending on the test case, the faults will be generated. Local link failures can be simulated on the port by "simulating link down" event. 
+* Remote link failures can be simulated by withdrawing the routes.
+* Control to data plane convergence will be measured by noting down the precise time of the control plane event and the data plane event. Convergence will be measured by taking the difference between contol and data plane events. Traffic generator will create those events and provide us with the control to data plane convergence value under statistics.
+* RIB-IN Convergence is the time it takes to install the routes in its RIB and then in its FIB to forward the traffic without any loss. In order to measure RIB-IN convergence, initially IPv4/IPv6 routes will not be advertised. Once traffic is sent, IPv4/IPv6 routes will be advertised and the timestamp will be noted. Once the traffic received rate goes above the configured threshold value, it will note down the data plane above threshold timestamp. The difference between these two event timestamps will provide us with the RIB-IN convergence value.
+* Route capacity can be measured by advertising routes in a linear search fashion. By doing this we can figure out the maximum routes a switch can learn and install in its RIB and then in its FIB to forward traffic without any loss.
+
+## Test cases
+### Test case # 1 – Convergence performance when remote link fails (route withdraw)
+#### Test objective
+Measure the convergence time when remote link failure event happens with in the network.
+
+<p float="left">
+  <img src="Img/Single_Link_Failure.png" width="500"  hspace="50"/>
+  <img src="Img/Failover_convergence.png" width="380" /> 
+</p>
+
+
+#### Test steps
+* Configure IPv4 EBGP sessions between Keysight ports and the SONiC switch.
+* Advertise IPv4 routes along with AS number via configured IPv4 BGP sessions.
+* Configure and advertise same IPv4 routes from both the test ports.
+* Configure another IPv4 session to send the traffic. This is the server port from which traffic will be sent to the VIP addresses.
+* Start all protocols and verify that IPv4 BGP neighborship is established.
+* Create a data traffic between the server port and receiver ports where the same VIP addresses are configured and enable tracking by "Destination Endpoint" and by "Destination session description".
+* Set the desired threshold value for receiving traffic. By default we will be set to 90% of expected receiving rate.
+* Apply and start the data traffic.
+* Verify that traffic is equally distributed between the receiving ports without any loss.
+* Simulate remote link failure by withdrawing the routes from one receiving port. 
+* Verify that the traffic is re-balanced and use the other available path to route the traffic.
+* Drill down by "Destination Endpoint" under traffic statistics to get the control plane to data plane convergence value.
+* In general the convergence value will fall in certain range. In order to achieve proper results, run the test multiple times and average out the test results. 
+* Set it back to default configuration.
+#### Test results
+![Single remote link failure](Img/Single_Remote_Link_Failure.png)
+
+For above test case, below are the test results when multiple remote link fails.
+
+![Multiple link failure](Img/Multi_link_failure.png)
+
+![Multiple remote link failure](Img/Multiple_Remote_Link_Failure.png)
+
+### Test case # 2 – RIB-IN Convergence 
+#### Test objective
+Measure the convergence time to install the routes in its RIB and then in its FIB to forward the packets after the routes are advertised.
+
+<p float="left">
+  <img src="Img/RIB-IN-Convergence_Topology.png" width="500" hspace="50"/>
+  <img src="Img/RIB-IN_Convergence_graph.png" width="380" /> 
+</p>
+
+#### Test steps
+* Configure IPv4 EBGP sessions between Keysight ports and the SONiC switch.
+* Configure IPv4 routes via configured IPv4 BGP sessions. Initially disable the routes so that they don't get advertised after starting the protocols.
+* Configure the same IPv4 routes from both the test receiving ports.
+* Configure another IPv4 session to send the traffic. This is the server port from which traffic will be sent to the VIP addresses.
+* Start all protocols and verify that IPv4 BGP neighborship is established.
+* Create a data traffic between the server port and receiver ports where the same VIP addresses are configured and enable tracking by "Destination Endpoint" and by "Destination session description".
+* Set the desired threshold value for receiving traffic. By default we will be set to 90% of expected receiving rate.
+* Apply and start the data traffic.
+* Verify that no traffic is being forwarded. 
+* Enable/advertise the routes which are already configured. 
+* Control plane event timestamp will be noted down and once the receiving traffic rate goes above the configured threshold value, it will note down the data plane threshold timestamp.
+* The difference between these two event timestamp will provide us with the RIB-IN convergence time.
+* In general the convergence value will fall in certain range. In order to achieve proper results, run the test multiple times and average out the test results. 
+* Set it back to default configuration.
+#### Test results
+![RIB-IN Convergence](Img/RIB-IN_convergence_test.png)
+
+In order to measure RIB-IN capacity of the switch, we can follow the same test methodology as RIB-IN convergence test. Below are the results for RIB-IN capacity test.
+
+![RIB-IN Capacity Test](Img/RIB-IN_Capacity_Test.png)
+### Call for action
+* Solicit experience in multi-DUT system test scenarios.
diff --git a/docs/testplan/Img/Failover_convergence.png b/docs/testplan/Img/Failover_convergence.png
diff --git a/docs/testplan/Img/Multi_link_failure.png b/docs/testplan/Img/Multi_link_failure.png
diff --git a/docs/testplan/Img/Multiple_Remote_Link_Failure.png b/docs/testplan/Img/Multiple_Remote_Link_Failure.png
diff --git a/docs/testplan/Img/RIB-IN-Convergence_Topology.png b/docs/testplan/Img/RIB-IN-Convergence_Topology.png
diff --git a/docs/testplan/Img/RIB-IN_Capacity_Test.png b/docs/testplan/Img/RIB-IN_Capacity_Test.png
diff --git a/docs/testplan/Img/RIB-IN_Convergence_graph.png b/docs/testplan/Img/RIB-IN_Convergence_graph.png
diff --git a/docs/testplan/Img/RIB-IN_convergence_test.png b/docs/testplan/Img/RIB-IN_convergence_test.png
diff --git a/docs/testplan/Img/Single_DUT_Topology.png b/docs/testplan/Img/Single_DUT_Topology.png
diff --git a/docs/testplan/Img/Single_Link_Failure.png b/docs/testplan/Img/Single_Link_Failure.png
diff --git a/docs/testplan/Img/Single_Remote_Link_Failure.png b/docs/testplan/Img/Single_Remote_Link_Failure.png
diff --git a/docs/testplan/Img/Switch_acting_as_leaf.png b/docs/testplan/Img/Switch_acting_as_leaf.png
diff --git a/docs/testplan/Img/Switch_as_ToR.png b/docs/testplan/Img/Switch_as_ToR.png