CSIT 1701 report files and script AD1
[csit.git] / docs / report / introduction / overview.rst
index e3b343c..dc86f86 100644 (file)
@@ -1,16 +1,42 @@
 Overview\r
 ========\r
 \r
-This is the Fast Data Project (FD.io) Continuous System Integration and Testing\r
-(CSIT) project report for CSIT |release| system testing of VPP-17.01 release.\r
-Initial sections of the report describe FD.io functional and performance tests\r
-and their continuous execution achieved in CSIT |release|. This is followed by\r
-high-level overview of FD.io test environments running in Linux Foundation\r
-(LF) FD.io Continuous Performance Labs), CSIT |release| release notes and\r
-result highlights. Subsequent sections list the functional and performance\r
-detailed test results generated by LF FD.io Jenkins system executing CSIT jobs\r
-running tests  against the VPP-17.01 release and associated sub-systems\r
-(HoneyComb, DPDK).\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. Initial sections of the report\r
+describe FD.io functional and performance tests and their continuous execution\r
+achieved in CSIT |release|. This is followed by high-level overview of FD.io\r
+test environments running in Linux Foundation (LF) FD.io Continuous\r
+Performance Labs), CSIT |release| release notes and result highlights.\r
+Subsequent sections list the functional and performance detailed test results\r
+generated by LF FD.io Jenkins system executing CSIT jobs running tests\r
+against the VPP-17.01 release and associated sub-systems (HoneyComb, DPDK).\r
+\r
+The exact structure of the report is as follows:\r
+\r
+#. ``Introduction`` - Includes: ``Overview`` - this section;\r
+   ``CSIT Test Naming`` - describing CSIT naming convention for test suites and\r
+   test cases, important to understand to correctly interpret the reported\r
+   results; ``General Remarks`` - additional notes related to this report.\r
+#. ``VPP Performance Tests HW`` - Summary of VPP performance tests executed in\r
+   physical Hardware testbed. Includes: ``Overview`` - containing topology\r
+   description and list of executed tests; ``Performance Tests Naming`` - lists\r
+   CSIT naming specifics for performance tests; ``CSIT Release Notes`` - with\r
+   changes in CSIT |release| including major test additions, performance\r
+   improvements, changes in testing environment and methodology and known\r
+   issues; ``Performance Measurements Methodology`` - details testing\r
+   methodology followed for multi-thread multi-core, packet throughput and\r
+   latency, and KVM VM vhost tests; ``Report Addendum Targets`` - lists content\r
+   to be added to this report as part of CSIT |release|.\r
+#. ``Testpmd Performance Tests HW`` - ...\r
+#. ``VPP Functional Tests VIRL`` - ...\r
+#. ``VPP Functional Tests VPPtest`` - ...\r
+#. ``HoneyComb Functional Tests VIRL`` - ..\r
+#. ``VPP Performance Results HW`` - ...\r
+#. ``Testpmd Performance Results HW`` - ...\r
+#. ``VPP Functional Results VIRL`` - ...\r
+#. ``VPP Functional Results VPPtest`` - ...\r
+#. ``HoneyComb Functional Results VIRL`` - ...\r
 \r
 FD.io CSIT system is developed using two main coding platforms: Robot\r
 Framework (RF) and Python. CSIT |release| source code for the executed test\r