aboutsummaryrefslogtreecommitdiffstats
path: root/docs/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst92
1 files changed, 74 insertions, 18 deletions
diff --git a/docs/index.rst b/docs/index.rst
index bce2aa61..889d4ab6 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,6 +1,6 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. (c) OPNFV, Intel Corporation, AT&T and others.
+.. (c) OPNFV, Intel Corporation, AT&T, Red Hat, Spirent, Ixia and others.
.. OPNFV VSPERF Documentation master file.
@@ -9,28 +9,84 @@ VSPERF
======
VSPERF is an OPNFV testing project.
-VSPERF will develop a generic and architecture agnostic vSwitch testing
-framework and associated tests, that will serve as a basis for validating the
-suitability of different vSwitch implementations in a Telco NFV deployment
-environment. The output of this project will be utilized by the OPNFV
-Performance and Test group and its associated projects, as part of OPNFV
-Platform and VNF level testing and validation.
+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.
-* Project Wiki: https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases
-* Project Repository: https://git.opnfv.org/vswitchperf
-* Project Artifacts: https://artifacts.opnfv.org/vswitchperf.html
-* Continuous Integration https://build.opnfv.org/ci/view/vswitchperf/
+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
+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.
+
+* 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::
- :maxdepth: 3
+ :caption: VSPERF Installation Guide
+ :maxdepth: 5
+ :numbered: 5
+
+ ./configguide/installation.rst
+ ./configguide/upgrade.rst
+ ./configguide/trafficgen.rst
+
+******************************
+VSPERF User Guide
+******************************
+
+.. toctree::
+ :caption: VSPERF User Guide
+ :maxdepth: 5
:numbered: 5
- ./configguide/index.rst
- ./userguide/index.rst
- ./design/index.rst
- ./requirements/index.rst
- ./release/index.rst
- ./results/index.rst
+ ./userguide/testusage.rst
+ ./userguide/teststeps.rst
+ ./userguide/integration.rst
+ Yardstick integration <./userguide/yardstick.rst>
+
+**************
+VSPERF Design
+**************
+
+.. toctree::
+ :caption: VSPERF Design
+ :maxdepth: 5
+ :numbered: 5
+
+ ./design/vswitchperf_design.rst
+ ./design/trafficgen_integration_guide.rst
+
+*******************
+VSPERF Requirements
+*******************
+
+.. toctree::
+ :caption: VSPERF Requirements
+ :maxdepth: 5
+ :numbered: 5
+
+ ./requirements/vswitchperf_ltp.rst
+ ./requirements/vswitchperf_ltd.rst
+
+**************
+VSPERF Results
+**************
+
+.. toctree::
+ :maxdepth: 3
+
+ ./results/scenario.rst
+ ./results/results.rst
Indices
=======