CSIT-1359: Add 3n-skx and 2n-skx comparisons to Report
[csit.git] / docs / tag_documentation.rst
index 8606734..33d38cf 100644 (file)
@@ -9,6 +9,16 @@ documentation.
 Topology TAGs
 -------------
 
+.. topic:: 2_NODE_DOUBLE_LINK_TOPO
+
+    2 nodes connected in a circular topology with two links interconnecting
+    the devices.
+
+.. topic:: 2_NODE_SINGLE_LINK_TOPO
+
+    2 nodes connected in a circular topology with at least one link
+    interconnecting devices.
+
 .. topic:: 3_NODE_DOUBLE_LINK_TOPO
 
     3 nodes connected in a circular topology with two links interconnecting
@@ -61,6 +71,10 @@ NIC model tags
 
     Intel X710 NIC.
 
+.. topic:: NIC_Intel-XXV710
+
+    Intel XXV710 NIC.
+
 .. topic:: NIC_Cisco-VIC-1227
 
     VIC-1227 by Cisco.
@@ -84,6 +98,54 @@ Scaling TAGs
 
     2x1,000,000 entries in single fib table
 
+.. topic:: L2BD_1
+
+    Test with 1 L2 bridge domain.
+
+.. topic:: L2BD_10
+
+    Test with 10 L2 bridge domains.
+
+.. topic:: L2BD_100
+
+    Test with 100 L2 bridge domains.
+
+.. topic:: L2BD_1K
+
+    Test with 1000 L2 bridge domains.
+
+.. topic:: VLAN_1
+
+    Test with 1 VLAN sub-interface.
+
+.. topic:: VLAN_10
+
+    Test with 10 VLAN sub-interfaces.
+
+.. topic:: VLAN_100
+
+    Test with 100 VLAN sub-interfaces.
+
+.. topic:: VLAN_1K
+
+    Test with 1000 VLAN sub-interfaces.
+
+.. topic:: VXLAN_1
+
+    Test with 1 VXLAN tunnel.
+
+.. topic:: VXLAN_10
+
+    Test with 10 VXLAN tunnels.
+
+.. topic:: VXLAN_100
+
+    Test with 100 VXLAN tunnels.
+
+.. topic:: VXLAN_1K
+
+    Test with 1000 VXLAN tunnels.
+
 .. topic:: TNL_1000
 
     IPSec in tunnel mode - 1000 tunnels.
@@ -137,25 +199,16 @@ Tags marking functional vs. performance of tests
 Performance testing tags
 ------------------------
 
-.. topic:: PDRDISC
-
-    Partial Drop Rate evaluation of single run result, with non-zero packet
-    loss tolerance (LT) expressed in percentage of packets transmitted.
-
-.. topic:: NDRDISC
+.. topic:: NDRPDR
 
-    Non Drop Rate evaluation of results. Loss acceptance of dropped packets is
-    set to zero lost packets.
+    Single test finding both No Drop Rate and Partial Drop Rate simultaneously.
+    The search is done by optimized algorithm which performs
+    multiple trial runs at different durations and transmit rates.
 
-.. topic:: NDRCHK
+.. topic:: MRR
 
-    Performance tests where TG verifies DUTs' throughput at ref-NDR (reference
-    Non Drop Rate) with zero packet loss tolerance.
-
-.. topic:: NDRPDRDISC
-
-    Find performance of DUT based on :rfc:`2544` with linear / binary / combined
-    search. (Previous LONG tests.)
+    Performance tests where TG sends the traffic at maximum rate (line rate)
+    and reports total sent/received packets over performance trial duration.
 
 Ethernet frame size tags for performance tests
 ----------------------------------------------
@@ -168,6 +221,10 @@ Ethernet frame size tags for performance tests
 
     78B frames used for test.
 
+.. topic:: 114B
+
+    114B frames used for test.
+
 .. topic:: IMIX
 
     IMIX frame sequence (28x 64B, 16x 570B, 4x 1518B) used for test.
@@ -219,6 +276,11 @@ Test type tags
     L2BD baseline test cases, no encapsulation, no feature(s) configured in
     tests.
 
