-CSIT Release Notes\r
-==================\r
-\r
-Changes in CSIT |release|\r
--------------------------\r
-\r
-#. **Added VPP performance tests**\r
-\r
- - *MRR tests :* New MRR tests measure the packet forwarding rate\r
- under the maximum load offered by traffic generator over a set\r
- trial duration, regardless of packet loss. Maximum load for\r
- specified Ethernet frame size is set to the bi-directional link\r
- rate. MRR tests are used for continuous performance trending and\r
- for comparison between releases.\r
-\r
- - *Service Chaining with SRv6 :* SRv6 (Segment Routing IPv6) proxy tests\r
- verifying performance of Endpoint to SR-unaware appliance via\r
- masquerading (End.AM), dynamic proxy (End.AD) or static proxy (End.AS)\r
- functions.\r
-\r
-#. **Presentation and Analytics Layer (PAL)**\r
-\r
- - Added continuous performance measuring, trending and anomaly\r
- detection. Includes new PAL code and Jenkins jobs for Performance\r
- Trending (PT) and Performance Analysis (PA) producing performance\r
- trending dashboard and trendline graphs with summary and drill-\r
- down views across all specified tests that can be reviewed and\r
- inspected regularly by FD.io developers and users community.\r
-\r
-#. **Test Framework Optimizations**\r
-\r
- - *Performance tests efficiency :* Qemu build/install\r
- optimizations, warmup phase handling, vpp restart handling.\r
- Resulted in improved stability and reduced total execution time by\r
- 30% for single pkt size e.g. 64B/78B.\r
-\r
- - *General code housekeeping :* ongoing RF keywords\r
- optimizations, removal of redundant RF keywords.\r
-\r
-Performance Changes\r
--------------------\r
-\r
-Relative performance changes in measured packet throughput in CSIT\r
-|release| are calculated against the results from CSIT |release-1|\r
-report. Listed mean and standard deviation values are computed based on\r
-a series of the same tests executed against respective VPP releases to\r
-verify test results repeatibility, with percentage change calculated for\r
-mean values. Note that the standard deviation is quite high for a small\r
-number of packet throughput tests, what indicates poor test results\r
-repeatability and makes the relative change of mean throughput value not\r
-fully representative for these tests. The root causes behind poor\r
-results repeatibility vary between the test cases.\r
-\r
-NDR Throughput Changes\r
-~~~~~~~~~~~~~~~~~~~~~~\r
-\r
-NDR small packet throughput changes between releases are available in a CSV and\r
-pretty ASCII formats:\r
-\r
- - `csv format for 1t1c <../_static/vpp/performance-changes-ndr-1t1c-full.csv>`_,\r
- - `csv format for 2t2c <../_static/vpp/performance-changes-ndr-2t2c-full.csv>`_,\r
- - `pretty ASCII format for 1t1c <../_static/vpp/performance-changes-ndr-1t1c-full.txt>`_,\r
- - `pretty ASCII format for 2t2c <../_static/vpp/performance-changes-ndr-2t2c-full.txt>`_.\r
-\r
-PDR Throughput Changes\r
-~~~~~~~~~~~~~~~~~~~~~~\r
-\r
-NDR small packet throughput changes between releases are available in a CSV and\r
-pretty ASCII formats:\r
-\r
- - `csv format for 1t1c <../_static/vpp/performance-changes-pdr-1t1c-full.csv>`_,\r
- - `csv format for 2t2c <../_static/vpp/performance-changes-pdr-2t2c-full.csv>`_,\r
- - `pretty ASCII format for 1t1c <../_static/vpp/performance-changes-pdr-1t1c-full.txt>`_,\r
- - `pretty ASCII format for 2t2c <../_static/vpp/performance-changes-pdr-2t2c-full.txt>`_.\r
-\r
-MRR Throughput Changes\r
-~~~~~~~~~~~~~~~~~~~~~~\r
-\r
-MRR changes between releases are available in a CSV and\r
-pretty ASCII formats:\r
-\r
- - `csv format for 1t1c <../_static/vpp/performance-changes-mrr-1t1c-full.csv>`_,\r
- - `csv format for 2t2c <../_static/vpp/performance-changes-mrr-2t2c-full.csv>`_,\r
- - `csv format for 4t4c <../_static/vpp/performance-changes-mrr-4t4c-full.csv>`_,\r
- - `pretty ASCII format for 1t1c <../_static/vpp/performance-changes-mrr-1t1c-full.txt>`_,\r
- - `pretty ASCII format for 2t2c <../_static/vpp/performance-changes-mrr-2t2c-full.txt>`_,\r
- - `pretty ASCII format for 4t4c <../_static/vpp/performance-changes-mrr-4t4c-full.txt>`_.\r
-\r
-Throughput Trending\r
--------------------\r
-\r
-In addition to reporting throughput changes between VPP releases, CSIT provides\r
-continuous performance trending for VPP master branch:\r
-\r
-#. `VPP Performance Dashboard <https://docs.fd.io/csit/master/trending/introduction/index.html>`_\r
-- per VPP test case throughput trend, trend compliance and summary of detected\r
-anomalies.\r
-\r
-#. `Trending Methodology <https://docs.fd.io/csit/master/trending/methodology/index.html>`_\r
-- throughput test metrics, trend calculations and anomaly classification\r
-(progression, regression, outlier).\r
-\r
-#. `Trendline Graphs <https://docs.fd.io/csit/master/trending/trending/index.html>`_\r
-- per VPP build MRR throughput measurements against the trendline with anomaly\r
-highlights, with associated CSIT test jobs.\r
-\r
-Known Issues\r
-------------\r
-\r
-Here is the list of known issues in CSIT |release| for VPP performance tests:\r
-\r
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-| # | Issue | Jira ID | Description |\r
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-| 1 | Sporadic (1 in 200) NDR discovery test failures | CSIT-570 | DPDK reporting rx-errors, indicating L1 issue. Suspected issue |\r
-| | on x520. | | with HW combination of X710-X520 in LF testbeds. Not observed |\r
-| | | | outside of LF testbeds. |\r
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-| 2 | Lower than expected NDR throughput of DPDK | CSIT-571 | Suspected NIC firmware or DPDK driver issue affecting NDR and |\r
-| | testpmd and VPP L2 path NDR throughput with | | PDR throughput on XL710 and X710 NICs. |\r
-| | xl710 and x710 NICs, compared to x520 NICs. | | |\r
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-| 3 | Tagged Ethernet dot1q and dot1ad L2 path | CSIT-1066 | Tagged Ethernet dot1q and dot1ad L2 path throughput regression: |\r
-| | throughput regression. | | NDR -2%..-5%, PDR -2%..-6%, MRR. Affects l2xc and l2bd |\r
-| | | | performance tests. |\r
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-| 4 | IPSec (software, no QAT HW) throughput | CSIT-1064 | IPSec throughput regression: NDR -3%..-8%, PDR -2%..-8%, MRR |\r
-| | regression. | | -3%..-7%. |\r
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-| 5 | High failure rate of creating working container | CSIT-1065 | Orchestrated container topology tests failing data plane |\r
-| | topologies with K8s/Ligato orchestration. | | verification indicating configuration issue. Suspected issue |\r
-| | | | with Ligato vpp-agent. |\r
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
+Release Notes
+=============
+
+Changes in |csit-release|
+-------------------------
+
+#. **VPP Performance Tests**
+
+ - **MRR Throughput**: MRR (Maximum Receive Rate) test code has now
+ configurable trial duration and number of consecutive executions.
+ Coverage of MRR tests has been extended across more test
+ scenarios. MRR tests are used for continuous performance trending
+ and for comparison between VPP releases.
+
+ - **MLRsearch Throughput**: MLRsearch algorithm has been introduced
+ for all NDR and PDR throughput tests. All tests that previously
+ used binary search got converted to MLRsearch. Coverage of NDR/PDR
+ tests has been extended across more test scenarios.
+
+ - **L2patch Tests**: Tests measure performance of VPP L2patch, the
+ fastest L2 forwarding path implemented in VPP, that cross-links
+ RX and TX of two physical interfaces.
+
+ - **2-Node Tests**: A new baseline set of 2-node tests covering base
+ ip4, ip6, l2patch, l2bd, l2xc, running on new Xeon Skylake
+ testbeds.
+
+ - **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 Multi-Threading**: SMT-aware detection of server
+ processor operation mode (HyperThreading enabled/disabled) with
+ associated compute resource configuration including thread
+ affinity, number of Rx queues and DPDK I/O mbufs. Tests are
+ automatically tagged during execution to indicate executed thread
+ configuration.
+
+ - **Intel Xeon Skylake Support**: Support for 2-Node and 3-Node
+ physical testbed topologies based on the new SuperMirco servers
+ each with two Intel Xeon Skylake Platinum processors. Full
+ Ansible playbooks refactor for quick server (re)installation and
+ reference pointers of configuration.
+
+#. **Presentation and Analytics Layer**
+
+ - **Performance trending**: Further improved continuous performance
+ trending with anomaly detection and analysis.
+
+#. **Test Framework Optimizations**
+
+ - **General Code Housekeeping**: Ongoing RF keywords optimizations,
+ removal of redundant RF keywords.
+
+Performance Changes
+-------------------
+
+Relative performance changes in measured NDR, PDR and MRR packet
+throughput in |csit-release| are calculated against the test results
+from |csit-release-1| report, for tests running on 3-Node Intel Xeon
+Haswell testbeds (3n-hsw) in 1-core, 2-core and 4-core (MRR only)
+configurations.
+
+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 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 repeatability vary between the test cases.
+
+NDR Changes
+~~~~~~~~~~~
+
+NDR throughput changes between releases are available in CSV and pretty
+ASCII formats:
+
+ - `CSV 1t1c NDR changes <../_static/vpp/performance-changes-1t1c-ndr.csv>`_,
+ - `CSV 2t2c NDR changes <../_static/vpp/performance-changes-2t2c-ndr.csv>`_,
+ - `ASCII 1t1c NDR changes <../_static/vpp/performance-changes-1t1c-ndr.txt>`_,
+ - `ASCII 2t2c NDR changes <../_static/vpp/performance-changes-2t2c-ndr.txt>`_.
+
+.. note::
+
+ Test results have been generated by
+ `FD.io test executor vpp performance job 3n-hsw`_,
+ with RF result
+ files csit-vpp-perf-|srelease|-\*.zip
+ `archived here <../_static/archive/>`_.
+
+PDR Changes
+~~~~~~~~~~~
+
+PDR throughput changes between releases are available in CSV and pretty
+ASCII formats:
+
+ - `CSV 1t1c PDR changes <../_static/vpp/performance-changes-1t1c-pdr.csv>`_,
+ - `CSV 2t2c PDR changes <../_static/vpp/performance-changes-2t2c-pdr.csv>`_,
+ - `ASCII 1t1c PDR changes <../_static/vpp/performance-changes-1t1c-pdr.txt>`_,
+ - `ASCII 2t2c PDR changes <../_static/vpp/performance-changes-2t2c-pdr.txt>`_.
+
+.. note::
+
+ Test results have been generated by
+ `FD.io test executor vpp performance job 3n-hsw`_,
+ with RF result
+ files csit-vpp-perf-|srelease|-\*.zip
+ `archived here <../_static/archive/>`_.
+
+MRR Changes
+~~~~~~~~~~~
+
+MRR throughput changes between releases are available in CSV and pretty
+ASCII formats:
+
+ - `CSV 1t1c MRR changes <../_static/vpp/performance-changes-1t1c-mrr.csv>`_,
+ - `CSV 2t2c MRR changes <../_static/vpp/performance-changes-2t2c-mrr.csv>`_,
+ - `CSV 4t4c MRR changes <../_static/vpp/performance-changes-4t4c-mrr.csv>`_,
+ - `ASCII 1t1c MRR changes <../_static/vpp/performance-changes-1t1c-mrr.txt>`_,
+ - `ASCII 2t2c MRR changes <../_static/vpp/performance-changes-2t2c-mrr.txt>`_,
+ - `ASCII 4t4c MRR changes <../_static/vpp/performance-changes-4t4c-mrr.txt>`_.
+
+.. note::
+
+ Test results have been generated by
+ `FD.io test executor vpp performance job 3n-hsw`_,
+ with RF result
+ files csit-vpp-perf-|srelease|-\*.zip
+ `archived here <../_static/archive/>`_.
+
+Skx vs. Hsw Comparison
+----------------------
+
+Relative performance comparison in measured NDR, PDR and MRR packet
+throughput is calculated for tests executed on 3-Node Skylake (3n-skx)
+and 3-Node Haswell (3n-hsw) physical testbed types in 1-core
+configurations.
+
+NDR Comparison
+~~~~~~~~~~~~~~
+
+NDR comparison between testbed types is available in CSV and pretty
+ASCII formats:
+
+ - `CSV 1c NDR comparison <../_static/vpp/performance-compare-testbeds-3n-hsw-3n-skx-ndr.csv>`_,
+ - `ASCII 1c NDR comparison <../_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 RF result
+ files csit-vpp-perf-|srelease|-\*.zip
+ `archived here <../_static/archive/>`_.
+
+PDR Comparison
+~~~~~~~~~~~~~~
+
+PDR comparison between testbed types is available in CSV and pretty
+ASCII formats:
+
+ - `CSV 1c PDR comparison <../_static/vpp/performance-compare-testbeds-3n-hsw-3n-skx-pdr.csv>`_,
+ - `ASCII 1c PDR comparison <../_static/vpp/performance-compare-testbeds-3n-hsw-3n-skx-pdr.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 RF result
+ files csit-vpp-perf-|srelease|-\*.zip
+ `archived here <../_static/archive/>`_.
+
+MRR Comparison
+~~~~~~~~~~~~~~
+
+MRR comparison between testbed types is available in CSV and pretty
+ASCII formats:
+
+ - `CSV 1c MRR comparison <../_static/vpp/performance-compare-testbeds-3n-hsw-3n-skx-mrr.csv>`_,
+ - `ASCII 1c MRR comparison <../_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 RF result
+ files csit-vpp-perf-|srelease|-\*.zip
+ `archived here <../_static/archive/>`_.
+
+Throughput Trending
+-------------------
+
+In addition to reporting throughput changes between VPP releases, CSIT
+provides continuous performance trending for VPP master branch:
+
+#. `VPP Performance Dashboard <https://docs.fd.io/csit/master/trending/introduction/index.html>`_
+ - per VPP test case throughput trend, trend compliance and summary of
+ detected anomalies.
+
+#. `Trending Methodology <https://docs.fd.io/csit/master/trending/methodology/index.html>`_
+ - throughput test metrics, trend calculations and anomaly
+ classification (progression, regression, outlier).
+
+#. `Trendline Graphs <https://docs.fd.io/csit/master/trending/trending/index.html>`_
+ - per VPP build MRR throughput measurements against the trendline
+ with anomaly highlights, with associated CSIT test jobs.
+
+Known Issues
+------------
+
+List of known issues in |csit-release| for VPP performance tests:
+
++---+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+| # | JiraID | Issue Description |
++===+=========================================+=================================================================================================================================+
+| 1 | `CSIT-570 | Sporadic (1 in 200) NDR discovery test failures on x520. DPDK reporting rx-errors, indicating L1 issue. |
+| | <https://jira.fd.io/browse/CSIT-570>`_ | Suspected issue with HW combination of X710-X520 in LF testbeds. Not observed outside of LF testbeds. |
++---+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+| 2 | `VPP-1361 | High failure rate of api call sw_interface_set_flags [admin-up|link-up]. |
+| | <https://jira.fd.io/browse/VPP-1361>`_ | Failure rate: 30-40% of tests failing due to interfaces not in link-up state after API call sw_interface_set_flags. |
++---+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+| 3 | `CSIT-1234 | VPP IPSecHW scale interface mode 1core, low NDR and PDR 64B throughput in 3n-hsw testbeds, in CSIT-18.07 vs. CSIT-18.04. |
+| | <https://jira.fd.io/browse/CSIT-1234>`_ | ip4ipsecscale1000tnl-ip4base-int 1core CSIT-18.07/18.04 relative change: NDR -31%, PDR -32%, MRR -38%. |
++---+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+| 4 | `CSIT-1242 | VPP xl710 ip4base test 1core, low NDR and PDR 64B throughput in 3n-hsw testbeds, in CSIT-18.07 vs. CSIT-18.04. |
+| | <https://jira.fd.io/browse/CSIT-1242>`_ | xl710 ip4base 1core CSIT-18.07/18.04 relative change: NDR -29%, high stdev. |
++---+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+| 5 | `CSIT-1243 | VPP nat44 base test 2core, low NDR and PDR 64B throughput in 3n-skx testbeds, compared to 3n-hsw testbeds. |
+| | <https://jira.fd.io/browse/CSIT-1243>`_ | ip4base-nat44 2core 3n-skx/3n-hsw relative change: NDR -19%, PDR -22%. |
++---+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+| 6 | `CSIT-1244 | VPP lispip4 base test 2core, low NDR and PDR 64B throughput in 3n-skx testbeds, compared to 3n-hsw testbeds. |
+| | <https://jira.fd.io/browse/CSIT-1244>`_ | ip4lispip4-ip4base 2core 3n-skx/3n-hsw relative change: NDR -11%, PDR -18%. |
++---+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+| 7 | `CSIT-1245 | VPP srv6proxy-stat and srv6proxy-masq, much higher NDR and PDR 78B throughput in 3n-hsw testbeds, in CSIT-18.07 vs. CSIT-18.04. |
+| | <https://jira.fd.io/browse/CSIT-1245>`_ | Due to wrong test suite configuration in dynamic-proxy mode. Artefact of suite code refactoring. |
++---+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+