X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=docs%2Freport%2Fintroduction%2Fintroduction.rst;h=7ccc270c76ddf6270f9f6822cf94e14d9b93736d;hp=e5fa19b08d401ad22476b8bd9cc82c4a87775dbb;hb=857828c169ce6cdfda06e82978de8562f6bb743c;hpb=637eb126bb4ed30df61a293e03d36bd8ad5265e5 diff --git a/docs/report/introduction/introduction.rst b/docs/report/introduction/introduction.rst index e5fa19b08d..7ccc270c76 100644 --- a/docs/report/introduction/introduction.rst +++ b/docs/report/introduction/introduction.rst @@ -1,34 +1,22 @@ -Introduction -============ +Report Structure +================ -This is FD.io CSIT (Fast Data i/o Continuous System Integration and -Testing) project report for |csit-release| system performance and -functional testing of |vpp-release|. +FD.io |csit-release| report contains system performance and functional +testing data of |vpp-release|. `PDF version of this report`_ is +available for download. -There is also a downloadable `PDF version of this report`_. +|csit-release| report is structured as follows: -This report describes CSIT performance and functional tests delivered in -|csit-release|. A high-level overview is provided for each CSIT test -environment running in :abbr:`LF (Linux Foundation)` FD.io Continuous -Performance Labs. This is followed by summary of all executed tests -against the |vpp-release| and associated FD.io projects and sub-systems -(Honeycomb, DPDK, NSH_SFC, DMM), |csit-release| release notes, result -highlights and known issues discovered in CSIT. More detailed -description of each environment, pointers to CSIT test code -documentation and detailed test resuls with links to the source data -files are also provided. - -|csit-release| report contains following main sections and sub-sections: - -#. **Introduction**: General introduction to CSIT project. +#. INTRODUCTION: General introduction to FD.io |csit-release|. - **Introduction**: This section. - **Test Scenarios Overview**: A brief overview of test scenarios covered in this report. - **Physical Testbeds**: Description of physical testbeds. - - **Performance Test Methodology**: Benchmarking methodologies. + - **Test Methodology**: Performance benchmarking and functional test + methodologies. -#. **VPP Performance**: VPP performance tests executed in physical +#. VPP PERFORMANCE: VPP performance tests executed in physical FD.io testbeds. - **Overview**: Tested logical topologies, test coverage and naming @@ -38,10 +26,15 @@ files are also provided. - **Packet Throughput**: NDR, PDR throughput graphs based on results from repeated same test job executions to verify repeatibility of measurements. - - **Packet Latency**: Latency graphs based on results from test job - executions. - **Speedup Multi-Core**: NDR, PDR throughput multi-core speedup graphs based on results from test job executions. + - **Packet Latency**: Latency graphs based on results from test job + executions. + - **Soak Tests**: Long duration soak tests are executed using PLRsearch + algorithm. + - **NFV Service Density**: Network Function Virtualization (NFV) service + density tests focus on measuring total per server throughput at varied NFV + service "packing" densities with vswitch providing host dataplane. - **HTTP/TCP Performance**: HTTP/TCP VPP test server performance graphs. - **Comparisons**: Performance comparisons between VPP releases and @@ -53,7 +46,7 @@ files are also provided. in CSIT and pointers to CSIT source code documentation for VPP performance tests. -#. **DPDK Performance**: DPDK performance tests executed in physical +#. DPDK PERFORMANCE: DPDK performance tests executed in physical FD.io testbeds. - **Overview**: Tested logical topologies, test coverage. @@ -71,28 +64,29 @@ files are also provided. - **Documentation**: Pointers to CSIT source code documentation for DPDK performance tests. -#. **VPP Functional**: VPP functional tests executed in virtual FD.io - testbeds. +#. VPP DEVICE: VPP functional tests executed in physical FD.io + testbeds using containers. - **Overview**: Tested virtual topologies, test coverage and naming specifics; - **Release Notes**: Changes in |csit-release|, added tests, environment or methodology changes, known issues. - - **Test Environment**: Functional test environment configuration. + - **Integration Tests**: Functional test environment configuration. - **Documentation**: Pointers to CSIT source code documentation for VPP functional tests. -#. **Honeycomb Functional**: Honeycomb functional tests executed in - virtual FD.io testbeds. +#. VPP FUNCTIONAL: VPP functional tests executed in virtual FD.io + testbeds. - **Overview**: Tested virtual topologies, test coverage and naming specifics; - - **Release Notes**: Changes in |csit-release|, known issues. + - **Release Notes**: Changes in |csit-release|, added tests, + environment or methodology changes, known issues. - **Test Environment**: Functional test environment configuration. - **Documentation**: Pointers to CSIT source code documentation for - Honeycomb functional tests. + VPP functional tests. -#. **NSH_SFC Functional**: NSH_SFC functional tests executed in +#. HONEYCOMB FUNCTIONAL: Honeycomb functional tests executed in virtual FD.io testbeds. - **Overview**: Tested virtual topologies, test coverage and naming @@ -100,9 +94,20 @@ files are also provided. - **Release Notes**: Changes in |csit-release|, known issues. - **Test Environment**: Functional test environment configuration. - **Documentation**: Pointers to CSIT source code documentation for - NSH_SFC functional tests. + Honeycomb functional tests. + +.. + #. NSH_SFC FUNCTIONAL: NSH_SFC functional tests executed in + virtual FD.io testbeds. + + - **Overview**: Tested virtual topologies, test coverage and naming + specifics; + - **Release Notes**: Changes in |csit-release|, known issues. + - **Test Environment**: Functional test environment configuration. + - **Documentation**: Pointers to CSIT source code documentation for + NSH_SFC functional tests. -#. **DMM Functional**: DMM functional tests executed in +#. DMM FUNCTIONAL: DMM functional tests executed in virtual FD.io testbeds. - **Overview**: Tested virtual topologies, test coverage and naming @@ -112,7 +117,7 @@ files are also provided. - **Documentation**: Pointers to CSIT source code documentation for DMM functional tests. -#. **Detailed Results**: Detailed result tables auto-generated from CSIT +#. DETAILED RESULTS: Detailed result tables auto-generated from CSIT test job executions using RF (Robot Framework) output files as sources. @@ -124,10 +129,9 @@ files are also provided. and latency. - **VPP Functional**: Detailed VPP functional results. - **Honeycomb Functional**: Detailed HoneyComb functional results. - - **NSH_SFC Functional**: Detailed nsh-plugin functional results. - **DMM Functional**: Detailed DMM functional results. -#. **Test Configuration**: VPP DUT configuration data based on VPP API +#. TEST CONFIGURATION: VPP DUT configuration data based on VPP API Test (VAT) Commands History auto-generated from CSIT test job executions using RF output files as sources. @@ -136,13 +140,13 @@ files are also provided. - **VPP K8s Container Memif**: Configuration data. - **VPP Functional**: Configuration data. -#. **Test Operational Data**: VPP DUT operational data auto-generated +#. TEST OPERATIONAL DATA: VPP DUT operational data auto-generated from CSIT test job executions using RFoutput files as sources. - **VPP Performance NDR/PDR**: VPP `show run` outputs under test load. -#. **CSIT Framework Documentation**: Description of the overall FD.io +#. CSIT FRAMEWORK DOCUMENTATION: Description of the overall FD.io CSIT framework. - **Design**: Framework modular design hierarchy.