Report: Add NF service density and soak tests to static content.
[csit.git] / docs / report / vpp_performance_tests / soak_tests / index.rst
diff --git a/docs/report/vpp_performance_tests/soak_tests/index.rst b/docs/report/vpp_performance_tests/soak_tests/index.rst
new file mode 100644 (file)
index 0000000..5c75f1d
--- /dev/null
@@ -0,0 +1,76 @@
+
+.. 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>
+
+.. _soak_tests:
+
+Soak Tests
+==========
+
+Long duration soak tests are executed using PLRsearch algorithm. See
+methodology section for PLRsearch description.
+
+Additional information about graph data:
+
+#. **Graph Title**: describes type of tests and soak test duration.
+
+#. **X-axis Labels**: indices of test suites.
+
+#. **Y-axis Labels**: measured packet throughput values in [Mpps].
+
+#. **Graph Legend**: list of X-axis indices with CSIT test suites.
+
+.. 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:: html
+
+    <center><b>
+
+:index:`30min Soak Test (PLRsearch)`
+
+.. raw:: html
+
+    </b>
+    <iframe id="ifrm01" onload="setIframeHeight(this.id)" width="700" frameborder="0" scrolling="no" src="../../_static/vpp/example-soak-boxes.html"></iframe>
+    <p><br><br></p>
+    </center>
+
+.. raw:: latex
+
+    \begin{figure}[H]
+        \centering
+            \graphicspath{{../_build/_static/vpp/}}
+            \includegraphics[clip, trim=0cm 0cm 5cm 0cm, width=0.70\textwidth]{example-soak-boxes}
+            \label{fig:example-soak-boxes}
+    \end{figure}