report 1807: editorial nit-picking in all graph sections.
[csit.git] / docs / report / vpp_performance_tests / packet_throughput_graphs / index.rst
1
2 .. raw:: latex
3
4     \clearpage
5
6 Packet Throughput
7 =================
8
9 Throughput graphs are generated by multiple executions of the same
10 performance tests across physical testbeds hosted LF FD.io labs: 3n-hsw,
11 2n-skx, 2n-skx. Box-and-Whisker plots are used to display variations in
12 measured throughput values, without making any assumptions of the
13 underlying statistical distribution.
14
15 For each test case, Box-and-Whisker plots show the quartiles (Min, 1st
16 quartile / 25th percentile, 2nd quartile / 50th percentile / mean, 3rd
17 quartile / 75th percentile, Max) across collected data set. Outliers are
18 plotted as individual points.
19
20 Additional information about graph data:
21
22 #. **Graph Title**: describes tested packet path, testbed topology,
23    processor model, NIC model, packet size, number of cores and
24    threads used by data plane workers and indication of VPP DUT
25    configuration.
26
27 #. **X-axis Labels**: indices of individual test suites as listed in
28    Graph Legend.
29
30 #. **Y-axis Labels**: measured Packets Per Second [pps] throughput
31    values.
32
33 #. **Graph Legend**: lists X-axis indices with associated CSIT test
34    suites executed to generate graphed test results.
35
36
37 .. note::
38
39     Test results have been generated by
40     `FD.io test executor vpp performance job 3n-hsw`_,
41     `FD.io test executor vpp performance job 3n-skx`_ and
42     `FD.io test executor vpp performance job 2n-skx`_ with RF
43     result files csit-vpp-perf-|srelease|-\*.zip
44     `archived here <../../_static/archive/>`_.
45     Required per test case data set size is **10**, but for VPP tests
46     the actual size varies per test case and is <=10. This is due to
47     not all test executions completing successfully due to a known
48     `VPP-1361 <https://jira.fd.io/browse/VPP-1361>`_ issue
49     sporadically impacting physical interface up/down state.
50
51 .. toctree::
52     :maxdepth: 1
53
54     l2
55     ip4
56     ip6
57     srv6
58     ip4_tunnels
59     ip6_tunnels
60     vm_vhost
61     container_memif
62     container_orchestrated
63     ipsec
64     vts