docs: results documentation

Add a results directory and relevant rst files for vsperf brahmaputra
results.

Change-Id: I99ea7b4246b801054d2582933f7d25b7f36abe5d
Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
Reviewed-by: Billy O Mahony <billy.o.mahony@intel.com>
Reviewed-by: Martin Klozik <martinx.klozik@intel.com>
Reviewed-by: Al Morton <acmorton@att.com>
Reviewed-by: Christopher Price <christopher.price@ericsson.com>

diff --git a/docs/index.rst b/docs/index.rst
index 06fafb8..37e0c43 100755 (executable)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -29,7 +29,7 @@ Platform and VNF level testing and validation.
    ./design/index.rst
    ./requirements/index.rst
    ./release/index.rst
-
+   ./results/index.rst
 
 Indices
 =======

diff --git a/docs/results/index.rst b/docs/results/index.rst
new file mode 100644 (file)
index 0000000..04899b5
--- /dev/null
+++ b/docs/results/index.rst
@@ -0,0 +1,14 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Intel Corporation, AT&T and others.
+
+**************
+VSPERF Results
+**************
+
+.. toctree::
+   :numbered:
+   :maxdepth: 3
+
+   scenario.rst
+   results.rst

diff --git a/docs/results/results.rst b/docs/results/results.rst
new file mode 100644 (file)
index 0000000..5aa4187
--- /dev/null
+++ b/docs/results/results.rst
@@ -0,0 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Intel Corporation, AT&T and others.
+
+OPNFV Brahmaputra Results
+=========================
+The vsperf CI jobs that were used to obtain the
+results can be found at https://wiki.opnfv.org/wiki/vsperf_results.

diff --git a/docs/results/scenario.rst b/docs/results/scenario.rst
new file mode 100644 (file)
index 0000000..8de2fb5
--- /dev/null
+++ b/docs/results/scenario.rst
@@ -0,0 +1,62 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Intel Corporation, AT&T and others.
+
+OPNFV Brahmaputra Scenarios
+===========================
+Available Tests and aspects of scenarios:
+
+===================== ===========================================================
+   Framework Test                          Definition
+===================== ===========================================================
+phy2phy_tput          PacketLossRatio_ for Phy2Phy_
+back2back             BackToBackFrames_ for Phy2Phy_
+phy2phy_tput_mod_vlan PacketLossRatioFrameModification_ for Phy2Phy_
+phy2phy_cont          Phy2Phy_ blast vswitch at x% TX rate and measure throughput
+pvp_cont              PVP_ blast vswitch at x% TX rate and measure throughput
+pvvp_cont             PVVP_ blast vswitch at x% TX rate and measure throughput
+phy2phy_scalability   Scalability0PacketLoss_ for Phy2Phy_
+pvp_tput              PacketLossRatio_ for PVP_
+pvp_back2back         BackToBackFrames_ for PVP_
+pvvp_tput             PacketLossRatio_ for PVVP_
+pvvp_back2back        BackToBackFrames_ for PVVP_
+phy2phy_cpu_load      CPU0PacketLoss_ for Phy2Phy_
+phy2phy_mem_load      Same as CPU0PacketLoss_ but using a memory intensive app
+===================== ===========================================================
+
+Supported deployment scenarios:
+
+* Phy2Phy_: Physical port -> vSwitch -> Physical port.
+* PVP_: Physical port -> vSwitch -> VNF -> vSwitch -> Physical port.
+* PVVP_: Physical port -> vSwitch -> VNF -> vSwitch -> VNF -> vSwitch ->
+  Physical port.
+
+Loopback applications in the Guest can be:
+
+* `DPDK testpmd <http://dpdk.org/doc/guides/testpmd_app_ug/index.html>`_.
+* Linux Bridge.
+* `l2fwd
+  <http://artifacts.opnfv.org/vswitchperf/docs/userguide/testusage.html#l2fwd-kernel-module>`_.
+
+Supported traffic generators:
+
+* Ixia: IxOS and IxNet.
+* Spirent.
+* Dummy.
+
+.. _PacketLossRatio: http://artifacts.opnfv.org/vswitchperf/docs/requirements/vswitchperf_ltd.html#test-id-ltd-throughput-rfc2544-packetlossratio
+
+.. _BackToBackFrames: http://artifacts.opnfv.org/vswitchperf/docs/requirements/vswitchperf_ltd.html#test-id-ltd-throughput-rfc2544-backtobackframes
+
+.. _PacketLossRatioFrameModification: http://artifacts.opnfv.org/vswitchperf/docs/requirements/vswitchperf_ltd.html#test-id-ltd-throughput-rfc2544-packetlossratioframemodification
+
+.. _Scalability0PacketLoss: http://artifacts.opnfv.org/vswitchperf/docs/requirements/vswitchperf_ltd.html#test-id-ltd-scalability-rfc2544-0packetloss
+
+.. _CPU0PacketLoss: http://artifacts.opnfv.org/vswitchperf/docs/requirements/vswitchperf_ltd.html#test-id-ltd-cpu-rfc2544-0packetloss
+
+.. _Phy2Phy : http://artifacts.opnfv.org/vswitchperf/docs/requirements/vswitchperf_ltd.html#physical-port-vswitch-physical-port
+
+.. _PVP: http://artifacts.opnfv.org/vswitchperf/docs/requirements/vswitchperf_ltd.html#physical-port-vswitch-vnf-vswitch-physical-port
+
+.. _PVVP: http://artifacts.opnfv.org/vswitchperf/docs/requirements/vswitchperf_ltd.html#physical-port-vswitch-vnf-vswitch-vnf-vswitch-physical-port
+