CSIT-891: Add data sources for 1801 report
[csit.git] / docs / report / vpp_performance_tests / csit_release_notes.rst
index d029bd0..85cbd7b 100644 (file)
@@ -8,61 +8,66 @@ Changes in CSIT |release|
 \r
    - **Container Topologies Orchestrated by K8s with VPP memif tests**\r
 \r
 \r
    - **Container Topologies Orchestrated by K8s with VPP memif tests**\r
 \r
-     - Added tests with VPP in L2 Cross-Connect and Bridge-Domain configurations\r
-       connecting over memif virtual interfaces VPPs running in Docker\r
-       containers, with service chain topologies orchestrated by Kubernetes.\r
-       Chained, horizontal and standalone linked topologies added;\r
+   - Added tests with VPP in L2 Cross-Connect and Bridge-Domain\r
+     configurations containers, with service chain topologies orchestrated by\r
+     Kubernetes. Added following forwarding topologies: i) "Parallel" with\r
+     packets flowing from NIC via VPP to container and back to VPP and NIC;\r
+     ii) "Chained" a.k.a. "Snake" with packets flowing via VPP to container,\r
+     back to VPP, to next container, back to VPP and so on until the last\r
+     container in chain, then back to VPP and NIC; iii) "Horizontal" with\r
+     packets flowing via VPP to container, then via "horizontal" memif to\r
+     next container, and so on until the last container, then back to VPP and\r
+     NIC;.\r
 \r
    - **VPP TCP/IP stack**\r
 \r
 \r
    - **VPP TCP/IP stack**\r
 \r
-     - Added tests with VPP builtin TCP based HTTP server. WRK traffic generator\r
-       is used.\r
+     - Added tests for VPP TCP/IP stack using VPP built-in HTTP server.\r
+       WRK traffic generator is used as a client-side;\r
 \r
    - **SRv6 tests**\r
 \r
 \r
    - **SRv6 tests**\r
 \r
-     - [placeholder]\r
+     - Initial SRv6 (Segment Routing IPv6) tests verifying performance of\r
+       IPv6 and SRH (Segment Routing Header) encapsulation, decapsulation,\r
+       lookups and rewrites based on configured End and End.DX6 SRv6 egress\r
+       functions;\r
 \r
    - **IPSecSW tests**\r
 \r
      - SW computed IPSec encryption with AES-GCM, CBC-SHA1 ciphers, in\r
 \r
    - **IPSecSW tests**\r
 \r
      - SW computed IPSec encryption with AES-GCM, CBC-SHA1 ciphers, in\r
-       combination with IPv4 routed-forwarding.\r
+       combination with IPv4 routed-forwarding;\r
 \r
 #. Presentation and Analytics Layer\r
 \r
 \r
 #. Presentation and Analytics Layer\r
 \r
-     - Added multi-core scale-up analysis into Presentation and Analytics Layer\r
-       (PAL) for automated CSIT test results analysis;\r
-\r
+     - Added throughput speedup analysis for multi-core and multi-thread\r
+       VPP tests into Presentation and Analytics Layer (PAL) for automated\r
+       CSIT test results analysis;\r
 \r
 #. Other improvements\r
 \r
      - **Framework optimizations**\r
 \r
 \r
 #. Other improvements\r
 \r
      - **Framework optimizations**\r
 \r
-       - Ability to run CSIT framework on ARM architecture.\r
+       - Ability to run CSIT framework on ARM architecture;\r
 \r
 \r
-       - Overall stability improvements.\r
+       - Overall stability improvements;\r
 \r
 \r
-Performance Improvements\r
-------------------------\r
+Performance Changes\r
+-------------------\r
 \r
 \r
-Substantial improvements in measured packet throughput have been observed in a\r
-number of CSIT |release| tests listed below, with relative increase of\r
-double-digit percentage points. Relative improvements for this release are\r
-calculated against the test results listed in CSIT |release-1| report. The\r
+Substantial changes in measured packet throughput have been observed in a\r
+number of CSIT |release| tests listed below. Relative changes for this release\r
+are calculated against the test results listed in CSIT |release-1| report. The\r
 comparison is calculated between the mean values based on collected and\r
 archived test results' samples for involved VPP releases. Standard deviation\r
 comparison is calculated between the mean values based on collected and\r
 archived test results' samples for involved VPP releases. Standard deviation\r
