Report: add 3n-alt static content
[csit.git] / docs / report / vpp_performance_tests / test_environment.rst
index 91ca3bc..dec8780 100644 (file)
@@ -1,36 +1,44 @@
-.. include:: test_environment_intro.rst
 
-.. include:: test_environment_sut_conf_1.rst
+.. raw:: latex
 
-.. include:: test_environment_sut_conf_2.rst
+    \clearpage
 
-.. include:: test_environment_sut_conf_3.rst
+.. _vpp_test_environment:
 
+.. include:: ../introduction/test_environment_intro.rst
 
-DUT Configuration - VPP
------------------------
+.. include:: ../introduction/test_environment_changes_vpp.rst
 
-**VPP Version**
+.. include:: ../introduction/test_environment_sut_conf_1.rst
+
+
+DUT Settings - VPP
+------------------
+
+VPP Version
+~~~~~~~~~~~
 
 |vpp-release|
 
-**VPP Compile Parameters**
+VPP Compile Parameters
+~~~~~~~~~~~~~~~~~~~~~~
 
 `FD.io VPP compile job`_
 
-**VPP Install Parameters**
+VPP Install Parameters
+~~~~~~~~~~~~~~~~~~~~~~
 
 ::
 
-    $ dpkg -i --force-all vpp*
+    $ dpkg -i --force-all *vpp*
 
-**VPP Startup Configuration**
+VPP Startup Configuration
+~~~~~~~~~~~~~~~~~~~~~~~~~
 
-VPP startup configuration changes per test case with different settings for CPU
-cores, rx-queues and no-multi-seg parameter. Startup config is aligned with
-applied test case tag:
-
-Tagged by **1T1C**
+VPP startup configuration vary per test case, with different settings
+for `$$CORELIST_WORKERS`, `$$NUM_RX_QUEUES`, `$$UIO_DRIVER`, and
+`$$NO_MULTI_SEG` parameter. List of plugins to enable is driven by test
+requirements. Default template is provided below:
 
 ::
 
@@ -38,11 +46,20 @@ Tagged by **1T1C**
     {
       heap-size 4G
     }
+    statseg
+    {
+      size 4G
+      per-node-counters on
+    }
     unix
     {
-      cli-listen localhost:5002
+      cli-listen /run/vpp/cli.sock
       log /tmp/vpe.log
       nodaemon
+      full-coredump
+    }
+    socksvr {
+      socket-name /run/vpp/api.sock
     }
     ip6
     {
@@ -56,131 +73,55 @@ Tagged by **1T1C**
       {
         disable
       }
-      plugin dpdk_plugin.so
+      plugin <$$test_requirement>_plugin.so
       {
         enable
       }
     }
     cpu
     {
-      corelist-workers 2
+      corelist-workers $$CORELIST_WORKERS
       main-core 1
     }
-    dpdk
+    buffers
     {
-      dev 0000:0a:00.0
-      dev 0000:0a:00.1
-      no-multi-seg
-      uio-driver uio_pci_generic
-      log-level debug
-      dev default
-      {
-        num-rx-queues 1
-      }
-      socket-mem 1024,1024
-      no-tx-checksum-offload
+      buffers-per-numa 215040
     }
 
-Tagged by **2T2C**
-
-::
-
-    ip
-    {
-      heap-size 4G
-    }
-    unix
-    {
-      cli-listen localhost:5002
-      log /tmp/vpe.log
-      nodaemon
-    }
-    ip6
-    {
-      heap-size 4G
-      hash-buckets 2000000
-    }
-    heapsize 4G
-    plugins
-    {
-      plugin default
-      {
-        disable
-      }
-      plugin dpdk_plugin.so
-      {
-        enable
-      }
-    }
-    cpu
-    {
-      corelist-workers 2,3
-      main-core 1
-    }
+    # Below: in case of dpdk based drivers (vfio-pci) only
     dpdk
     {
-      dev 0000:0a:00.0
-      dev 0000:0a:00.1
-      no-multi-seg
-      uio-driver uio_pci_generic
+      uio-driver $$UIO_DRIVER
+      $$NO_MULTI_SEG
       log-level debug
       dev default
       {
-        num-rx-queues 1
+        num-rx-queues $$NUM_RX_QUEUES
       }
-      socket-mem 1024,1024
       no-tx-checksum-offload
+      dev $$DEV_1
+      dev $$DEV_2
     }
 
-Tagged by **4T4C**
+Description of VPP startup settings used in CSIT is provided in
+:ref:`test_methodology`.
 
-::
+.. include:: ../introduction/test_environment_tg.rst
 
-    ip
-    {
-      heap-size 4G
-    }
-    unix
-    {
-      cli-listen localhost:5002
-      log /tmp/vpe.log
-      nodaemon
-    }
-    ip6
-    {
-      heap-size 4G
-      hash-buckets 2000000
-    }
-    heapsize 4G
-    plugins
-    {
-      plugin default
-      {
-        disable
-      }
-      plugin dpdk_plugin.so
-      {
-        enable
-      }
-    }
-    cpu
-    {
-      corelist-workers 2,3,4,5
-      main-core 1
-    }
-    dpdk
-    {
-      dev 0000:0a:00.0
-      dev 0000:0a:00.1
-      no-multi-seg
-      uio-driver uio_pci_generic
-      log-level debug
-      dev default
-      {
-        num-rx-queues 1
-      }
-      socket-mem 1024,1024
-      no-tx-checksum-offload
-    }
+.. include:: ../introduction/test_environment_pre_test_server_calib.rst
+
+.. include:: ../introduction/test_environment_sut_calib_icx.rst
+
+.. include:: ../introduction/test_environment_sut_calib_skx.rst
+
+.. include:: ../introduction/test_environment_sut_calib_clx.rst
+
+.. include:: ../introduction/test_environment_sut_calib_hsw.rst
+
+.. include:: ../introduction/test_environment_sut_calib_dnv.rst
+
+.. include:: ../introduction/test_environment_sut_calib_alt.rst
+
+.. include:: ../introduction/test_environment_sut_calib_tsh.rst
 
-.. include:: test_environment_tg.rst
+.. include:: ../introduction/test_environment_sut_calib_tx2.rst