CSIT 1701 report files and script AD1

[csit.git] / docs / report / vpp_performance_tests_hw / overview.rst

diff --git a/docs/report/vpp_performance_tests_hw/overview.rst b/docs/report/vpp_performance_tests_hw/overview.rst
index a0425fa..e1afabf 100644 (file)
--- a/docs/report/vpp_performance_tests_hw/overview.rst
+++ b/docs/report/vpp_performance_tests_hw/overview.rst
@@ -1,11 +1,13 @@
 Overview\r
 ========\r
 \r
 Overview\r
 ========\r
 \r

-VPP Performance Test Topologies\r
--------------------------------\r
+Tested Topologies HW\r
+--------------------\r

 \r
 CSIT VPP performance tests are executed on physical baremetal servers hosted by LF\r
 \r
 CSIT VPP performance tests are executed on physical baremetal servers hosted by LF\r

-FD.io project. Testbed physical topology is shown in the figure below.::\r
+FD.io project. Testbed physical topology is shown in the figure below.\r
+\r
+::\r

 \r
     +------------------------+           +------------------------+\r
     |                        |           |                        |\r
 \r
     +------------------------+           +------------------------+\r
     |                        |           |                        |\r


@@ -39,13 +41,15 @@ installed and tested NIC models include:
 #. 2port40GE VIC1385 Cisco.\r
 #. 2port40GE XL710 Intel.\r
 \r
 #. 2port40GE VIC1385 Cisco.\r
 #. 2port40GE XL710 Intel.\r
 \r

-Detailed LF FD.io test bed specification and topology is described on `CSIT LF\r
-testbed wiki page <https://wiki.fd.io/view/CSIT/CSIT_LF_testbed>`_.\r
+Detailed LF FD.io test bed specification and physical topology are described\r
+in `wiki CSIT LF testbed <https://wiki.fd.io/view/CSIT/CSIT_LF_testbed>`_.\r

 \r
 For test cases that require DUT (VPP) to communicate with VM over vhost-user\r
 interfaces, a VM is created on SUT1 and SUT2. DUT (VPP) test topology with VM\r
 is shown in the figure below including applicable packet flow thru the VM\r
 \r
 For test cases that require DUT (VPP) to communicate with VM over vhost-user\r
 interfaces, a VM is created on SUT1 and SUT2. DUT (VPP) test topology with VM\r
 is shown in the figure below including applicable packet flow thru the VM\r

-(marked with \*\*\*).::\r
+(marked in the figure with ``***``).\r
+\r
+::\r

 \r
     +------------------------+           +------------------------+\r
     |      +----------+      |           |      +----------+      |\r
 \r
     +------------------------+           +------------------------+\r
     |      +----------+      |           |      +----------+      |\r


@@ -70,25 +74,29 @@ is shown in the figure below including applicable packet flow thru the VM
                              +-----------+\r
 \r
 Note that for VM tests, packets are switched by DUT (VPP) twice, hence the\r
                              +-----------+\r
 \r
 Note that for VM tests, packets are switched by DUT (VPP) twice, hence the\r

-throughput rates measured by TG must be multiplied by two to represent the\r
-actual DUT packet forwarding rate.\r
+throughput rates measured by TG (and listed in this report) must be multiplied\r
+by two to represent the actual DUT aggregate packet forwarding rate.\r

 \r
 VPP Performance Tests Overview\r
 ------------------------------\r
 \r
 \r
 VPP Performance Tests Overview\r
 ------------------------------\r
 \r

-Performance tests are split into two main categories:\r
+Performance tests are split into the two main categories:\r

 \r
 - Throughput discovery - discovery of packet forwarding rate using binary search\r
   in accordance to RFC2544.\r
 \r
 \r
 - Throughput discovery - discovery of packet forwarding rate using binary search\r
   in accordance to RFC2544.\r
 \r

-  - NDR - discovery of Non Drop Rate, zero packet loss.\r
-  - PDR - discovery of Partial Drop Rate, with specified non-zero packet loss.\r
+  - NDR - discovery of Non Drop Rate packet throughput, at zero packet loss;\r
+    followed by packet one-way latency measurements at 10%, 50% and 100% of\r
+    discovered NDR throughput.\r
+  - PDR - discovery of Partial Drop Rate, with specified non-zero packet loss\r
+    currently set to 0.5%; followed by packet one-way latency measurements at\r
+    100% of discovered PDR throughput.\r

 \r
 - Throughput verification - verification of packet forwarding rate against\r
   previously discovered throughput rate. These tests are currently done against\r
   0.9 of reference NDR, with reference rates updated periodically.\r
 \r
 \r
 - Throughput verification - verification of packet forwarding rate against\r
   previously discovered throughput rate. These tests are currently done against\r
   0.9 of reference NDR, with reference rates updated periodically.\r
 \r

-CSIT |release| includes following performance test suites:\r
+CSIT |release| includes following performance test suites, listed per NIC type:\r

 \r
 - 2port10GE X520-DA2 Intel\r
 \r
 \r
 - 2port10GE X520-DA2 Intel\r
 \r


@@ -138,3 +146,11 @@ CSIT |release| includes following performance test suites:
   - **L2BD** - L2 Bridge-Domain switched-forwarding of untagged Ethernet frames\r
      with MAC learning.\r
 \r
   - **L2BD** - L2 Bridge-Domain switched-forwarding of untagged Ethernet frames\r
      with MAC learning.\r
 \r

+Execution of performance tests takes time, especially the throughput discovery\r
+tests. Due to limited HW testbed resources available within FD.io labs hosted\r
+by Linux Foundation, the number of tests for NICs other than X520 (a.k.a.\r
+Niantic) has been limited to few baseline tests. Over time we expect the HW\r
+testbed resources to grow, and will be adding complete set of performance\r
+tests for all models of hardware to be executed regularly and(or)\r
+continuously.\r
+\r