From bc8d2a0910b3a49679f6e0c185d894d82e464e2a Mon Sep 17 00:00:00 2001 From: Trevor Cooper Date: Tue, 21 Mar 2017 23:24:54 -0700 Subject: [PATCH] Updated doc locations for new structure Change-Id: I8d948bad350ec90618edac5fc451167c06e8baa5 Signed-off-by: Trevor Cooper --- docs/index.rst | 67 ++++++++++----------- docs/release/release-notes/index.rst | 15 ++++- .../developer/design}/LICENSE | 0 .../developer}/design/factory_and_loader.png | Bin .../developer}/design/traffic_controller.png | Bin .../design/trafficgen_integration_guide.rst | 0 docs/{ => testing/developer}/design/vsperf.png | Bin .../developer}/design/vswitchperf_design.rst | 0 .../developer/requirements}/LICENSE | 0 .../developer}/requirements/ietf_draft/LICENSE | 0 .../draft-ietf-bmwg-vswitch-opnfv-00.xml | 0 .../draft-ietf-bmwg-vswitch-opnfv-01.xml | 0 .../draft-vsperf-bmwg-vswitch-opnfv-00.xml | 0 .../draft-vsperf-bmwg-vswitch-opnfv-01.xml | 0 .../draft-vsperf-bmwg-vswitch-opnfv-02.xml | 0 .../requirements/vm2vm_alternative_benchmark.png | Bin .../developer}/requirements/vm2vm_benchmark.png | Bin .../requirements/vm2vm_hypervisor_benchmark.png | Bin .../vm2vm_virtual_interface_benchmark.png | Bin .../developer}/requirements/vswitchperf_ltd.rst | 0 .../developer}/requirements/vswitchperf_ltp.rst | 0 docs/{ => testing/developer}/results/results.rst | 10 +-- docs/{ => testing/developer}/results/scenario.rst | 20 +++--- .../user/configguide}/LICENSE | 0 .../user}/configguide/TCLServerProperties.png | Bin .../user}/configguide/installation.rst | 0 docs/{ => testing/user}/configguide/trafficgen.rst | 0 docs/{ => testing/user}/configguide/upgrade.rst | 0 docs/{ => testing/user}/userguide/integration.rst | 0 docs/{ => testing/user}/userguide/teststeps.rst | 0 docs/{ => testing/user}/userguide/testusage.rst | 0 docs/{ => testing/user}/userguide/yardstick.rst | 0 32 files changed, 60 insertions(+), 52 deletions(-) rename docs/{configguide => testing/developer/design}/LICENSE (100%) rename docs/{ => testing/developer}/design/factory_and_loader.png (100%) rename docs/{ => testing/developer}/design/traffic_controller.png (100%) rename docs/{ => testing/developer}/design/trafficgen_integration_guide.rst (100%) rename docs/{ => testing/developer}/design/vsperf.png (100%) rename docs/{ => testing/developer}/design/vswitchperf_design.rst (100%) rename docs/{design => testing/developer/requirements}/LICENSE (100%) rename docs/{ => testing/developer}/requirements/ietf_draft/LICENSE (100%) rename docs/{ => testing/developer}/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-00.xml (100%) rename docs/{ => testing/developer}/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-01.xml (100%) rename docs/{ => testing/developer}/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-00.xml (100%) rename docs/{ => testing/developer}/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-01.xml (100%) rename docs/{ => testing/developer}/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-02.xml (100%) rename docs/{ => testing/developer}/requirements/vm2vm_alternative_benchmark.png (100%) rename docs/{ => testing/developer}/requirements/vm2vm_benchmark.png (100%) rename docs/{ => testing/developer}/requirements/vm2vm_hypervisor_benchmark.png (100%) rename docs/{ => testing/developer}/requirements/vm2vm_virtual_interface_benchmark.png (100%) rename docs/{ => testing/developer}/requirements/vswitchperf_ltd.rst (100%) rename docs/{ => testing/developer}/requirements/vswitchperf_ltp.rst (100%) rename docs/{ => testing/developer}/results/results.rst (86%) rename docs/{ => testing/developer}/results/scenario.rst (89%) rename docs/{requirements => testing/user/configguide}/LICENSE (100%) rename docs/{ => testing/user}/configguide/TCLServerProperties.png (100%) rename docs/{ => testing/user}/configguide/installation.rst (100%) rename docs/{ => testing/user}/configguide/trafficgen.rst (100%) rename docs/{ => testing/user}/configguide/upgrade.rst (100%) rename docs/{ => testing/user}/userguide/integration.rst (100%) rename docs/{ => testing/user}/userguide/teststeps.rst (100%) rename docs/{ => testing/user}/userguide/testusage.rst (100%) rename docs/{ => testing/user}/userguide/yardstick.rst (100%) diff --git a/docs/index.rst b/docs/index.rst index 889d4ab6..9bfc2f4f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -27,19 +27,6 @@ setup of the network and/or for control of the test-generator and test execution * Artifacts: https://artifacts.opnfv.org/vswitchperf.html * Continuous Integration status: https://build.opnfv.org/ci/view/vswitchperf/ -****************************** -VSPERF Installation Guide -****************************** - -.. toctree:: - :caption: VSPERF Installation Guide - :maxdepth: 5 - :numbered: 5 - - ./configguide/installation.rst - ./configguide/upgrade.rst - ./configguide/trafficgen.rst - ****************************** VSPERF User Guide ****************************** @@ -49,44 +36,54 @@ VSPERF User Guide :maxdepth: 5 :numbered: 5 - ./userguide/testusage.rst - ./userguide/teststeps.rst - ./userguide/integration.rst - Yardstick integration <./userguide/yardstick.rst> + ./testing/user/configguide/installation.rst + ./testing/user/configguide/upgrade.rst + ./testing/user/configguide/trafficgen.rst + + ./testing/user/userguide/testusage.rst + ./testing/user/userguide/teststeps.rst + ./testing/user/userguide/integration.rst + ./testing/user/userguide/yardstick.rst -************** -VSPERF Design -************** +**************************** +VSPERF Developer Guide +**************************** .. toctree:: - :caption: VSPERF Design + :caption: VSPERF Developer Guide :maxdepth: 5 :numbered: 5 - ./design/vswitchperf_design.rst - ./design/trafficgen_integration_guide.rst + ./testing/developer/design/trafficgen_integration_guide.rst + ./testing/developer/design/vswitchperf_design.rst + + ./testing/developer/requirements/vswitchperf_ltd.rst + ./testing/developer/requirements/vswitchperf_ltp.rst -******************* -VSPERF Requirements -******************* +***************************** +VSPERF - IETF Internet Draft +***************************** .. toctree:: - :caption: VSPERF Requirements + :caption: IETF Internet Draft :maxdepth: 5 :numbered: 5 - ./requirements/vswitchperf_ltp.rst - ./requirements/vswitchperf_ltd.rst +`Benchmarking Virtual Switches in OPNFV `_ -************** -VSPERF Results -************** +Location of xml drafts :doc:`./testing/developer/requirements/ietf_draft/` + +******************************** +VSPERF Scenarios and CI Results +******************************** .. toctree:: - :maxdepth: 3 + :caption: VSPERF Scenarios & Results + :maxdepth: 5 + :numbered: 5 - ./results/scenario.rst - ./results/results.rst + ./testing/developer/results/scenario.rst + ./testing/developer/results/results.rst Indices ======= diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst index eaa7bb71..2d6132ee 100644 --- a/docs/release/release-notes/index.rst +++ b/docs/release/release-notes/index.rst @@ -2,11 +2,20 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) OPNFV, Intel Corporation and others. +.. _vswitchperf-releasenotes: + ================================================== -OPNFV VSPERF Release Notes +VSPERF Release Notes ================================================== .. toctree:: - :maxdepth: 1 + :numbered: + :maxdepth: 2 + + release-notes.rst + +Revision: _sha1_ + +:Author: Trevor Cooper (trevor.cooper@intel.com) - release-notes +Build date: |today| diff --git a/docs/configguide/LICENSE b/docs/testing/developer/design/LICENSE similarity index 100% rename from docs/configguide/LICENSE rename to docs/testing/developer/design/LICENSE diff --git a/docs/design/factory_and_loader.png b/docs/testing/developer/design/factory_and_loader.png similarity index 100% rename from docs/design/factory_and_loader.png rename to docs/testing/developer/design/factory_and_loader.png diff --git a/docs/design/traffic_controller.png b/docs/testing/developer/design/traffic_controller.png similarity index 100% rename from docs/design/traffic_controller.png rename to docs/testing/developer/design/traffic_controller.png diff --git a/docs/design/trafficgen_integration_guide.rst b/docs/testing/developer/design/trafficgen_integration_guide.rst similarity index 100% rename from docs/design/trafficgen_integration_guide.rst rename to docs/testing/developer/design/trafficgen_integration_guide.rst diff --git a/docs/design/vsperf.png b/docs/testing/developer/design/vsperf.png similarity index 100% rename from docs/design/vsperf.png rename to docs/testing/developer/design/vsperf.png diff --git a/docs/design/vswitchperf_design.rst b/docs/testing/developer/design/vswitchperf_design.rst similarity index 100% rename from docs/design/vswitchperf_design.rst rename to docs/testing/developer/design/vswitchperf_design.rst diff --git a/docs/design/LICENSE b/docs/testing/developer/requirements/LICENSE similarity index 100% rename from docs/design/LICENSE rename to docs/testing/developer/requirements/LICENSE diff --git a/docs/requirements/ietf_draft/LICENSE b/docs/testing/developer/requirements/ietf_draft/LICENSE similarity index 100% rename from docs/requirements/ietf_draft/LICENSE rename to docs/testing/developer/requirements/ietf_draft/LICENSE diff --git a/docs/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-00.xml b/docs/testing/developer/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-00.xml similarity index 100% rename from docs/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-00.xml rename to docs/testing/developer/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-00.xml diff --git a/docs/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-01.xml b/docs/testing/developer/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-01.xml similarity index 100% rename from docs/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-01.xml rename to docs/testing/developer/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-01.xml diff --git a/docs/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-00.xml b/docs/testing/developer/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-00.xml similarity index 100% rename from docs/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-00.xml rename to docs/testing/developer/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-00.xml diff --git a/docs/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-01.xml b/docs/testing/developer/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-01.xml similarity index 100% rename from docs/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-01.xml rename to docs/testing/developer/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-01.xml diff --git a/docs/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-02.xml b/docs/testing/developer/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-02.xml similarity index 100% rename from docs/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-02.xml rename to docs/testing/developer/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-02.xml diff --git a/docs/requirements/vm2vm_alternative_benchmark.png b/docs/testing/developer/requirements/vm2vm_alternative_benchmark.png similarity index 100% rename from docs/requirements/vm2vm_alternative_benchmark.png rename to docs/testing/developer/requirements/vm2vm_alternative_benchmark.png diff --git a/docs/requirements/vm2vm_benchmark.png b/docs/testing/developer/requirements/vm2vm_benchmark.png similarity index 100% rename from docs/requirements/vm2vm_benchmark.png rename to docs/testing/developer/requirements/vm2vm_benchmark.png diff --git a/docs/requirements/vm2vm_hypervisor_benchmark.png b/docs/testing/developer/requirements/vm2vm_hypervisor_benchmark.png similarity index 100% rename from docs/requirements/vm2vm_hypervisor_benchmark.png rename to docs/testing/developer/requirements/vm2vm_hypervisor_benchmark.png diff --git a/docs/requirements/vm2vm_virtual_interface_benchmark.png b/docs/testing/developer/requirements/vm2vm_virtual_interface_benchmark.png similarity index 100% rename from docs/requirements/vm2vm_virtual_interface_benchmark.png rename to docs/testing/developer/requirements/vm2vm_virtual_interface_benchmark.png diff --git a/docs/requirements/vswitchperf_ltd.rst b/docs/testing/developer/requirements/vswitchperf_ltd.rst similarity index 100% rename from docs/requirements/vswitchperf_ltd.rst rename to docs/testing/developer/requirements/vswitchperf_ltd.rst diff --git a/docs/requirements/vswitchperf_ltp.rst b/docs/testing/developer/requirements/vswitchperf_ltp.rst similarity index 100% rename from docs/requirements/vswitchperf_ltp.rst rename to docs/testing/developer/requirements/vswitchperf_ltp.rst diff --git a/docs/results/results.rst b/docs/testing/developer/results/results.rst similarity index 86% rename from docs/results/results.rst rename to docs/testing/developer/results/results.rst index 1fd6d443..df9c52cb 100644 --- a/docs/results/results.rst +++ b/docs/testing/developer/results/results.rst @@ -2,12 +2,12 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) OPNFV, Intel Corporation, AT&T and others. -OPNFV Brahmaputra Results +OPNFV Test Results ========================= -The vsperf CI jobs that were used to obtain the -results can be found at https://wiki.opnfv.org/wiki/vsperf_results. +VSPERF CI jobs are run daily and sample results can be found at +https://wiki.opnfv.org/display/vsperf/Vsperf+Results -The following table maps the results in the test dashboard to the appropriate +The following example 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 @@ -34,5 +34,5 @@ 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 +The loopback application in the VNF was used for PVP and PVVP scenarios was DPDK testpmd. diff --git a/docs/results/scenario.rst b/docs/testing/developer/results/scenario.rst similarity index 89% rename from docs/results/scenario.rst rename to docs/testing/developer/results/scenario.rst index 49ff626a..a57d6a03 100644 --- a/docs/results/scenario.rst +++ b/docs/testing/developer/results/scenario.rst @@ -2,12 +2,13 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) OPNFV, Intel Corporation, AT&T and others. -OPNFV Brahmaputra Scenarios -=========================== -Available Tests and aspects of scenarios: +VSPERF Test Scenarios +===================== + +Predefined Tests run with CI: ===================== =========================================================== - Framework Test Definition + Test Definition ===================== =========================================================== phy2phy_tput :ref:`PacketLossRatio ` for :ref:`Phy2Phy ` back2back :ref:`BackToBackFrames ` for :ref:`Phy2Phy ` @@ -24,14 +25,14 @@ phy2phy_cpu_load :ref:`CPU0PacketLoss ` for :ref:`Phy2Phy < phy2phy_mem_load Same as :ref:`CPU0PacketLoss ` but using a memory intensive app ===================== =========================================================== -Supported deployment scenarios: +Deployment topologies: * :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: +Loopback applications in the Guest: * `DPDK testpmd `_. * Linux Bridge. @@ -39,7 +40,8 @@ Loopback applications in the Guest can be: Supported traffic generators: +* Spirent Testcenter * Ixia: IxOS and IxNet. -* Spirent. -* Dummy. - +* Xena +* MoonGen +* Dummy diff --git a/docs/requirements/LICENSE b/docs/testing/user/configguide/LICENSE similarity index 100% rename from docs/requirements/LICENSE rename to docs/testing/user/configguide/LICENSE diff --git a/docs/configguide/TCLServerProperties.png b/docs/testing/user/configguide/TCLServerProperties.png similarity index 100% rename from docs/configguide/TCLServerProperties.png rename to docs/testing/user/configguide/TCLServerProperties.png diff --git a/docs/configguide/installation.rst b/docs/testing/user/configguide/installation.rst similarity index 100% rename from docs/configguide/installation.rst rename to docs/testing/user/configguide/installation.rst diff --git a/docs/configguide/trafficgen.rst b/docs/testing/user/configguide/trafficgen.rst similarity index 100% rename from docs/configguide/trafficgen.rst rename to docs/testing/user/configguide/trafficgen.rst diff --git a/docs/configguide/upgrade.rst b/docs/testing/user/configguide/upgrade.rst similarity index 100% rename from docs/configguide/upgrade.rst rename to docs/testing/user/configguide/upgrade.rst diff --git a/docs/userguide/integration.rst b/docs/testing/user/userguide/integration.rst similarity index 100% rename from docs/userguide/integration.rst rename to docs/testing/user/userguide/integration.rst diff --git a/docs/userguide/teststeps.rst b/docs/testing/user/userguide/teststeps.rst similarity index 100% rename from docs/userguide/teststeps.rst rename to docs/testing/user/userguide/teststeps.rst diff --git a/docs/userguide/testusage.rst b/docs/testing/user/userguide/testusage.rst similarity index 100% rename from docs/userguide/testusage.rst rename to docs/testing/user/userguide/testusage.rst diff --git a/docs/userguide/yardstick.rst b/docs/testing/user/userguide/yardstick.rst similarity index 100% rename from docs/userguide/yardstick.rst rename to docs/testing/user/userguide/yardstick.rst -- 2.16.6