diff options
-rw-r--r-- | docs/index.rst | 79 | ||||
-rw-r--r-- | docs/release/release-notes/index.rst | 19 | ||||
-rw-r--r-- | docs/testing/developer/design/LICENSE (renamed from docs/configguide/LICENSE) | 0 | ||||
-rw-r--r-- | docs/testing/developer/design/factory_and_loader.png (renamed from docs/design/factory_and_loader.png) | bin | 25586 -> 25586 bytes | |||
-rw-r--r-- | docs/testing/developer/design/traffic_controller.png (renamed from docs/design/traffic_controller.png) | bin | 57868 -> 57868 bytes | |||
-rw-r--r-- | docs/testing/developer/design/trafficgen_integration_guide.rst (renamed from docs/design/trafficgen_integration_guide.rst) | 0 | ||||
-rw-r--r-- | docs/testing/developer/design/vsperf.png (renamed from docs/design/vsperf.png) | bin | 93029 -> 93029 bytes | |||
-rw-r--r-- | docs/testing/developer/design/vswitchperf_design.rst (renamed from docs/design/vswitchperf_design.rst) | 0 | ||||
-rw-r--r-- | docs/testing/developer/requirements/LICENSE (renamed from docs/design/LICENSE) | 0 | ||||
-rw-r--r-- | docs/testing/developer/requirements/ietf_draft/LICENSE (renamed from docs/requirements/ietf_draft/LICENSE) | 0 | ||||
-rw-r--r-- | docs/testing/developer/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-00.xml (renamed from docs/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-00.xml) | 0 | ||||
-rw-r--r-- | docs/testing/developer/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-01.xml (renamed from docs/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-01.xml) | 0 | ||||
-rw-r--r-- | docs/testing/developer/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-00.xml (renamed from docs/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-00.xml) | 0 | ||||
-rw-r--r-- | docs/testing/developer/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-01.xml (renamed from docs/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-01.xml) | 0 | ||||
-rw-r--r-- | docs/testing/developer/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-02.xml (renamed from docs/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-02.xml) | 0 | ||||
-rw-r--r-- | docs/testing/developer/requirements/vm2vm_alternative_benchmark.png (renamed from docs/requirements/vm2vm_alternative_benchmark.png) | bin | 104244 -> 104244 bytes | |||
-rw-r--r-- | docs/testing/developer/requirements/vm2vm_benchmark.png (renamed from docs/requirements/vm2vm_benchmark.png) | bin | 80797 -> 80797 bytes | |||
-rw-r--r-- | docs/testing/developer/requirements/vm2vm_hypervisor_benchmark.png (renamed from docs/requirements/vm2vm_hypervisor_benchmark.png) | bin | 122975 -> 122975 bytes | |||
-rw-r--r-- | docs/testing/developer/requirements/vm2vm_virtual_interface_benchmark.png (renamed from docs/requirements/vm2vm_virtual_interface_benchmark.png) | bin | 99544 -> 99544 bytes | |||
-rw-r--r-- | docs/testing/developer/requirements/vswitchperf_ltd.rst (renamed from docs/requirements/vswitchperf_ltd.rst) | 0 | ||||
-rw-r--r-- | docs/testing/developer/requirements/vswitchperf_ltp.rst (renamed from docs/requirements/vswitchperf_ltp.rst) | 0 | ||||
-rw-r--r-- | docs/testing/developer/results/results.rst (renamed from docs/results/results.rst) | 6 | ||||
-rw-r--r-- | docs/testing/developer/results/scenario.rst (renamed from docs/results/scenario.rst) | 37 | ||||
-rw-r--r-- | docs/testing/user/configguide/LICENSE (renamed from docs/requirements/LICENSE) | 0 | ||||
-rw-r--r-- | docs/testing/user/configguide/TCLServerProperties.png (renamed from docs/configguide/TCLServerProperties.png) | bin | 11667 -> 11667 bytes | |||
-rw-r--r-- | docs/testing/user/configguide/installation.rst (renamed from docs/configguide/installation.rst) | 0 | ||||
-rw-r--r-- | docs/testing/user/configguide/trafficgen.rst (renamed from docs/configguide/trafficgen.rst) | 0 | ||||
-rw-r--r-- | docs/testing/user/configguide/upgrade.rst (renamed from docs/configguide/upgrade.rst) | 0 | ||||
-rw-r--r-- | docs/testing/user/userguide/integration.rst (renamed from docs/userguide/integration.rst) | 0 | ||||
-rw-r--r-- | docs/testing/user/userguide/teststeps.rst (renamed from docs/userguide/teststeps.rst) | 0 | ||||
-rw-r--r-- | docs/testing/user/userguide/testusage.rst (renamed from docs/userguide/testusage.rst) | 0 | ||||
-rw-r--r-- | docs/testing/user/userguide/yardstick.rst (renamed from docs/userguide/yardstick.rst) | 0 |
32 files changed, 65 insertions, 76 deletions
diff --git a/docs/index.rst b/docs/index.rst index 889d4ab6..11aaf655 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,20 +7,22 @@ ====== 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 @@ -28,19 +30,6 @@ setup of the network and/or for control of the test-generator and test execution * 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 index 7bc572ce..7bc572ce 100644 --- a/docs/configguide/LICENSE +++ b/docs/testing/developer/design/LICENSE diff --git a/docs/design/factory_and_loader.png b/docs/testing/developer/design/factory_and_loader.png Binary files differindex 290c0af6..290c0af6 100644 --- a/docs/design/factory_and_loader.png +++ b/docs/testing/developer/design/factory_and_loader.png diff --git a/docs/design/traffic_controller.png b/docs/testing/developer/design/traffic_controller.png Binary files differindex 598296ec..598296ec 100644 --- a/docs/design/traffic_controller.png +++ b/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 index 382cedcb..382cedcb 100644 --- a/docs/design/trafficgen_integration_guide.rst +++ b/docs/testing/developer/design/trafficgen_integration_guide.rst diff --git a/docs/design/vsperf.png b/docs/testing/developer/design/vsperf.png Binary files differindex 4af2ac62..4af2ac62 100644 --- a/docs/design/vsperf.png +++ b/docs/testing/developer/design/vsperf.png diff --git a/docs/design/vswitchperf_design.rst b/docs/testing/developer/design/vswitchperf_design.rst index da7ec6fd..da7ec6fd 100644 --- a/docs/design/vswitchperf_design.rst +++ b/docs/testing/developer/design/vswitchperf_design.rst diff --git a/docs/design/LICENSE b/docs/testing/developer/requirements/LICENSE index 7bc572ce..7bc572ce 100644 --- a/docs/design/LICENSE +++ b/docs/testing/developer/requirements/LICENSE diff --git a/docs/requirements/ietf_draft/LICENSE b/docs/testing/developer/requirements/ietf_draft/LICENSE index 7fc9ae14..7fc9ae14 100644 --- a/docs/requirements/ietf_draft/LICENSE +++ b/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 index 2259b23c..2259b23c 100644 --- 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 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 index c8a3d99b..c8a3d99b 100644 --- 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 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 index b5f7f833..b5f7f833 100644 --- 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 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 index a9405a77..a9405a77 100644 --- 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 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 index 9157763e..9157763e 100644 --- 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 diff --git a/docs/requirements/vm2vm_alternative_benchmark.png b/docs/testing/developer/requirements/vm2vm_alternative_benchmark.png Binary files differindex d21334ba..d21334ba 100644 --- a/docs/requirements/vm2vm_alternative_benchmark.png +++ b/docs/testing/developer/requirements/vm2vm_alternative_benchmark.png diff --git a/docs/requirements/vm2vm_benchmark.png b/docs/testing/developer/requirements/vm2vm_benchmark.png Binary files differindex 3a85e51f..3a85e51f 100644 --- a/docs/requirements/vm2vm_benchmark.png +++ b/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 Binary files differindex b5b76e8a..b5b76e8a 100644 --- a/docs/requirements/vm2vm_hypervisor_benchmark.png +++ b/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 Binary files differindex 55294af6..55294af6 100644 --- a/docs/requirements/vm2vm_virtual_interface_benchmark.png +++ b/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 index e1372520..e1372520 100644 --- a/docs/requirements/vswitchperf_ltd.rst +++ b/docs/testing/developer/requirements/vswitchperf_ltd.rst diff --git a/docs/requirements/vswitchperf_ltp.rst b/docs/testing/developer/requirements/vswitchperf_ltp.rst index 2b74d676..2b74d676 100644 --- a/docs/requirements/vswitchperf_ltp.rst +++ b/docs/testing/developer/requirements/vswitchperf_ltp.rst diff --git a/docs/results/results.rst b/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 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 <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` ===================== =========================================================== - Framework Test Definition + Testcase Definition ===================== =========================================================== phy2phy_tput :ref:`PacketLossRatio <PacketLossRatio>` for :ref:`Phy2Phy <Phy2Phy>` back2back :ref:`BackToBackFrames <BackToBackFrames>` for :ref:`Phy2Phy <Phy2Phy>` @@ -23,23 +34,3 @@ pvvp_back2back :ref:`BackToBackFrames <BackToBackFrames>` for :ref:`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. - diff --git a/docs/requirements/LICENSE b/docs/testing/user/configguide/LICENSE index 7bc572ce..7bc572ce 100644 --- a/docs/requirements/LICENSE +++ b/docs/testing/user/configguide/LICENSE diff --git a/docs/configguide/TCLServerProperties.png b/docs/testing/user/configguide/TCLServerProperties.png Binary files differindex 682de7c5..682de7c5 100644 --- a/docs/configguide/TCLServerProperties.png +++ b/docs/testing/user/configguide/TCLServerProperties.png diff --git a/docs/configguide/installation.rst b/docs/testing/user/configguide/installation.rst index 1965a8f5..1965a8f5 100644 --- a/docs/configguide/installation.rst +++ b/docs/testing/user/configguide/installation.rst diff --git a/docs/configguide/trafficgen.rst b/docs/testing/user/configguide/trafficgen.rst index 4e42b2be..4e42b2be 100644 --- a/docs/configguide/trafficgen.rst +++ b/docs/testing/user/configguide/trafficgen.rst diff --git a/docs/configguide/upgrade.rst b/docs/testing/user/configguide/upgrade.rst index cf92572c..cf92572c 100644 --- a/docs/configguide/upgrade.rst +++ b/docs/testing/user/configguide/upgrade.rst diff --git a/docs/userguide/integration.rst b/docs/testing/user/userguide/integration.rst index 83b29da6..83b29da6 100644 --- a/docs/userguide/integration.rst +++ b/docs/testing/user/userguide/integration.rst diff --git a/docs/userguide/teststeps.rst b/docs/testing/user/userguide/teststeps.rst index 870c3d80..870c3d80 100644 --- a/docs/userguide/teststeps.rst +++ b/docs/testing/user/userguide/teststeps.rst diff --git a/docs/userguide/testusage.rst b/docs/testing/user/userguide/testusage.rst index c6037aaf..c6037aaf 100644 --- a/docs/userguide/testusage.rst +++ b/docs/testing/user/userguide/testusage.rst diff --git a/docs/userguide/yardstick.rst b/docs/testing/user/userguide/yardstick.rst index b5e5c72d..b5e5c72d 100644 --- a/docs/userguide/yardstick.rst +++ b/docs/testing/user/userguide/yardstick.rst |