report: update to vpp performance release notes
[csit.git] / docs / report / vpp_performance_tests / csit_release_notes.rst
index 58f0cc2..4f986eb 100644 (file)
-CSIT Release Notes\r
-==================\r
-\r
-Changes in CSIT |release|\r
--------------------------\r
-\r
-#. **VPP performance tests**\r
-\r
-   - *MRR tests* - New Maximum Receive Rate tests measure the packet\r
-     forwarding rate under the maximum load offered by traffic\r
-     generator over a set trial duration, regardless of packet loss.\r
-     MRR tests are used for continuous performance trending and for\r
-     comparison between releases.\r
-\r
-   - *Service Chaining with SRv6* - New SRv6 (Segment Routing IPv6) proxy\r
-     tests measure performance of SRv6 Endpoint fronting SR-unaware\r
-     appliance via masquerading (End.AM), dynamic proxy (End.AD) or\r
-     static proxy (End.AS) SR functions.\r
-\r
-#. **Presentation and Analytics Layer**\r
-\r
-   - *Performance trending* - Added continuous performance trending and\r
-     analysis. New Performance Trending and Performance Analysis jobs\r
-     executed regular throughput tests, with results being subsequently\r
-     analysed and trend and anomalies summarized and presented in VPP\r
-     Performance Dashboard and trendline graphs.\r
-\r
-#. **Test Framework Optimizations**\r
-\r
-   - *Performance tests efficiency* - Qemu build/install optimizations,\r
-     warmup phase handling, vpp restart handling. Resulted in improved\r
-     stability and reduced total execution time by 30% for single pkt\r
-     size e.g. 64B/78B.\r
-\r
-   - *General code housekeeping* - ongoing RF keywords optimizations,\r
-     removal of redundant RF keywords.\r
-\r
-Performance Changes\r
--------------------\r
-\r
-Relative performance changes in measured packet throughput in CSIT\r
-|release| are calculated against the results from CSIT |release-1|\r
-report. Listed mean and standard deviation values are computed based on\r
-a series of the same tests executed against respective VPP releases to\r
-verify test results repeatibility, with percentage change calculated for\r
-mean values. Note that the standard deviation is quite high for a small\r
-number of packet throughput tests, what indicates poor test results\r
-repeatability and makes the relative change of mean throughput value not\r
-fully representative for these tests. The root causes behind poor\r
-results repeatibility vary between the test cases.\r
-\r
-NDR Changes\r
-~~~~~~~~~~~\r
-\r
-NDR small packet throughput changes between releases are available in a\r
-CSV and pretty ASCII formats:\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
-  - `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
-\r
-.. note::\r
-\r
-    Test results have been generated by\r
-    `FD.io test executor vpp performance jobs`_ with Robot Framework result\r
-    files csit-vpp-perf-|srelease|-\*.zip `archived here <../../_static/archive/>`_.\r
-\r
-PDR Changes\r
-~~~~~~~~~~~\r
-\r
-NDR small packet throughput changes between releases are available in a\r
-CSV and pretty 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
-  - `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
-\r
-.. note::\r
-\r
-    Test results have been generated by\r
-    `FD.io test executor vpp performance jobs`_ with Robot Framework result\r
-    files csit-vpp-perf-|srelease|-\*.zip `archived here <../../_static/archive/>`_.\r
-\r
-MRR Changes\r
-~~~~~~~~~~~\r
-\r
-MRR small packet throughput changes between releases are available in a\r
-CSV and pretty ASCII formats:\r
-\r
-  - `csv format for 1t1c <../_static/vpp/performance-changes-mrr-1t1c-full.csv>`_,\r
-  - `csv format for 2t2c <../_static/vpp/performance-changes-mrr-2t2c-full.csv>`_,\r
-  - `csv format for 4t4c <../_static/vpp/performance-changes-mrr-4t4c-full.csv>`_,\r
-  - `pretty ASCII format for 1t1c <../_static/vpp/performance-changes-mrr-1t1c-full.txt>`_,\r
-  - `pretty ASCII format for 2t2c <../_static/vpp/performance-changes-mrr-2t2c-full.txt>`_,\r
-  - `pretty ASCII format for 4t4c <../_static/vpp/performance-changes-mrr-4t4c-full.txt>`_.\r
-\r
-.. note::\r
-\r
-    Test results have been generated by\r
-    `FD.io test executor vpp mrr jobs <https://jenkins.fd.io/view/csit/job/csit-vpp-perf-mrr-daily-master/>`_\r
-    with Robot Framework result files csit-vpp-perf-mrr-daily-master__*__output.xml.gz\r
-    `archived here <https://docs.fd.io/csit/master/trending/_static/archive/>`_.\r
-\r
-Throughput Trending\r
--------------------\r
-\r
-In addition to reporting throughput changes between VPP releases, CSIT\r
-provides continuous performance trending for VPP master branch:\r
-\r
-#. `VPP Performance Dashboard <https://docs.fd.io/csit/master/trending/introduction/index.html>`_\r
-   - per VPP test case throughput trend, trend compliance and summary of\r
-   detected anomalies.\r
-\r
-#. `Trending Methodology <https://docs.fd.io/csit/master/trending/methodology/index.html>`_\r
-   - throughput test metrics, trend calculations and anomaly\r
-   classification (progression, regression, outlier).\r
-\r
-#. `Trendline Graphs <https://docs.fd.io/csit/master/trending/trending/index.html>`_\r
-   - per VPP build MRR throughput measurements against the trendline\r
-   with anomaly highlights, with associated CSIT test jobs.\r
-\r
-Known Issues\r
-------------\r
-\r
-List of known issues in CSIT |release| for VPP performance tests:\r
-\r
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-| # | Issue                                           | Jira ID    | Description                                                     |\r
-+===+=================================================+============+=================================================================+\r
-| 1 | Sporadic (1 in 200) NDR discovery test failures | CSIT-570   | DPDK reporting rx-errors, indicating L1 issue. Suspected issue  |\r
-|   | on x520.                                        |            | with HW combination of X710-X520 in LF testbeds. Not observed   |\r
-|   |                                                 |            | outside of LF testbeds.                                         |\r
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-| 2 | Lower than expected NDR throughput of DPDK      | CSIT-571   | Suspected NIC firmware or DPDK driver issue affecting NDR and   |\r
-|   | testpmd and VPP L2 path NDR throughput with     |            | PDR throughput on XL710 and X710 NICs.                          |\r
-|   | xl710 and x710 NICs, compared to x520 NICs.     |            |                                                                 |\r
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-| 3 | Tagged Ethernet dot1q and dot1ad L2 path        | CSIT-1066  | Tagged Ethernet dot1q and dot1ad L2 path throughput regression: |\r
-|   | throughput regression.                          |            | NDR -2%..-5%, PDR -2%..-6%, MRR. Affects l2xc and l2bd          |\r
-|   |                                                 |            | performance tests.                                              |\r
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-| 4 | IPSec (software, no QAT HW) throughput          | CSIT-1064  | IPSec throughput regression: NDR -3%..-8%, PDR -2%..-8%, MRR    |\r
-|   | regression.                                     |            | -3%..-7%. Affects IPSec SW tests, QAT HW tests not affected.    |\r
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-| 5 | High failure rate of creating working container | CSIT-1065  | About 20% of orchestrated container topology tests failing data |\r
-|   | topologies with K8s/Ligato orchestration.       |            | plane verification indicating configuration issue. Suspected    |\r
-|   |                                                 |            | issue with Ligato vpp-agent.                                    |\r
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
+.. _vpp_performance_tests_release_notes:
+
+Release Notes
+=============
+
+Changes in |csit-release|
+-------------------------
+
+#. VPP PERFORMANCE TESTS
+
+   - **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`.
+
+   - **AWS EC2 c5n**: Performance test data for AWS c5n instances has
+     been added to report for ip4, ip6 and ipsec tests.
+
+   - **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
+
+   - **CSIT test environment** version has been updated to ver. 8, see
+     :ref:`test_environment_versioning`.
+
+   - **CSIT in AWS environment**: Completed CSIT automation support for
+     AWS c5n instances environment, including weekly performance 
+     trending tests execution.
+
+   - **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.
+
+   - **General Code Housekeeping**: Ongoing code optimizations and bug
+     fixes.
+
+#. PRESENTATION AND ANALYTICS LAYER
+
+   - **Graphs improvements**: Updated Packet Latency graphs,
+     see :ref:`latency_methodology`.
+
+.. raw:: latex
+
+    \clearpage
+
+.. _vpp_known_issues:
+
+Known Issues
+------------
+
+List of known issues in |csit-release| for VPP performance tests:
+
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| #  | 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>`_  |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+