Merge "ixia: Support of 1 NIC connection to trafficgen"
[vswitchperf.git] / docs / testing / developer / index.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. (c) OPNFV, Intel Corporation, AT&T, Red Hat, Spirent, Ixia  and others.
4
5 .. OPNFV VSPERF Documentation master file.
6
7 ======
8 VSPERF
9 ======
10
11 VSPERF is an OPNFV testing project.
12
13 VSPERF provides an automated test-framework and comprehensive test suite based on
14 industry standards for measuring data-plane performance of Telco NFV switching
15 technologies as well as physical and virtual network interfaces (NFVI). The VSPERF
16 architecture is switch and traffic generator agnostic and provides full control of
17 software component versions and configurations as well as test-case customization.
18
19 The Danube release of VSPERF includes improvements in documentation and capabilities.
20 This includes additional test-cases such as RFC 5481 Latency test and RFC-2889
21 address-learning-rate test. Hardware traffic generator support is now provided for
22 Spirent and Xena in addition to Ixia. The Moongen software traffic generator is also
23 now fully supported. VSPERF can be used in a variety of modes for configuration and
24 setup of the network and/or for control of the test-generator and test execution.
25
26 * Wiki: https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases
27 * Repository: https://git.opnfv.org/vswitchperf
28 * Artifacts: https://artifacts.opnfv.org/vswitchperf.html
29 * Continuous Integration status: https://build.opnfv.org/ci/view/vswitchperf/
30
31
32 ****************************
33 VSPERF Developer Guide
34 ****************************
35
36 .. toctree::
37    :caption: Traffic Gen Integration, VSPERF Design, Test Design, Test Plan
38    :maxdepth: 2
39    :numbered: 2
40
41    ./design/trafficgen_integration_guide.rst
42    ./design/vswitchperf_design.rst
43
44    ./requirements/vswitchperf_ltd.rst
45    ./requirements/vswitchperf_ltp.rst
46
47 *****************************
48 VSPERF IETF Internet Draft
49 *****************************
50
51 .. toctree::
52    :caption: vSwitch Internet Draft
53    :maxdepth: 2
54    :numbered:
55
56 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/
57
58 ********************************
59 VSPERF Scenarios and CI Results
60 ********************************
61
62 .. toctree::
63    :caption: VSPERF Scenarios & Results
64    :maxdepth: 2
65    :numbered:
66
67    ./results/scenario.rst
68    ./results/results.rst