docs/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 VSPERF is an OPNFV testing project.
  11
  12 VSPERF provides an automated test-framework and comprehensive test suite based on
  13 industry standards for measuring data-plane performance of Telco NFV switching
  14 technologies as well as physical and virtual network interfaces (NFVI). The VSPERF
  15 architecture is switch and traffic generator agnostic and provides full control of
  16 software component versions and configurations as well as test-case customization.
  17
  18 The Danube release of VSPERF includes improvements in documentation and capabilities.
  19 This includes additional test-cases such as RFC 5481 Latency test and RFC-2889
  20 address-learning-rate test. Hardware traffic generator support is now provided for
  21 Spirent and Xena in addition to Ixia. The Moongen software traffic generator is also
  22 now fully supported. VSPERF can be used in a variety of modes for configuration and
  23 setup of the network and/or for control of the test-generator and test execution.
  24
  25 * Wiki: https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases
  26 * Repository: https://git.opnfv.org/vswitchperf
  27 * Artifacts: https://artifacts.opnfv.org/vswitchperf.html
  28 * Continuous Integration status: https://build.opnfv.org/ci/view/vswitchperf/
  29
  30 ******************************
  31 VSPERF User Guide
  32 ******************************
  33
  34 .. toctree::
  35    :caption: VSPERF User Guide
  36    :maxdepth: 5
  37    :numbered: 5
  38
  39    ./testing/user/configguide/installation.rst
  40    ./testing/user/configguide/upgrade.rst
  41    ./testing/user/configguide/trafficgen.rst
  42
  43    ./testing/user/userguide/testusage.rst
  44    ./testing/user/userguide/teststeps.rst
  45    ./testing/user/userguide/integration.rst
  46    ./testing/user/userguide/yardstick.rst
  47
  48 ****************************
  49 VSPERF Developer Guide
  50 ****************************
  51
  52 .. toctree::
  53    :caption: VSPERF Developer Guide
  54    :maxdepth: 5
  55    :numbered: 5
  56
  57    ./testing/developer/design/trafficgen_integration_guide.rst
  58    ./testing/developer/design/vswitchperf_design.rst
  59
  60    ./testing/developer/requirements/vswitchperf_ltd.rst
  61    ./testing/developer/requirements/vswitchperf_ltp.rst
  62
  63 *****************************
  64 VSPERF - IETF Internet Draft
  65 *****************************
  66
  67 .. toctree::
  68    :caption: IETF Internet Draft
  69    :maxdepth: 5
  70    :numbered: 5
  71
  72 `Benchmarking Virtual Switches in OPNFV <https://tools.ietf.org/html/draft-ietf-bmwg-vswitch-opnfv-01>`_
  73
  74 Location of xml drafts :doc:`./testing/developer/requirements/ietf_draft/`
  75
  76 ********************************
  77 VSPERF Scenarios and CI Results
  78 ********************************
  79
  80 .. toctree::
  81    :caption: VSPERF Scenarios & Results
  82    :maxdepth: 5
  83    :numbered: 5
  84
  85    ./testing/developer/results/scenario.rst
  86    ./testing/developer/results/results.rst
  87
  88 Indices
  89 =======
  90 * :ref:`search`