-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
+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|.
+
+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 :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:
+
+#. **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.
+
+#. **VPP Performance Tests** - 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
+ 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; *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
+ physical FD.io testbeds; *Overview* - tested topologies, test coverage;
+ *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
+ 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, tests to be
+ added; *Test Environment* - environment description ; *Documentation* -
+ source code documentation for VPP functional tests.
+
+#. **Honeycomb Functional Tests** - 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;
+ *Documentation* - source code documentation for Honeycomb functional tests.
+
+#. **NSH_SFC Functional Tests** - 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;
+ *Documentation* - source code documentation for NSH_SFC functional tests.
+
+#. **Detailed Test 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*.
+
+#. **Test Configuration** - auto-generated DUT configuration data from CSIT jobs
+ executions using CSIT Robot Framework output files as source data; *VPP
+ Performance Test Configs*, *VPP Functional Test Configs*.
+
+#. **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.