report 1807: list and table formatting fixes.
[csit.git] / docs / report / vpp_performance_tests / csit_release_notes.rst
index 90058d3..f6887e1 100644 (file)
@@ -4,64 +4,69 @@ Release Notes
 Changes in |csit-release|
 -------------------------
 
-#. **VPP performance tests**
+#. **VPP Performance Tests**
 
-   - *MRR tests* - Maximum Receive Rate tests measure the packet forwarding rate
-     under the maximum load offered by traffic generator over a set trial
-     duration, regardless of packet loss. MRR tests are used for continuous
-     performance trending and for comparison between releases.
+   - **MRR Throughput**: MRR (Maximum Receive Rate) test code has now
+     configurable trial duration and number of consecutive executions.
+     Coverage of MRR tests has been extended across more test
+     scenarios. MRR tests are used for continuous performance trending
+     and for comparison between VPP releases.
 
-   - *MLR tests* - NDR and PDR tests measure the packet forwarding rate using
-     MLRsearch library by traffic generator. All tests that previously used
-     binary search were converted to MLRsearch.
+   - **MLRsearch Throughput**: MLRsearch algorithm has been introduced
+     for all NDR and PDR throughput tests. All tests that previously
+     used binary search got converted to MLRsearch. Coverage of NDR/PDR
+     tests has been extended across more test scenarios.
 
-   - *L2patch tests* - Tests measure performance of L2patch, cross linking
+   - **L2patch Tests**: Tests measure performance of VPP L2patch, the
+     fastest L2 forwarding path implemented in VPP, that cross-links
      RX and TX of two physical interfaces.
 
-   - *2-node tests* - Baseline set of 2-node tests covering base ip4, ip4,
-     l2patch, l2bd, l2xc.
-
-   - *Generated tests* - Simplified and unified test structure,
-     semi-autogenerated by generator script. Test generator is currently able
-     to create test combinations with various frame size and cores combinations.
-     All existing test cases were converted to new format.
-
-   - *Simultaneous multithreading* - SMT-aware automatic detection and
-     resource configuration including thread affinity, number of rx queues and
-     DPDK I/O mbufs. Tests are automatically tagged during execution indicating
+   - **2-Node Tests**: A new baseline set of 2-node tests covering base
+     ip4, ip6, l2patch, l2bd, l2xc, running on new Xeon Skylake
+     testbeds.
+
+   - **Generated tests**: Simplified and unified test structure, semi-
+     autogenerated by generator script. Test generator is currently
+     able to create test combinations with various frame size and
+     cores combinations. All existing test cases were converted to new
+     format.
+
+   - **Simultaneous Multi-Threading**: SMT-aware detection of server
+     processor operation mode (HyperThreading enabled/disabled) with
+     associated compute resource configuration including thread
+     affinity, number of Rx queues and DPDK I/O mbufs. Tests are
+     automatically tagged during execution to indicate executed thread
      configuration.
 
-  - *Intel Skylake* - Topologies consisting of 2-node and 3-node using
-    SuperMirco servers each equipped with two Intel Xeon Skylake Platinum
-    processors.
+   - **Intel Xeon Skylake Support**: Support for 2-Node and 3-Node
+     physical testbed topologies based on the new SuperMirco servers
+     each with two Intel Xeon Skylake Platinum processors. Full
+     Ansible playbooks refactor for quick server (re)installation and
+     reference pointers of configuration.
 
 #. **Presentation and Analytics Layer**
 
-   - *Performance trending* - Added continuous performance trending and
-     analysis. New Performance Trending and Performance Analysis jobs
-     executed regular throughput tests, with results being subsequently
-     analysed and trend and anomalies summarized and presented in VPP
-     Performance Dashboard and trendline graphs.
+   - **Performance trending**: Further improved continuous performance
+     trending with anomaly detection and analysis.
 
 #. **Test Framework Optimizations**
 
-   - *Performance tests efficiency* - Qemu build/install optimizations,
-     warmup phase handling, vpp restart handling. Resulted in improved
-     stability and reduced total execution time by 30% for single pkt
-     size e.g. 64B/78B.
-
-   - *General code housekeeping* - ongoing RF keywords optimizations,
+   - **General Code Housekeeping**: Ongoing RF keywords optimizations,
      removal of redundant RF keywords.
 
 Performance Changes
 -------------------
 
