Update 18.07 release notes
[csit.git] / docs / report / vpp_performance_tests / csit_release_notes.rst
index 1954ad1..da25ef6 100644 (file)
@@ -1,21 +1,39 @@
 Release Notes
 =============
 
-Changes in CSIT |release|
+Changes in |csit-release|
 -------------------------
 
 #. **VPP performance tests**
 
-   - *MRR tests* - New Maximum Receive Rate tests measure the packet
-     forwarding rate under the maximum load offered by traffic
-     generator over a set trial duration, regardless of packet loss.
-     MRR tests are used for continuous performance trending and for
-     comparison between releases.
+   - *MRR tests* - Maximum Receive Rate tests measure the packet forwarding rate
+     under the maximum load offered by traffic generator over a set trial
+     duration, regardless of packet loss. MRR tests are used for continuous
+     performance trending and for comparison between releases.
 
-   - *Service Chaining with SRv6* - New SRv6 (Segment Routing IPv6) proxy
-     tests measure performance of SRv6 Endpoint fronting SR-unaware
-     appliance via masquerading (End.AM), dynamic proxy (End.AD) or
-     static proxy (End.AS) SR functions.
+   - *MLR tests* - NDR and PDR tests measure the packet forwarding rate using
+     MLRsearch library by traffic generator. All tests that previously used
+     binary search were converted to MLRsearch.
+
+   - *L2patch tests* - Tests measure performance of L2patch, cross linking
+     RX and TX of two physical interfaces.
+
+   - *2-node tests* - Baseline set of 2-node tests covering base ip4, ip4,
+     l2patch, l2bd, l2xc.
+
+   - *Generated tests* - Simplified and unified test structure,
+     semi-autogenerated by generator script. Test generator is currently able
+     to create test combinations with various frame size and cores combinations.
+     All existing test cases were converted to new format.
+
+   - *Simultaneous multithreading* - SMT-aware automatic detection and
+     resource configuration including thread affinity, number of rx queues and
+     DPDK I/O mbufs. Tests are automatically tagged during execution indicating
+     configuration.
+
+  - *Intel Skylake* - Topologies consisting of 2-node and 3-node using
+    SuperMirco servers each equipped with two Intel Xeon Skylake Platinum
+    processors.
 
 #. **Presentation and Analytics Layer**
 
@@ -38,21 +56,21 @@ Changes in CSIT |release|
 Performance Changes
 -------------------
 
-Relative performance changes in measured packet throughput in CSIT
-|release| are calculated against the results from CSIT |release-1|
+Relative performance changes in measured packet throughput in |csit-release|
+are calculated against the results from |csit-release-1|
 report. Listed mean and standard deviation values are computed based on
 a series of the same tests executed against respective VPP releases to
-verify test results repeatibility, with percentage change calculated for
+verify test results repeatability, with percentage change calculated for
 mean values. Note that the standard deviation is quite high for a small
 number of packet throughput tests, what indicates poor test results
 repeatability and makes the relative change of mean throughput value not
 fully representative for these tests. The root causes behind poor
-results repeatibility vary between the test cases.
+results repeatability vary between the test cases.
 
 NDR Changes
 ~~~~~~~~~~~
 
-NDR small packet throughput changes between releases are available in a
+NDR throughput changes between releases are available in a
 CSV and pretty ASCII formats:
 
   - `csv format for 1t1c <../_static/vpp/performance-changes-1t1c-ndr.csv>`_,
@@ -63,13 +81,15 @@ CSV and pretty ASCII formats:
 .. note::
 
     Test results have been generated by
-    `FD.io test executor vpp performance jobs`_ with Robot Framework result
-    files csit-vpp-perf-|srelease|-\*.zip `archived here <../_static/archive/>`_.
+    `FD.io test executor vpp performance job 3n-hsw`_,
+    with Robot Framework result
+    files csit-vpp-perf-|srelease|-\*.zip
+    `archived here <../_static/archive/>`_.
 
 PDR Changes
 ~~~~~~~~~~~
 
-NDR small packet throughput changes between releases are available in a
+PDR throughput changes between releases are available in a
 CSV and pretty ASCII formats:
 
   - `csv format for 1t1c <../_static/vpp/performance-changes-1t1c-pdr.csv>`_,
@@ -80,8 +100,10 @@ CSV and pretty ASCII formats:
 .. note::
 
     Test results have been generated by
-    `FD.io test executor vpp performance jobs`_ with Robot Framework result
-    files csit-vpp-perf-|srelease|-\*.zip `archived here <../_static/archive/>`_.
+    `FD.io test executor vpp performance job 3n-hsw`_,
+    with Robot Framework result
+    files csit-vpp-perf-|srelease|-\*.zip
+    `archived here <../_static/archive/>`_.
 
 MRR Changes
 ~~~~~~~~~~~
@@ -99,22 +121,70 @@ CSV and pretty ASCII formats:
 .. note::
 
     Test results have been generated by
