docs/testing/developer/devguide/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 OPNFV VSPERF Developer Guide
   9 ****************************
  10
  11 ============
  12 Introduction
  13 ============
  14
  15 VSPERF is an OPNFV testing project.
  16
  17 VSPERF provides an automated test-framework and comprehensive test suite based on Industry
  18 Test Specifications for measuring NFVI data-plane performance. The data-path includes switching technologies with
  19 physical and virtual network interfaces. The VSPERF architecture is switch and traffic generator agnostic and test
  20 cases can be easily customized. VSPERF was designed to be independent of OpenStack therefore OPNFV installer scenarios
  21 are not required. VSPERF can source, configure and deploy the device-under-test using specified software versions and
  22 network topology. VSPERF is used as a development tool for optimizing switching technologies, qualification of packet
  23 processing functions and for evaluation of data-path performance.
  24
  25 The Euphrates release adds new features and improvements that will help advance high performance packet processing
  26 on Telco NFV platforms. This includes new test cases, flexibility in customizing test-cases, new results display
  27 options, improved tool resiliency, additional traffic generator support and VPP support.
  28
  29 VSPERF provides a framework where the entire NFV Industry can learn about NFVI data-plane performance and try-out
  30 new techniques together. A new IETF benchmarking specification (RFC8204) is based on VSPERF work contributed since
  31 2015. VSPERF is also contributing to development of ETSI NFV test specifications through the Test and Open Source
  32 Working Group.
  33
  34 * Wiki: https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases
  35 * Repository: https://git.opnfv.org/vswitchperf
  36 * Artifacts: https://artifacts.opnfv.org/vswitchperf.html
  37 * Continuous Integration: https://build.opnfv.org/ci/view/vswitchperf/
  38
  39 =============
  40 Design Guides
  41 =============
  42
  43 .. toctree::
  44    :caption: Traffic Gen Integration, VSPERF Design, Test Design, Test Plan
  45    :maxdepth: 2
  46    :numbered:
  47
  48    ./design/trafficgen_integration_guide.rst
  49    ./design/vswitchperf_design.rst
  50
  51    ./requirements/vswitchperf_ltd.rst
  52    ./requirements/vswitchperf_ltp.rst
  53
  54 =============
  55 IETF RFC 8204
  56 =============
  57
  58 .. toctree::
  59    :caption: VSPERF contributions to Industry Specifications
  60    :maxdepth: 2
  61    :numbered:
  62
  63 The IETF Benchmarking Methodology Working Group (BMWG) was re-chartered in 2014 to include benchmarking for
  64 Virtualized Network Functions (VNFs) and their infrastructure. A version of the VSPERF test specification was
  65 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
  66 approved the most recent version of the draft for publication as a new test specification (RFC 8204).
  67
  68 ====================
  69 VSPERF CI Test Cases
  70 ====================
  71
  72 .. toctree::
  73    :caption: VSPERF Scenarios & Results
  74    :maxdepth: 2
  75    :numbered:
  76
  77 CI Test cases run daily on the VSPERF Pharos POD for master and stable branches.
  78
  79    ./results/scenario.rst
  80    ./results/results.rst