Add the NSH SFC functional test document.
[csit.git] / docs / report / introduction / general_notes.rst
index c05401e..64e6231 100644 (file)
@@ -3,31 +3,32 @@ General Notes
 \r
 All CSIT test results listed in this report are sourced and auto-generated\r
 from output.xml Robot Framework (RF) files resulting from LF FD.io Jenkins\r
-jobs execution against VPP-17.01 release artifacts. References are provided\r
-to the original LF FD.io Jenkins job results. However, as LF FD.io Jenkins\r
-infrastructure does not automatically archive all jobs (history record is\r
-provided for the last 30 days or 40 jobs only), additional references are\r
+jobs execution against |vpp-release| release artifacts. References are\r
+provided to the original LF FD.io Jenkins job results. However, as LF FD.io\r
+Jenkins infrastructure does not automatically archive all jobs (history record\r
+is provided for the last 30 days or 40 jobs only), additional references are\r
 provided to the RF result files that got archived in FD.io nexus online\r
 storage system.\r
 \r
 FD.io CSIT project currently covers multiple FD.io system and sub-system\r
 testing areas and this is  reflected in this report, where each testing area\r
-is listed separately, as follows\r
+is listed separately, as follows:\r
 \r
-#. **VPP Performance Tests** - VPP performance are tests executed in physical\r
-   FD.io testbeds,  focusing on VPP network data plane performance at this stage,\r
+#. **VPP Performance Tests** - VPP performance tests are executed in physical\r
+   FD.io testbeds, focusing on VPP network data plane performance at this stage,\r
    both for Phy-to-Phy (NIC-to-NIC) and Phy-to-VM-to-Phy (NIC-to-VM-to-NIC)\r
    forwarding topologies. Tested across a range of NICs, 10GE and 40GE\r
    interfaces, range of multi-thread and multi-core configurations. VPP\r
    application runs in host user- mode. TRex is used as a traffic generator.\r
 \r
-#. **Testpmd Performance Tests** - VPP is using DPDK code to control and drive\r
+#. **DPDK Performance Tests** - VPP is using DPDK code to control and drive\r
    the NICs and physical interfaces. Testpmd tests are used as a baseline to\r
-   profile the DPDK sub-system of VPP. Testpmd performance tests executed in\r
-   physical FD.io testbeds, focusing on Testpmd data plane performance for Phy-\r
-   to-Phy (NIC-to-NIC). Tests cover a range of NICs, 10GE and 40GE interfaces,\r
-   range of multi-thread and multi-core configurations. Testpmd application runs\r
-   in host user-mode. TRex is used as a traffic generator.\r
+   profile the DPDK sub-system of VPP. DPDK performance tests executed in\r
+   physical FD.io testbeds, focusing on Testpmd/L3FWD data plane performance for\r
+   Phy-to-Phy (NIC-to-NIC). Tests cover a range of NICs, 10GE and 40GE\r
+   interfaces, range of multi-thread and multi-core configurations.\r
+   Testpmd/L3FWD application runs in host user-mode. TRex is used as a traffic\r
+   generator.\r
 \r
 #. **VPP Functional Tests** - VPP functional tests are executed in virtual\r
    FD.io testbeds focusing on VPP packet processing functionality, including\r
@@ -40,11 +41,15 @@ is listed separately, as follows
    functionality of VPP. Tests cover a range of CRUD operations executed\r
    against VPP.\r
 \r
-CSIT |release| report does also include VPP unit test results. These tests\r
-have been developed within the FD.io VPP project, and not in CSIT, but they do\r
-complement tests done by CSIT. They are provided mainly as a reference, to\r
-give the reader a more complete view of automated testing executed against\r
-VPP-17.01 release.\r
+#. **NSH_SFC Functional Tests** - NSH_SFC functional tests are executed in\r
+   virtual FD.io testbeds focusing on NSH_SFC of VPP. Tests cover a range of\r
+   CRUD operations executed against VPP.\r
+\r
+In addition to above, CSIT |release| report does also include VPP unit test\r
+results. VPP unit tests are developed within the FD.io VPP project and as they\r
+complement CSIT system functional tests, they are provided mainly as a reference\r
+and to provide a more complete view of automated testing executed against\r
+|vpp-release|.\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
@@ -54,4 +59,4 @@ obtained by cloning CSIT git repository - "git clone
 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>`_.
\ No newline at end of file
+<https://wiki.fd.io/view/CSIT#Tutorials>`_.\r