.. 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.
======
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 User Guide
+******************************
+
+.. toctree::
+ :caption: VSPERF User Guide
+ :maxdepth: 5
+ :numbered: 5
+
+ ./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 Developer Guide
+****************************
+
+.. toctree::
+ :caption: VSPERF Developer Guide
+ :maxdepth: 5
+ :numbered: 5
+
+ ./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 - IETF Internet Draft
+*****************************
+
+.. toctree::
+ :caption: IETF Internet Draft
+ :maxdepth: 5
+ :numbered: 5
+
+`Benchmarking Virtual Switches in OPNFV <https://tools.ietf.org/html/draft-ietf-bmwg-vswitch-opnfv-01>`_
+
+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
- ./configguide/index.rst
- ./userguide/index.rst
- ./design/index.rst
- ./requirements/index.rst
- ./release/index.rst
- ./results/index.rst
+ ./testing/developer/results/scenario.rst
+ ./testing/developer/results/results.rst
Indices
=======
Code Review / vswitchperf.git / blobdiff