From 32a5263216d79ad34041dca55357278f092bb931 Mon Sep 17 00:00:00 2001 From: Trevor Cooper Date: Tue, 21 Mar 2017 13:25:49 -0700 Subject: [PATCH] Moved doc files to testing document structure testing/user ... testing/developer and modified doc index to match dir structure Change-Id: I4b1a535808a48773505fa7874c61707cd349fced Signed-off-by: Trevor Cooper --- docs/index.rst | 79 +++++++++------------ docs/release/release-notes/index.rst | 19 +++-- .../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 | 6 +- docs/{ => testing/developer}/results/scenario.rst | 37 ++++------ .../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, 65 insertions(+), 76 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 (93%) rename docs/{ => testing/developer}/results/scenario.rst (90%) 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..11aaf655 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,39 +7,28 @@ ====== VSPERF ====== + VSPERF is an OPNFV testing project. -VSPERF provides an automated test-framework and comprehensive test suite based on -industry standards for measuring data-plane performance of Telco NFV switching -technologies as well as physical and virtual network interfaces (NFVI). The VSPERF -architecture is switch and traffic generator agnostic and provides full control of -software component versions and configurations as well as test-case customization. +VSPERF provides a configurable and automated test-framework with test cases based on +industry standard network benchmarks applicable to NFVI. This includes the network +tolpology with physical and virtual network interfaces as well as the switching +technology. The VSPERF architecture was designed to be switch and traffic generator +agnostic and provides control of NFVI software components, switch configurations and +test-case customization. The Danube release of VSPERF includes improvements in documentation and capabilities. -This includes additional test-cases such as RFC 5481 Latency test and RFC-2889 -address-learning-rate test. Hardware traffic generator support is now provided for +This includes additional test-cases such as RFC 5481 (latency tests) and RFC-2889 +(address-learning-rate test). Hardware traffic generator support is now provided for Spirent and Xena in addition to Ixia. The Moongen software traffic generator is also -now fully supported. VSPERF can be used in a variety of modes for configuration and -setup of the network and/or for control of the test-generator and test execution. +now supported. VSPERF can be used in a variety of modes for configuration and +setup of the network and/or for control of the traffic-generator and test execution. * Wiki: https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases * Repository: https://git.opnfv.org/vswitchperf * 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 +38,44 @@ VSPERF User Guide :maxdepth: 5 :numbered: 5 - ./userguide/testusage.rst - ./userguide/teststeps.rst - ./userguide/integration.rst + ./user/configguide/installation.rst + ./user/configguide/upgrade.rst + ./user/configguide/trafficgen.rst + + ./user/userguide/testusage.rst + ./user/userguide/teststeps.rst + ./user/userguide/integration.rst Yardstick integration <./userguide/yardstick.rst> -************** -VSPERF Design -************** + +**************************** +VSPERF Developer +**************************** .. toctree:: - :caption: VSPERF Design + :caption: VSPERF Developer Guide :maxdepth: 5 :numbered: 5 - ./design/vswitchperf_design.rst - ./design/trafficgen_integration_guide.rst + ./developer/design/trafficgen_integration_guide.rst + ./developer/design/vswitchperf_design.rst -******************* -VSPERF Requirements -******************* - -.. toctree:: - :caption: VSPERF Requirements - :maxdepth: 5 - :numbered: 5 + ./developer/requirements/vswitchperf_ltd.rst + ./developer/requirements/vswitchperf_ltp.rst + IETF Internet Draft: Benchmarking Virtual Switches in OPNFV <./requirements/ietf_draft/> - ./requirements/vswitchperf_ltp.rst - ./requirements/vswitchperf_ltd.rst -************** +****************************** VSPERF Results -************** +****************************** .. toctree:: + :caption: VSPERF Scenarios and Test Cases :maxdepth: 3 + :numbered: 3 - ./results/scenario.rst - ./results/results.rst + ./developer/results/scenario.rst + ./developer/results/results.rst Indices ======= diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst index eaa7bb71..8b38d53e 100644 --- a/docs/release/release-notes/index.rst +++ b/docs/release/release-notes/index.rst @@ -1,12 +1,21 @@ +.. _vswitchperf-releasenotes: + .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 .. (c) OPNFV, Intel Corporation and others. -================================================== -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 93% rename from docs/results/results.rst rename to docs/testing/developer/results/results.rst index 1fd6d443..42df9611 100644 --- a/docs/results/results.rst +++ b/docs/testing/developer/results/results.rst @@ -2,10 +2,10 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) OPNFV, Intel Corporation, AT&T and others. -OPNFV Brahmaputra Results +OPNFV VSPERF CI Results ========================= -The vsperf CI jobs that were used to obtain the -results can be found at https://wiki.opnfv.org/wiki/vsperf_results. +The VSPERF CI jobs are run daily through Jenkins. Result samples 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 test case in the VSPERF Framework and specifies the metric the vertical/Y axis diff --git a/docs/results/scenario.rst b/docs/testing/developer/results/scenario.rst similarity index 90% rename from docs/results/scenario.rst rename to docs/testing/developer/results/scenario.rst index 49ff626a..2967fc60 100644 --- a/docs/results/scenario.rst +++ b/docs/testing/developer/results/scenario.rst @@ -2,12 +2,23 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) OPNFV, Intel Corporation, AT&T and others. -OPNFV Brahmaputra Scenarios +OPNFV VSPERF Scenarios =========================== -Available Tests and aspects of scenarios: + +Predefined network 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: +* `DPDK testpmd `_. +* Linux Bridge. +* :ref:`l2fwd-module` ===================== =========================================================== - Framework Test Definition + Testcase Definition ===================== =========================================================== phy2phy_tput :ref:`PacketLossRatio ` for :ref:`Phy2Phy ` back2back :ref:`BackToBackFrames ` for :ref:`Phy2Phy ` @@ -23,23 +34,3 @@ 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: - -* :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. -* :ref:`l2fwd-module` - -Supported traffic generators: - -* Ixia: IxOS and IxNet. -* Spirent. -* 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