-Relative performance changes in measured packet throughput in |csit-release|
-are calculated against the results from |csit-release-1|
-report. Listed mean and standard deviation values are computed based on
-a series of the same tests executed against respective VPP releases to
-verify test results repeatability, with percentage change calculated for
-mean values. Note that the standard deviation is quite high for a small
+Relative performance changes in measured NDR, PDR and MRR packet
+throughput in |csit-release| are calculated against the test results
+from |csit-release-1| report, for tests running on 3-Node Intel Xeon
+Haswell testbeds (3n-hsw) in 1-core, 2-core and 4-core (MRR only)
+configurations.
+
+Listed mean and standard deviation values are computed based on a series
+of the same tests executed against respective VPP releases to verify
+test results repeatability, with percentage change calculated for mean
+values. Note that the standard deviation is quite high for a small
 number of packet throughput tests, what indicates poor test results
 repeatability and makes the relative change of mean throughput value not
 fully representative for these tests. The root causes behind poor
@@ -70,119 +75,121 @@ results repeatability vary between the test cases.
 NDR Changes
 ~~~~~~~~~~~
 
-NDR throughput changes between releases are available in a
-CSV and pretty ASCII formats:
+NDR throughput changes between releases are available in CSV and pretty
+ASCII formats:
 
-  - `csv format for 1t1c <../_static/vpp/performance-changes-1t1c-ndr.csv>`_,
-  - `csv format for 2t2c <../_static/vpp/performance-changes-2t2c-ndr.csv>`_,
-  - `pretty ASCII format for 1t1c <../_static/vpp/performance-changes-1t1c-ndr.txt>`_,
-  - `pretty ASCII format for 2t2c <../_static/vpp/performance-changes-2t2c-ndr.txt>`_.
+  - `CSV 1t1c NDR changes <../_static/vpp/performance-changes-1t1c-ndr.csv>`_,
+  - `CSV 2t2c NDR changes <../_static/vpp/performance-changes-2t2c-ndr.csv>`_,
+  - `ASCII 1t1c NDR changes <../_static/vpp/performance-changes-1t1c-ndr.txt>`_,
+  - `ASCII 2t2c NDR changes <../_static/vpp/performance-changes-2t2c-ndr.txt>`_.
 
 .. note::
 
     Test results have been generated by
     `FD.io test executor vpp performance job 3n-hsw`_,
-    with Robot Framework result
+    with RF result
     files csit-vpp-perf-|srelease|-\*.zip
     `archived here <../_static/archive/>`_.
 
 PDR Changes
 ~~~~~~~~~~~
 
-PDR throughput changes between releases are available in a
-CSV and pretty ASCII formats:
+PDR throughput changes between releases are available in CSV and pretty
+ASCII formats:
 
-  - `csv format for 1t1c <../_static/vpp/performance-changes-1t1c-pdr.csv>`_,
-  - `csv format for 2t2c <../_static/vpp/performance-changes-2t2c-pdr.csv>`_,
-  - `pretty ASCII format for 1t1c <../_static/vpp/performance-changes-1t1c-pdr.txt>`_,
-  - `pretty ASCII format for 2t2c <../_static/vpp/performance-changes-2t2c-pdr.txt>`_.
+  - `CSV 1t1c PDR changes <../_static/vpp/performance-changes-1t1c-pdr.csv>`_,
+  - `CSV 2t2c PDR changes <../_static/vpp/performance-changes-2t2c-pdr.csv>`_,
+  - `ASCII 1t1c PDR changes <../_static/vpp/performance-changes-1t1c-pdr.txt>`_,
+  - `ASCII 2t2c PDR changes <../_static/vpp/performance-changes-2t2c-pdr.txt>`_.
 
 .. note::
 
     Test results have been generated by
     `FD.io test executor vpp performance job 3n-hsw`_,
