CSIT-891: Add data sources for 1801 report
[csit.git] / docs / report / vpp_performance_tests / csit_release_notes.rst
1 CSIT Release Notes\r
2 ==================\r
3 \r
4 Changes in CSIT |release|\r
5 -------------------------\r
6 \r
7 #. Added VPP performance tests\r
8 \r
9    - **Container Topologies Orchestrated by K8s with VPP memif tests**\r
10 \r
11    - Added tests with VPP in L2 Cross-Connect and Bridge-Domain\r
12      configurations containers, with service chain topologies orchestrated by\r
13      Kubernetes. Added following forwarding topologies: i) "Parallel" with\r
14      packets flowing from NIC via VPP to container and back to VPP and NIC;\r
15      ii) "Chained" a.k.a. "Snake" with packets flowing via VPP to container,\r
16      back to VPP, to next container, back to VPP and so on until the last\r
17      container in chain, then back to VPP and NIC; iii) "Horizontal" with\r
18      packets flowing via VPP to container, then via "horizontal" memif to\r
19      next container, and so on until the last container, then back to VPP and\r
20      NIC;.\r
21 \r
22    - **VPP TCP/IP stack**\r
23 \r
24      - Added tests for VPP TCP/IP stack using VPP built-in HTTP server.\r
25        WRK traffic generator is used as a client-side;\r
26 \r
27    - **SRv6 tests**\r
28 \r
29      - Initial SRv6 (Segment Routing IPv6) tests verifying performance of\r
30        IPv6 and SRH (Segment Routing Header) encapsulation, decapsulation,\r
31        lookups and rewrites based on configured End and End.DX6 SRv6 egress\r
32        functions;\r
33 \r
34    - **IPSecSW tests**\r
35 \r
36      - SW computed IPSec encryption with AES-GCM, CBC-SHA1 ciphers, in\r
37        combination with IPv4 routed-forwarding;\r
38 \r
39 #. Presentation and Analytics Layer\r
40 \r
41      - Added throughput speedup analysis for multi-core and multi-thread\r
42        VPP tests into Presentation and Analytics Layer (PAL) for automated\r
43        CSIT test results analysis;\r
44 \r
45 #. Other improvements\r
46 \r
47      - **Framework optimizations**\r
48 \r
49        - Ability to run CSIT framework on ARM architecture;\r
50 \r
51        - Overall stability improvements;\r
52 \r
53 Performance Changes\r
54 -------------------\r
55 \r
56 Substantial changes in measured packet throughput have been observed in a\r
57 number of CSIT |release| tests listed below. Relative changes for this release\r
58 are calculated against the test results listed in CSIT |release-1| report. The\r
59 comparison is calculated between the mean values based on collected and\r
60 archived test results' samples for involved VPP releases. Standard deviation\r
61 has been also listed for CSIT |release|.\r
62 \r
63 NDR Throughput: Best 20 Changes\r
64 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
65 \r
66 .. only:: html\r
67 \r
68    .. csv-table::\r
69       :align: center\r
70       :file: ../../../_build/_static/vpp/performance-changes-ndr-1t1c-top.csv\r
71 \r
72 .. only:: latex\r
73 \r
74    .. raw:: latex\r
75 \r
76       \makeatletter\r
77       \csvset{\r
78         perfimprovements column width/.style={after head=\csv@pretable\begin{longtable}{m{5cm} m{#1} m{#1} m{#1} m{#1} m{#1}}\csv@tablehead},\r
79       }\r
80       \makeatother\r
81 \r
82       {\tiny\r
83       \csvautobooklongtable[separator=comma,\r
84         respect all,\r
85         no check column count,\r
86         perfimprovements column width=1cm,\r
87         late after line={\\\hline},\r
88         late after last line={\end{longtable}}\r
89         ]{../_build/_static/vpp/performance-changes-ndr-1t1c-top.csv}\r
90       }\r
91 \r
92 NDR Throughput: Worst 20 Changes\r
93 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
94 \r
95 .. only:: html\r
96 \r
97    .. csv-table::\r
98       :align: center\r
99       :file: ../../../_build/_static/vpp/performance-changes-ndr-1t1c-bottom.csv\r
100 \r
101 .. only:: latex\r
102 \r
103    .. raw:: latex\r
104 \r
105       \makeatletter\r
106       \csvset{\r
107         perfimprovements column width/.style={after head=\csv@pretable\begin{longtable}{m{6cm} m{#1} m{#1} m{#1} m{#1} m{#1}}\csv@tablehead},\r
108       }\r
109       \makeatother\r
110 \r
111       {\tiny\r
112       \csvautobooklongtable[separator=comma,\r
113         respect all,\r
114         no check column count,\r
115         perfimprovements column width=1cm,\r
116         late after line={\\\hline},\r
117         late after last line={\end{longtable}}\r
118         ]{../_build/_static/vpp/performance-changes-ndr-1t1c-bottom.csv}\r
119       }\r
120 \r
121 .. only:: html\r
122 \r
123       NDR Throughput: All Changes\r
124       ~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
125 \r
126       Complete results for all NDR tests are available in a CSV and pretty\r
127       ASCII formats:\r
128 \r
129         - `csv format for 1t1c <../_static/vpp/performance-changes-ndr-1t1c-full.csv>`_,\r
130         - `csv format for 2t2c <../_static/vpp/performance-changes-ndr-2t2c-full.csv>`_,\r
131         - `csv format for 4t4c <../_static/vpp/performance-changes-ndr-4t4c-full.csv>`_,\r
132         - `pretty ASCII format for 1t1c <../_static/vpp/performance-changes-ndr-1t1c-full.txt>`_,\r
133         - `pretty ASCII format for 2t2c <../_static/vpp/performance-changes-ndr-2t2c-full.txt>`_,\r
134         - `pretty ASCII format for 4t4c <../_static/vpp/performance-changes-ndr-4t4c-full.txt>`_.\r
135 \r
136 PDR Throughput: Best 20 Changes\r
137 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
138 \r
139 .. only:: html\r
140 \r
141    .. csv-table::\r
142       :align: center\r
143       :file: ../../../_build/_static/vpp/performance-changes-pdr-1t1c-top.csv\r
144 \r
145 .. only:: latex\r
146 \r
147    .. raw:: latex\r
148 \r
149       \makeatletter\r
150       \csvset{\r
151         perfimprovements column width/.style={after head=\csv@pretable\begin{longtable}{m{5cm} m{#1} m{#1} m{#1} m{#1} m{#1}}\csv@tablehead},\r
152       }\r
153       \makeatother\r
154 \r
155       {\tiny\r
156       \csvautobooklongtable[separator=comma,\r
157         respect all,\r
158         no check column count,\r
159         perfimprovements column width=2cm,\r
160         late after line={\\\hline},\r
161         late after last line={\end{longtable}}\r
162         ]{../_build/_static/vpp/performance-changes-pdr-1t1c-top.csv}\r
163       }\r
164 \r
165 PDR Throughput: Worst 20 Changes\r
166 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
167 \r
168 .. only:: html\r
169 \r
170    .. csv-table::\r
171       :align: center\r
172       :file: ../../../_build/_static/vpp/performance-changes-pdr-1t1c-bottom.csv\r
173 \r
174 .. only:: latex\r
175 \r
176    .. raw:: latex\r
177 \r
178       \makeatletter\r
179       \csvset{\r
180         perfimprovements column width/.style={after head=\csv@pretable\begin{longtable}{m{6cm} m{#1} m{#1} m{#1} m{#1} m{#1}}\csv@tablehead},\r
181       }\r
182       \makeatother\r
183 \r
184       {\tiny\r
185       \csvautobooklongtable[separator=comma,\r
186         respect all,\r
187         no check column count,\r
188         perfimprovements column width=2cm,\r
189         late after line={\\\hline},\r
190         late after last line={\end{longtable}}\r
191         ]{../_build/_static/vpp/performance-changes-pdr-1t1c-bottom.csv}\r
192       }\r
193 \r
194 .. only:: html\r
195 \r
196       PDR Throughput: All Changes\r
197       ~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
198 \r
199             Complete results for all PDR tests are available in a CSV and pretty\r
200             ASCII formats:\r
201 \r
202               - `csv format for 1t1c <../_static/vpp/performance-changes-pdr-1t1c-full.csv>`_,\r
203               - `csv format for 2t2c <../_static/vpp/performance-changes-pdr-2t2c-full.csv>`_,\r
204               - `csv format for 4t4c <../_static/vpp/performance-changes-pdr-4t4c-full.csv>`_,\r
205               - `pretty ASCII format for 1t1c <../_static/vpp/performance-changes-pdr-1t1c-full.txt>`_,\r
206               - `pretty ASCII format for 2t2c <../_static/vpp/performance-changes-pdr-2t2c-full.txt>`_,\r
207               - `pretty ASCII format for 4t4c <../_static/vpp/performance-changes-pdr-4t4c-full.txt>`_.\r
208 \r
209 Measured improvements are in line with VPP code optimizations listed in\r
210 `VPP-17.10 release notes\r
211 <https://docs.fd.io/vpp/17.10/release_notes_1710.html>`_.\r
212 \r
213 Known Issues\r
214 ------------\r
215 \r
216 Here is the list of known issues in CSIT |release| for VPP performance tests:\r
217 \r
218 +---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
219 | # | Issue                                           | Jira ID    | Description                                                     |\r
220 +---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
221 | 1 | Vic1385 and Vic1227 low performance.            | VPP-664    | Low NDR performance.                                            |\r
222 |   |                                                 |            |                                                                 |\r
223 +---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
224 | 2 | Sporadic NDR discovery test failures on x520.   | CSIT-750   | Suspected issue with HW combination of X710-X520 in LF          |\r
225 |   |                                                 |            | infrastructure. Issue can't be replicated outside LF.           |\r
226 +---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
227 | 3 | VPP in 2t2c setups - large variation            | CSIT-568   | Suspected NIC firmware or DPDK driver issue affecting NDR       |\r
228 |   | of discovered NDR throughput values across      |            | throughput. Applies to XL710 and X710 NICs, x520 NICs are fine. |\r
229 |   | multiple test runs with xl710 and x710 NICs.    |            |                                                                 |\r
230 +---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
231 | 4 | Lower than expected NDR throughput with         | CSIT-569   | Suspected NIC firmware or DPDK driver issue affecting NDR and   |\r
232 |   | xl710 and x710 NICs, compared to x520 NICs.     |            | PDR throughput. Applies to XL710 and X710 NICs.                 |\r
233 +---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r