Merge "Revert "Moved doc files to testing document structure"

2 files changed, 83 insertions, 0 deletions

diff --git a/docs/results/results.rst b/docs/results/results.rst
new file mode 100644
index 00000000..1fd6d443
--- /dev/null
+++ b/docs/results/results.rst
@@ -0,0 +1,38 @@
+.. 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.
+
+The following table maps the results in the test dashboard to the appropriate
+test case in the VSPERF Framework and specifies the metric the vertical/Y axis
+is plotting. **Please note**, the presence of dpdk within a test name signifies
+that the vswitch under test was OVS with DPDK, while its absence indicates that
+the vswitch under test was stock OVS.
+
+===================== ===================== ================== ===============
+   Dashboard Test        Framework Test          Metric        Guest Interface
+===================== ===================== ================== ===============
+tput_ovsdpdk          phy2phy_tput          Throughput (FPS)   N/A
+tput_ovs              phy2phy_tput          Throughput (FPS)   N/A
+b2b_ovsdpdk           back2back             Back-to-back value N/A
+b2b_ovs               back2back             Back-to-back value N/A
+tput_mod_vlan_ovs     phy2phy_tput_mod_vlan Throughput (FPS)   N/A
+tput_mod_vlan_ovsdpdk phy2phy_tput_mod_vlan Throughput (FPS)   N/A
+scalability_ovs       phy2phy_scalability   Throughput (FPS)   N/A
+scalability_ovsdpdk   phy2phy_scalability   Throughput (FPS)   N/A
+pvp_tput_ovsdpdkuser  pvp_tput              Throughput (FPS)   vhost-user
+pvp_tput_ovsvirtio    pvp_tput              Throughput (FPS)   virtio-net
+pvp_b2b_ovsdpdkuser   pvp_back2back         Back-to-back value vhost-user
+pvp_b2b_ovsvirtio     pvp_back2back         Back-to-back value virtio-net
+pvvp_tput_ovsdpdkuser pvvp_tput             Throughput (FPS)   vhost-user
+pvvp_tput_ovsvirtio   pvvp_tput             Throughput (FPS)   virtio-net
+pvvp_b2b_ovsdpdkuser  pvvp_back2back        Throughput (FPS)   vhost-user
+pvvp_b2b_ovsvirtio    pvvp_back2back        Throughput (FPS)   virtio-net
+===================== ===================== ================== ===============
+
+The loopback application in the VNF used for PVP and PVVP scenarios was DPDK
+testpmd.
diff --git a/docs/results/scenario.rst b/docs/results/scenario.rst
new file mode 100644
index 00000000..49ff626a
--- /dev/null
+++ b/docs/results/scenario.rst
@@ -0,0 +1,45 @@
+.. 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          :ref:`PacketLossRatio <PacketLossRatio>` for :ref:`Phy2Phy <Phy2Phy>`
+back2back             :ref:`BackToBackFrames <BackToBackFrames>` for :ref:`Phy2Phy <Phy2Phy>`
+phy2phy_tput_mod_vlan :ref:`PacketLossRatioFrameModification <PacketLossRatioFrameModification>` for :ref:`Phy2Phy <Phy2Phy>`
+phy2phy_cont          :ref:`Phy2Phy <Phy2Phy>` blast vswitch at x% TX rate and measure throughput
+pvp_cont              :ref:`PVP <PVP>` blast vswitch at x% TX rate and measure throughput
+pvvp_cont             :ref:`PVVP <PVVP>` blast vswitch at x% TX rate and measure throughput
+phy2phy_scalability   :ref:`Scalability0PacketLoss <Scalability0PacketLoss>` for :ref:`Phy2Phy <Phy2Phy>`
+pvp_tput              :ref:`PacketLossRatio <PacketLossRatio>` for :ref:`PVP <PVP>`
+pvp_back2back         :ref:`BackToBackFrames <BackToBackFrames>` for :ref:`PVP <PVP>`
+pvvp_tput             :ref:`PacketLossRatio <PacketLossRatio>` for :ref:`PVVP <PVVP>`
+pvvp_back2back        :ref:`BackToBackFrames <BackToBackFrames>` for :ref:`PVVP <PVVP>`
+phy2phy_cpu_load      :ref:`CPU0PacketLoss <CPU0PacketLoss>` for :ref:`Phy2Phy <Phy2Phy>`
+phy2phy_mem_load      Same as :ref:`CPU0PacketLoss <CPU0PacketLoss>` but using a memory intensive app
+===================== ===========================================================
+
+Supported deployment scenarios:
+
+* :ref:`Phy2Phy <Phy2Phy>`: Physical port -> vSwitch -> Physical port.
+* :ref:`PVP <PVP>`: Physical port -> vSwitch -> VNF -> vSwitch -> Physical port.
+* :ref:`PVVP <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.
+* :ref:`l2fwd-module`
+
+Supported traffic generators:
+
+* Ixia: IxOS and IxNet.
+* Spirent.
+* Dummy.
+