-    with Robot Framework result
+    with RF result
     files csit-vpp-perf-|srelease|-\*.zip
     `archived here <../_static/archive/>`_.
 
 MRR Changes
 ~~~~~~~~~~~
 
-MRR small packet throughput changes between releases are available in a
-CSV and pretty ASCII formats:
+MRR throughput changes between releases are available in CSV and pretty
+ASCII formats:
 
-  - `csv format for 1t1c <../_static/vpp/performance-changes-1t1c-mrr.csv>`_,
-  - `csv format for 2t2c <../_static/vpp/performance-changes-2t2c-mrr.csv>`_,
-  - `csv format for 4t4c <../_static/vpp/performance-changes-4t4c-mrr.csv>`_,
-  - `pretty ASCII format for 1t1c <../_static/vpp/performance-changes-1t1c-mrr.txt>`_,
-  - `pretty ASCII format for 2t2c <../_static/vpp/performance-changes-2t2c-mrr.txt>`_,
-  - `pretty ASCII format for 4t4c <../_static/vpp/performance-changes-4t4c-mrr.txt>`_.
+  - `CSV 1t1c MRR changes <../_static/vpp/performance-changes-1t1c-mrr.csv>`_,
+  - `CSV 2t2c MRR changes <../_static/vpp/performance-changes-2t2c-mrr.csv>`_,
+  - `CSV 4t4c MRR changes <../_static/vpp/performance-changes-4t4c-mrr.csv>`_,
+  - `ASCII 1t1c MRR changes <../_static/vpp/performance-changes-1t1c-mrr.txt>`_,
+  - `ASCII 2t2c MRR changes <../_static/vpp/performance-changes-2t2c-mrr.txt>`_,
+  - `ASCII 4t4c MRR changes <../_static/vpp/performance-changes-4t4c-mrr.txt>`_.
 
 .. note::
 
     Test results have been generated by
     `FD.io test executor vpp performance job 3n-hsw`_,
-    with Robot Framework result
+    with RF result
     files csit-vpp-perf-|srelease|-\*.zip
     `archived here <../_static/archive/>`_.
 
-Comparison Across Testbeds
---------------------------
+Skx vs. Hsw Comparison
+----------------------
 
-Relative performance changes in measured packet throughputon 3-Node Skx testbed
-are calculated against the results measured on 3-Node Hsw testbed.
+Relative performance comparison in measured NDR, PDR and MRR packet
+throughput is calculated for tests executed on 3-Node Skylake (3n-skx)
+and 3-Node Haswell (3n-hsw) physical testbed types in 1-core
+configurations.
 
-NDR Changes
-~~~~~~~~~~~
+NDR Comparison
+~~~~~~~~~~~~~~
 
-NDR changes between testbeds are available in a
-CSV and pretty ASCII formats:
+NDR comparison between testbed types is available in CSV and pretty
+ASCII formats:
 
-  - `csv format for ndr <../_static/vpp/performance-compare-testbeds-3n-hsw-3n-skx-ndr.csv>`_,
-  - `pretty ASCII format for ndr <../_static/vpp/performance-compare-testbeds-3n-hsw-3n-skx-ndr.txt>`_.
+  - `CSV 1c NDR comparison <../_static/vpp/performance-compare-testbeds-3n-hsw-3n-skx-ndr.csv>`_,
+  - `ASCII 1c NDR comparison <../_static/vpp/performance-compare-testbeds-3n-hsw-3n-skx-ndr.txt>`_.
 
 .. note::
 
     Test results have been generated by
     `FD.io test executor vpp performance job 3n-hsw`_ and
     `FD.io test executor vpp performance job 3n-skx`_
-    with Robot Framework result
+    with RF result
     files csit-vpp-perf-|srelease|-\*.zip
     `archived here <../_static/archive/>`_.
 
-PDR Changes
-~~~~~~~~~~~
+PDR Comparison
+~~~~~~~~~~~~~~
 
-PDR throughput changes between testbeds are available in a
-CSV and pretty ASCII formats:
+PDR comparison between testbed types is available in CSV and pretty
+ASCII formats:
 
