CSIT-1213: Add 2n/3n-skx to Test Oper Data

[csit.git] / docs / report / vpp_performance_tests / csit_release_notes.rst

diff --git a/docs/report/vpp_performance_tests/csit_release_notes.rst b/docs/report/vpp_performance_tests/csit_release_notes.rst
index 0309885..4fdee97 100644 (file)
--- a/docs/report/vpp_performance_tests/csit_release_notes.rst
+++ b/docs/report/vpp_performance_tests/csit_release_notes.rst
@@ -1,7 +1,7 @@
-CSIT Release Notes
-==================
+Release Notes
+=============
 
-Changes in CSIT |release|
+Changes in |csit-release|
 -------------------------
 
 #. **VPP performance tests**
@@ -55,10 +55,10 @@ NDR Changes
 NDR small packet throughput changes between releases are available in a
 CSV and pretty ASCII formats:
 
-  - `csv format for 1t1c <../_static/vpp/performance-changes-ndr-1t1c-full.csv>`_,
-  - `csv format for 2t2c <../_static/vpp/performance-changes-ndr-2t2c-full.csv>`_,
-  - `pretty ASCII format for 1t1c <../_static/vpp/performance-changes-ndr-1t1c-full.txt>`_,
-  - `pretty ASCII format for 2t2c <../_static/vpp/performance-changes-ndr-2t2c-full.txt>`_.
+  - `csv format for 1t1c <../_static/vpp/performance-changes-1t1c-ndr.csv>`_,
+  - `csv format for 2t2c <../_static/vpp/performance-changes-2t2c-ndr.csv>`_,
+  - `pretty ASCII format for 1t1c <../_static/vpp/performance-changes-1t1c-ndr.txt>`_,
+  - `pretty ASCII format for 2t2c <../_static/vpp/performance-changes-2t2c-ndr.txt>`_.
 
 .. note::
 
@@ -72,10 +72,10 @@ PDR Changes
 NDR small packet throughput changes between releases are available in a
 CSV and pretty ASCII formats:
 
-  - `csv format for 1t1c <../_static/vpp/performance-changes-pdr-1t1c-full.csv>`_,
-  - `csv format for 2t2c <../_static/vpp/performance-changes-pdr-2t2c-full.csv>`_,
-  - `pretty ASCII format for 1t1c <../_static/vpp/performance-changes-pdr-1t1c-full.txt>`_,
-  - `pretty ASCII format for 2t2c <../_static/vpp/performance-changes-pdr-2t2c-full.txt>`_.
+  - `csv format for 1t1c <../_static/vpp/performance-changes-1t1c-pdr.csv>`_,
+  - `csv format for 2t2c <../_static/vpp/performance-changes-2t2c-pdr.csv>`_,
+  - `pretty ASCII format for 1t1c <../_static/vpp/performance-changes-1t1c-pdr.txt>`_,
+  - `pretty ASCII format for 2t2c <../_static/vpp/performance-changes-2t2c-pdr.txt>`_.
 
 .. note::
 
@@ -89,12 +89,12 @@ MRR Changes
 MRR small packet throughput changes between releases are available in a
 CSV and pretty ASCII formats:
 
-  - `csv format for 1t1c <../_static/vpp/performance-changes-mrr-1t1c-full.csv>`_,
-  - `csv format for 2t2c <../_static/vpp/performance-changes-mrr-2t2c-full.csv>`_,
-  - `csv format for 4t4c <../_static/vpp/performance-changes-mrr-4t4c-full.csv>`_,
-  - `pretty ASCII format for 1t1c <../_static/vpp/performance-changes-mrr-1t1c-full.txt>`_,
-  - `pretty ASCII format for 2t2c <../_static/vpp/performance-changes-mrr-2t2c-full.txt>`_,
-  - `pretty ASCII format for 4t4c <../_static/vpp/performance-changes-mrr-4t4c-full.txt>`_.
+  - `csv format for 1t1c <../_static/vpp/performance-changes-1t1c-mrr.csv>`_,
+  - `csv format for 2t2c <../_static/vpp/performance-changes-2t2c-mrr.csv>`_,
+  - `csv format for 4t4c <../_static/vpp/performance-changes-4t4c-mrr.csv>`_,
+  - `pretty ASCII format for 1t1c <../_static/vpp/performance-changes-1t1c-mrr.txt>`_,
+  - `pretty ASCII format for 2t2c <../_static/vpp/performance-changes-2t2c-mrr.txt>`_,
+  - `pretty ASCII format for 4t4c <../_static/vpp/performance-changes-4t4c-mrr.txt>`_.
 
 .. note::
 
@@ -103,6 +103,19 @@ CSV and pretty ASCII formats:
     with Robot Framework result files csit-vpp-perf-mrr-daily-master__*__output.xml.gz
     `archived here <https://docs.fd.io/csit/master/trending/_static/archive/>`_.
 
+Comparison Across Testbeds
+--------------------------
+
+.. warning::
+
+    TODO: Add:
+
+    Table 1.
+    Test Case     3-Node Hsw    3-Node Skx    Skx vs. Hsw Delta [%]
+
+    Table 2.
+    Test Case     3-Node Skx    2-Node Skx    2-Node vs. 3-Node Delta [%]
+
 Throughput Trending
 -------------------
 
@@ -124,7 +137,7 @@ provides continuous performance trending for VPP master branch:
 Known Issues
 ------------
 
-List of known issues in CSIT |release| for VPP performance tests:
+List of known issues in |csit-release| for VPP performance tests:
 
 +---+-------------------------------------------------+------------+-----------------------------------------------------------------+
 | # | Issue                                           | Jira ID    | Description                                                     |