X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=docs%2Freport%2Fintroduction%2Fintroduction.rst;h=c15df8d9bc3e10b2174c514584e38efff590c365;hb=1077b448dd6c9397cfa5a3c2773ea4b8863f3016;hp=e5fa19b08d401ad22476b8bd9cc82c4a87775dbb;hpb=637eb126bb4ed30df61a293e03d36bd8ad5265e5;p=csit.git diff --git a/docs/report/introduction/introduction.rst b/docs/report/introduction/introduction.rst index e5fa19b08d..c15df8d9bc 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 @@ -53,7 +41,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,7 +59,7 @@ 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 +#. VPP FUNCTIONAL: VPP functional tests executed in virtual FD.io testbeds. - **Overview**: Tested virtual topologies, test coverage and naming @@ -82,7 +70,7 @@ files are also provided. - **Documentation**: Pointers to CSIT source code documentation for VPP functional tests. -#. **Honeycomb Functional**: Honeycomb functional tests executed in +#. HONEYCOMBE FUNCTIONAL: Honeycomb functional tests executed in virtual FD.io testbeds. - **Overview**: Tested virtual topologies, test coverage and naming @@ -92,7 +80,7 @@ files are also provided. - **Documentation**: Pointers to CSIT source code documentation for Honeycomb functional tests. -#. **NSH_SFC Functional**: NSH_SFC functional tests executed in +#. NSH_SFC FUNCTIONAL: NSH_SFC functional tests executed in virtual FD.io testbeds. - **Overview**: Tested virtual topologies, test coverage and naming @@ -102,7 +90,7 @@ files are also provided. - **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 +100,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. @@ -127,7 +115,7 @@ files are also provided. - **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 +124,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.