-  - `csv format for pdr <../_static/vpp/performance-compare-testbeds-3n-hsw-3n-skx-pdr.csv>`_,
-  - `pretty ASCII format for pdr <../_static/vpp/performance-compare-testbeds-3n-hsw-3n-skx-pdr.txt>`_.
+  - `CSV 1c PDR comparison <../_static/vpp/performance-compare-testbeds-3n-hsw-3n-skx-pdr.csv>`_,
+  - `ASCII 1c PDR comparison <../_static/vpp/performance-compare-testbeds-3n-hsw-3n-skx-pdr.txt>`_.
 
 .. note::
 
     Test results have been generated by
     `FD.io test executor vpp performance job 3n-hsw`_ and
     `FD.io test executor vpp performance job 3n-skx`_
-    with Robot Framework result
+    with RF result
     files csit-vpp-perf-|srelease|-\*.zip
     `archived here <../_static/archive/>`_.
 
-MRR Changes
-~~~~~~~~~~~
+MRR Comparison
+~~~~~~~~~~~~~~
 
-MRR throughput changes between testbeds are available in a
-CSV and pretty ASCII formats:
+MRR comparison between testbed types is available in CSV and pretty
+ASCII formats:
 
-  - `csv format for mrr <../_static/vpp/performance-compare-testbeds-3n-hsw-3n-skx-mrr.csv>`_,
-  - `pretty ASCII format for mrr <../_static/vpp/performance-compare-testbeds-3n-hsw-3n-skx-mrr.txt>`_.
+  - `CSV 1c MRR comparison <../_static/vpp/performance-compare-testbeds-3n-hsw-3n-skx-mrr.csv>`_,
+  - `ASCII 1c MRR comparison <../_static/vpp/performance-compare-testbeds-3n-hsw-3n-skx-mrr.txt>`_.
 
 .. note::
 
     Test results have been generated by
     `FD.io test executor vpp performance job 3n-hsw`_ and
     `FD.io test executor vpp performance job 3n-skx`_
-    with Robot Framework result
+    with RF result
     files csit-vpp-perf-|srelease|-\*.zip
     `archived here <../_static/archive/>`_.
 
@@ -216,14 +223,9 @@ List of known issues in |csit-release| for VPP performance tests:
 |   | on x520.                                        |            | with HW combination of X710-X520 in LF testbeds. Not observed   |
 |   |                                                 |            | outside of LF testbeds.                                         |
 +---+-------------------------------------------------+------------+-----------------------------------------------------------------+
-| 2 | Lower than expected NDR throughput of DPDK      | CSIT-571   | Suspected NIC firmware or DPDK driver issue affecting NDR and   |
-|   | testpmd and VPP L2 path NDR throughput with     |            | PDR throughput on XL710 and X710 NICs.                          |
-|   | xl710 and x710 NICs, compared to x520 NICs.     |            |                                                                 |
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+
-| 3 | Tagged Ethernet dot1q and dot1ad L2 path        | CSIT-1066  | Tagged Ethernet dot1q and dot1ad L2 path throughput regression: |
-|   | throughput regression.                          |            | NDR -2%..-5%, PDR -2%..-6%, MRR. Affects l2xc and l2bd          |
-|   |                                                 |            | performance tests.                                              |
+| 2 | High failure rate of api call                   | VPP-1361   | Failure rate: 30-40% of tests failing due to interfaces not     |
+|   | sw_interface_set_flags [admin-up|link-up]       |            | in link-up state after API call sw_interface_set_flags.         |
 +---+-------------------------------------------------+------------+-----------------------------------------------------------------+
-| 4 | IPSec (software, no QAT HW) throughput          | CSIT-1064  | IPSec throughput regression: NDR -3%..-8%, PDR -2%..-8%, MRR    |
-|   | regression.                                     |            | -3%..-7%. Affects IPSec SW tests, QAT HW tests not affected.    |
+| 3 | Scale IPSecHW Interface mode throughput         | CSIT-1234  | IPSec throughput regression: NDR -28%..-31%, PDR -28%..-31%,    |
+|   | regression.                                     |            | MRR -40%. Affects IPSec HW Scale 1000tnl tests with Int mode.   |
 +---+-------------------------------------------------+------------+-----------------------------------------------------------------+