+.. topic:: L2PATCH
+
+    L2PATCH baseline test cases, no encapsulation, no feature(s) configured in
+    tests.
+
 .. topic:: SCALE
 
     Scale test cases.
@@ -235,6 +297,26 @@ Test type tags
 
     Functional test cases for TLDK.
 
+.. topic:: DMM
+
+    Functional test cases for DMM.
+
+.. topic:: TCP
+
+    Tests which use TCP.
+
+.. topic:: TCP_CPS
+
+    Performance tests which measure connections per second using http requests.
+
+.. topic:: TCP_RPS
+
+    Performance tests which measure requests per second using http requests.
+
+.. topic:: HTTP
+
+    Tests which use HTTP.
+
 Forwarding mode tags
 --------------------
 
@@ -330,6 +412,10 @@ Encapsulation tags
 
     All test cases with IPSEC.
 
+.. topic:: SRv6
+
+    All test cases with Segment routing over IPv6 dataplane.
+
 Interface tags
 --------------
 
@@ -369,6 +455,52 @@ Interface tags
 
     All test cases which uses Memif.
 
+.. topic:: SINGLE_MEMIF
+
+    All test cases which uses only single Memif connection per DUT. One DUT
+    instance is running in container having one physical interface exposed to
+    container.
+
+.. topic:: LBOND
+
+    All test cases which uses link bonding (BondEthernet interface).
+
+.. topic:: LBOND_DPDK
+
+    All test cases which uses DPDK link bonding.
+
+.. topic:: LBOND_VPP
+
+    All test cases which uses VPP link bonding.
+
+.. topic:: LBOND_MODE_XOR
+
+    All test cases which uses link bonding with mode XOR.
+
+.. topic:: LBOND_MODE_LACP
+
+    All test cases which uses link bonding with mode LACP.
+
+.. topic:: LBOND_LB_L34
+
+    All test cases which uses link bonding with load-balance mode l34.
+
+.. topic:: LBOND_1L
+
+    All test cases which uses one link for link bonding.
+
+.. topic:: LBOND_2L
+
+    All test cases which uses two links for link bonding.
+
+.. topic:: DRV_AVF
+
+    All test cases which uses Intel Adaptive Virtual Function (AVF) device
+    plugin for VPP. This plugins provides native device support for Intel AVF.
+    AVF is driver specification for current and future Intel Virtual Function
+    devices. In essence, today this driver can be used only with Intel
+    XL710 / X710 / XXV710 adapters.
+
 Feature tags
 ------------
 
@@ -380,9 +512,13 @@ Feature tags
 
     COP whitelist.
 
-.. topic:: SNAT
+.. topic:: NAT44
+
+    NAT44 configured and tested.
 
-    SNAT configured and tested.
+.. topic:: NAT64
+
+    NAT44 configured and tested.
 
 .. topic:: ACL
 
@@ -416,6 +552,22 @@ Feature tags
 
     ACL plugin configured and tested with 50 not-hitting ACEs.
 
+.. topic:: SRv6_PROXY
+
+    SRv6 endpoint to SR-unaware appliance via proxy.
+
+.. topic:: SRv6_PROXY_STAT
+
+    SRv6 endpoint to SR-unaware appliance via static proxy.
+
+.. topic:: SRv6_PROXY_DYN
+
+    SRv6 endpoint to SR-unaware appliance via dynamic proxy.
+
+.. topic:: SRv6_PROXY_MASQ
+
+    SRv6 endpoint to SR-unaware appliance via masquerading proxy.
+
 Encryption tags
 ---------------
 
@@ -444,21 +596,60 @@ Client-workload tags
 
 .. topic:: LXC
 
-    All test cases which use Linux container.
+    All test cases which use Linux container and LXC utils.
+
+.. topic:: DOCKER
+
+    All test cases which use Docker as container manager.
 
 .. topic:: APP
 
     All test cases with specific APP use.
 
