CSIT-618 CSIT rls1707 Report - Update II
[csit.git] / docs / report / introduction / overview.rst
index 7954686..4aac352 100644 (file)
@@ -1,82 +1,82 @@
-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-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-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
-#. **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; *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* - CSIT source code documentation for VPP performance tests.\r
-\r
-#. **DPDK Performance Tests** - DPDK 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
-   *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
-   CSIT source code documentation for DPDK 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
-   *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
-#. **NSH_SFC Functional Tests** - NSH_SFC 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
-   *Test Environment* - environment description ;\r
-   *Documentation* - source code documentation for NSH_SFC functional 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*, *DPDK 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
+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|.
+
+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
+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; *Test Environment* - environment description;
+   *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.
+
+#. **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
+   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*.

©2016 FD.io a Linux Foundation Collaborative Project. All Rights Reserved.
Linux Foundation is a registered trademark of The Linux Foundation. Linux is a registered trademark of Linus Torvalds.
Please see our privacy policy and terms of use.