CSIT-651 Add keywords and template for memif

[csit.git] / docs / tag_documentation.rst

diff --git a/docs/tag_documentation.rst b/docs/tag_documentation.rst
index 4c0e628..3e2d44d 100644 (file)
--- a/docs/tag_documentation.rst
+++ b/docs/tag_documentation.rst
@@ -17,6 +17,7 @@ Topology TAGs
     3 nodes connected in a circular topology with at least one link
     interconnecting devices.
 
+
 Objective TAGs
 --------------
 
@@ -25,6 +26,10 @@ Objective TAGs
     Test case(s) marked to not run in case of vpp-csit-verify (i.e. VPP patch)
     and csit-vpp-verify jobs (i.e. CSIT patch).
 
+.. topic:: SKIP_VPP_PATCH
+
+    Test case(s) marked to not run in case of vpp-csit-verify (i.e. VPP patch).
+
 
 Environment TAGs
 ----------------
@@ -81,6 +86,30 @@ Scaling TAGs
 
     2x1,000,000 entries in single fib table
 
+.. topic:: TNL_1000
+
+    IPSec in tunnel mode - 1000 tunnels.
+
+.. topic:: SRC_USER_10
+
+    Traffic flow with 10 unique IPs (users) in one direction.
+
+.. topic:: SRC_USER_100
+
+    Traffic flow with 100 unique IPs (users) in one direction.
+
+.. topic:: SRC_USER_1000
+
+    Traffic flow with 1000 unique IPs (users) in one direction.
+
+.. topic:: SRC_USER_2000
+
+    Traffic flow with 2000 unique IPs (users) in one direction.
+
+.. topic:: SRC_USER_4000
+
+    Traffic flow with 4000 unique IPs (users) in one direction.
+
 
 Tags marking functional vs. performance of tests
 ------------------------------------------------
@@ -191,6 +220,10 @@ Test type tags
 
     At least one feature is configured in test cases. Use also feature tag(s).
 
+.. topic:: TLDK
+    
+    Functional test cases for TLDK.
+
 
 Forwarding mode tags
 --------------------
@@ -311,6 +344,9 @@ Interface tags
 
     All test cases which uses Netmap.
 
+.. topic:: MEMIF
+
+    All test cases which uses Memif.
 
 Feature tags
 ------------
@@ -415,3 +451,20 @@ Multi-threading tags
 
     8 worker threads pinned to 8 dedicated physical cores. 4 receive queues per
     interface. Main thread pinned to core 0.
+
+
+Honeycomb tags
+--------------
+
+.. topic:: HC_FUNC
+
+    Honeycomb functional test cases.
+
+.. topic:: HC_PERSIST
+
+    Honeycomb persistence test cases.
+
+.. topic:: HC_REST_ONLY
+
+    (Exclusion tag) Honeycomb test cases that cannot be run in Netconf mode
+    using ODL client for Restfconf -> Netconf translation.