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    - **HTTP/TCP Performance**: HTTP/TCP VPP test server performance
  39      graphs.
  40    - **Comparisons**: Performance comparisons between VPP releases and
  41      between different testbed types.
  42    - **Throughput Trending**: References to continuous VPP performance
  43      trending.
  44    - **Test Environment**: Performance test environment configuration.
  45    - **Documentation**: Documentation of K8s Pod/Container orchestration
  46      in CSIT and pointers to CSIT source code documentation for VPP
  47      performance tests.
  48
  49 #. DPDK PERFORMANCE: DPDK performance tests executed in physical
  50    FD.io testbeds.
  51
  52    - **Overview**: Tested logical topologies, test coverage.
  53    - **Release Notes**: Changes in |csit-release|, known issues.
  54    - **Packet Throughput**: NDR, PDR throughput graphs based on results
  55      from repeated same test job executions to verify repeatibility of
  56      measurements.
  57    - **Packet Latency**: Latency graphs based on results from test job
  58      executions.
  59    - **Comparisons**: Performance comparisons between DPDK releases and
  60      between different testbed types.
  61    - **Throughput Trending**: References to regular DPDK performance
  62      trending.
  63    - **Test Environment**: Performance test environment configuration.
  64    - **Documentation**: Pointers to CSIT source code documentation for
  65      DPDK performance tests.
  66
  67 #. VPP DEVICE: VPP functional tests executed in physical FD.io
  68    testbeds using containers.
  69
  70    - **Overview**: Tested virtual topologies, test coverage and naming
  71      specifics;
  72    - **Release Notes**: Changes in |csit-release|, added tests,
  73      environment or methodology changes, known issues.
  74    - **Integration Tests**: Functional test environment configuration.
  75    - **Documentation**: Pointers to CSIT source code documentation for
  76      VPP functional tests.
  77
  78 #. VPP FUNCTIONAL: VPP functional tests executed in virtual FD.io
  79    testbeds.
  80
  81    - **Overview**: Tested virtual topologies, test coverage and naming
  82      specifics;
  83    - **Release Notes**: Changes in |csit-release|, added tests,
  84      environment or methodology changes, known issues.
  85    - **Test Environment**: Functional test environment configuration.
  86    - **Documentation**: Pointers to CSIT source code documentation for
  87      VPP functional tests.
  88
  89 #. HONEYCOMB FUNCTIONAL: Honeycomb functional tests executed in
  90    virtual FD.io testbeds.
  91
  92    - **Overview**: Tested virtual topologies, test coverage and naming
  93      specifics;
  94    - **Release Notes**: Changes in |csit-release|, known issues.
  95    - **Test Environment**: Functional test environment configuration.
  96    - **Documentation**: Pointers to CSIT source code documentation for
  97      Honeycomb functional tests.
  98
  99 ..
 100     #. NSH_SFC FUNCTIONAL: NSH_SFC functional tests executed in
 101        virtual FD.io testbeds.
 102
 103        - **Overview**: Tested virtual topologies, test coverage and naming
 104          specifics;
 105        - **Release Notes**: Changes in |csit-release|, known issues.
 106        - **Test Environment**: Functional test environment configuration.
 107        - **Documentation**: Pointers to CSIT source code documentation for
 108          NSH_SFC functional tests.
 109
 110 #. DMM FUNCTIONAL: DMM functional tests executed in
 111    virtual FD.io testbeds.
 112
 113    - **Overview**: Tested virtual topologies, test coverage and naming
 114      specifics;
 115    - **Release Notes**: Changes in |csit-release|, known issues.
 116    - **Test Environment**: Functional test environment configuration.
 117    - **Documentation**: Pointers to CSIT source code documentation for
 118      DMM functional tests.
 119
 120 #. DETAILED RESULTS: Detailed result tables auto-generated from CSIT
 121    test job executions using RF (Robot Framework) output files as
 122    sources.
 123
 124    - **VPP Performance NDR/PDR**: VPP NDR/PDR throughput and latency.
 125    - **VPP Performance MRR**: VPP MRR throughput.
 126    - **VPP K8s Container Memif**: VPP K8s Container/Pod topologies
 127      NDR/PDR throughput.
 128    - **DPDK Performance**: DPDK Testpmd and L3fwd NDR/PDR throughput
 129      and latency.
 130    - **VPP Functional**: Detailed VPP functional results.
 131    - **Honeycomb Functional**: Detailed HoneyComb functional results.
 132    - **NSH_SFC Functional**: Detailed nsh-plugin functional results.
 133    - **DMM Functional**: Detailed DMM functional results.
 134
 135 #. TEST CONFIGURATION: VPP DUT configuration data based on VPP API
 136    Test (VAT) Commands History auto-generated from CSIT test job
 137    executions using RF output files as sources.
 138
 139    - **VPP Performance NDR/PDR**: Configuration data.
 140    - **VPP Performance MRR**: Configuration data.
 141    - **VPP K8s Container Memif**: Configuration data.
 142    - **VPP Functional**: Configuration data.
 143
 144 #. TEST OPERATIONAL DATA: VPP DUT operational data auto-generated
 145    from CSIT test job executions using RFoutput files as sources.
 146
 147    - **VPP Performance NDR/PDR**: VPP `show run` outputs under test
 148      load.
 149
 150 #. CSIT FRAMEWORK DOCUMENTATION: Description of the overall FD.io
 151    CSIT framework.
 152
 153    - **Design**: Framework modular design hierarchy.
 154    - **Test naming**: Test naming convention.
 155    - **Presentation and Analytics Layer**: Description of PAL CSIT
 156      analytics module.
 157    - **CSIT RF Tags Descriptions**: CSIT RF Tags used for test suite and
 158      test case grouping and selection.