CSIT-1229: Add DMM to report
[csit.git] / docs / report / introduction / overview.rst
index 4aac352..c3537a9 100644 (file)
@@ -2,76 +2,82 @@ Overview
 ========
 
 This is the **F**\ast **D**\ata **I**/**O** Project (**FD.io**) **C**\ontinuous
-**S**\ystem **I**\ntegration and **T**\esting (**CSIT**) project report for CSIT
-|release| system testing of |vpp-release|.
+**S**\ystem **I**\ntegration and **T**\esting (**CSIT**) project report for
+|csit-release| system testing of |vpp-release|.
+
+This is the full html version, there is also a reduced
+`PDF version of this report`_.
 
 The report describes CSIT functional and performance tests and their
-continuous execution delivered in CSIT |release|. A high-level overview is
-provided for each CSIT test environment running in Linux Foundation (LF) 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), CSIT |release| release notes, result highlights and
+continuous execution 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), |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:
+|csit-release| report contains following main sections and sub-sections:
 
 #. **Introduction** - general introduction to CSIT project; *Overview* -
-   this section; *CSIT Test Naming* - CSIT general naming convention for test
-   suites and test cases, important to recognize the high-level test content
-   and interpret reported results; *General Notes* - general notes related to
-   this report.
+   this section; *General Notes* - general notes related to this report;
+   *Physical Testbeds* - Description of physical testbeds used in CSIT;
+   *Performance Test Methodology* - Methodologies used in CSIT.
 
-#. **VPP Performance Tests** - VPP performance tests executed in physical
+#. **VPP Performance** - VPP performance tests executed in physical
    FD.io testbeds; *Overview* - tested topologies, test coverage and naming
    specifics, methodology for multi-core, packet throughput and latency, and
-   KVM VM vhost tests; *CSIT Release Notes* - changes in CSIT |release|, added
+   KVM VM vhost tests; *CSIT Release Notes* - changes in |csit-release|, added
    tests, performance changes, environment or methodology changes, known CSIT
    issues; *Packet Throughput Graphs* and *Packet Latency
    Graphs* - plotted NDR, PDR throughput and latency results from multiple
-   test job executions; *Test Environment* - environment description;
-   *Documentation* - CSIT source code documentation for VPP performance tests.
+   test job executions; *Throughput Speedup Multi-Core* - plotted core
+   configuration speedup comparision; *Test Environment* - environment
+   description; *VPP HTTP Server Performance Results* - plotted HTTP Server
+   performance; *Documentation* - CSIT source code documentation for VPP
+   performance tests.
 
-#. **DPDK Performance Tests** - DPDK performance tests executed in
+#. **DPDK Performance** - DPDK performance tests executed in
    physical FD.io testbeds; *Overview* - tested topologies, test coverage;
-   *CSIT Release Notes* - changes in CSIT |release|, any known CSIT issues;
+   *CSIT Release Notes* - changes in |csit-release|, any known CSIT issues;
    *Packet Throughput Graphs* and *Packet Latency Graphs*
    - plotted NDR, PDR throughput and latency results from multiple test job
    executions; *Test Environment* - environment description; *Documentation* -
    CSIT source code documentation for DPDK performance tests.
 
-#. **VPP Functional Tests** - VPP functional tests executed in virtual
+#. **VPP Functional** - VPP functional tests executed in virtual
    FD.io testbeds; *Overview* - tested virtual topologies, test coverage and
-   naming specifics; *CSIT Release Notes* - changes in CSIT |release|, added
+   naming specifics; *CSIT Release Notes* - changes in |csit-release|, added
    tests, environment or methodology changes, known CSIT issues, tests to be
    added; *Test Environment* - environment description ; *Documentation* -
    source code documentation for VPP functional tests.
 
-#. **HoneyComb Functional Tests** - HoneyComb functional tests executed in
+#. **Honeycomb Functional** - Honeycomb functional tests executed in
    virtual FD.io testbeds; *Overview* - tested virtual topologies, test
    coverage and naming specifics; *CSIT Release Notes* - changes in CSIT
    |release|, added tests, environment or methodology changes, known CSIT issues;
-   *Test Environment* - environment description ;
+   *Test Environment* - environment description;
    *Documentation* - source code documentation for Honeycomb functional tests.
 
-#. **VPP Unit Tests** - refers to VPP functional unit tests executed as
-   part of vpp make test verify option within the FD.io VPP project; listed in
-   this report to give a more complete view about executed VPP functional tests;
-   *Overview* - short overview of unit test framework and executed tests;
-   *Documentation* - source code documentation of VPP unit tests.
-
-#. **NSH_SFC Functional Tests** - 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 specifics; *CSIT Release Notes* - changes in CSIT
    |release|, added tests, environment or methodology changes, known CSIT issues;
-   *Test Environment* - environment description ;
+   *Test Environment* - environment description;
    *Documentation* - source code documentation for NSH_SFC functional tests.
 
-#. **Detailed Test Results** - auto-generated results from CSIT jobs
+#. **DMM Functional** - DMM functional tests executed in
+   virtual FD.io testbeds; *Overview* - tested virtual topologies, test
+   coverage and naming specifics; *CSIT Release Notes* - changes in CSIT
+   |release|, added tests, environment or methodology changes, known CSIT issues;
+   *Test Environment* - environment description;
+   *Documentation* - source code documentation for DMM functional tests.
+
+#. **Detailed Results** - auto-generated results from CSIT jobs
    executions using CSIT Robot Framework output files as source data; *VPP
    Performance Results*, *DPDK Performance Results*, *VPP Functional
-   Results*, *HoneyComb Functional Results*, *VPPtest Functional Results*.
+   Results*, *Honeycomb Functional Results*, *VPPtest Functional Results*.
 
 #. **Test Configuration** - auto-generated DUT configuration data from CSIT jobs
    executions using CSIT Robot Framework output files as source data; *VPP
@@ -80,3 +86,8 @@ CSIT |release| report contains following main sections and sub-sections:
 #. **Test Operational Data** - auto-generated DUT operational data from CSIT jobs
    executions using CSIT Robot Framework output files as source data; *VPP
    Performance Operational Data*.
+
+#. **CSIT Framework Documentation** - description of the overall CSIT
+   framework design hierarchy, CSIT test naming convention, followed by
+   description of Presentation and Analytics Layer (PAL) introduced in
+   CSIT-17.07 and description of CSIT RF Tags.