-has been also listed for CSIT |release|. Performance numbers since release\r
-VPP-16.09 are provided for reference.\r
-\r
-NDR Throughput\r
-~~~~~~~~~~~~~~\r
+has been also listed for CSIT |release|.\r
 \r
 \r
-Non-Drop Rate Throughput discovery tests:\r
+NDR Throughput: Best 20 Changes\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
 \r
 .. only:: html\r
 \r
    .. csv-table::\r
       :align: center\r
 \r
 .. only:: html\r
 \r
    .. csv-table::\r
       :align: center\r
-      :file: performance_improvements/performance_improvements_ndr_top.csv\r
+      :file: ../../../../_build/_static/vpp/performance-changes-ndr-1t1c-top.csv\r
 \r
 .. only:: latex\r
 \r
 \r
 .. only:: latex\r
 \r
@@ -70,7 +75,7 @@ Non-Drop Rate Throughput discovery tests:
 \r
       \makeatletter\r
       \csvset{\r
 \r
       \makeatletter\r
       \csvset{\r
-        perfimprovements column width/.style={after head=\csv@pretable\begin{longtable}{ m{1.5cm} m{4cm} m{#1} m{#1} m{#1} m{#1} m{#1} m{#1} m{#1}}\csv@tablehead},\r
+        perfimprovements column width/.style={after head=\csv@pretable\begin{longtable}{m{4cm} m{#1} m{#1} m{#1} m{#1} m{#1}}\csv@tablehead},\r
       }\r
       \makeatother\r
 \r
       }\r
       \makeatother\r
 \r
@@ -81,20 +86,17 @@ Non-Drop Rate Throughput discovery tests:
         perfimprovements column width=1cm,\r
         late after line={\\\hline},\r
         late after last line={\end{longtable}}\r
         perfimprovements column width=1cm,\r
         late after line={\\\hline},\r
         late after last line={\end{longtable}}\r
-        ]{../_tmp/src/vpp_performance_tests/performance_improvements/performance_improvements_ndr_top.csv}\r
+        ]{../_build/_static/vpp/performance-changes-ndr-1t1c-top.csv}\r
       }\r
 \r
       }\r
 \r
-\r
-PDR Throughput\r
-~~~~~~~~~~~~~~\r
-\r
-Partial Drop Rate thoughput discovery tests with packet Loss Tolerance of 0.5%:\r
+NDR Throughput: Worst 20 Changes\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
 \r
 .. only:: html\r
 \r
    .. csv-table::\r
       :align: center\r
 \r
 .. only:: html\r
 \r
    .. csv-table::\r
       :align: center\r
-      :file: performance_improvements/performance_improvements_pdr_top.csv\r
+      :file: ../../../../_build/_static/vpp/performance-changes-ndr-1t1c-bottom.csv\r
 \r
 .. only:: latex\r
 \r
 \r
 .. only:: latex\r
 \r
@@ -102,7 +104,7 @@ Partial Drop Rate thoughput discovery tests with packet Loss Tolerance of 0.5%:
 \r
       \makeatletter\r
       \csvset{\r
 \r
       \makeatletter\r
       \csvset{\r
-        perfimprovements column width/.style={after head=\csv@pretable\begin{longtable}{ m{1.5cm} m{4cm} m{#1} m{#1} m{#1} m{#1} m{#1} m{#1} m{#1}}\csv@tablehead},\r
+        perfimprovements column width/.style={after head=\csv@pretable\begin{longtable}{m{4cm} m{#1} m{#1} m{#1} m{#1} m{#1}}\csv@tablehead},\r
       }\r
       \makeatother\r
 \r
       }\r
       \makeatother\r
 \r
@@ -113,32 +115,32 @@ Partial Drop Rate thoughput discovery tests with packet Loss Tolerance of 0.5%:
         perfimprovements column width=1cm,\r
         late after line={\\\hline},\r
         late after last line={\end{longtable}}\r
         perfimprovements column width=1cm,\r
         late after line={\\\hline},\r
         late after last line={\end{longtable}}\r
-        ]{../_tmp/src/vpp_performance_tests/performance_improvements/performance_improvements_pdr_top.csv}\r
+        ]{../_build/_static/vpp/performance-changes-ndr-1t1c-bottom.csv}\r
       }\r
 \r
       }\r
 \r
+.. only:: html\r
 \r
 \r
-Measured improvements are in line with VPP code optimizations listed in\r
-`VPP-17.10 release notes\r
-<https://docs.fd.io/vpp/17.10/release_notes_1710.html>`_.\r
-\r
-Other Performance Changes\r
--------------------------\r
+      NDR Throughput: All Changes\r
+      ~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
 \r
 \r
-Other changes in measured packet throughput, with either minor relative increase\r
-or decrease, have been observed in a number of CSIT |release| tests listed\r
-below. Relative changes are calculated against the test results listed in CSIT\r
-|release-1| report.\r
+      Complete results for all NDR tests are available in a CSV and pretty\r
+      ASCII formats:\r
 \r
 \r
-NDR Throughput\r
-~~~~~~~~~~~~~~\r
+        - `csv format for 1t1c <../../_static/vpp/performance-changes-ndr-1t1c-full.csv>`_,\r
+        - `csv format for 2t2c <../../_static/vpp/performance-changes-ndr-2t2c-full.csv>`_,\r
+        - `csv format for 4t4c <../../_static/vpp/performance-changes-ndr-4t4c-full.csv>`_,\r
+        - `pretty ASCII format for 1t1c <../../_static/vpp/performance-changes-ndr-1t1c-full.txt>`_,\r
+        - `pretty ASCII format for 2t2c <../../_static/vpp/performance-changes-ndr-2t2c-full.txt>`_,\r
+        - `pretty ASCII format for 4t4c <../../_static/vpp/performance-changes-ndr-4t4c-full.txt>`_.\r
 \r
 \r
-Non-Drop Rate Throughput discovery tests:\r
+PDR Throughput: Best 20 Changes\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
 \r
 .. only:: html\r
 \r
    .. csv-table::\r
       :align: center\r
 \r
 .. only:: html\r
 \r
    .. csv-table::\r
       :align: center\r
-      :file: performance_improvements/performance_improvements_ndr_low.csv\r
+      :file: ../../../../_build/_static/vpp/performance-changes-pdr-1t1c-top.csv\r
 \r
 .. only:: latex\r
 \r
 \r
 .. only:: latex\r
 \r
@@ -146,7 +148,7 @@ Non-Drop Rate Throughput discovery tests:
 \r
       \makeatletter\r
       \csvset{\r
 \r
       \makeatletter\r
       \csvset{\r
-        perfimprovements column width/.style={after head=\csv@pretable\begin{longtable}{ m{1.5cm} m{4cm} m{#1} m{#1} m{#1} m{#1} m{#1} m{#1} m{#1}}\csv@tablehead},\r
+        perfimprovements column width/.style={after head=\csv@pretable\begin{longtable}{m{4cm} m{#1} m{#1} m{#1} m{#1} m{#1}}\csv@tablehead},\r
       }\r
       \makeatother\r
 \r
       }\r
       \makeatother\r
 \r
@@ -157,20 +159,17 @@ Non-Drop Rate Throughput discovery tests:
         perfimprovements column width=1cm,\r
         late after line={\\\hline},\r
         late after last line={\end{longtable}}\r
         perfimprovements column width=1cm,\r
         late after line={\\\hline},\r
         late after last line={\end{longtable}}\r
-        ]{../_tmp/src/vpp_performance_tests/performance_improvements/performance_improvements_ndr_low.csv}\r
+        ]{../_build/_static/vpp/performance-changes-pdr-1t1c-top.csv}\r
       }\r
 \r
       }\r
 \r
-\r
-PDR Throughput\r
-~~~~~~~~~~~~~~\r
-\r
-Partial Drop Rate thoughput discovery tests with packet Loss Tolerance of 0.5%:\r
+PDR Throughput: Worst 20 Changes\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
 \r
 .. only:: html\r
 \r
    .. csv-table::\r
       :align: center\r
 \r
 .. only:: html\r
 \r
    .. csv-table::\r
       :align: center\r
-      :file: performance_improvements/performance_improvements_pdr_low.csv\r
+      :file: ../../../../_build/_static/vpp/performance-changes-pdr-1t1c-bottom.csv\r
 \r
 .. only:: latex\r
 \r
 \r
 .. only:: latex\r
 \r
@@ -178,7 +177,7 @@ Partial Drop Rate thoughput discovery tests with packet Loss Tolerance of 0.5%:
 \r
       \makeatletter\r
       \csvset{\r
 \r
       \makeatletter\r
       \csvset{\r
-        perfimprovements column width/.style={after head=\csv@pretable\begin{longtable}{ m{1.5cm} m{4cm} m{#1} m{#1} m{#1} m{#1} m{#1} m{#1} m{#1}}\csv@tablehead},\r
+        perfimprovements column width/.style={after head=\csv@pretable\begin{longtable}{m{4cm} m{#1} m{#1} m{#1} m{#1} m{#1}}\csv@tablehead},\r
       }\r
       \makeatother\r
 \r
       }\r
       \makeatother\r
 \r
@@ -189,9 +188,27 @@ Partial Drop Rate thoughput discovery tests with packet Loss Tolerance of 0.5%:
         perfimprovements column width=1cm,\r
         late after line={\\\hline},\r
         late after last line={\end{longtable}}\r
         perfimprovements column width=1cm,\r
         late after line={\\\hline},\r
         late after last line={\end{longtable}}\r
-        ]{../_tmp/src/vpp_performance_tests/performance_improvements/performance_improvements_pdr_low.csv}\r
+        ]{../_build/_static/vpp/performance-changes-pdr-1t1c-bottom.csv}\r
       }\r
 \r
       }\r
 \r
+.. only:: html\r
+\r
+      PDR Throughput: All Changes\r
+      ~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+\r
+            Complete results for all PDR tests are available in a CSV and pretty\r
+            ASCII formats:\r
+\r
+              - `csv format for 1t1c <../../_static/vpp/performance-changes-pdr-1t1c-full.csv>`_,\r
+              - `csv format for 2t2c <../../_static/vpp/performance-changes-pdr-2t2c-full.csv>`_,\r
+              - `csv format for 4t4c <../../_static/vpp/performance-changes-pdr-4t4c-full.csv>`_,\r
+              - `pretty ASCII format for 1t1c <../../_static/vpp/performance-changes-pdr-1t1c-full.txt>`_,\r
+              - `pretty ASCII format for 2t2c <../../_static/vpp/performance-changes-pdr-2t2c-full.txt>`_,\r
+              - `pretty ASCII format for 4t4c <../../_static/vpp/performance-changes-pdr-4t4c-full.txt>`_.\r
+\r
+Measured improvements are in line with VPP code optimizations listed in\r
+`VPP-17.10 release notes\r
+<https://docs.fd.io/vpp/17.10/release_notes_1710.html>`_.\r
 \r
 Known Issues\r
 ------------\r
 \r
 Known Issues\r
 ------------\r
@@ -214,4 +231,3 @@ Here is the list of known issues in CSIT |release| for VPP performance tests:
 | 4 | Lower than expected NDR throughput with         | CSIT-569   | Suspected NIC firmware or DPDK driver issue affecting NDR and   |\r
 |   | xl710 and x710 NICs, compared to x520 NICs.     |            | PDR throughput. Applies to XL710 and X710 NICs.                 |\r
 +---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
 | 4 | Lower than expected NDR throughput with         | CSIT-569   | Suspected NIC firmware or DPDK driver issue affecting NDR and   |\r
 |   | xl710 and x710 NICs, compared to x520 NICs.     |            | PDR throughput. Applies to XL710 and X710 NICs.                 |\r
 +---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-\r