CSIT-1332: Proposal of new layout of all graphs

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

diff --git a/docs/report/vpp_performance_tests/packet_latency_graphs/index.rst b/docs/report/vpp_performance_tests/packet_latency_graphs/index.rst
index 8c3e941..c2dc2ae 100644 (file)
--- a/docs/report/vpp_performance_tests/packet_latency_graphs/index.rst
+++ b/docs/report/vpp_performance_tests/packet_latency_graphs/index.rst
@@ -1,11 +1,54 @@
-Packet Latency Graphs
-=====================
+
+.. raw:: latex
+
+    \clearpage
+
+Packet Latency
+==============
+
+Latency results are generated from a single execution of NDR discovery
+test across physical testbeds hosted LF FD.io labs: 3n-hsw, 2n-skx, 2n-
+skx. Box plots are used to show the Minimum, Median and Maximum packet
+latency per test.
+
+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 DUT
+   configuration.
+
+#. **X-axis Labels**: indices of individual test suites as listed in
+   Graph Legend and direction of latency flow:
+
+   - West-to-East: TGint1-to-SUT1-to-SUT2-to-TGint2.
+   - East-to-West: TGint2-to-SUT2-to-SUT1-to-TGint1.
+
+#. **Y-axis Labels**: measured packet latency values in [uSec].
+
+#. **Graph Legend**: lists X-axis indices with associated CSIT test
+   suites executed to generate graphed test results.
+
+.. 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/>`_.
 
 .. toctree::
+    :maxdepth: 3
 
     l2
-    ipv4
-    ipv6
-    ipv4_tunnels
-    ipv6_tunnels
+    ip4
+    ip6
+    srv6
+    ip4_tunnels
+    ip6_tunnels
     vm_vhost
+    container_memif
+    container_orchestrated
+    ipsec
+    vts