Code Review / csit.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
rls1807 report: added section logical topologies in ../vpp_performance_tests/overview...
[csit.git] / docs / tag_documentation.rst
diff --git a/docs/tag_documentation.rst b/docs/tag_documentation.rst
index e5dd388..9800197 100644 (file)
--- a/docs/tag_documentation.rst
+++ b/docs/tag_documentation.rst
@@ -147,14 +147,30 @@ Performance testing tags
     Non Drop Rate evaluation of results. Loss acceptance of dropped packets is
     set to zero lost packets.
 
     Non Drop Rate evaluation of results. Loss acceptance of dropped packets is
     set to zero lost packets.
 
+.. topic:: NDRPDR
+
+    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
 
     Performance tests where TG verifies DUTs' throughput at ref-NDR (reference
     Non Drop Rate) with zero packet loss tolerance.
 
 .. topic:: NDRCHK
 
     Performance tests where TG verifies DUTs' throughput at ref-NDR (reference
     Non Drop Rate) with zero packet loss tolerance.
 
+.. topic:: PDRCHK
+
+    Performance tests where TG verifies DUTs' throughput at ref-PDR (reference
+    Partial Drop Rate) with 0.5% loss tolerance.
+
+.. topic:: MRR
+
+    Performance tests where TG sends the traffic at maximum rate (line rate)
+    and reports total sent/received packets over performance trial duration.
+
 .. topic:: NDRPDRDISC
 
 .. topic:: NDRPDRDISC
 
-    Find performance of DUT based on RFC2544 with linear / binary / combined
+    Find performance of DUT based on :rfc:`2544` with linear / binary / combined
     search. (Previous LONG tests.)
 
 Ethernet frame size tags for performance tests
     search. (Previous LONG tests.)
 
 Ethernet frame size tags for performance tests
@@ -235,6 +251,22 @@ Test type tags
 
     Functional test cases for TLDK.
 
 
     Functional test cases for TLDK.
 
+.. 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
 --------------------
 
 Forwarding mode tags
 --------------------
 
@@ -330,6 +362,10 @@ Encapsulation tags
 
     All test cases with IPSEC.
 
 
     All test cases with IPSEC.
 
+.. topic:: SRv6
+
+    All test cases with Segment routing over IPv6 dataplane.
+
 Interface tags
 --------------
 
 Interface tags
 --------------
 
@@ -369,6 +405,36 @@ Interface tags
 
     All test cases which uses Memif.
 
 
     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.
+
 Feature tags
 ------------
 
 Feature tags
 ------------
 
@@ -380,9 +446,13 @@ Feature tags
 
     COP whitelist.
 
 
     COP whitelist.
 
-.. topic:: SNAT
+.. topic:: NAT44
+
+    NAT44 configured and tested.
 
 
-    SNAT configured and tested.
+.. topic:: NAT64
+
+    NAT44 configured and tested.
 
 .. topic:: ACL
 
 
 .. topic:: ACL
 
@@ -416,6 +486,22 @@ Feature tags
 
     ACL plugin configured and tested with 50 not-hitting ACEs.
 
 
     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
 ---------------
 
 Encryption tags
 ---------------
 
@@ -444,21 +530,60 @@ Client-workload tags
 
 .. topic:: LXC
 
 
 .. 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.
 
 
 .. 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
 
 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
 
 
 .. topic:: MTHREAD
 
+   *Dynamic tag*.
     All test cases using more then one poll mode driver thread.
 
 .. topic:: 1NUMA
     All test cases using more then one poll mode driver thread.
 
 .. topic:: 1NUMA
@@ -469,38 +594,41 @@ Multi-threading tags
 
     All test cases with packet processing on two sockets.
 
 
     All test cases with packet processing on two sockets.
 
-.. topic:: SMT
-
-    All test cases with symmetric Multi-Threading (HyperThreading) enabled.
-
-.. topic:: NOSMT
-
-    All test cases with symmetric Multi-Threading (HyperThreading) disabled.
-
 .. topic:: 1T1C
 
 .. topic:: 1T1C
 
+   *Dynamic tag*.
     1 worker thread pinned to 1 dedicated physical core. 1 receive queue per
     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
 
 
 .. topic:: 2T2C
 
+   *Dynamic tag*.
     2 worker threads pinned to 2 dedicated physical cores. 1 receive queue per
     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
 
 
 .. topic:: 4T4C
 
+   *Dynamic tag*.
     4 worker threads pinned to 4 dedicated physical cores. 2 receive queues per
     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:: 6T6C
+.. topic:: 2T1C
 
 
-    6 worker threads pinned to 6 dedicated physical cores. 3 receive queues per
-    interface. Main thread pinned to core 0.
+   *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.
 
 
-.. topic:: 8T8C
+.. topic:: 4T2C
 
 
-    8 worker threads pinned to 8 dedicated physical cores. 4 receive queues per
-    interface. Main thread pinned to core 0.
+   *Dynamic tag*.
+    4 worker threads each pinned to a separate logical core within 2 dedicated
+    physical core. 2 receive queue per interface. Main thread pinned to core 1.
+
+.. topic:: 8T4C
+
+   *Dynamic tag*.
+    8 worker threads each pinned to a separate logical core within 4 dedicated
+    physical core. 4 receive queue per interface. Main thread pinned to core 1.
 
 Honeycomb tags
 --------------
 
 Honeycomb tags
 --------------
@@ -509,6 +637,10 @@ Honeycomb tags
 
     Honeycomb functional test cases.
 
 
     Honeycomb functional test cases.
 
+.. topic:: HC_NSH
+
+    Honeycomb NSH test cases.
+
 .. topic:: HC_PERSIST
 
     Honeycomb persistence test cases.
 .. topic:: HC_PERSIST
 
     Honeycomb persistence test cases.
Integration tests