X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=docs%2Freport%2Fintroduction%2Fintroduction.rst;h=7ccc270c76ddf6270f9f6822cf94e14d9b93736d;hp=c88aeb4e30d55a6ff8c746cdcb7c09716c37a006;hb=857828c169ce6cdfda06e82978de8562f6bb743c;hpb=e253cf226e1595acecf42db1262e1cb179aae5e7 diff --git a/docs/report/introduction/introduction.rst b/docs/report/introduction/introduction.rst index c88aeb4e30..7ccc270c76 100644 --- a/docs/report/introduction/introduction.rst +++ b/docs/report/introduction/introduction.rst @@ -1,111 +1,123 @@ -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. +#. INTRODUCTION: General introduction to FD.io |csit-release|. -|csit-release| report contains following main sections and sub-sections: - -#. **Introduction**: general introduction to CSIT project. - - - **Introduction**: this section. - - **Test Scenarios Overview**: a brief overview of test scenarios + - **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. + - **Physical Testbeds**: Description of physical testbeds. + - **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 + - **Overview**: Tested logical topologies, test coverage and naming specifics. - - **Release Notes**: changes in |csit-release|, added tests, - performance changes, environment or methodology changes, known - issues. + - **Release Notes**: Changes in |csit-release|, added tests, + environment or methodology changes, known issues. - **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. - - **Test Environment**: performance test environment configuration. - - **Documentation**: documentation of K8s Pod/Container orchestration + - **Comparisons**: Performance comparisons between VPP releases and + between different testbed types. + - **Throughput Trending**: References to continuous VPP performance + trending. + - **Test Environment**: Performance test environment configuration. + - **Documentation**: Documentation of K8s Pod/Container orchestration 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. - - **Release Notes**: changes in |csit-release|, known issues. + - **Overview**: Tested logical topologies, test coverage. + - **Release Notes**: Changes in |csit-release|, known issues. - **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. - - **Test Environment**: performance test environment configuration. - - **Documentation**: pointers to CSIT source code documentation for + - **Comparisons**: Performance comparisons between DPDK releases and + between different testbed types. + - **Throughput Trending**: References to regular DPDK performance + trending. + - **Test Environment**: Performance test environment configuration. + - **Documentation**: Pointers to CSIT source code documentation for DPDK performance tests. -#. **VPP Functional**: VPP functional tests executed in virtual FD.io +#. 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. + - **Integration Tests**: Functional test environment configuration. + - **Documentation**: Pointers to CSIT source code documentation for + VPP functional tests. + +#. VPP FUNCTIONAL: VPP functional tests executed in virtual FD.io testbeds. - - **Overview**: tested virtual topologies, test coverage and naming + - **Overview**: Tested virtual topologies, test coverage and naming specifics; - - **Release Notes** - changes in |csit-release|, added tests, + - **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 + - **Test Environment**: Functional test environment configuration. + - **Documentation**: Pointers to CSIT source code documentation for VPP functional tests. -#. **Honeycomb Functional**: Honeycomb functional tests executed in +#. HONEYCOMB FUNCTIONAL: Honeycomb functional tests executed in virtual FD.io testbeds. - - **Overview**: tested virtual topologies, test coverage and naming + - **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 + - **Release Notes**: Changes in |csit-release|, known issues. + - **Test Environment**: Functional test environment configuration. + - **Documentation**: Pointers to CSIT source code documentation for Honeycomb functional tests. -#. **NSH_SFC Functional**: NSH_SFC functional tests executed in - virtual FD.io testbeds. +.. + #. 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. + - **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 + - **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 + - **Release Notes**: Changes in |csit-release|, known issues. + - **Test Environment**: Functional test environment configuration. + - **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. @@ -115,32 +127,31 @@ files are also provided. NDR/PDR throughput. - **DPDK Performance**: DPDK Testpmd and L3fwd NDR/PDR throughput 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. + - **VPP Functional**: Detailed VPP functional results. + - **Honeycomb Functional**: Detailed HoneyComb 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. - - **VPP Performance NDR/PDR**: configuration data. - - **VPP Performance MRR**: configuration data. - - **VPP K8s Container Memif**: configuration data. - - **VPP Functional**: configuration data. + - **VPP Performance NDR/PDR**: Configuration data. + - **VPP Performance MRR**: Configuration data. + - **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. - - **Test naming**: test naming convention. - - **Presentation and Analytics Layer**: description of PAL CSIT + - **Design**: Framework modular design hierarchy. + - **Test naming**: Test naming convention. + - **Presentation and Analytics Layer**: Description of PAL CSIT analytics module. - **CSIT RF Tags Descriptions**: CSIT RF Tags used for test suite and test case grouping and selection.