report: add 2n-icx and 3n-icx testbed documentation
[csit.git] / docs / report / vpp_performance_tests / csit_release_notes.rst
index a96a4f4..a077791 100644 (file)
@@ -1,3 +1,5 @@
+.. _vpp_performance_tests_release_notes:
+
 Release Notes
 =============
 
@@ -6,50 +8,39 @@ Changes in |csit-release|
 
 #. VPP PERFORMANCE TESTS
 
-   - **Service density 2n-skx tests**: Added higher NF density tests with two
-     NFs' data-plane threads sharing a physical core. VPP IPv4 routing is now 
-     used as a VNF payload similar to CNF tests.
-
-   - **Soak Tests**: Optimized performamce soak tests framework
-     code for extended time duration tests and throughput discovery
-     at given PLR and at give total test time e.g. minutes, hours,
-     days, weeks. See updated
-     :ref:`test_methodology` section for more details.
+   - CSIT test environment is versioned, see
+     :ref:`test_environment_versioning`.
 
-#. TEST FRAMEWORK
+   - **Upgrade to Ubuntu 20.04 LTS**: Reinstall base operating system to
+     Ubuntu 20.04.2 LTS. Upgrade includes also baseline Docker
+     containers used for spawning topology.
 
-   - **Qemu code refactor**: Complete code refactor of the key components of
-     QemuUtil.py and QemuManager.py (L1 and L2 KW counterparts). Added
-     implementation of kernel-image-kvm based VM replacing the previously used
-     NestedVM images. Added ability to run VPP as a payload in VNF.
+   - Initial test data for Intel Xeon Ice Lake platforms. Current
+     CSIT-2106 report data for Intel Xeon Ice Lake comes from an
+     external source (Intel labs running CSIT code on 8360Y D Stepping
+     and 6338N processors). For detail about the physical setup
+     see :ref:`tested_physical_topologies`. Tested VPP and CSIT
+     versions are pre-release, VPP 21.06-rc0~779-gd640ae52f.
 
-   - **CSIT PAPI Support**: Continued conversion of CSIT VAT L1 keywords to 
-     PAPI L1 KWs in CSIT using VPP Python bindings. Redesign of key components
-     of PAPI Executor and PAPI history.
+   - **AF_XDP**: Added af_xdp driver testing for all testcases.
 
-   - **General Code Housekeeping**: Ongoing RF keywords optimizations,
-     removal of redundant RF keywords.
+   - **GTPU tunnel**: Added GTPU HW Offload IPv4 routing tests.
 
-   - **Test suite generator**: Added capability to generate suites for
-     different NIC models as well as throughput search algorithm types. Uses
-     base tests suites as source.
+   - **Telemetry retouch**: Redesign telemetry retrieval from DUT.
+     Include VPP perfmon plugin telemetry.
 
-   - **TOX verification**: Added verifications for test suite generator.
+#. TEST FRAMEWORK
 
-#. PRESENTATION AND ANALYTICS LAYER
+   - **CSIT PAPI support**: Due to issues with PAPI performance, VAT is
+     still used in CSIT for all VPP scale tests. See known issues below.
 
-   - **Graphs Layout Improvements**: Improved performance graphs layout
-     for better readibility and maintenance: test grouping, axis
-     labels, descriptions, other informative decoration.
+   - **General Code Housekeeping**: Ongoing code optimizations,
+     speed ups and bug fixes.
 
-#. MISCELLANEOUS
+#. PRESENTATION AND ANALYTICS LAYER
 
-   - **2n-dnv Tests (3rd Party)**: Published performance tests for 2n-
-     dnv (2-Node Atom Denverton) from 3rd party testbeds running FD.io
-     |csit-release| automated testing code.
-     Only graphs for Packet Throughput and Speedup Multi-core and not
-     for Packet Latency were published as there are no results for Packet
-     Latency available.
+   - **Graphs improvements**: Updated Packet Latency graphs,
+     see :ref:`latency_methodology`.
 
 .. raw:: latex
 
@@ -62,12 +53,30 @@ Known Issues
 
 List of known issues in |csit-release| for VPP performance tests:
 
-+----+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-| #  | JiraID                                  | Issue Description                                                                                                               |
-+====+=========================================+=================================================================================================================================+
-| 1  | `CSIT-570                               | Sporadic (1 in 200) NDR discovery test failures on x520. DPDK reporting rx-errors, indicating L1 issue.                         |
-|    | <https://jira.fd.io/browse/CSIT-570>`_  | Suspected issue with HW combination of X710-X520 in LF testbeds. Not observed outside of LF testbeds.                           |
-+----+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-| 2  | `CSIT-????                              | IPSecHW interface AES-128-CBC tests failing due to traffic not passing.                                                             |
-|    | <https://jira.fd.io/browse/CSIT-????>`_ |                                                                                                                                 |
-+----+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| #  | JiraID                                  | Issue Description                                                                                         |
++====+=========================================+===========================================================================================================+
+|  1 | `CSIT-1782                              | Multicore AVF tests are failing when trying to create interface.                                          |
+|    | <https://jira.fd.io/browse/CSIT-1782>`_ |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+|  2 | `CSIT-1763                              | Adapt ramp-up phase of nat44 tests for different frame sizes.                                             |
+|    | <https://jira.fd.io/browse/CSIT-1763>`_ | Currently ramp-up phase rate and duration values are correctly set for tests with 64B frame size.         |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+|  3 | `CSIT-1671                              | All CSIT scale tests can not use PAPI due to much slower performance compared to VAT/CLI (it takes much   |
+|    | <https://jira.fd.io/browse/CSIT-1671>`_ | longer to program VPP). This needs to be addressed on the PAPI side.                                      |
+|    +-----------------------------------------+ The usual PAPI library spends too much time parsing arguments, so even with async processing (hundreds of |
+|    | `VPP-1763                               | commands in flight over socket), the VPP configuration for large scale tests (millions of messages) takes |
+|    | <https://jira.fd.io/browse/VPP-1763>`_  | too long.                                                                                                 |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+
+Root Cause Analysis for Performance Changes
+-------------------------------------------
+
+List of RCAs in |csit-release| for VPP performance changes:
+
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| #  | JiraID                                  | Issue Description                                                                                         |
++====+=========================================+===========================================================================================================+
+|  1 | `VPP-1972                               | One VPP change has decreased performance of NAT44ed processing, both slow path and fast path.             |
+|    | <https://jira.fd.io/browse/VPP-1972>`_  |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+