aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTrevor Cooper <trevor.cooper@intel.com>2017-08-22 15:29:08 -0700
committerTrevor Cooper <trevor.cooper@intel.com>2017-08-22 15:34:54 -0700
commitffc0fc7902e2f46cb5982f55aacd262073f08e1c (patch)
treeb91bfb15e64665d43bc9597d202931e40bb1cdae
parent1375b9eff007b51af9b04b4c36975c39cc04cde8 (diff)
Moved devguide for consitency with docs dir structure for all testing projects
Updated RFC description based on IETF approval of Internet Draft Change-Id: Ifd37da946866f350b8968bbbe8c5a3f5ce762cfa Signed-off-by: Trevor Cooper <trevor.cooper@intel.com>
-rw-r--r--docs/testing/developer/devguide/design/LICENSE (renamed from docs/testing/developer/design/LICENSE)0
-rw-r--r--docs/testing/developer/devguide/design/factory_and_loader.png (renamed from docs/testing/developer/design/factory_and_loader.png)bin25586 -> 25586 bytes
-rw-r--r--docs/testing/developer/devguide/design/traffic_controller.png (renamed from docs/testing/developer/design/traffic_controller.png)bin57868 -> 57868 bytes
-rw-r--r--docs/testing/developer/devguide/design/trafficgen_integration_guide.rst (renamed from docs/testing/developer/design/trafficgen_integration_guide.rst)0
-rw-r--r--docs/testing/developer/devguide/design/vsperf.png (renamed from docs/testing/developer/design/vsperf.png)bin93029 -> 93029 bytes
-rw-r--r--docs/testing/developer/devguide/design/vswitchperf_design.rst (renamed from docs/testing/developer/design/vswitchperf_design.rst)0
-rw-r--r--docs/testing/developer/devguide/index.rst (renamed from docs/testing/developer/index.rst)39
-rw-r--r--docs/testing/developer/devguide/requirements/LICENSE (renamed from docs/testing/developer/requirements/LICENSE)0
-rw-r--r--docs/testing/developer/devguide/requirements/ietf_draft/LICENSE (renamed from docs/testing/developer/requirements/ietf_draft/LICENSE)0
-rw-r--r--docs/testing/developer/devguide/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-00.xml (renamed from docs/testing/developer/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-00.xml)0
-rw-r--r--docs/testing/developer/devguide/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-01.xml (renamed from docs/testing/developer/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-01.xml)0
-rw-r--r--docs/testing/developer/devguide/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-00.xml (renamed from docs/testing/developer/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-00.xml)0
-rw-r--r--docs/testing/developer/devguide/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-01.xml (renamed from docs/testing/developer/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-01.xml)0
-rw-r--r--docs/testing/developer/devguide/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-02.xml (renamed from docs/testing/developer/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-02.xml)0
-rw-r--r--docs/testing/developer/devguide/requirements/vm2vm_alternative_benchmark.png (renamed from docs/testing/developer/requirements/vm2vm_alternative_benchmark.png)bin104244 -> 104244 bytes
-rw-r--r--docs/testing/developer/devguide/requirements/vm2vm_benchmark.png (renamed from docs/testing/developer/requirements/vm2vm_benchmark.png)bin80797 -> 80797 bytes
-rw-r--r--docs/testing/developer/devguide/requirements/vm2vm_hypervisor_benchmark.png (renamed from docs/testing/developer/requirements/vm2vm_hypervisor_benchmark.png)bin122975 -> 122975 bytes
-rw-r--r--docs/testing/developer/devguide/requirements/vm2vm_virtual_interface_benchmark.png (renamed from docs/testing/developer/requirements/vm2vm_virtual_interface_benchmark.png)bin99544 -> 99544 bytes
-rw-r--r--docs/testing/developer/devguide/requirements/vswitchperf_ltd.rst (renamed from docs/testing/developer/requirements/vswitchperf_ltd.rst)0
-rw-r--r--docs/testing/developer/devguide/requirements/vswitchperf_ltp.rst (renamed from docs/testing/developer/requirements/vswitchperf_ltp.rst)0
-rw-r--r--docs/testing/developer/devguide/results/index.rst (renamed from docs/testing/developer/results/index.rst)0
-rw-r--r--docs/testing/developer/devguide/results/results.rst (renamed from docs/testing/developer/results/results.rst)0
-rw-r--r--docs/testing/developer/devguide/results/scenario.rst (renamed from docs/testing/developer/results/scenario.rst)0
-rw-r--r--docs/testing/user/configguide/index.rst27
24 files changed, 44 insertions, 22 deletions
diff --git a/docs/testing/developer/design/LICENSE b/docs/testing/developer/devguide/design/LICENSE
index 7bc572ce..7bc572ce 100644
--- a/docs/testing/developer/design/LICENSE
+++ b/docs/testing/developer/devguide/design/LICENSE
diff --git a/docs/testing/developer/design/factory_and_loader.png b/docs/testing/developer/devguide/design/factory_and_loader.png
index 290c0af6..290c0af6 100644
--- a/docs/testing/developer/design/factory_and_loader.png
+++ b/docs/testing/developer/devguide/design/factory_and_loader.png
Binary files differ
diff --git a/docs/testing/developer/design/traffic_controller.png b/docs/testing/developer/devguide/design/traffic_controller.png
index 598296ec..598296ec 100644
--- a/docs/testing/developer/design/traffic_controller.png
+++ b/docs/testing/developer/devguide/design/traffic_controller.png
Binary files differ
diff --git a/docs/testing/developer/design/trafficgen_integration_guide.rst b/docs/testing/developer/devguide/design/trafficgen_integration_guide.rst
index 7dae19ba..7dae19ba 100644
--- a/docs/testing/developer/design/trafficgen_integration_guide.rst
+++ b/docs/testing/developer/devguide/design/trafficgen_integration_guide.rst
diff --git a/docs/testing/developer/design/vsperf.png b/docs/testing/developer/devguide/design/vsperf.png
index 4af2ac62..4af2ac62 100644
--- a/docs/testing/developer/design/vsperf.png
+++ b/docs/testing/developer/devguide/design/vsperf.png
Binary files differ
diff --git a/docs/testing/developer/design/vswitchperf_design.rst b/docs/testing/developer/devguide/design/vswitchperf_design.rst
index 8111b513..8111b513 100644
--- a/docs/testing/developer/design/vswitchperf_design.rst
+++ b/docs/testing/developer/devguide/design/vswitchperf_design.rst
diff --git a/docs/testing/developer/index.rst b/docs/testing/developer/devguide/index.rst
index cdda1d98..4ae155f9 100644
--- a/docs/testing/developer/index.rst
+++ b/docs/testing/developer/devguide/index.rst
@@ -4,9 +4,13 @@
.. OPNFV VSPERF Documentation master file.
-======
-VSPERF
-======
+****************************
+OPNFV VSPERF Developer Guide
+****************************
+
+============
+Introduction
+============
VSPERF is an OPNFV testing project.
@@ -28,15 +32,14 @@ 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 Developer Guide
-****************************
+=============
+Design Guides
+=============
.. toctree::
:caption: Traffic Gen Integration, VSPERF Design, Test Design, Test Plan
:maxdepth: 2
- :numbered: 2
+ :numbered:
./design/trafficgen_integration_guide.rst
./design/vswitchperf_design.rst
@@ -44,25 +47,31 @@ VSPERF Developer Guide
./requirements/vswitchperf_ltd.rst
./requirements/vswitchperf_ltp.rst
-*****************************
-VSPERF IETF Internet Draft
-*****************************
+====================
+VSPERF IETF RFC 8204
+====================
.. toctree::
:caption: vSwitch Internet Draft
:maxdepth: 2
:numbered:
-This IETF INternet Draft on `Benchmarking Virtual Switches in OPNFV <https://tools.ietf.org/html/draft-ietf-bmwg-vswitch-opnfv-01>`_ was developed by VSPERF contributors and is maintained in the IETF repo. at https://tools.ietf.org/html/
+The VSPERF test specification was summarized in a 23 page Internet Draft ... `Benchmarking Virtual Switches in OPNFV
+<https://tools.ietf.org/html/draft-ietf-bmwg-vswitch-opnfv-01>`_
+ which was contributed to the IETF Benchmarking Methodology Working Group (BMWG). The BMWG was re-chartered in 2014
+to include benchmarking for Virtualized Network Functions (VNFs) and their infrastructure. The Internet Engineering
+Steering Group of the IETF has approved the most recent version for publication as RFC 8204.
-********************************
-VSPERF Scenarios and CI Results
-********************************
+====================
+VSPERF CI Test Cases
+====================
.. toctree::
:caption: VSPERF Scenarios & Results
:maxdepth: 2
:numbered:
+CI Test cases run daily on the VSPERF Pharos POD for master and stable branches.
+
./results/scenario.rst
./results/results.rst
diff --git a/docs/testing/developer/requirements/LICENSE b/docs/testing/developer/devguide/requirements/LICENSE
index 7bc572ce..7bc572ce 100644
--- a/docs/testing/developer/requirements/LICENSE
+++ b/docs/testing/developer/devguide/requirements/LICENSE
diff --git a/docs/testing/developer/requirements/ietf_draft/LICENSE b/docs/testing/developer/devguide/requirements/ietf_draft/LICENSE
index 7fc9ae14..7fc9ae14 100644
--- a/docs/testing/developer/requirements/ietf_draft/LICENSE
+++ b/docs/testing/developer/devguide/requirements/ietf_draft/LICENSE
diff --git a/docs/testing/developer/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-00.xml b/docs/testing/developer/devguide/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-00.xml
index 2259b23c..2259b23c 100644
--- a/docs/testing/developer/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-00.xml
+++ b/docs/testing/developer/devguide/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-00.xml
diff --git a/docs/testing/developer/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-01.xml b/docs/testing/developer/devguide/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-01.xml
index c8a3d99b..c8a3d99b 100644
--- a/docs/testing/developer/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-01.xml
+++ b/docs/testing/developer/devguide/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-01.xml
diff --git a/docs/testing/developer/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-00.xml b/docs/testing/developer/devguide/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-00.xml
index b5f7f833..b5f7f833 100644
--- a/docs/testing/developer/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-00.xml
+++ b/docs/testing/developer/devguide/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-00.xml
diff --git a/docs/testing/developer/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-01.xml b/docs/testing/developer/devguide/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-01.xml
index a9405a77..a9405a77 100644
--- a/docs/testing/developer/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-01.xml
+++ b/docs/testing/developer/devguide/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-01.xml
diff --git a/docs/testing/developer/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-02.xml b/docs/testing/developer/devguide/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-02.xml
index 9157763e..9157763e 100644
--- a/docs/testing/developer/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-02.xml
+++ b/docs/testing/developer/devguide/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-02.xml
diff --git a/docs/testing/developer/requirements/vm2vm_alternative_benchmark.png b/docs/testing/developer/devguide/requirements/vm2vm_alternative_benchmark.png
index d21334ba..d21334ba 100644
--- a/docs/testing/developer/requirements/vm2vm_alternative_benchmark.png
+++ b/docs/testing/developer/devguide/requirements/vm2vm_alternative_benchmark.png
Binary files differ
diff --git a/docs/testing/developer/requirements/vm2vm_benchmark.png b/docs/testing/developer/devguide/requirements/vm2vm_benchmark.png
index 3a85e51f..3a85e51f 100644
--- a/docs/testing/developer/requirements/vm2vm_benchmark.png
+++ b/docs/testing/developer/devguide/requirements/vm2vm_benchmark.png
Binary files differ
diff --git a/docs/testing/developer/requirements/vm2vm_hypervisor_benchmark.png b/docs/testing/developer/devguide/requirements/vm2vm_hypervisor_benchmark.png
index b5b76e8a..b5b76e8a 100644
--- a/docs/testing/developer/requirements/vm2vm_hypervisor_benchmark.png
+++ b/docs/testing/developer/devguide/requirements/vm2vm_hypervisor_benchmark.png
Binary files differ
diff --git a/docs/testing/developer/requirements/vm2vm_virtual_interface_benchmark.png b/docs/testing/developer/devguide/requirements/vm2vm_virtual_interface_benchmark.png
index 55294af6..55294af6 100644
--- a/docs/testing/developer/requirements/vm2vm_virtual_interface_benchmark.png
+++ b/docs/testing/developer/devguide/requirements/vm2vm_virtual_interface_benchmark.png
Binary files differ
diff --git a/docs/testing/developer/requirements/vswitchperf_ltd.rst b/docs/testing/developer/devguide/requirements/vswitchperf_ltd.rst
index e1372520..e1372520 100644
--- a/docs/testing/developer/requirements/vswitchperf_ltd.rst
+++ b/docs/testing/developer/devguide/requirements/vswitchperf_ltd.rst
diff --git a/docs/testing/developer/requirements/vswitchperf_ltp.rst b/docs/testing/developer/devguide/requirements/vswitchperf_ltp.rst
index e5147bea..e5147bea 100644
--- a/docs/testing/developer/requirements/vswitchperf_ltp.rst
+++ b/docs/testing/developer/devguide/requirements/vswitchperf_ltp.rst
diff --git a/docs/testing/developer/results/index.rst b/docs/testing/developer/devguide/results/index.rst
index 04899b5a..04899b5a 100644
--- a/docs/testing/developer/results/index.rst
+++ b/docs/testing/developer/devguide/results/index.rst
diff --git a/docs/testing/developer/results/results.rst b/docs/testing/developer/devguide/results/results.rst
index df9c52cb..df9c52cb 100644
--- a/docs/testing/developer/results/results.rst
+++ b/docs/testing/developer/devguide/results/results.rst
diff --git a/docs/testing/developer/results/scenario.rst b/docs/testing/developer/devguide/results/scenario.rst
index a57d6a03..a57d6a03 100644
--- a/docs/testing/developer/results/scenario.rst
+++ b/docs/testing/developer/devguide/results/scenario.rst
diff --git a/docs/testing/user/configguide/index.rst b/docs/testing/user/configguide/index.rst
index a7df2ebc..bfeb0d2b 100644
--- a/docs/testing/user/configguide/index.rst
+++ b/docs/testing/user/configguide/index.rst
@@ -4,9 +4,13 @@
.. OPNFV VSPERF Documentation master file.
-======
-VSPERF
-======
+***********************************
+VSPERF Configuration and User Guide
+***********************************
+
+============
+Introduction
+============
VSPERF is an OPNFV testing project.
@@ -28,12 +32,12 @@ 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 User Guide
-******************************
+================================
+VSPERF Install and Configuration
+================================
.. toctree::
- :caption: VSPERF Install, Upgrade, Traffic Generator Guide, Test Suite Guide
+ :caption: VSPERF Install, Upgrade, Traffic Generator Guide
:maxdepth: 2
:numbered:
@@ -41,6 +45,15 @@ VSPERF User Guide
./upgrade.rst
./trafficgen.rst
+=================
+VSPERF Test Guide
+=================
+
+.. toctree::
+ :caption: VSPERF Test Execution
+ :maxdepth: 2
+ :numbered:
+
../userguide/testusage.rst
../userguide/teststeps.rst
../userguide/integration.rst