-    `FD.io test executor vpp mrr jobs <https://jenkins.fd.io/view/csit/job/csit-vpp-perf-mrr-daily-master/>`_
-    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/>`_.
+    `FD.io test executor vpp performance job 3n-hsw`_,
+    with Robot Framework result
+    files csit-vpp-perf-|srelease|-\*.zip
+    `archived here <../_static/archive/>`_.
 
 Comparison Across Testbeds
 --------------------------
 
-.. warning::
+Relative performance changes in measured packet throughputon 3-Node Skx testbed
+are calculated against the results measured on 3-Node Hsw testbed.
+
+NDR Changes
+~~~~~~~~~~~
+
+NDR changes between testbeds are available in a
+CSV and pretty ASCII formats:
+
+  - `csv format for ndr <../_static/vpp/performance-compare-testbeds-3n-hsw-3n-skx-ndr.csv>`_,
+  - `pretty ASCII format for ndr <../_static/vpp/performance-compare-testbeds-3n-hsw-3n-skx-ndr.txt>`_.
+
+.. note::
+
+    Test results have been generated by
+    `FD.io test executor vpp performance job 3n-hsw`_ and
+    `FD.io test executor vpp performance job 3n-skx`_
+    with Robot Framework result
+    files csit-vpp-perf-|srelease|-\*.zip
+    `archived here <../_static/archive/>`_.
+
+PDR Changes
+~~~~~~~~~~~
+
+PDR throughput changes between testbeds are available in a
+CSV and pretty ASCII formats:
 
-    TODO: Add:
+  - `csv format for pdr <../_static/vpp/performance-compare-testbeds-3n-hsw-3n-skx-pdr.csv>`_,
+  - `pretty ASCII format for pdr <../_static/vpp/performance-compare-testbeds-3n-hsw-3n-skx-pdr.txt>`_.
 
-    Table 1.
-    Test Case     3-Node Hsw    3-Node Skx    Skx vs. Hsw Delta [%]
+.. note::
 
-    Table 2.
-    Test Case     3-Node Skx    2-Node Skx    2-Node vs. 3-Node Delta [%]
+    Test results have been generated by
+    `FD.io test executor vpp performance job 3n-hsw`_ and
+    `FD.io test executor vpp performance job 3n-skx`_
+    with Robot Framework result
+    files csit-vpp-perf-|srelease|-\*.zip
+    `archived here <../_static/archive/>`_.
+
+MRR Changes
+~~~~~~~~~~~
+
+MRR throughput changes between testbeds are available in a
+CSV and pretty ASCII formats:
+
+  - `csv format for mrr <../_static/vpp/performance-compare-testbeds-3n-hsw-3n-skx-mrr.csv>`_,
+  - `pretty ASCII format for mrr <../_static/vpp/performance-compare-testbeds-3n-hsw-3n-skx-mrr.txt>`_.
+
+.. note::
+
+    Test results have been generated by
+    `FD.io test executor vpp performance job 3n-hsw`_ and
+    `FD.io test executor vpp performance job 3n-skx`_
+    with Robot Framework result
+    files csit-vpp-perf-|srelease|-\*.zip
+    `archived here <../_static/archive/>`_.
 
 Throughput Trending
 -------------------
@@ -137,7 +207,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                                                     |
@@ -146,18 +216,9 @@ List of known issues in CSIT |release| for VPP performance tests:
 |   | on x520.                                        |            | with HW combination of X710-X520 in LF testbeds. Not observed   |
 |   |                                                 |            | outside of LF testbeds.                                         |
 +---+-------------------------------------------------+------------+-----------------------------------------------------------------+
-| 2 | Lower than expected NDR throughput of DPDK      | CSIT-571   | Suspected NIC firmware or DPDK driver issue affecting NDR and   |
-|   | testpmd and VPP L2 path NDR throughput with     |            | PDR throughput on XL710 and X710 NICs.                          |
-|   | xl710 and x710 NICs, compared to x520 NICs.     |            |                                                                 |
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+
-| 3 | Tagged Ethernet dot1q and dot1ad L2 path        | CSIT-1066  | Tagged Ethernet dot1q and dot1ad L2 path throughput regression: |
-|   | throughput regression.                          |            | NDR -2%..-5%, PDR -2%..-6%, MRR. Affects l2xc and l2bd          |
-|   |                                                 |            | performance tests.                                              |
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+
-| 4 | IPSec (software, no QAT HW) throughput          | CSIT-1064  | IPSec throughput regression: NDR -3%..-8%, PDR -2%..-8%, MRR    |
-|   | regression.                                     |            | -3%..-7%. Affects IPSec SW tests, QAT HW tests not affected.    |
+| 2 | High failure rate of api call                   | VPP-1361   | Failure rate: 30-40% of tests failing due to interfaces not     |
+|   | sw_interface_set_flags [admin-up|link-up]       |            | in link-up state after API call sw_interface_set_flags.         |
 +---+-------------------------------------------------+------------+-----------------------------------------------------------------+
-| 5 | High failure rate of creating working container | CSIT-1065  | About 20% of orchestrated container topology tests failing data |
-|   | topologies with K8s/Ligato orchestration.       |            | plane verification indicating configuration issue. Suspected    |
-|   |                                                 |            | issue with Ligato vpp-agent.                                    |
+| 3 | Scale IPSecHW Interface mode throughput         | CSIT-1234  | IPSec throughput regression: NDR -28%..-31%, PDR -28%..-31%,    |
+|   | regression.                                     |            | MRR -40%. Affects IPSec HW Scale 1000tnl tests with Int mode.   |
 +---+-------------------------------------------------+------------+-----------------------------------------------------------------+