Report: update Hoststack release notes
[csit.git] / docs / report / vpp_performance_tests / csit_release_notes.rst
1 Release Notes
2 =============
3
4 Changes in |csit-release|
5 -------------------------
6
7 #. VPP PERFORMANCE TESTS
8
9    - **Intel Xeon 2n-skx, 3n-skx and 2n-clx testbeds**: VPP performance
10      test data is not included in this report version. This is due to
11      the lower performance and behaviour inconsistency of these
12      systems following the upgrade of processor microcode packages
13      (skx ucode 0x2000064, clx ucode 0x500002c), done as part of
14      updating Ubuntu 18.04 LTS kernel version. Tested VPP and DPDK
15      applications (L3fwd) are affected. Skx and Clx test data will be
16      added in subsequent maintenance report version(s) once the issue
17      is resolved. See :ref:`vpp_known_issues`.
18
19    - **Service density 2n-skx tests**: Added new NF density tests with
20      IPsec encryption between DUTs.
21
22    - **AVF tests**: Full test coveraged based on code changes in CSIT
23      core layer (driver/interface awareness) and generated by suite
24      generator (Intel Fortville NICs only).
25
26    - **Hoststack tests**: Major refactor of VPP Hoststack TCP/IP
27      performance tests using WRK generator talking to the VPP HTTP
28      static server plugin measuring connections per second and
29      requests per second. Added new iperf3 with LDPreload tests,
30      iperf3/LDPreload tests with packet loss induced via the VPP NSIM
31      (Network Simulator) plugin, and QUIC/UDP/IP transport tests.
32      All of the new tests measure goodput through the VPP Hoststack
33      from client to server.
34
35    - **Latency HDRHistogram**: Added High Dynamic Range Histogram
36      latency measurements based on the new capability in TRex traffic
37      generator. HDRH latency data presented in latency packet
38      percentile graphs and in detailed results tables.
39
40    - **Mellanox MCX556A-EDAT tests**: Added tests with Mellanox
41      ConnectX5-2p100GE NICs in 2n-clx testbeds using VPP native rdma
42      driver.
43
44    - **IPsec reconfiguration tests**: Added tests measuring the impact
45      of IPsec tunnels creations and removals.
46
47    - **Load Balancer tests**: Added VPP performance tests for Maglev,
48      L3DSR (Direct Server Return), Layer 4 Load Balancing NAT Mode.
49
50 #. TEST FRAMEWORK
51
52    - **CSIT Python3 support**: Full migration of CSIT from Python2.7 to
53      Python3.6. This change includes library migration, PIP dependency
54      upgrade, CSIT container images, infrastructure packages
55      ugrade/installation.
56
57    - **CSIT PAPI support**: Finished conversion of CSIT VAT L1 keywords
58      to PAPI L1 KWs in CSIT using VPP Python bindings (VPP PAPI).
59      Redesign of key components of PAPI Socket Executor and PAPI
60      history. Due to issues with PAPI performance, VAT is still used
61      in CSIT for all VPP scale tests. See known issues below.
62
63    - **Test Suite Generator**: Added capability to generate suites for
64      different drivers per NIC model including DPDK, AVF, RDMA.
65      Extended coverage for all tests.
66
67    - **General Code Housekeeping**: Ongoing RF keywords optimizations,
68      removal of redundant RF keywords and aligning of suite/test
69      setup/teardowns.
70
71
72 #. PRESENTATION AND ANALYTICS LAYER
73
74    - **Graphs layout improvements**: Improved performance graphs layout
75      for better readibility and maintenance: test grouping, axis
76      labels, descriptions, other informative decoration.
77
78    - **Latency graphs**: Min/Avg/Max group bar latency graphs are
79      replaced with packet latency percentile distributon at different
80      background packet loads based on TRex latency hdrhistogram
81      measurements.
82
83 ..
84     // Alternative Note for 1st Bullet when bad microcode Skx, Clx results are published
85     - **Intel Xeon 2n-skx, 3n-skx and 2n-clx testbeds**: VPP performance
86       test data is included in this report version, but it shows lower
87       performance and behaviour inconsistency of these systems
88       following the upgrade of processor microcode packages (skx ucode
89       0x2000064, clx ucode 0x500002c) as part of updating Ubuntu 18.04
90       LTS kernel version. Tested VPP and DPDK applications (L3fwd) are
91       affected. Skx and Clx test data will be corrected in subsequent
92       maintenance report version(s) once the issue is resolved. See
93       :ref:`vpp_known_issues`.
94
95 .. raw:: latex
96
97     \clearpage
98
99 .. _vpp_known_issues:
100
101 Known Issues
102 ------------
103
104 List of known issues in |csit-release| for VPP performance tests:
105
106 +----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
107 | #  | JiraID                                  | Issue Description                                                                                         |
108 +====+=========================================+===========================================================================================================+
109 | 1  | `CSIT-570                               | Sporadic (1 in 200) NDR discovery test failures on x520. DPDK reporting rx-errors, indicating L1 issue.   |
110 |    | <https://jira.fd.io/browse/CSIT-570>`_  | Suspected issue with HW combination of X710-X520 in LF testbeds. Not observed outside of LF testbeds.     |
111 +----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
112 | 2  | `VPP-662                                | 9000B packets not supported by NICs VIC1227 and VIC1387.                                                  |
113 |    | <https://jira.fd.io/browse/VPP-662>`_   |                                                                                                           |
114 +----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
115 | 3  | `CSIT-1498                              | Memif tests are sporadically failing on initialization of memif connection.                               |
116 |    | <https://jira.fd.io/browse/CSIT-1498>`_ |                                                                                                           |
117 +----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
118 | 4  | `VPP-1677                               | 9000B ip4 nat44: VPP crash + coredump.                                                                    |
119 |    | <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).   |
120 +----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
121 | 5  | `CSIT-1591                              | All CSIT scale tests can not use PAPI due to much slower performance compared to VAT/CLI (it takes much   |
122 |    | <https://jira.fd.io/browse/CSIT-1499>`_ | longer to program VPP). This needs to be addressed on the PAPI side.                                      |
123 |    +-----------------------------------------+                                                                                                           |
124 |    | `VPP-1763                               |                                                                                                           |
125 |    | <https://jira.fd.io/browse/VPP-1763>`_  |                                                                                                           |
126 +----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
127 | 6  | `VPP-1675                               | IPv4 IPSEC 9000B packet tests are failing as no packet is forwarded.                                      |
128 |    | <https://jira.fd.io/browse/VPP-1675>`_  | Reason: chained buffers are not supported.                                                                |
129 +----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
130 | 7  | `CSIT-1593                              | IPv4 AVF 9000B packet tests are failing on 3n-skx while passing on 2n-skx.                                |
131 |    | <https://jira.fd.io/browse/CSIT-1593>`_ |                                                                                                           |
132 +----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
133 | 8  | `CSIT-1675                              | Intel Xeon 2n-skx, 3n-skx and 2n-clx testbeds behaviour and performance became inconsistent following     |
134 |    | <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    |
135 |    |                                         | packages (skx ucode 0x2000064, clx ucode 0x500002c). VPP as well as DPDK L3fwd tests are affected.        |
136 +----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+