+Container orchestration tags
+----------------------------
+
+.. topic:: K8S
+
+    All test cases which use Kubernetes for orchestration.
+
+.. topic:: SFC_CONTROLLER
+
+    All test cases which use ligato/sfc_controller for driving configuration
+    of vpp inside container.
+
+.. topic:: VPP_AGENT
+
+    All test cases which use Golang implementation of a control/management plane
+    for VPP
+
+.. topic:: 1VSWITCH
+
+    VPP running in Docker container acting as VSWITCH.
+
+.. topic:: 1VNF
+
+    1 VPP running in Docker container acting as VNF work load.
+
+.. topic:: 2VNF
+
+    2 VPP running in 2 Docker containers acting as VNF work load.
+
+.. topic:: 4VNF
+
+    4 VPP running in 4 Docker containers acting as VNF work load.
+
 Multi-threading tags
 --------------------
 
 .. topic:: STHREAD
 
-    All test cases using single poll mode thread.
+   *Dynamic tag*.
+   All test cases using single poll mode thread.
 
 .. topic:: MTHREAD
 
+   *Dynamic tag*.
     All test cases using more then one poll mode driver thread.
 
 .. topic:: 1NUMA
@@ -469,38 +660,61 @@ Multi-threading tags
 
     All test cases with packet processing on two sockets.
 
-.. topic:: SMT
+.. topic:: 1C
 
-    All test cases with symmetric Multi-Threading (HyperThreading) enabled.
+    1 worker thread pinned to 1 dedicated physical core; or if HyperThreading is
+    enabled, 2 worker threads each pinned to a separate logical core within 1
+    dedicated physical core. Main thread pinned to core 1.
 
-.. topic:: NOSMT
+.. topic:: 2C
 
-    All test cases with symmetric Multi-Threading (HyperThreading) disabled.
+    2 worker threads pinned to 2 dedicated physical cores; or if HyperThreading
+    is enabled, 4 worker threads each pinned to a separate logical core within 2
+    dedicated physical cores. Main thread pinned to core 1.
+
+.. topic:: 4C
+
+    4 worker threads pinned to 4 dedicated physical cores; or if HyperThreading
+    is enabled, 8 worker threads each pinned to a separate logical core within 4
+    dedicated physical cores. Main thread pinned to core 1.
 
 .. topic:: 1T1C
 
+   *Dynamic tag*.
     1 worker thread pinned to 1 dedicated physical core. 1 receive queue per
-    interface. Main thread pinned to core 0.
+    interface. Main thread pinned to core 1.
 
 .. topic:: 2T2C
 
+   *Dynamic tag*.
     2 worker threads pinned to 2 dedicated physical cores. 1 receive queue per
-    interface. Main thread pinned to core 0.
+    interface. Main thread pinned to core 1.
 
 .. topic:: 4T4C
 
+   *Dynamic tag*.
     4 worker threads pinned to 4 dedicated physical cores. 2 receive queues per
-    interface. Main thread pinned to core 0.
+    interface. Main thread pinned to core 1.
+
+.. topic:: 2T1C
 
-.. topic:: 6T6C
+   *Dynamic tag*.
+    2 worker threads each pinned to a separate logical core within 1 dedicated
+    physical core. 1 receive queue per interface. Main thread pinned to core 1.
 
-    6 worker threads pinned to 6 dedicated physical cores. 3 receive queues per
-    interface. Main thread pinned to core 0.
+.. topic:: 4T2C
 
-.. topic:: 8T8C
+   *Dynamic tag*.
+    4 worker threads each pinned to a separate logical core within 2 dedicated
+    physical cores. 2 receive queues per interface. Main thread pinned to core
+    1.
 
-    8 worker threads pinned to 8 dedicated physical cores. 4 receive queues per
-    interface. Main thread pinned to core 0.
+.. topic:: 8T4C
+
+   *Dynamic tag*.
+    8 worker threads each pinned to a separate logical core within 4 dedicated
+    physical cores. 4 receive queues per interface. Main thread pinned to core
+    1.
 
 Honeycomb tags
 --------------
@@ -509,6 +723,10 @@ Honeycomb tags
 
     Honeycomb functional test cases.
 
+.. topic:: HC_NSH
+
+    Honeycomb NSH test cases.
+
 .. topic:: HC_PERSIST
 
     Honeycomb persistence test cases.