Update report doc for rls1807
[csit.git] / docs / report / dpdk_performance_tests / csit_release_notes.rst
1 Release Notes
2 =============
3
4 Changes in |csit-release|
5 -------------------------
6
7 #. **DPDK performance tests**
8
9    - *MRR tests* - Maximum Receive Rate tests measure the packet forwarding rate
10      under the maximum load offered by traffic generator over a set trial
11      duration, regardless of packet loss. MRR tests are used for continuous
12      performance trending and for comparison between releases.
13
14    - *MLR tests* - NDR and PDR tests measure the packet forwarding rate using
15      MLRsearch library by traffic generator. All tests that previously used
16      binary search were converted to MLRsearch.
17
18    - *2-node tests* - Set of 2-node tests covering testpmd and l3fwd.
19
20    - Increased coverage of NIC specific tests (Intel-xxv710-da2, Intel-x710)
21
22    - *Generated tests* - Simplified and unified test structure,
23      semi-autogenerated by generator script. Test generator is currently able
24      to create test combinations with various frame size and cores combinations.
25      All existing test cases were converted to new format.
26
27
28 Performance Changes
29 -------------------
30
31 Relative performance changes in measured packet throughput in |csit-release|
32 are calculated against the results from |csit-release-1|
33 report. Listed mean and standard deviation values are computed based on
34 a series of the same tests executed against respective DPDK releases to
35 verify test results repeatability, with percentage change calculated for
36 mean values.
37
38 NDR Changes
39 ~~~~~~~~~~~
40
41 NDR throughput changes between releases are available in a CSV and pretty ASCII
42 formats:
43
44   - `csv format for 1t1c <../_static/dpdk/performance-changes-1t1c-ndr.csv>`_,
45   - `csv format for 2t2c <../_static/dpdk/performance-changes-2t2c-ndr.csv>`_,
46   - `pretty ASCII format for 1t1c <../_static/dpdk/performance-changes-1t1c-ndr.txt>`_,
47   - `pretty ASCII format for 2t2c <../_static/dpdk/performance-changes-2t2c-ndr.txt>`_.
48
49 .. note::
50
51     Test results have been generated by
52     `FD.io test executor dpdk performance job 3n-hsw`_
53     with Robot Framework result
54     files csit-dpdk-perf-|srelease|-\*.zip
55     `archived here <../_static/archive/>`_.
56
57 PDR Changes
58 ~~~~~~~~~~~
59
60 PDR throughput changes between releases are available in a CSV and pretty ASCII
61 formats:
62
63   - `csv format for 1t1c <../_static/dpdk/performance-changes-1t1c-pdr.csv>`_,
64   - `csv format for 2t2c <../_static/dpdk/performance-changes-2t2c-pdr.csv>`_,
65   - `pretty ASCII format for 1t1c <../_static/dpdk/performance-changes-1t1c-pdr.txt>`_,
66   - `pretty ASCII format for 2t2c <../_static/dpdk/performance-changes-2t2c-pdr.txt>`_.
67
68 .. note::
69
70     Test results have been generated by
71     `FD.io test executor dpdk performance job 3n-hsw`_
72     with Robot Framework result
73     files csit-dpdk-perf-|srelease|-\*.zip
74     `archived here <../_static/archive/>`_.
75
76 Comparison Across Testbeds
77 --------------------------
78
79 Relative performance changes in measured packet throughput on 3-Node Skx testbed
80 are calculated against the results measured on 3-Node Hsw testbed.
81
82 NDR Changes
83 ~~~~~~~~~~~
84
85 NDR throughput changes between testbeds are available in a CSV and pretty ASCII
86 formats:
87
88   - `csv format for ndr <../_static/dpdk/performance-compare-testbeds-3n-hsw-3n-skx-ndr.csv>`_,
89   - `pretty ASCII format for ndr <../_static/dpdk/performance-compare-testbeds-3n-hsw-3n-skx-ndr.txt>`_.
90
91 .. note::
92
93     Test results have been generated by
94     `FD.io test executor dpdk performance job 3n-hsw`_ and
95     `FD.io test executor dpdk performance job 3n-skx`_
96     with Robot Framework result
97     files csit-dpdk-perf-|srelease|-\*.zip
98     `archived here <../_static/archive/>`_.
99
100 PDR Changes
101 ~~~~~~~~~~~
102
103 PDR throughput changes between testbeds are available in a CSV and pretty ASCII
104 formats:
105
106   - `csv format for pdr <../_static/dpdk/performance-compare-testbeds-3n-hsw-3n-skx-pdr.csv>`_,
107   - `pretty ASCII format for pdr <../_static/dpdk/performance-compare-testbeds-3n-hsw-3n-skx-pdr.txt>`_.
108
109 .. note::
110
111     Test results have been generated by
112     `FD.io test executor dpdk performance job 3n-hsw`_ and
113     `FD.io test executor dpdk performance job 3n-skx`_
114     with Robot Framework result
115     files csit-dpdk-perf-|srelease|-\*.zip
116     `archived here <../_static/archive/>`_.
117
118 Known Issues
119 ------------
120
121 Here is the list of known issues in |csit-release| for Testpmd performance tests:
122
123 +---+---------------------------------------------------+------------+-----------------------------------------------------------------+
124 | # | Issue                                             | Jira ID    | Description                                                     |
125 +---+---------------------------------------------------+------------+-----------------------------------------------------------------+
126 |   | No known issues                                   |            |                                                                 |
127 +---+---------------------------------------------------+------------+-----------------------------------------------------------------+