From 455dd6483d66705ce78e60ce6ee22c73db80230b Mon Sep 17 00:00:00 2001 From: Peter Mikus Date: Mon, 5 Nov 2018 08:51:09 +0000 Subject: Static content for vpp_device sections Change-Id: Ia445ab5c339aecc0dfc6db40b2eb962436f9aeea Signed-off-by: Peter Mikus --- docs/report/index.html.template | 9 +++ docs/report/index.pdf.template | 1 + .../test_environment_sut_calib_hsw.rst | 6 +- .../introduction/test_environment_sut_conf_1.rst | 15 +++-- .../introduction/test_environment_sut_conf_3.rst | 18 ------ .../test_environment_sut_meltspec_hsw.rst | 1 + .../test_environment_sut_meltspec_skx.rst | 1 + .../report/vpp_device_tests/csit_release_notes.rst | 18 ++++++ docs/report/vpp_device_tests/documentation.rst | 6 ++ docs/report/vpp_device_tests/index.rst | 9 +++ docs/report/vpp_device_tests/overview.rst | 75 ++++++++++++++++++++++ docs/report/vpp_device_tests/test_environment.rst | 2 + 12 files changed, 133 insertions(+), 28 deletions(-) create mode 100644 docs/report/vpp_device_tests/csit_release_notes.rst create mode 100644 docs/report/vpp_device_tests/documentation.rst create mode 100644 docs/report/vpp_device_tests/index.rst create mode 100644 docs/report/vpp_device_tests/overview.rst create mode 100644 docs/report/vpp_device_tests/test_environment.rst (limited to 'docs') diff --git a/docs/report/index.html.template b/docs/report/index.html.template index 4e52a15c9f..b28fcec515 100644 --- a/docs/report/index.html.template +++ b/docs/report/index.html.template @@ -39,6 +39,15 @@ CSIT 18.10 dpdk_performance_tests/test_environment dpdk_performance_tests/documentation +.. toctree:: + :maxdepth: 2 + :caption: VPP Device + + vpp_device_tests/overview + vpp_device_tests/csit_release_notes + vpp_device_tests/test_environment + vpp_device_tests/documentation + .. toctree:: :maxdepth: 2 :caption: VPP Functional diff --git a/docs/report/index.pdf.template b/docs/report/index.pdf.template index c5c09590a3..40e6aa5145 100644 --- a/docs/report/index.pdf.template +++ b/docs/report/index.pdf.template @@ -7,6 +7,7 @@ CSIT 18.10 introduction/index vpp_performance_tests/index dpdk_performance_tests/index + vpp_device_tests/index vpp_functional_tests/index honeycomb_functional_tests/index nsh_sfc_functional_tests/index diff --git a/docs/report/introduction/test_environment_sut_calib_hsw.rst b/docs/report/introduction/test_environment_sut_calib_hsw.rst index b5ebdd25e5..dc2a53cac8 100644 --- a/docs/report/introduction/test_environment_sut_calib_hsw.rst +++ b/docs/report/introduction/test_environment_sut_calib_hsw.rst @@ -16,7 +16,7 @@ Linux cmdline :: $ cat /proc/cmdline - BOOT_IMAGE=/vmlinuz-4.4.0-72-generic root=UUID=efb7e8b3-3548-4440-98f6-6ebe102e9ec6 ro isolcpus=1-17,19-35 nohz_full=1-17,19-35 rcu_nocbs=1-17,19-35 intel_pstate=disable console=tty0 console=ttyS0,115200n8 + BOOT_IMAGE=/vmlinuz-4.15.0-36-generic root=UUID=5d2ecc97-245b-4e94-b0ae-c3548567de19 ro isolcpus=1-17,19-35 nohz_full=1-17,19-35 rcu_nocbs=1-17,19-35 numa_balancing=disable intel_pstate=disable intel_iommu=on iommu=pt nmi_watchdog=0 audit=0 nosoftlockup processor.max_cstate=1 intel_idle.max_cstate=1 hpet=disable tsc=reliable mce=off console=tty0 console=ttyS0,115200n8 Linux uname @@ -25,7 +25,7 @@ Linux uname :: $ uname -a - Linux t3-sut2 4.4.0-72-generic #93-Ubuntu SMP Fri Mar 31 14:07:41 UTC 2017 x86_64 x86_64 x86_64 GNU/Linux + Linux t1-tg1 4.15.0-36-generic #39-Ubuntu SMP Mon Sep 24 16:19:09 UTC 2018 x86_64 x86_64 x86_64 GNU/Linux System-level core jitter @@ -220,4 +220,4 @@ L1/L2/LLC latency Reader Numa Node Writer Numa Node 0 1 0 - 107.7 - 1 106.6 - \ No newline at end of file + 1 106.6 - diff --git a/docs/report/introduction/test_environment_sut_conf_1.rst b/docs/report/introduction/test_environment_sut_conf_1.rst index c6803e07a3..2422e4589c 100644 --- a/docs/report/introduction/test_environment_sut_conf_1.rst +++ b/docs/report/introduction/test_environment_sut_conf_1.rst @@ -7,16 +7,17 @@ install and Below a subset of the running configuration: -1. Xeon Haswell - Ubuntu 16.04.1 LTS +1. Xeon Haswell - Ubuntu 18.04.1 LTS :: $ lsb_release -a No LSB modules are available. - Distributor ID: Ubuntu - Description: Ubuntu 16.04.1 LTS - Release: 16.04 - Codename: xenial + Distributor ID: Ubuntu + Description: Ubuntu 18.04.1 LTS + Release: 18.04 + Codename: bionic + 2. Xeon Skylake - Ubuntu 18.04 LTS @@ -71,12 +72,12 @@ Linux Boot Parameters Applied Boot Cmdline ~~~~~~~~~~~~~~~~~~~~ -1. Xeon Haswell - Ubuntu 16.04.1 LTS +1. Xeon Haswell - Ubuntu 18.04.1 LTS :: $ cat /proc/cmdline - BOOT_IMAGE=/vmlinuz-4.4.0-72-generic root=UUID=35ea11e4-e44f-4f67-8cbe-12f09c49ed90 ro isolcpus=1-17,19-35 nohz_full=1-17,19-35 rcu_nocbs=1-17,19-35 intel_pstate=disable console=tty0 console=ttyS0,115200n8 + BOOT_IMAGE=/vmlinuz-4.15.0-36-generic root=UUID=5d2ecc97-245b-4e94-b0ae-c3548567de19 ro isolcpus=1-17,19-35 nohz_full=1-17,19-35 rcu_nocbs=1-17,19-35 numa_balancing=disable intel_pstate=disable intel_iommu=on iommu=pt nmi_watchdog=0 audit=0 nosoftlockup processor.max_cstate=1 intel_idle.max_cstate=1 hpet=disable tsc=reliable mce=off console=tty0 console=ttyS0,115200n8 2. Xeon Skylake - Ubuntu 18.04 LTS diff --git a/docs/report/introduction/test_environment_sut_conf_3.rst b/docs/report/introduction/test_environment_sut_conf_3.rst index f09327d531..20dc155058 100644 --- a/docs/report/introduction/test_environment_sut_conf_3.rst +++ b/docs/report/introduction/test_environment_sut_conf_3.rst @@ -1,22 +1,4 @@ -Host IRQ Affinity -~~~~~~~~~~~~~~~~~ - -IRQs are pinned to core 0. The same configuration is applied in host Linux and guest VM. - -:: - - $ for l in `ls /proc/irq`; do echo 1 | sudo tee /proc/irq/$l/smp_affinity; done - -Host RCU Affinity -~~~~~~~~~~~~~~~~~ - -RCUs are pinned to core 0. The same configuration is applied in host Linux and guest VM. - -:: - - $ for i in `pgrep rcu[^c]` ; do sudo taskset -pc 0 $i ; done - Host Writeback Affinity ~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/report/introduction/test_environment_sut_meltspec_hsw.rst b/docs/report/introduction/test_environment_sut_meltspec_hsw.rst index 652b5b2e3c..0e68e57802 100644 --- a/docs/report/introduction/test_environment_sut_meltspec_hsw.rst +++ b/docs/report/introduction/test_environment_sut_meltspec_hsw.rst @@ -16,6 +16,7 @@ made public in 2018. Script is available on `Spectre & Meltdown Checker Github - CVE-2018-3646 [L1 terminal fault] aka 'Foreshadow-NG (VMM)' :: + $ sudo ./spectre-meltdown-checker.sh --no-color Spectre and Meltdown mitigation detection tool v0.40 diff --git a/docs/report/introduction/test_environment_sut_meltspec_skx.rst b/docs/report/introduction/test_environment_sut_meltspec_skx.rst index 7e852a6bc5..517ab3a0bc 100644 --- a/docs/report/introduction/test_environment_sut_meltspec_skx.rst +++ b/docs/report/introduction/test_environment_sut_meltspec_skx.rst @@ -16,6 +16,7 @@ made public in 2018. Script is available on `Spectre & Meltdown Checker Github - CVE-2018-3646 [L1 terminal fault] aka 'Foreshadow-NG (VMM)' :: + $ sudo ./spectre-meltdown-checker.sh --no-color Spectre and Meltdown mitigation detection tool v0.40 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 -- cgit 1.2.3-korg