diff options
author | Trevor Cooper <trevor.cooper@intel.com> | 2017-03-21 23:24:54 -0700 |
---|---|---|
committer | Trevor Cooper <trevor.cooper@intel.com> | 2017-03-21 23:24:54 -0700 |
commit | bc8d2a0910b3a49679f6e0c185d894d82e464e2a (patch) | |
tree | 40e375d81195a38edea713e9c09a854d3e0c21db | |
parent | f56bcee58ec3710b02a0f7639f13d7a8ed903ebf (diff) |
Updated doc locations for new structure
Change-Id: I8d948bad350ec90618edac5fc451167c06e8baa5
Signed-off-by: Trevor Cooper <trevor.cooper@intel.com>
-rw-r--r-- | docs/index.rst | 67 | ||||
-rw-r--r-- | docs/release/release-notes/index.rst | 15 | ||||
-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) | 10 | ||||
-rw-r--r-- | docs/testing/developer/results/scenario.rst (renamed from docs/results/scenario.rst) | 20 | ||||
-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, 60 insertions, 52 deletions
diff --git a/docs/index.rst b/docs/index.rst index 889d4ab6..9bfc2f4f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -28,19 +28,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 +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 <https://tools.ietf.org/html/draft-ietf-bmwg-vswitch-opnfv-01>`_ -************** -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 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..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 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 <PacketLossRatio>` for :ref:`Phy2Phy <Phy2Phy>` back2back :ref:`BackToBackFrames <BackToBackFrames>` for :ref:`Phy2Phy <Phy2Phy>` @@ -24,14 +25,14 @@ phy2phy_cpu_load :ref:`CPU0PacketLoss <CPU0PacketLoss>` for :ref:`Phy2Phy < phy2phy_mem_load Same as :ref:`CPU0PacketLoss <CPU0PacketLoss>` but using a memory intensive app ===================== =========================================================== -Supported deployment scenarios: +Deployment 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: +Loopback applications in the Guest: * `DPDK testpmd <http://dpdk.org/doc/guides/testpmd_app_ug/index.html>`_. * 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 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 |