aboutsummaryrefslogtreecommitdiffstats
path: root/docs/testing/developer/devguide/index.rst
blob: 236fb3d90564e0a21cf77b6d6189a4476bd96fc0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
.. 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, Red Hat, Spirent, Ixia  and others.

.. OPNFV VSPERF Documentation master file.

****************************
OPNFV VSPERF Developer Guide
****************************

============
Introduction
============

VSPERF is an OPNFV testing project.

VSPERF is an OPNFV project that provides an automated test-framework and comprehensive test suite based on Industry
Test Specifications for measuring NFVI data-plane performance. The data-path includes switching technologies with
physical and virtual network interfaces. The VSPERF architecture is switch and traffic generator agnostic and test
cases can be easily customized. Software versions and configurations including the vSwitch (OVS or VPP) as well as
the network topology are controlled by VSPERF (independent of OpenStack). VSPERF is used as a development tool for
optimizing switching technologies, qualification of packet processing components and for pre-deployment evaluation
of the NFV platform data-path.

The Euphrates release adds new features and improvements that will help advance high performance packet processing
on Telco NFV platforms. This includes new test cases, flexibility in customizing test-cases, new results display
options, improved tool resiliency, additional traffic generator support and VPP support.

VSPERF provides a framework where the entire NFV Industry can learn about NFVI data-plane performance and try-out
new techniques together. A new IETF benchmarking specification (RFC8204) is based on VSPERF work contributed since
2015. VSPERF is also contributing to development of ETSI NFV test specifications through the Test and Open Source
Working Group.

* 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: https://build.opnfv.org/ci/view/vswitchperf/

=============
Design Guides
=============

.. toctree::
   :caption: Traffic Gen Integration, VSPERF Design, Test Design, Test Plan
   :maxdepth: 2
   :numbered:

   ./design/trafficgen_integration_guide.rst
   ./design/vswitchperf_design.rst

   ./requirements/vswitchperf_ltd.rst
   ./requirements/vswitchperf_ltp.rst

=============
IETF RFC 8204
=============

.. toctree::
   :caption: VSPERF contributions to Industry Specifications
   :maxdepth: 2
   :numbered:

The IETF Benchmarking Methodology Working Group (BMWG) was re-chartered in 2014 to include benchmarking for
Virtualized Network Functions (VNFs) and their infrastructure. A version of the VSPERF test specification was
summarized in an Internet Draft ... `Benchmarking Virtual Switches in OPNFV <https://tools.ietf.org/html/draft-ietf-bmwg-vswitch-opnfv-01>`_ and contributed to the BMWG. In June 2017 the Internet Engineering Steering Group of the IETF
approved the most recent version of the draft for publication as a new test specification (RFC 8204).

====================
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