docs/report/introduction/introduction.rst

   1 Report Structure
   2 ================
   3
   4 FD.io |csit-release| report contains system performance and functional
   5 testing data of |vpp-release|. `PDF version of this report`_ is
   6 available for download.
   7
   8 |csit-release| report is structured as follows:
   9
  10 #. INTRODUCTION: General introduction to FD.io |csit-release|.
  11
  12    - **Introduction**: This section.
  13    - **Test Scenarios Overview**: A brief overview of test scenarios
  14      covered in this report.
  15    - **Physical Testbeds**: Description of physical testbeds.
  16    - **Test Methodology**: Performance benchmarking and functional test
  17      methodologies.
  18
  19 #. VPP PERFORMANCE: VPP performance tests executed in physical
  20    FD.io testbeds.
  21
  22    - **Overview**: Tested logical topologies, test coverage and naming
  23      specifics.
  24    - **Release Notes**: Changes in |csit-release|, added tests,
  25      environment or methodology changes, known issues.
  26    - **Packet Throughput**: NDR, PDR throughput graphs based on results
  27      from repeated same test job executions to verify repeatibility of
  28      measurements.
  29    - **Speedup Multi-Core**: NDR, PDR throughput multi-core speedup
  30      graphs based on results from test job executions.
  31    - **Packet Latency**: Latency graphs based on results from test job
  32      executions.
  33    - **Soak Tests**: Long duration soak tests are executed using PLRsearch
  34      algorithm.
  35    - **NFV Service Density**: Network Function Virtualization (NFV) service
  36      density tests focus on measuring total per server throughput at varied NFV
  37      service "packing" densities with vswitch providing host dataplane.
  38    - **Comparisons**: Performance comparisons between VPP releases and
  39      between different testbed types.
  40    - **Throughput Trending**: References to continuous VPP performance
  41      trending.
  42    - **Test Environment**: Performance test environment configuration.
  43    - **Documentation**: Pointers to CSIT source code documentation for VPP
  44      performance tests.
  45
  46 #. DPDK PERFORMANCE: DPDK performance tests executed in physical
  47    FD.io testbeds.
  48
  49    - **Overview**: Tested logical topologies, test coverage.
  50    - **Release Notes**: Changes in |csit-release|, known issues.
  51    - **Packet Throughput**: NDR, PDR throughput graphs based on results
  52      from repeated same test job executions to verify repeatibility of
  53      measurements.
  54    - **Packet Latency**: Latency graphs based on results from test job
  55      executions.
  56    - **Comparisons**: Performance comparisons between DPDK releases and
  57      between different testbed types.
  58    - **Throughput Trending**: References to regular DPDK performance
  59      trending.
  60    - **Test Environment**: Performance test environment configuration.
  61    - **Documentation**: Pointers to CSIT source code documentation for
  62      DPDK performance tests.
  63
  64 #. VPP DEVICE: VPP functional tests executed in physical FD.io
  65    testbeds using containers.
  66
  67    - **Overview**: Tested virtual topologies, test coverage and naming
  68      specifics;
  69    - **Release Notes**: Changes in |csit-release|, added tests,
  70      environment or methodology changes, known issues.
  71    - **Integration Tests**: Functional test environment configuration.
  72    - **Documentation**: Pointers to CSIT source code documentation for
  73      VPP functional tests.
  74
  75 #. VPP FUNCTIONAL: VPP functional tests executed in virtual FD.io
  76    testbeds.
  77
  78    - **Overview**: Tested virtual topologies, test coverage and naming
  79      specifics;
  80    - **Release Notes**: Changes in |csit-release|, added tests,
  81      environment or methodology changes, known issues.
  82    - **Test Environment**: Functional test environment configuration.
  83    - **Documentation**: Pointers to CSIT source code documentation for
  84      VPP functional tests.
  85
  86 #. DETAILED RESULTS: Detailed result tables auto-generated from CSIT
  87    test job executions using RF (Robot Framework) output files as
  88    sources.
  89
  90    - **VPP Performance NDR/PDR**: VPP NDR/PDR throughput and latency.
  91    - **VPP Performance MRR**: VPP MRR throughput.
  92    - **DPDK Performance**: DPDK Testpmd and L3fwd NDR/PDR throughput
  93      and latency.
  94    - **VPP Functional**: Detailed VPP functional results.
  95    - **Honeycomb Functional**: Detailed HoneyComb functional results.
  96
  97 #. TEST CONFIGURATION: VPP DUT configuration data based on VPP API
  98    Test (VAT) Commands History auto-generated from CSIT test job
  99    executions using RF output files as sources.
 100
 101    - **VPP Performance NDR/PDR**: Configuration data.
 102    - **VPP Performance MRR**: Configuration data.
 103    - **VPP Functional**: Configuration data.
 104
 105 #. TEST OPERATIONAL DATA: VPP DUT operational data auto-generated
 106    from CSIT test job executions using RFoutput files as sources.
 107
 108    - **VPP Performance NDR/PDR**: VPP `show run` outputs under test
 109      load.
 110
 111 #. CSIT FRAMEWORK DOCUMENTATION: Description of the overall FD.io
 112    CSIT framework.
 113
 114    - **Design**: Framework modular design hierarchy.
 115    - **Test naming**: Test naming convention.
 116    - **Presentation and Analytics Layer**: Description of PAL CSIT
 117      analytics module.
 118    - **CSIT RF Tags Descriptions**: CSIT RF Tags used for test suite and
 119      test case grouping and selection.
 120
 121 ..
 122     #. DMM FUNCTIONAL: DMM functional tests executed in
 123        virtual FD.io testbeds.
 124
 125        - **Overview**: Tested virtual topologies, test coverage and naming
 126          specifics;
 127        - **Release Notes**: Changes in |csit-release|, known issues.
 128        - **Test Environment**: Functional test environment configuration.
 129        - **Documentation**: Pointers to CSIT source code documentation for
 130          DMM functional tests.