Report: Remove Ligato

[csit.git] / docs / report / vpp_performance_tests / packet_throughput_graphs / index.rst

diff --git a/docs/report/vpp_performance_tests/packet_throughput_graphs/index.rst b/docs/report/vpp_performance_tests/packet_throughput_graphs/index.rst
index bf2a87f..48f66d1 100644 (file)
--- a/docs/report/vpp_performance_tests/packet_throughput_graphs/index.rst
+++ b/docs/report/vpp_performance_tests/packet_throughput_graphs/index.rst
@@ -1,11 +1,72 @@
-Packet Throughput Graphs
-========================
+
+.. raw:: latex
+
+    \clearpage
+
+.. _VPP_Packet_Throughput:
+
+Packet Throughput
+=================
+
+Throughput graphs are generated by multiple executions of the same
+performance tests across physical testbeds hosted LF FD.io labs: 3n-hsw,
+2n-skx, 2n-skx. Box-and-Whisker plots are used to display variations in
+measured throughput values, without making any assumptions of the
+underlying statistical distribution.
+
+For each test case, Box-and-Whisker plots show the quartiles (Min, 1st
+quartile / 25th percentile, 2nd quartile / 50th percentile / mean, 3rd
+quartile / 75th percentile, Max) across collected data set. Outliers are
+plotted as individual points.
+
+Additional information about graph data:
+
+#. **Graph Title**: describes tested packet path, testbed topology,
+   processor model, NIC model, packet size, number of cores and
+   threads used by data plane workers and indication of VPP DUT
+   configuration.
+
+#. **X-axis Labels**: indices of individual test suites as listed in
+   Graph Legend.
+
+#. **Y-axis Labels**: measured Packets Per Second [pps] throughput
+   values.
+
+#. **Graph Legend**: lists X-axis indices with associated CSIT test
+   suites executed to generate graphed test results.
+
+#. **Hover Information**: lists minimum, first quartile, median,
+   third quartile, and maximum. If either type of outlier is present the
+   whisker on the appropriate side is taken to 1.5×IQR from the quartile
+   (the "inner fence") rather than the max or min, and individual outlying
+   data points are displayed as unfilled circles (for suspected outliers)
+   or filled circles (for outliers). (The "outer fence" is 3×IQR from the
+   quartile.)
+
+.. note::
+
+    Test results have been generated by
+    `FD.io test executor vpp performance job 3n-hsw`_,
+    `FD.io test executor vpp performance job 3n-skx`_ and
+    `FD.io test executor vpp performance job 2n-skx`_ with RF
+    result files csit-vpp-perf-|srelease|-\*.zip
+    `archived here <../../_static/archive/>`_.
+    Required per test case data set size is **10**, but for VPP tests
+    the actual size varies per test case and is <=10.
 
 .. toctree::
+    :maxdepth: 3
 
     l2
-    ipv4
-    ipv6
-    ipv4_tunnels
-    ipv6_tunnels
+    ip4
+    ip6
+    srv6
+    ip4_tunnels
+    ip6_tunnels
     vm_vhost
+    container_memif
+    ipsec
+    vts
+
+..
+    container_orchestrated