CSIT rls1704 report - small updates

[csit.git] / docs / tag_documentation.rst

diff --git a/docs/tag_documentation.rst b/docs/tag_documentation.rst
index e0be374..4c0e628 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.
 
@@ -62,6 +42,30 @@ Environment TAGs
     DUTs with VPP and capable of running Virtual Machine.
 
 
+NIC model tags
+--------------
+
+.. topic:: NIC_Intel-X520-DA2
+
+    Intel X520-DA2 NIC.
+
+.. topic:: NIC_Intel-XL710
+
+    Intel XL710 NIC.
+
+.. topic:: NIC_Intel-X710
+
+    Intel X710 NIC.
+
+.. topic:: NIC_Cisco-VIC-1227
+
+    VIC-1227 by Cisco.
+
+.. topic:: NIC_Cisco-VIC-1385
+
+    VIC-1385 by Cisco.
+
+
 Scaling TAGs
 ------------
 
@@ -78,8 +82,8 @@ Scaling TAGs
     2x1,000,000 entries in single fib table
 
 
-Tags marking the kinds of tags
-------------------------------
+Tags marking functional vs. performance of tests
+------------------------------------------------
 
 .. topic:: FUNCTEST
 
@@ -113,6 +117,40 @@ Performance testing tags
     Find performance of DUT based on RFC2544 with linear / binary / combined
     search. (Previous LONG tests.)
 
+Ethernet frame size tags for performance tests
+----------------------------------------------
+
+.. topic:: 64B
+
+    64B frames used for test.
+
+.. topic:: 78B
+
+    78B frames used for test.
+
+.. topic:: IMIX
+
+    IMIX frame sequence (28x 64B, 16x 570B, 4x 1518B) used for test.
+
+.. topic:: 1460B
+
+    1460B frames used for test.
+
+.. topic:: 1480B
+
+    1480B frames used for test.
+
+.. topic:: 1514B
+
+    1514B frames used for test.
+
+.. topic:: 1518B
+
+    1518B frames used for test.
+
+.. topic:: 9000B
+
+    9000B frames used for test.
 
 Test type tags
 --------------
@@ -121,6 +159,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.
@@ -159,7 +217,7 @@ Forwarding mode tags
 
 
 Underlay tags
-----------
+-------------
 
 .. topic:: IP4UNRLAY
 
@@ -175,7 +233,7 @@ Underlay tags
 
 
 Overlay tags
-----------
+------------
 
 .. topic:: L2OVRLAY
 
@@ -225,6 +283,10 @@ Encapsulation tags
 
     All test cases with GRE.
 
+.. topic:: IPSEC
+
+    All test cases with IPSEC.
+
 
 Interface tags
 --------------
@@ -261,6 +323,30 @@ Feature tags
 
     COP whitelist.
 
+.. topic:: SNAT
+
+    SNAT configured and tested.
+
+
+Encryption tags
+---------------
+
+.. topic:: IPSECSW
+
+    Crypto in software.
+
+.. topic:: IPSECHW
+
+    Crypto in hardware.
+
+.. topic:: IPSECTRAN
+
+    IPSec in transport mode.
+
+.. topic:: IPSECTUN
+
+    IPSec in tunnel mode.
+
 
 Client-workload tags
 --------------------