report: update to vpp performance release notes
[csit.git] / docs / report / vpp_performance_tests / csit_release_notes.rst
index 5d87b85..4f986eb 100644 (file)
@@ -1,3 +1,5 @@
+.. _vpp_performance_tests_release_notes:
+
 Release Notes
 =============
 
@@ -6,82 +8,38 @@ Changes in |csit-release|
 
 #. VPP PERFORMANCE TESTS
 
-   - **BMRR Throughput**: MRR (Maximum Receive Rate) test code has been
-     updated with a configurable burst MRR parameters: trial duration
-     and number of trials in a single burst. Enables a new Burst MRR
-     (BMRR for short) methodology for more precise performance
-     trending. See updated :ref:`test_methodology` section
-     for more details.
-
-   - **2n-skx tests**: Added performamce tests for 2n-skx (2-Node Xeon
-     Skylake) testbeds: focus on baseline and scale tests, including
-     VM vhost and Container memif tests.
-
-   - **3n-skx tests**: Added performamce tests for 3n-skx (3-Node Xeon
-     Skylake) testbeds: VM vhost and Container memif tests.
-
-   - **VXLAN Scale Tests**: Added performamce tests for VXLAN scale with
-     dot1q and VPP L2BD.
-
-   - **AVF Driver Tests**: Added performamce tests for i40e AVF driver
-     on VPP, no DPDK required.
-
-   - **QAT**: Fixed reoccuring issues with QAT crypto accelerator cards.
+   - **Intel Xeon Ice Lake**: Performance test data for these platforms
+     continues to be provided by external Intel benchmarking labs
+     executing |csit-release| tests. For details about the physical
+     setup see :ref:`tested_physical_topologies`.
 
-   - **VM Vhost Virtio Params Combinations**: Added performance tests
-     for VM vhost with different virtio parameters combinations:
-     indirect buffers, mergeable buffers.
+   - **AWS EC2 c5n**: Performance test data for AWS c5n instances has
+     been added to report for ip4, ip6 and ipsec tests.
 
-   - **K8s/Ligato in Trending**: Added K8s/Ligato Container memif tests
-     to daily trending.
+   - **Reduction of tests**: Removed certain test variations executed
+     iteratively for the report (as well as in daily and weekly
+     trending) due to physical testbeds overload.
 
 #. TEST FRAMEWORK
 
-   - **Experimental Soak Tests**: Added 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, months, years. See updated
-     :ref:`test_methodology` section for more details.
+   - **CSIT test environment** version has been updated to ver. 8, see
+     :ref:`test_environment_versioning`.
 
-   - **Trending Tests BMRR**: Used new Burst MRR (BMRR) tests for daily
-     trending.
+   - **CSIT in AWS environment**: Completed CSIT automation support for
+     AWS c5n instances environment, including weekly performance 
+     trending tests execution.
 
-   - **Per VPP Patch Performance Checks**: Per VPP gerrit patch vs.
-     parent performance tests, anomaly detection and no verify voting
-     (-1/0/+1) yet. Manual trigger only. Not "marketed" to FD.io
-     community yet to avoid excessive LFN FD.io physical performance
-     testbed blocking.
+   - **CSIT PAPI support**: Due to issues with PAPI performance, and
+     deprecation of VAT, CLI is used in CSIT for many VPP scale tests.
+     See known issues below.
 
-   - **Patch-on-Patch Infra**: Added capability to run performance tests
-     using CSIT gerrit patch code testing VPP gerrit patch code, i.e.
-     before any VPP and/or CSIT code is merged into git branch.
-
-   - **CSIT PAPI Support**: Initial implementation of PAPI L1 KWs in
-     CSIT using VPP Python bindings. Required for migraing away from
-     VAT. Very few L1 KWs implemented ("show version", "show
-     interfaces").
-
-   - **General Code Housekeeping**: Ongoing RF keywords optimizations,
-     removal of redundant RF keywords.
+   - **General Code Housekeeping**: Ongoing code optimizations and bug
+     fixes.
 
 #. PRESENTATION AND ANALYTICS LAYER
 
-   - **Graphs Layout Improvements**: Improved performance graphs layout
-     for better readibility and maintenance: test grouping, axis
-     labels, descriptions, other informative decoration. Master report
-     generated. 744 graphs(!)
-
-   - **Performance Trending**: Further improvements of continuous
-     performance trending, anomaly detection and analysis.
-
-#. MISCELLANEOUS
-
-   - **3n-dnv Tests (3rd Party)**: Published performance tests for 3n-
-     dnv (3-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
 
@@ -94,22 +52,45 @@ 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-1234                              | VPP IPSecHW scale interface mode 1core, low NDR and PDR 64B throughput in 3n-hsw testbeds, in CSIT-18.07 vs. CSIT-18.04.        |
-|    | <https://jira.fd.io/browse/CSIT-1234>`_ | ip4ipsecscale1000tnl-ip4base-int 1core CSIT-18.07/18.04 relative change: NDR -31%, PDR -32%, MRR -38%.                          |
-+----+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-| 3  | `CSIT-1242                              | VPP xl710 ip4base test 1core, low NDR and PDR 64B throughput in 3n-hsw testbeds, in CSIT-18.07 vs. CSIT-18.04.                  |
-|    | <https://jira.fd.io/browse/CSIT-1242>`_ | xl710 ip4base 1core CSIT-18.07/18.04 relative change: NDR -29%, high stdev.                                                     |
-+----+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-| 4  | `CSIT-1243                              | VPP nat44 base test 2core, low NDR and PDR 64B throughput in 3n-skx testbeds, compared to 3n-hsw testbeds.                      |
-|    | <https://jira.fd.io/browse/CSIT-1243>`_ | ip4base-nat44 2core 3n-skx/3n-hsw relative change: NDR -19%, PDR -22%.                                                          |
-+----+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-| 5  | `CSIT-1246                              | Ligato K8S orchestrated tests are failing due to incompatibility of the latest released Ligato vpp-agent with VPP-18.07.        |
-|    | <https://jira.fd.io/browse/CSIT-1246>`_ | Past vpp-agent releases are not compatible either.                                                                              |
-+----+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| #  | JiraID                                  | Issue Description                                                                                         |
++====+=========================================+===========================================================================================================+
+|  1 | `CSIT-1782                              | Multicore AVF tests are failing when trying to create interface. The issue persists after FVL FW upgrade. |
+|    | <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.                                                                                                 |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+|  4 | `CSIT-1789                              | AVF driver does not perform RSS in a deterministic way.                                                   |
+|    | <https://jira.fd.io/browse/CSIT-1789>`_ | This increases standard deviation of tests with small number of flows (mainly ipsec).                     |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+|  5 | `CSIT-1780                              | IPSEC SW async scheduler MRR tests failing with no traffic forwarded.                                     |
+|    | <https://jira.fd.io/browse/CSIT-1780>`_ |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+|  6 | `CSIT-1786                              | IP4 and IP6 scale tests failing with no traffic forwarded.                                                |
+|    | <https://jira.fd.io/browse/CSIT-1786>`_ | Issue reported to VPP devs.                                                                               |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+|  7 | `CSIT-1785                              | NAT44ED tests failing to establish all TCP sessions.                                                      |
+|    | <https://jira.fd.io/browse/CSIT-1785>`_ |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+|  8 | `CSIT-1791                              | Performance regression in RDMA tests, due to CSIT environment changes.                                    |
+|    | <https://jira.fd.io/browse/CSIT-1791>`_ |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+
+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, mostly slow path.                         |
+|    | <https://jira.fd.io/browse/VPP-1972>`_  |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+