CSIT 1701 report files and script AD1

[csit.git] / docs / report / vpp_functional_tests_virl / overview.rst

diff --git a/docs/report/vpp_functional_tests_virl/overview.rst b/docs/report/vpp_functional_tests_virl/overview.rst
index cf7a5d2..16c7ef7 100644 (file)
--- a/docs/report/vpp_functional_tests_virl/overview.rst
+++ b/docs/report/vpp_functional_tests_virl/overview.rst
@@ -1,16 +1,18 @@
 Overview\r
 ========\r
 \r
-VPP Functional Test Topologies in VIRL\r
---------------------------------------\r
+Tested Topologies VIRL\r
+----------------------\r
 \r
 CSIT VPP functional tests are executed on virtualized topologies created using\r
 Virtual Internet Routing Lab (VIRL) simulation platform contributed by Cisco.\r
 VIRL runs on physical baremetal servers hosted by LF FD.io project.  Majority\r
 of the tests are executed in the three node logical test topology - Traffic\r
 Generator (TG) node and two Systems Under Test (SUT) nodes connected in a\r
-loop. Some tests use two node logical test topology - TG node and SUT node.\r
-Both logical test topologies are shown in the figures below:::\r
+loop. Some tests use two node logical test topology - TG node and SUT1 node.\r
+Both logical test topologies are shown in the figures below.\r
+\r
+::\r
 \r
     +------------------------+           +------------------------+\r
     |                        |           |                        |\r
@@ -48,18 +50,27 @@ Both logical test topologies are shown in the figures below:::
           +------------------>           <------------------+\r
                              +-----------+\r
 \r
-Virtual testbeds are created dynamically whenever a verification job is\r
-started triggered by the patch submission to gerrit and destroyed upon\r
-completion of all functional tests. During test execution, all nodes are\r
-reachable thru the MGMT network connected to every node via dedicated NICs and\r
-links (not shown above for clarity). Each node is a Virtual Machine and each\r
-connection that is drawn on the diagram is available for use in any test case.\r
+SUT1 and SUT2 are two VMs (Ubuntu or Centos, depending on the test suite), TG\r
+is a Traffic Generator (TG, another Ubuntu VM). SUTs run VPP SW application in\r
+Linux user-mode as a Device Under Test (DUT) within the VM. TG runs Scapy SW\r
+application as a packet Traffic Generator. Logical connectivity between SUTs\r
+and to TG is provided using virtual NICs using VMs' virtio driver.\r
+\r
+Virtual testbeds are created on-demand whenever a verification job is started\r
+(e.g. triggered by the gerrit patch submission) and destroyed upon completion\r
+of all functional tests. Each node is a Virtual Machine and each connection\r
+that is drawn on the diagram is available for use in any test case. During the\r
+test execution, all nodes are reachable thru the Management network connected\r
+to every node via dedicated virtual NICs and virtual links (not shown above\r
+for clarity).\r
+\r
+For the test cases that require DUT (VPP) to communicate with VM over the\r
+vhost-user interfaces, a nested VM is created on SUT1 and/or SUT2 for the\r
+duration of these particular test cases only. DUT (VPP) test topology with VM\r
+is shown in the figure below including the applicable packet flow thru the VM\r
+(marked in the figure with ``***``).\r
 \r
-For test cases that require DUT (VPP) to communicate with VM over vhost-user\r
-interfaces, a nested VM is created on SUT1 and/or SUT2 for the duration of\r
-that particular test case only. DUT (VPP) test topology with VM is shown in\r
-the figure below including the applicable packet flow thru the VM (marked with\r
-``*``).::\r
+::\r
 \r
     +------------------------+           +------------------------+\r
     |      +----------+      |           |      +----------+      |\r