Release Notes
=============
-Changes in CSIT |release|
+Changes in |csit-release|
-------------------------
-#. **VPP performance tests**
+#. VPP PERFORMANCE TESTS
- - *MRR tests* - New 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.
+ - CSIT test environment is now versioned, with ver. 1 associated
+ with CSIT rls1908 git branch as of 2019-08-21, and ver. 2
+ associated with CSIT rls2001 and master git branches as of
+ 2020-03-27.
- - *Service Chaining with SRv6* - New SRv6 (Segment Routing IPv6) proxy
- tests measure performance of SRv6 Endpoint fronting SR-unaware
- appliance via masquerading (End.AM), dynamic proxy (End.AD) or
- static proxy (End.AS) SR functions.
+ - 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. 2 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`.
-#. **Presentation and Analytics Layer**
+#. TEST FRAMEWORK
- - *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.
+ - **CSIT PAPI support**: Due to issues with PAPI performance, VAT is
+ still used in CSIT for all VPP scale tests. See known issues below.
-#. **Test Framework Optimizations**
+ - **General Code Housekeeping**: Ongoing RF keywords optimizations,
+ removal of redundant RF keywords and aligning of suite/test
+ setup/teardowns.
- - *Performance tests efficiency* - Qemu build/install optimizations,
- warmup phase handling, vpp restart handling. Resulted in improved
- stability and reduced total execution time by 30% for single pkt
- size e.g. 64B/78B.
+#. PRESENTATION AND ANALYTICS LAYER
- - *General code housekeeping* - ongoing RF keywords optimizations,
- removal of redundant RF keywords.
+ - **Graphs layout improvements**: Improved performance graphs layout
+ for better readibility and maintenance: test grouping, axis
+ labels, descriptions, other informative decoration.
-Performance Changes
--------------------
+.. raw:: latex
-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 repeatibility, 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 repeatibility vary between the test cases.
+ \clearpage
-NDR Changes
-~~~~~~~~~~~
-
-NDR small packet throughput changes between releases are available in a
-CSV and pretty ASCII formats:
-
- - `csv format for 1t1c <../_static/vpp/performance-changes-ndr-1t1c-full.csv>`_,
- - `csv format for 2t2c <../_static/vpp/performance-changes-ndr-2t2c-full.csv>`_,
- - `pretty ASCII format for 1t1c <../_static/vpp/performance-changes-ndr-1t1c-full.txt>`_,
- - `pretty ASCII format for 2t2c <../_static/vpp/performance-changes-ndr-2t2c-full.txt>`_.
-
-.. note::
-
- Test results have been generated by
- `FD.io test executor vpp performance jobs`_ with Robot Framework result
- files csit-vpp-perf-|srelease|-\*.zip `archived here <../_static/archive/>`_.
-
-PDR Changes
-~~~~~~~~~~~
-
-NDR small packet throughput changes between releases are available in a
-CSV and pretty ASCII formats:
-
- - `csv format for 1t1c <../_static/vpp/performance-changes-pdr-1t1c-full.csv>`_,
- - `csv format for 2t2c <../_static/vpp/performance-changes-pdr-2t2c-full.csv>`_,
- - `pretty ASCII format for 1t1c <../_static/vpp/performance-changes-pdr-1t1c-full.txt>`_,
- - `pretty ASCII format for 2t2c <../_static/vpp/performance-changes-pdr-2t2c-full.txt>`_.
-
-.. note::
-
- Test results have been generated by
- `FD.io test executor vpp performance jobs`_ 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-mrr-1t1c-full.csv>`_,
- - `csv format for 2t2c <../_static/vpp/performance-changes-mrr-2t2c-full.csv>`_,
- - `csv format for 4t4c <../_static/vpp/performance-changes-mrr-4t4c-full.csv>`_,
- - `pretty ASCII format for 1t1c <../_static/vpp/performance-changes-mrr-1t1c-full.txt>`_,
- - `pretty ASCII format for 2t2c <../_static/vpp/performance-changes-mrr-2t2c-full.txt>`_,
- - `pretty ASCII format for 4t4c <../_static/vpp/performance-changes-mrr-4t4c-full.txt>`_.
-
-.. note::
-
- Test results have been generated by
- `FD.io test executor vpp mrr jobs <https://jenkins.fd.io/view/csit/job/csit-vpp-perf-mrr-daily-master/>`_
- with Robot Framework result files csit-vpp-perf-mrr-daily-master__*__output.xml.gz
- `archived here <https://docs.fd.io/csit/master/trending/_static/archive/>`_.
-
-Comparison Across Testbeds
---------------------------
-
-.. warning::
-
- TODO: Add:
-
- Table 1.
- Test Case 3-Node Hsw 3-Node Skx Skx vs. Hsw Delta [%]
-
- Table 2.
- Test Case 3-Node Skx 2-Node Skx 2-Node vs. 3-Node Delta [%]
-
-Throughput Trending
--------------------
-
-In addition to reporting throughput changes between VPP releases, CSIT
-provides continuous performance trending for VPP master branch:
-
-#. `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.
-
-#. `Trending Methodology <https://docs.fd.io/csit/master/trending/methodology/index.html>`_
- - throughput test metrics, trend calculations and anomaly
- classification (progression, regression, outlier).
-
-#. `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 | Lower than expected NDR throughput of DPDK | CSIT-571 | Suspected NIC firmware or DPDK driver issue affecting NDR and |
-| | testpmd and VPP L2 path NDR throughput with | | PDR throughput on XL710 and X710 NICs. |
-| | xl710 and x710 NICs, compared to x520 NICs. | | |
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+
-| 3 | Tagged Ethernet dot1q and dot1ad L2 path | CSIT-1066 | Tagged Ethernet dot1q and dot1ad L2 path throughput regression: |
-| | throughput regression. | | NDR -2%..-5%, PDR -2%..-6%, MRR. Affects l2xc and l2bd |
-| | | | performance tests. |
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+
-| 4 | IPSec (software, no QAT HW) throughput | CSIT-1064 | IPSec throughput regression: NDR -3%..-8%, PDR -2%..-8%, MRR |
-| | regression. | | -3%..-7%. Affects IPSec SW tests, QAT HW tests not affected. |
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+
-| 5 | High failure rate of creating working container | CSIT-1065 | About 20% of orchestrated container topology tests failing data |
-| | topologies with K8s/Ligato orchestration. | | plane verification indicating configuration issue. Suspected |
-| | | | issue with Ligato vpp-agent. |
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+
+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 | `VPP-662 | 9000B packets not supported by NICs VIC1227 and VIC1387. |
+| | <https://jira.fd.io/browse/VPP-662>`_ | |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| 3 | `CSIT-1498 | Memif tests are sporadically failing on initialization of memif connection. |
+| | <https://jira.fd.io/browse/CSIT-1498>`_ | |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| 4 | `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). |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| 5 | `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>`_ | |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| 6 | `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. |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| 7 | `CSIT-1593 | IPv4 AVF 9000B packet tests are failing on 3n-skx while passing on 2n-skx. |
+| | <https://jira.fd.io/browse/CSIT-1593>`_ | |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| 8 | `CSIT-1675 | Intel Xeon 2n-skx, 3n-skx and 2n-clx testbeds behaviour and performance became inconsistent following |
+| | <https://jira.fd.io/browse/CSIT-1675>`_ | the upgrade to the latest Ubuntu 18.04 LTS kernel version (4.15.0-72-generic) and associated microcode |
+| | | packages (skx ucode 0x2000064, clx ucode 0x500002c). VPP as well as DPDK L3fwd tests are affected. |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| 9 | `CSIT-1679 | All 2n-clx VPP ip4 tests with xxv710 and avf driver are failing. |
+| | <https://jira.fd.io/browse/CSIT-1679>`_ | |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| 10 | `CSIT-1680 | Some 2n-clx cx556a rdma tests are failing. |
+| | <https://jira.fd.io/browse/CSIT-1680>`_ | |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| 11 | `CSIT-1699 | Root Cause Analysis for CSIT-2001. Investigate high stdev of tests with VPP inside VM. |
+| | <https://jira.fd.io/browse/CSIT-1699>`_ | |
+| +-----------------------------------------+ |
+| | `CSIT-1704 | |
+| | <https://jira.fd.io/browse/CSIT-1704>`_ | |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| 12 | `CSIT-1699 | Root Cause Analysis for CSIT-2001. Identify cause of dot1q-l2xcbase progression. |
+| | <https://jira.fd.io/browse/CSIT-1699>`_ | |
+| +-----------------------------------------+ |
+| | `CSIT-1705 | |
+| | <https://jira.fd.io/browse/CSIT-1705>`_ | |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| 13 | `CSIT-1699 | Root Cause Analysis for CSIT-2001. Identify cause of avf-ip4scale regression. |
+| | <https://jira.fd.io/browse/CSIT-1699>`_ | |
+| +-----------------------------------------+ |
+| | `CSIT-1706 | |
+| | <https://jira.fd.io/browse/CSIT-1706>`_ | |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| 14 | `CSIT-1699 | Root Cause Analysis for CSIT-2001. Identify cause of progression in vhost-user tests with testpmd in VM. |
+| | <https://jira.fd.io/browse/CSIT-1699>`_ | |
+| +-----------------------------------------+ |
+| | `CSIT-1707 | |
+| | <https://jira.fd.io/browse/CSIT-1707>`_ | |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| 15 | `CSIT-1699 | Root Cause Analysis for CSIT-2001. Identify cause for avf-ip4base regression. |
+| | <https://jira.fd.io/browse/CSIT-1699>`_ | |
+| +-----------------------------------------+ |
+| | `CSIT-1708 | |
+| | <https://jira.fd.io/browse/CSIT-1708>`_ | |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
Code Review / csit.git / blobdiff