aboutsummaryrefslogtreecommitdiffstats
path: root/docs/report/vpp_device_tests
diff options
context:
space:
mode:
authorPeter Mikus <pmikus@cisco.com>2018-11-05 08:51:09 +0000
committerTibor Frank <tifrank@cisco.com>2018-11-05 12:05:53 +0000
commit5daea0d37e7a778abef1b7d69f2ca8243704e92a (patch)
treec85cbe06fbd42dda5bcc3d63ea261a94a72ecc72 /docs/report/vpp_device_tests
parent33f0653d0316b33199a48302f205e59b01dc9b7a (diff)
Static content for vpp_device sections
Change-Id: Ia445ab5c339aecc0dfc6db40b2eb962436f9aeea Signed-off-by: Peter Mikus <pmikus@cisco.com> (cherry picked from commit 455dd6483d66705ce78e60ce6ee22c73db80230b) (cherry picked from commit a3f83b81b20deb7519c52e5e8363f2c4d3a326d3)
Diffstat (limited to 'docs/report/vpp_device_tests')
-rw-r--r--docs/report/vpp_device_tests/csit_release_notes.rst18
-rw-r--r--docs/report/vpp_device_tests/documentation.rst6
-rw-r--r--docs/report/vpp_device_tests/index.rst9
-rw-r--r--docs/report/vpp_device_tests/overview.rst75
-rw-r--r--docs/report/vpp_device_tests/test_environment.rst2
5 files changed, 110 insertions, 0 deletions
diff --git a/docs/report/vpp_device_tests/csit_release_notes.rst b/docs/report/vpp_device_tests/csit_release_notes.rst
new file mode 100644
index 0000000000..9e6f002f08
--- /dev/null
+++ b/docs/report/vpp_device_tests/csit_release_notes.rst
@@ -0,0 +1,18 @@
+Release Notes
+=============
+
+Changes in |csit-release|
+-------------------------
+
+#. Initial release
+
+Known Issues
+------------
+
+List of known issues in |csit-release| for VPP functional tests in VIRL:
+
++---+----------------------------------------+---------------------+
+| # | JiraID | Issue Description |
++===+========================================+=====================+
+| 1 | | |
++---+----------------------------------------+---------------------+
diff --git a/docs/report/vpp_device_tests/documentation.rst b/docs/report/vpp_device_tests/documentation.rst
new file mode 100644
index 0000000000..6ab6d51287
--- /dev/null
+++ b/docs/report/vpp_device_tests/documentation.rst
@@ -0,0 +1,6 @@
+Documentation
+=============
+
+`CSIT VPP Device Tests Documentation`_ contains detailed
+functional description and input parameters for each test case.
+
diff --git a/docs/report/vpp_device_tests/index.rst b/docs/report/vpp_device_tests/index.rst
new file mode 100644
index 0000000000..4a6e6c81e6
--- /dev/null
+++ b/docs/report/vpp_device_tests/index.rst
@@ -0,0 +1,9 @@
+VPP Device
+==========
+
+.. toctree::
+
+ overview
+ csit_release_notes
+ test_environment
+ documentation
diff --git a/docs/report/vpp_device_tests/overview.rst b/docs/report/vpp_device_tests/overview.rst
new file mode 100644
index 0000000000..25bfecd9e5
--- /dev/null
+++ b/docs/report/vpp_device_tests/overview.rst
@@ -0,0 +1,75 @@
+Overview
+========
+
+Virtual Topologies
+------------------
+
+CSIT VPP Device tests are executed in Physical containerized topologies
+created on demand using set of scripts hosted and developed under CSIT
+repository. It runs on physical baremetal servers hosted by LF FD.io project.
+Based on the packet path thru SUT Containers, two distinct logical topology
+types are used for VPP DUT data plane testing:
+
+#. vfNIC-to-vfNIC switching topologies.
+#. Nested-VM service switching topologies. (Planned to be added in rls1901)
+
+vfNIC-to-vfNIC Switching
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+The simplest physical topology for software data plane application like
+VPP is vfNIC-to-vfNIC switching. Tested virtual topologies for 2-Node testbeds
+are shown in figures below.
+
+.. only:: latex
+
+ .. raw:: latex
+
+ \begin{figure}[H]
+ \centering
+ \graphicspath{{../_tmp/src/vpp_device_tests/}}
+ \includegraphics[width=0.90\textwidth]{vf-2n-nic2nic}
+ \label{fig:vf-2n-nic2nic}
+ \end{figure}
+
+.. only:: html
+
+ .. figure:: ../vpp_device_tests/vf-2n-nic2nic.svg
+ :alt: vf-2n-nic2nic
+ :align: center
+
+SUT1 is Docker Container (running Ubuntu, depending on the test suite), TG is
+a Traffic Generator (running Ubuntu Container). SUTs run VPP
+SW application in Linux user-mode as a Device Under Test (DUT) within
+the container. TG runs Scapy SW application as a packet Traffic Generator.
+Network connectivity between SUTs and to TG is provided using virtual function
+of physical NICs.
+
+Virtual topologies are created on-demand whenever a verification job is
+started (e.g. triggered by the gerrit patch submission) and destroyed
+upon completion of all functional tests. Each node is a container running on
+physical server. During the test execution, all nodes are reachable thru
+the Management (not shown above for clarity).
+
+Functional Tests Coverage
+-------------------------
+
+|csit-release| includes following VPP functionality tested in virtual VM
+environment:
+
++-----------------------+----------------------------------------------+
+| Functionality | Description |
++=======================+==============================================+
+| IPv4 | ICMPv4. |
++-----------------------+----------------------------------------------+
+| IPv6 | ICMPv6. |
++-----------------------+----------------------------------------------+
+
+Tests Naming
+------------
+
+|csit-release| follows a common structured naming convention for all
+performance and system functional tests, introduced in CSIT-17.01.
+
+The naming should be intuitive for majority of the tests. Complete
+description of CSIT test naming convention is provided on
+:ref:`csit_test_naming`.
diff --git a/docs/report/vpp_device_tests/test_environment.rst b/docs/report/vpp_device_tests/test_environment.rst
new file mode 100644
index 0000000000..e18ad6400d
--- /dev/null
+++ b/docs/report/vpp_device_tests/test_environment.rst
@@ -0,0 +1,2 @@
+
+.. include:: ../../vpp-device.rst