Func test reorg - decrease exec time per vpp patch

[csit.git] / docs / tag_documentation.rst

diff --git a/docs/tag_documentation.rst b/docs/tag_documentation.rst
index 11fc26f..79b9f81 100644 (file)
--- a/docs/tag_documentation.rst
+++ b/docs/tag_documentation.rst
@@ -1,25 +1,5 @@
-.. |copy| unicode:: 0xA9 .. copyright sign
-
-| Copyright |copy| 2016 Cisco and/or its affiliates.
-| Licensed under the Apache License, Version 2.0 (the "License");
-| you may not use this file except in compliance with the License.
-| You may obtain a copy of the License at:
-|
-|     http://www.apache.org/licenses/LICENSE-2.0
-|
-| Unless required by applicable law or agreed to in writing, software
-| distributed under the License is distributed on an "AS IS" BASIS,
-| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-| See the License for the specific language governing permissions and
-| limitations under the License.
-
-
-.. contents:: Table of Contents
-    :depth: 2
-
-
-TAGs and their descriptions
-===========================
+CSIT TAGs Descriptions
+======================
 
 Documentation for tags used to select and identify test cases.
 
@@ -37,6 +17,7 @@ Topology TAGs
     3 nodes connected in a circular topology with at least one link
     interconnecting devices.
 
+
 Objective TAGs
 --------------
 
@@ -45,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
 ----------------
@@ -101,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
 ------------------------------------------------
@@ -179,6 +188,26 @@ Test type tags
 
     Baseline test cases, no encapsulation, no feature(s) configured in tests.
 
+.. topic:: IP4BASE
+
+    IPv4 baseline test cases, no encapsulation, no feature(s) configured in
+    tests.
+
+.. topic:: IP6BASE
+
+    IPv6 baseline test cases, no encapsulation, no feature(s) configured in
+    tests.
+
+.. topic:: L2XCBASE
+
+    L2XC baseline test cases, no encapsulation, no feature(s) configured in
+    tests.
+
+.. topic:: L2BDBASE
+
+    L2BD baseline test cases, no encapsulation, no feature(s) configured in
+    tests.
+
 .. topic:: SCALE
 
     Scale test cases.
@@ -415,3 +444,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.