CSIT-1430 Update release notes
[csit.git] / docs / report / vpp_performance_tests / csit_release_notes.rst
index 6ac7fcd..50dce62 100644 (file)
@@ -4,217 +4,78 @@ 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.
+   - **Service density 2n-skx tests**: Network Function Virtualization (NFV)
+     service density tests focus on measuring total per server throughput at
+     varied NFV service *packing* densities with vswitch providing host
+     dataplane. The goal is to compare and contrast performance of a shared
+     vswitch for different network topologies and virtualization technologies,
+     and their impact on vswitch performance and efficiency in a range of NFV
+     service configurations.
 
-   - *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.
+   - **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.
 
-   - *L2patch tests* - Tests measure performance of L2patch, cross linking
-     RX and TX of two physical interfaces.
+#. TEST FRAMEWORK
 
-   - *2-node tests* - Baseline set of 2-node tests covering base ip4, ip6,
-     l2patch, l2bd, l2xc.
+   - **Container code optimizations**: Optimized container library allows to
+     run containre_memif tests faster.
 
-   - *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.
+   - **CSIT PAPI Support**: Continue converting existing VAT L1 keywords to
+     PAPI L1 KWs in CSIT using VPP Python bindings. Required for migrating away
+     from VAT.
 
-   - *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
-     configuration.
-
-   - *Intel Skylake* - Topologies consisting of 2-node and 3-node using
-     SuperMirco servers each equipped 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.
-
-#. **Test Framework Optimizations**
-
-   - *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
-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
-results repeatability vary between the test cases.
-
-NDR Changes
-~~~~~~~~~~~
-
-NDR throughput changes between releases are available in a
-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>`_.
-
-.. note::
-
-    Test results have been generated by
-    `FD.io test executor vpp performance job 3n-hsw`_,
-    with Robot Framework 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:
-
-  - `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>`_.
-
-.. note::
-
-    Test results have been generated by
-    `FD.io test executor vpp performance job 3n-hsw`_,
-    with Robot Framework 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:
-
-  - `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>`_.
-
-.. note::
-
-    Test results have been generated by
-    `FD.io test executor vpp performance job 3n-hsw`_,
-    with Robot Framework result
-    files csit-vpp-perf-|srelease|-\*.zip
-    `archived here <../_static/archive/>`_.
-
-Comparison Across Testbeds
---------------------------
-
-Relative performance changes in measured packet throughputon 3-Node Skx testbed
-are calculated against the results measured on 3-Node Hsw testbed.
-
-NDR Changes
-~~~~~~~~~~~
-
-NDR changes between testbeds are available in a
-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>`_.
-
-.. 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
-    files csit-vpp-perf-|srelease|-\*.zip
-    `archived here <../_static/archive/>`_.
-
-PDR Changes
-~~~~~~~~~~~
-
-PDR throughput changes between testbeds are available in a
-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>`_.
-
-.. 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
-    files csit-vpp-perf-|srelease|-\*.zip
-    `archived here <../_static/archive/>`_.
-
-MRR Changes
-~~~~~~~~~~~
-
-MRR throughput changes between testbeds are available in a
-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>`_.
-
-.. note::
+#. PRESENTATION AND ANALYTICS LAYER
 
-    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
-    files csit-vpp-perf-|srelease|-\*.zip
-    `archived here <../_static/archive/>`_.
+   - **Graphs Layout Improvements**: Improved performance graphs layout
+     for better readibility and maintenance: test grouping, axis
+     labels, descriptions, other informative decoration.
 
-Throughput Trending
--------------------
+#. MISCELLANEOUS
 
-In addition to reporting throughput changes between VPP releases, CSIT
-provides continuous performance trending for VPP master branch:
+   - **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.
 
-#. `VPP Performance Dashboard <https://docs.fd.io/csit/master/trending/introduction/index.html>`_
-   - per VPP test case throughput trend, trend compliance and summary of
-   detected anomalies.
+.. raw:: latex
 
-#. `Trending Methodology <https://docs.fd.io/csit/master/trending/methodology/index.html>`_
-   - throughput test metrics, trend calculations and anomaly
-   classification (progression, regression, outlier).
+    \clearpage
 
-#. `Trendline Graphs <https://docs.fd.io/csit/master/trending/trending/index.html>`_
-   - per VPP build MRR throughput measurements against the trendline
-   with anomaly highlights, with associated CSIT test jobs.
+.. _vpp_known_issues:
 
 Known Issues
 ------------
 
 List of known issues in |csit-release| for VPP performance tests:
 
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+
-| # | Issue                                           | Jira ID    | Description                                                     |
-+===+=================================================+============+=================================================================+
-| 1 | Sporadic (1 in 200) NDR discovery test failures | CSIT-570   | DPDK reporting rx-errors, indicating L1 issue. Suspected issue  |
-|   | on x520.                                        |            | with HW combination of X710-X520 in LF testbeds. Not observed   |
-|   |                                                 |            | outside of LF testbeds.                                         |
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+
-| 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.         |
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+
-| 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.   |
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+
++----+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+| #  | 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-1562                               | Link bonding (mode LACP, transmit policy l34) test are failing due to VPP crashing producing core dump.                         |
+|    | <https://jira.fd.io/browse/VPP-1562>`_  |                                                                                                                                 |
++----+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+| 3  | `CSIT-1427                              | Scale HW IPsec are failing due to issue with selecting ipsec backend in VPP.                                                    |
+|    | <https://jira.fd.io/browse/CSIT-1427>`_ |                                                                                                                                 |
++----+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+| 4  | `VPP-1563                               | AVF L2patch tests are failing for all packet size and core combination. Reason: null-node blackholed packets in show error.     |
+|    | <https://jira.fd.io/browse/VPP-1563>`_  |                                                                                                                                 |
++----+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+| 5  | `CSIT-1234                              | VPP IPSecHW/IPSecsW scale interface mode, low NDR and PDR 64B throughput in 3n-hsw testbeds, in CSIT-19.01 vs. CSIT-18.10.      |
+|    | <https://jira.fd.io/browse/CSIT-1234>`_ |                                                                                                                                 |
++----+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+| 6  | `CSIT-1428                              | VM vhost tests with RXQ more than 2 are failing on 3n-skx. Suspecting RXQ configuration issues.                                 |
+|    | <https://jira.fd.io/browse/CSIT-1428>`_ |                                                                                                                                 |
++----+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+