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