Report 2005: Add pdf version
[csit.git] / docs / report / vpp_performance_tests / csit_release_notes.rst
index a54d25b..94e8bde 100644 (file)
@@ -6,83 +6,30 @@ 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:`performance_test_methodology` section
-     for more details.
+   - CSIT test environment is versioned, see
+     :ref:`test_environment_versioning`.
 
-   - **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.
-
-   - **VM Vhost Virtio Params Combinations**: Added performance tests
-     for VM vhost with different virtio parameters combinations:
-     indirect buffers, mergeable buffers.
-
-   - **K8s/Ligato in Trending**: Added K8s/Ligato Container memif tests
-     to daily trending.
+   - To identify performance changes due to VPP code changes from
+     v20.01.0 to v20.05.0, both have been tested in CSIT environment
+     ver. 4 and compared against each other. All substantial
+     progressions has been marked up with RCA analysis. See
+     :ref:`vpp_compare_current_vs_previous_release` and
+     :ref:`vpp_known_issues`.
 
 #. 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:`performance_test_methodology` section for more details.
-
-   - **Trending Tests BMRR**: Used new Burst MRR (BMRR) tests for daily
-     trending.
-
-   - **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.
-
-   - **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").
+   - **CSIT PAPI support**: Due to issues with PAPI performance, VAT is
+     still used in CSIT for all VPP scale tests. See known issues below.
 
    - **General Code Housekeeping**: Ongoing RF keywords optimizations,
-     removal of redundant RF keywords.
+     removal of redundant RF keywords and aligning of suite/test
+     setup/teardowns.
 
 #. PRESENTATION AND ANALYTICS LAYER
 
-   - **Graphs Layout Improvements**: Improved performance graphs layout
+   - **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.
+     labels, descriptions, other informative decoration.
 
 .. raw:: latex
 
@@ -95,22 +42,78 @@ 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-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 | `VPP-662                                | 9000B packets not supported by NICs VIC1227 and VIC1387.                                                  |
+|    | <https://jira.fd.io/browse/VPP-662>`_   |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+|  3 | `VPP-1677                               | 9000B ip4 nat44: VPP crash + coredump.                                                                    |
+|    | <https://jira.fd.io/browse/VPP-1677>`_  | VPP crashes very often in case that NAT44 is configured and it has to process IP4 jumbo frames (9000B).   |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+|  4 | `CSIT-1591                              | 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-1499>`_ | longer to program VPP). This needs to be addressed on the PAPI side.                                      |
+|    +-----------------------------------------+                                                                                                           |
+|    | `VPP-1763                               |                                                                                                           |
+|    | <https://jira.fd.io/browse/VPP-1763>`_  |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+|  5 | `VPP-1675                               | IPv4 IPSEC 9000B packet tests are failing as no packet is forwarded.                                      |
+|    | <https://jira.fd.io/browse/VPP-1675>`_  | Reason: chained buffers are not supported.                                                                |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+|  6 | `CSIT-1593                              | IPv4 AVF 9000B packet tests are failing on 3n-skx while passing on 2n-skx.                                |
+|    | <https://jira.fd.io/browse/CSIT-1593>`_ |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+|  7 | `CSIT-1679                              | 2n-clx VPP ip4 tests with xxv710 and avf driver are sporadically failing.                                 |
+|    | <https://jira.fd.io/browse/CSIT-1679>`_ |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+
+Root Cause Analysis for Performance Changes
+-------------------------------------------
+
+List of RCAs in |csit-release| for VPP performance changes:
+
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| #  | JiraID                                  | Issue Description                                                                                         |
++====+=========================================+===========================================================================================================+
+|  1 | `CSIT-1731                              | Confirm the cause for ip4scale -rnd regressions.                                                          |
+|    | <https://jira.fd.io/browse/CSIT-1731>`_ |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+|  2 | `CSIT-1735                              | Identify cause of ethip6-ip6scale2m progression.                                                          |
+|    | <https://jira.fd.io/browse/CSIT-1735>`_ |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+|  3 | `CSIT-1738                              | Identify cause for vppl2xc CSIT progressions.                                                             |
+|    | <https://jira.fd.io/browse/CSIT-1738>`_ |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+|  4 | `CSIT-1739                              | Identify cause of ACL regressions.                                                                        |
+|    | <https://jira.fd.io/browse/CSIT-1739>`_ |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+|  5 | `CSIT-1740                              | Identify cause for avf-eth-l2xcbase CSIT progression.                                                     |
+|    | <https://jira.fd.io/browse/CSIT-1740>`_ |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+|  6 | `CSIT-1741                              | Identify cause for vppl2xc VPP regressions.                                                               |
+|    | <https://jira.fd.io/browse/CSIT-1741>`_ |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+|  7 | `CSIT-1742                              | Identify cause of ipsec CSIT regression.                                                                  |
+|    | <https://jira.fd.io/browse/CSIT-1742>`_ |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+|  8 | `CSIT-1744                              | Identify cause of memif VPP progression.                                                                  |
+|    | <https://jira.fd.io/browse/CSIT-1744>`_ |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+|  9 | `CSIT-1745                              | Verify cause of l2bdscale10kmaclrn VPP progression.                                                       |
+|    | <https://jira.fd.io/browse/CSIT-1745>`_ |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| 10 | `CSIT-1746                              | Identify cause for avf-dot1q-ip6base VPP progression.                                                     |
+|    | <https://jira.fd.io/browse/CSIT-1746>`_ |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| 11 | `CSIT-1747                              | Identify cause of ip4base-nat44 VPP progression.                                                          |
+|    | <https://jira.fd.io/browse/CSIT-1747>`_ |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| 12 | `CSIT-1748                              | Identify cause of aes128cbc-hmac512sha VPP progression.                                                   |
+|    | <https://jira.fd.io/browse/CSIT-1748>`_ |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| 13 | `CSIT-1749                              | Identify cause for l2bdbasemaclrn VPP progression in tests with dpdk app in VM.                           |
+|    | <https://jira.fd.io/browse/CSIT-1749>`_ |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+