CSIT-612 Report: Minimization of hand-crafted content.
[csit.git] / docs / report / introduction / overview.rst
index ee1a91c..30f62a9 100644 (file)
@@ -3,17 +3,17 @@ Overview
 \r
 This is the **F**\ast **D**\ata **I**/**O** Project (**FD.io**) **C**\ontinuous\r
 **S**\ystem **I**\ntegration and **T**\esting (**CSIT**) project report for CSIT\r
-|release| system testing of VPP-17.01 release.\r
+|release| system testing of |vpp-release|.\r
 \r
 The report describes CSIT functional and performance tests and their\r
 continuous execution delivered in CSIT |release|. A high-level overview is\r
 provided for each CSIT test environment running in Linux Foundation (LF) FD.io\r
 Continuous Performance Labs. This is followed by summary of all executed tests\r
-against the VPP-17.01 release and associated sub-systems (HoneyComb, DPDK),\r
-CSIT |release| release notes, result highlights and known issues. More\r
-detailed description of each environment, pointers to CSIT test code\r
-documentation and detailed test resuls with links to the source data files are\r
-also provided.\r
+against the |vpp-release| and associated FD.io projects and sub-systems\r
+(HoneyComb, DPDK), CSIT |release| release notes, result highlights and known\r
+issues discovered in CSIT. More detailed description of each environment,\r
+pointers to CSIT test code documentation and detailed test resuls with links to\r
+the source data files are also provided.\r
 \r
 CSIT |release| report contains following main sections and sub-sections:\r
 \r
@@ -28,19 +28,18 @@ CSIT |release| report contains following main sections and sub-sections:
    specifics, methodology for multi-core, packet throughput and latency, and\r
    KVM VM vhost tests; *CSIT Release Notes* - changes in CSIT |release|, added\r
    tests, performance changes, environment or methodology changes, known CSIT\r
-   issues, tests to be added; *Packet Throughput Graphs* and *Packet Latency\r
+   issues; *Packet Throughput Graphs* and *Packet Latency\r
    Graphs* - plotted NDR, PDR throughput and latency results from multiple\r
-   test job executions; *Test Environment* - environment description ;\r
-   *Documentation* - source code documentation for VPP performance tests.\r
+   test job executions; *Test Environment* - environment description;\r
+   *Documentation* - CSIT source code documentation for VPP performance tests.\r
 \r
 #. **Testpmd Performance Tests** - Testpmd performance tests executed in\r
    physical FD.io testbeds; *Overview* - tested topologies, test coverage;\r
    *CSIT Release Notes* - changes in CSIT |release|, any known CSIT issues;\r
-   *Tests to Be Added* - performance tests to be added in the next revision of\r
-   CSIT |release| report; *Packet Throughput Graphs* and *Packet Latency Graphs*\r
+   *Packet Throughput Graphs* and *Packet Latency Graphs*\r
    - plotted NDR, PDR throughput and latency results from multiple test job\r
    executions; *Test Environment* - environment description; *Documentation* -\r
-   source code documentation for Testpmd performance tests.\r
+   CSIT source code documentation for Testpmd performance tests.\r
 \r
 #. **VPP Functional Tests** - VPP functional tests executed in virtual\r
    FD.io testbeds; *Overview* - tested virtual topologies, test coverage and\r
@@ -52,8 +51,8 @@ CSIT |release| report contains following main sections and sub-sections:
 #. **HoneyComb Functional Tests** - HoneyComb functional tests executed in\r
    virtual FD.io testbeds; *Overview* - tested virtual topologies, test\r
    coverage and naming specifics; *CSIT Release Notes* - changes in CSIT\r
-   |release|, added tests, environment or methodology changes, known CSIT issues,\r
-   tests to be added; *Test Environment* - environment description ;\r
+   |release|, added tests, environment or methodology changes, known CSIT issues;\r
+   *Test Environment* - environment description ;\r
    *Documentation* - source code documentation for Honeycomb functional tests.\r
 \r
 #. **VPP Unit Tests** - refers to VPP functional unit tests executed as\r
@@ -66,3 +65,11 @@ CSIT |release| report contains following main sections and sub-sections:
    executions using CSIT Robot Framework output files as source data; *VPP\r
    Performance Results*, *Testpmd Performance Results*, *VPP Functional\r
    Results*, *HoneyComb Functional Results*, *VPPtest Functional Results*.\r
+\r
+#. **Test Configuration** - auto-generated DUT configuration data from CSIT jobs\r
+   executions using CSIT Robot Framework output files as source data; *VPP\r
+   Performance Test Configs*, *VPP Functional Test Configs*.\r
+\r
+#. **Test Operational Data** - auto-generated DUT operational data from CSIT jobs\r
+   executions using CSIT Robot Framework output files as source data; *VPP\r
+   Performance Operational Data*.\r