Report: Add disclaimer for reconf tests

[csit.git] / docs / report / vpp_performance_tests / reconf_tests / vnf_service_chains_reconf.rst

diff --git a/docs/report/vpp_performance_tests/reconf_tests/vnf_service_chains_reconf.rst b/docs/report/vpp_performance_tests/reconf_tests/vnf_service_chains_reconf.rst
new file mode 100644 (file)
index 0000000..4793465
--- /dev/null
+++ b/docs/report/vpp_performance_tests/reconf_tests/vnf_service_chains_reconf.rst
@@ -0,0 +1,151 @@
+
+.. raw:: latex
+
+    \clearpage
+
+.. raw:: html
+
+    <script type="text/javascript">
+
+        function getDocHeight(doc) {
+            doc = doc || document;
+            var body = doc.body, html = doc.documentElement;
+            var height = Math.max( body.scrollHeight, body.offsetHeight,
+                html.clientHeight, html.scrollHeight, html.offsetHeight );
+            return height;
+        }
+
+        function setIframeHeight(id) {
+            var ifrm = document.getElementById(id);
+            var doc = ifrm.contentDocument? ifrm.contentDocument:
+                ifrm.contentWindow.document;
+            ifrm.style.visibility = 'hidden';
+            ifrm.style.height = "10px"; // reset to minimal height ...
+            // IE opt. for bing/msn needs a bit added or scrollbar appears
+            ifrm.style.height = getDocHeight( doc ) + 4 + "px";
+            ifrm.style.visibility = 'visible';
+        }
+
+    </script>
+
+.. _vnf_service_chains_reconf:
+
+VNF Service Chains
+==================
+
+.. important::
+
+    **DISCLAIMER**: Presented test results should be taken with a pinch of
+    salt as they may not represent correctly the system behaviour due
+    to experimental nature of used test methodology (see :ref:`reconf_tests`).
+
+In each test, a single service chain is added, the re-configuration
+contains all the steps the initial chains got, except the last step
+(starting VMs) is skipped.
+
+Additional information about graph data:
+
+#. **Graph Title**: describes tested VPP packet path. Format:
+
+  - wire encapsulation ``dot1qip4vlxan``,
+  - VPP forwarding mode ``l2bd``,
+  - total number {Y} of service chains ``{Y}ch``,
+  - total number of chains being reconfigured ``1ach``,
+  - total number of vhost-user interfaces forwarding packets on VPP with {Y}
+    chains and {X} VMs per chain ``{2XY}vh`` (2 interfaces per {X} VMs per {Y}
+    chains),
+    total number {XY} of VNF VMs forwarding packets ``{XY}vm`` and finally
+  - VNF workload in VM ``testpmd``.
+
+#. **X-axis Labels**: indices of individual test suites as listed in
+   Graph Legend.
+
+#. **Y-axis Labels**: measured Implied time loss [s] values.
+
+#. **Graph Legend**: lists X-axis indices with associated CSIT test
+   suites executed to generate graphed test results and the average value and
+   standard deviation of measured packet loss in millions of packets.
+
+#. **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 2n-skx`_ with RF
+    result files csit-vpp-perf-|srelease|-\*.zip
+    `archived here <../../_static/archive/>`_.
+
+.. raw:: latex
+
+    \clearpage
+
+2n-skx-xxv710
+~~~~~~~~~~~~~
+
+imix-2t1c-dot1qip4vxlan-l2bd
+----------------------------
+
+.. raw:: html
+
+    <center>
+    <iframe id="01" onload="setIframeHeight(this.id)" width="700" frameborder="0" scrolling="no" src="../../_static/vpp/2n-skx-xxv710-imix-2t1c-dot1qip4vxlan-l2bd-reconf.html"></iframe>
+    </center>
+
+.. raw:: latex
+
+    \begin{figure}[H]
+        \centering
+            \graphicspath{{../_build/_static/vpp/}}
+            \includegraphics[clip, trim=0cm 0cm 5cm 0cm, width=0.70\textwidth]{2n-skx-xxv710-imix-2t1c-dot1qip4vxlan-l2bd-reconf}
+            \label{fig:2n-skx-xxv710-imix-2t1c-dot1qip4vxlan-l2bd-reconf}
+    \end{figure}
+
+.. raw:: latex
+
+    \clearpage
+
+imix-4t2c-dot1qip4vxlan-l2bd
+----------------------------
+
+.. raw:: html
+
+    <center>
+    <iframe id="02" onload="setIframeHeight(this.id)" width="700" frameborder="0" scrolling="no" src="../../_static/vpp/2n-skx-xxv710-imix-4t2c-dot1qip4vxlan-l2bd-reconf.html"></iframe>
+    </center>
+
+.. raw:: latex
+
+    \begin{figure}[H]
+        \centering
+            \graphicspath{{../_build/_static/vpp/}}
+            \includegraphics[clip, trim=0cm 0cm 5cm 0cm, width=0.70\textwidth]{2n-skx-xxv710-imix-4t2c-dot1qip4vxlan-l2bd-reconf}
+            \label{fig:2n-skx-xxv710-imix-4t2c-dot1qip4vxlan-l2bd-reconf}
+    \end{figure}
+
+.. raw:: latex
+
+    \clearpage
+
+imix-8t4c-dot1qip4vxlan-l2bd
+----------------------------
+
+.. raw:: html
+
+    <center>
+    <iframe id="03" onload="setIframeHeight(this.id)" width="700" frameborder="0" scrolling="no" src="../../_static/vpp/2n-skx-xxv710-imix-8t4c-dot1qip4vxlan-l2bd-reconf.html"></iframe>
+    </center>
+
+.. raw:: latex
+
+    \begin{figure}[H]
+        \centering
+            \graphicspath{{../_build/_static/vpp/}}
+            \includegraphics[clip, trim=0cm 0cm 5cm 0cm, width=0.70\textwidth]{2n-skx-xxv710-imix-8t4c-dot1qip4vxlan-l2bd-reconf}
+            \label{fig:2n-skx-xxv710-imix-8t4c-dot1qip4vxlan-l2bd-reconf}
+    \end{figure}