Report: Add disclaimer for reconf tests

+ Improve description for reconf tests

Change-Id: Ib1f397eda88a6c1db79b7a3a518584420770fd5c
Signed-off-by: Tibor Frank <tifrank@cisco.com>
(cherry picked from commit 2fc48e8d0a4712ec99dd2bb3a814ec9cb2bc12cf)

diff --git a/docs/report/index.html.template b/docs/report/index.html.template
index 554dd9b..8a01129 100644 (file)
--- a/docs/report/index.html.template
+++ b/docs/report/index.html.template
@@ -21,6 +21,7 @@ CSIT-1908
     vpp_performance_tests/throughput_speedup_multi_core/index
     vpp_performance_tests/packet_latency_graphs/index
     vpp_performance_tests/soak_tests/index
     vpp_performance_tests/throughput_speedup_multi_core/index
     vpp_performance_tests/packet_latency_graphs/index
     vpp_performance_tests/soak_tests/index

+    vpp_performance_tests/reconf_tests/index

     vpp_performance_tests/nf_service_density/index
     vpp_performance_tests/http_server_performance/index
     vpp_performance_tests/comparisons/index
     vpp_performance_tests/nf_service_density/index
     vpp_performance_tests/http_server_performance/index
     vpp_performance_tests/comparisons/index

diff --git a/docs/report/introduction/methodology.rst b/docs/report/introduction/methodology.rst
index b111fe5..af9bfc6 100644 (file)
--- a/docs/report/introduction/methodology.rst
+++ b/docs/report/introduction/methodology.rst
@@ -16,6 +16,7 @@ Test Methodology
     methodology_plrsearch
     methodology_packet_latency
     methodology_multi_core_speedup
     methodology_plrsearch
     methodology_packet_latency
     methodology_multi_core_speedup

+    methodology_reconf

     methodology_vpp_startup_settings
     methodology_kvm_vms_vhost_user
     methodology_lxc_drc_container_memif
     methodology_vpp_startup_settings
     methodology_kvm_vms_vhost_user
     methodology_lxc_drc_container_memif

diff --git a/docs/report/introduction/methodology_data_plane_throughput/index.rst b/docs/report/introduction/methodology_data_plane_throughput/index.rst
index 71af4a9..487d300 100644 (file)
--- a/docs/report/introduction/methodology_data_plane_throughput/index.rst
+++ b/docs/report/introduction/methodology_data_plane_throughput/index.rst
@@ -7,4 +7,3 @@ Data Plane Throughput
     methodology_mlrsearch_tests
     methodology_mrr_throughput
     methodology_plrsearch
     methodology_mlrsearch_tests
     methodology_mrr_throughput
     methodology_plrsearch

-    methodology_reconf

diff --git a/docs/report/introduction/methodology_data_plane_throughput/methodology_reconf.rst b/docs/report/introduction/methodology_reconf.rst
similarity index 91%
rename from docs/report/introduction/methodology_data_plane_throughput/methodology_reconf.rst
rename to docs/report/introduction/methodology_reconf.rst
index 8922b32..32e0fd7 100644 (file)
--- a/docs/report/introduction/methodology_data_plane_throughput/methodology_reconf.rst
+++ b/docs/report/introduction/methodology_reconf.rst
@@ -1,7 +1,13 @@
 .. _reconf_tests:
 
 .. _reconf_tests:
 

-Reconf Tests
-^^^^^^^^^^^^
+Reconfiguration Tests
+---------------------
+
+.. important::
+
+    **DISCLAIMER**: Described reconf test methodology is experimental, and
+    subject to change following consultation within csit-dev, vpp-dev
+    and user communities. Current test results should be treated as indicative.

 
 Overview
 ~~~~~~~~
 
 Overview
 ~~~~~~~~

diff --git a/docs/report/vpp_performance_tests/index.rst b/docs/report/vpp_performance_tests/index.rst
index c5c3e66..0f09377 100644 (file)
--- a/docs/report/vpp_performance_tests/index.rst
+++ b/docs/report/vpp_performance_tests/index.rst
@@ -9,6 +9,7 @@ VPP Performance
     throughput_speedup_multi_core/index
     packet_latency_graphs/index
     soak_tests/index
     throughput_speedup_multi_core/index
     packet_latency_graphs/index
     soak_tests/index

+    reconf_tests/index

     nf_service_density/index
     http_server_performance/index
     comparisons/index
     nf_service_density/index
     http_server_performance/index
     comparisons/index

diff --git a/docs/report/vpp_performance_tests/nf_service_density/index.rst b/docs/report/vpp_performance_tests/nf_service_density/index.rst
index 8c827eb..4c3143b 100644 (file)
--- a/docs/report/vpp_performance_tests/nf_service_density/index.rst
+++ b/docs/report/vpp_performance_tests/nf_service_density/index.rst
@@ -25,4 +25,3 @@ resources.
     vnf_service_chains
     cnf_service_chains
     cnf_service_pipelines
     vnf_service_chains
     cnf_service_chains
     cnf_service_pipelines

-    vnf_service_chains_reconf

diff --git a/docs/report/vpp_performance_tests/reconf_tests/index.rst b/docs/report/vpp_performance_tests/reconf_tests/index.rst
new file mode 100644 (file)
index 0000000..c5da438
--- /dev/null
+++ b/docs/report/vpp_performance_tests/reconf_tests/index.rst
@@ -0,0 +1,15 @@
+
+.. raw:: latex
+
+    \clearpage
+
+.. _reconfiguration_tests:
+
+Reconfiguration Tests
+=====================
+
+See :ref:`reconf_tests` for methodology description of this test type.
+
+.. toctree::
+
+    vnf_service_chains_reconf

diff --git a/docs/report/vpp_performance_tests/nf_service_density/vnf_service_chains_reconf.rst b/docs/report/vpp_performance_tests/reconf_tests/vnf_service_chains_reconf.rst
similarity index 83%
rename from docs/report/vpp_performance_tests/nf_service_density/vnf_service_chains_reconf.rst
rename to docs/report/vpp_performance_tests/reconf_tests/vnf_service_chains_reconf.rst
index 66b1af1..4793465 100644 (file)
--- a/docs/report/vpp_performance_tests/nf_service_density/vnf_service_chains_reconf.rst
+++ b/docs/report/vpp_performance_tests/reconf_tests/vnf_service_chains_reconf.rst
@@ -30,10 +30,14 @@
 
 .. _vnf_service_chains_reconf:
 
 
 .. _vnf_service_chains_reconf:
 

-Reconfiguration of VNF Service Chains
-=====================================
+VNF Service Chains
+==================

 
 

-See :ref:`reconf_tests` for methodology description of this test type.
+.. 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
 
 In each test, a single service chain is added, the re-configuration
 contains all the steps the initial chains got, except the last step


@@ -41,8 +45,17 @@ contains all the steps the initial chains got, except the last step
 
 Additional information about graph data:
 
 
 Additional information about graph data:
 

-#. **Graph Title**: describes tested packet path including VNF workload
-   running in each VM.
+#. **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.
 
 #. **X-axis Labels**: indices of individual test suites as listed in
    Graph Legend.