csit rls1701 report edits:
[csit.git] / docs / report / introduction / overview.rst
index dc86f86..ee1a91c 100644 (file)
@@ -1,49 +1,68 @@
 Overview\r
 ========\r
 \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
-suites is available in CSIT branch |release| in the directory\r
-"./tests/<name_of_the_test_suite>". A local copy of CSIT source code can be\r
-obtained by cloning CSIT git repository - "git clone\r
-https://gerrit.fd.io/r/csit". The CSIT testing virtual environment can be run\r
-on a local computer workstation (laptop, server) using Vagrant by following\r
-the instructions in `CSIT tutorials\r
-<https://wiki.fd.io/view/CSIT#Tutorials>`_.\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
+\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
+\r
+CSIT |release| report contains following main sections and sub-sections:\r
+\r
+#. **Introduction** - general introduction to CSIT project; *Overview* -\r
+   this section; *CSIT Test Naming* - CSIT general naming convention for test\r
+   suites and test cases, important to recognize the high-level test content\r
+   and interpret reported results; *General Notes* - general notes related to\r
+   this report.\r
+\r
+#. **VPP Performance Tests** - VPP performance tests executed in physical\r
+   FD.io testbeds; *Overview* - tested topologies, test coverage and naming\r
+   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
+   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
+\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
+   - 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
+\r
+#. **VPP Functional Tests** - VPP functional tests executed in virtual\r
+   FD.io testbeds; *Overview* - tested virtual topologies, test coverage and\r
+   naming specifics; *CSIT Release Notes* - changes in CSIT |release|, added\r
+   tests, environment or methodology changes, known CSIT issues, tests to be\r
+   added; *Test Environment* - environment description ; *Documentation* -\r
+   source code documentation for VPP functional tests.\r
+\r
+#. **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
+   *Documentation* - source code documentation for Honeycomb functional tests.\r
+\r
+#. **VPP Unit Tests** - refers to VPP functional unit tests executed as\r
+   part of vpp make test verify option within the FD.io VPP project; listed in\r
+   this report to give a more complete view about executed VPP functional tests;\r
+   *Overview* - short overview of unit test framework and executed tests;\r
+   *Documentation* - source code documentation of VPP unit tests.\r
+\r
+#. **Detailed Test Results** - auto-generated results from CSIT jobs\r
+   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