From ea4376cb3c89f4e3605d7f48036fd61325a52fcf Mon Sep 17 00:00:00 2001 From: Martin Klozik Date: Thu, 26 Jan 2017 15:08:11 +0000 Subject: docs: Remove hyperlinks to docs in artifacts It is possible to use sphinx cross referencing feature in case, that only one level of toctree is used. Thus documentation was reorganized to utilize just one top level index with toctree. After that it was possible to use rst native syntax to create a cross links among vsperf documentation chapters. As a result only 2 hyperlinks to the yardstick documentation are version specific. JIRA: VSPERF-442 Change-Id: I15c2f53922e88765506448de61af4a299f5d53c5 Signed-off-by: Martin Klozik Reviewed-by: Al Morton Reviewed-by: Christian Trautman Reviewed-by: Bill Michalowski Reviewed-by: Antonio Fischetti Reviewed-by: Sridhar Rao Reviewed-by: Martin Goldammer Reviewed-by: Trevor Cooper --- docs/results/index.rst | 14 ------------- docs/results/scenario.rst | 51 ++++++++++++++++------------------------------- 2 files changed, 17 insertions(+), 48 deletions(-) delete mode 100644 docs/results/index.rst (limited to 'docs/results') diff --git a/docs/results/index.rst b/docs/results/index.rst deleted file mode 100644 index 04899b5a..00000000 --- a/docs/results/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. 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/scenario.rst b/docs/results/scenario.rst index cb42c8dc..49ff626a 100644 --- a/docs/results/scenario.rst +++ b/docs/results/scenario.rst @@ -9,34 +9,33 @@ 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 +phy2phy_tput :ref:`PacketLossRatio ` for :ref:`Phy2Phy ` +back2back :ref:`BackToBackFrames ` for :ref:`Phy2Phy ` +phy2phy_tput_mod_vlan :ref:`PacketLossRatioFrameModification ` for :ref:`Phy2Phy ` +phy2phy_cont :ref:`Phy2Phy ` blast vswitch at x% TX rate and measure throughput +pvp_cont :ref:`PVP ` blast vswitch at x% TX rate and measure throughput +pvvp_cont :ref:`PVVP ` blast vswitch at x% TX rate and measure throughput +phy2phy_scalability :ref:`Scalability0PacketLoss ` for :ref:`Phy2Phy ` +pvp_tput :ref:`PacketLossRatio ` for :ref:`PVP ` +pvp_back2back :ref:`BackToBackFrames ` for :ref:`PVP ` +pvvp_tput :ref:`PacketLossRatio ` for :ref:`PVVP ` +pvvp_back2back :ref:`BackToBackFrames ` for :ref:`PVVP ` +phy2phy_cpu_load :ref:`CPU0PacketLoss ` for :ref:`Phy2Phy ` +phy2phy_mem_load Same as :ref:`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 -> +* :ref:`Phy2Phy `: Physical port -> vSwitch -> Physical port. +* :ref:`PVP `: Physical port -> vSwitch -> VNF -> vSwitch -> Physical port. +* :ref:`PVVP `: Physical port -> vSwitch -> VNF -> vSwitch -> VNF -> vSwitch -> Physical port. Loopback applications in the Guest can be: * `DPDK testpmd `_. * Linux Bridge. -* `l2fwd - `_. +* :ref:`l2fwd-module` Supported traffic generators: @@ -44,19 +43,3 @@ Supported traffic generators: * 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-flows-rfc2544-0packetloss - -.. _CPU0PacketLoss: http://artifacts.opnfv.org/vswitchperf/docs/requirements/vswitchperf_ltd.html#test-id-ltd-stress-rfc2544-0packetloss - -.. _Phy2Phy : http://artifacts.opnfv.org/vswitchperf/docs/requirements/vswitchperf_ltp.html#physical-port-vswitch-physical-port - -.. _PVP: http://artifacts.opnfv.org/vswitchperf/docs/requirements/vswitchperf_ltp.html#physical-port-vswitch-vnf-vswitch-physical-port - -.. _PVVP: http://artifacts.opnfv.org/vswitchperf/docs/requirements/vswitchperf_ltp.html#physical-port-vswitch-vnf-vswitch-vnf-vswitch-physical-port - -- cgit 1.2.3-korg