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 and others.
   4
   5 .. OPNFV VSPERF Documentation master file.
   6
   7 ======
   8 VSPERF
   9 ======
  10 VSPERF is an OPNFV testing project.
  11
  12 VSPERF will develop a generic and architecture agnostic vSwitch testing
  13 framework and associated tests, that will serve as a basis for validating the
  14 suitability of different vSwitch implementations in a Telco NFV deployment
  15 environment. The output of this project will be utilized by the OPNFV
  16 Performance and Test group and its associated projects, as part of OPNFV
  17 Platform and VNF level testing and validation.
  18
  19 * Project Wiki: https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases
  20 * Project Repository: https://git.opnfv.org/vswitchperf
  21 * Project Artifacts: https://artifacts.opnfv.org/vswitchperf.html
  22 * Continuous Integration https://build.opnfv.org/ci/view/vswitchperf/
  23
  24 ******************************
  25 VSPERF Installation Guide
  26 ******************************
  27
  28 .. toctree::
  29    :caption: VSPERF Installation Guide
  30    :maxdepth: 5
  31    :numbered: 5
  32
  33    ./configguide/installation.rst
  34    ./configguide/upgrade.rst
  35    ./configguide/trafficgen.rst
  36
  37 ******************************
  38 VSPERF User Guide
  39 ******************************
  40
  41 .. toctree::
  42    :caption: VSPERF User Guide
  43    :maxdepth: 5
  44    :numbered: 5
  45
  46    ./userguide/testusage.rst
  47    ./userguide/teststeps.rst
  48    ./userguide/integration.rst
  49    Yardstick integration <./userguide/yardstick.rst>
  50
  51 **************
  52 VSPERF Design
  53 **************
  54
  55 .. toctree::
  56    :caption: VSPERF Design
  57    :maxdepth: 5
  58    :numbered: 5
  59
  60    ./design/vswitchperf_design.rst
  61    ./design/trafficgen_integration_guide.rst
  62
  63 *******************
  64 VSPERF Requirements
  65 *******************
  66
  67 .. toctree::
  68    :caption: VSPERF Requirements
  69    :maxdepth: 5
  70    :numbered: 5
  71
  72    ./requirements/vswitchperf_ltp.rst
  73    ./requirements/vswitchperf_ltd.rst
  74
  75 .. toctree::
  76    :titlesonly:
  77    :maxdepth: 3
  78
  79    ./release/NEWS.rst
  80
  81 **************
  82 VSPERF Results
  83 **************
  84
  85 .. toctree::
  86    :maxdepth: 3
  87
  88    ./results/scenario.rst
  89    ./results/results.rst
  90
  91 Indices
  92 =======
  93 * :ref:`search`