report 18.07: draft v0.9 editorial nit-picking.
[csit.git] / docs / report / vpp_performance_tests / csit_release_notes.rst
index 17003bc..233bf45 100644 (file)
-CSIT Release Notes\r
-==================\r
-\r
-Changes in CSIT |release|\r
--------------------------\r
-\r
-#. Added VPP performance tests\r
-\r
-   - **Container Service Chain Topologies Orchestrated by K8s with VPP Memif**\r
-\r
-     - Added tests with VPP vswitch in container connecting a number of VPP-\r
-       in-container service chain topologies with L2 Cross-Connect and L2\r
-       Bridge-Domain configurations, orchestrated by Kubernetes. Added\r
-       following forwarding topologies: i) "Parallel" with packets flowing from\r
-       NIC via VPP to container and back to VPP and NIC; ii) "Chained" (a.k.a.\r
-       "Snake") with packets flowing via VPP to container, back to VPP, to next\r
-       container, back to VPP and so on until the last container in a chain,\r
-       then back to VPP and NIC; iii) "Horizontal" with packets flowing via VPP\r
-       to container, then via "horizontal" memif to next container, and so on\r
-       until the last container, then back to VPP and NIC;\r
-\r
-   - **VPP TCP/IP stack**\r
-\r
-     - Added tests for VPP TCP/IP stack using VPP built-in HTTP server.\r
-       WRK traffic generator is used as a client-side;\r
-\r
-   - **SRv6**\r
-\r
-     - Initial SRv6 (Segment Routing IPv6) tests verifying performance of\r
-       IPv6 and SRH (Segment Routing Header) encapsulation, decapsulation,\r
-       lookups and rewrites based on configured End and End.DX6 SRv6 egress\r
-       functions;\r
-\r
-   - **IPSecSW**\r
-\r
-     - SW computed IPSec encryption with AES-GCM, CBC-SHA1 ciphers, in\r
-       combination with IPv4 routed-forwarding;\r
-\r
-#. Presentation and Analytics Layer\r
-\r
-     - Added throughput speedup analysis for multi-core and multi-thread\r
-       VPP tests into Presentation and Analytics Layer (PAL) for automated\r
-       CSIT test results analysis;\r
-\r
-#. Other changes\r
-\r
-     - **Framework optimizations**\r
-\r
-       - Ability to run CSIT framework on ARM architecture;\r
-\r
-       - Overall stability improvements;\r
-\r
-     - **NDR and PDR throughput binary search change**\r
-\r
-       - Increased binary search resolution by reducing final step from\r
-         100kpps to 50kpps;\r
-\r
-     - **VPP plugin loaded as needed by tests**\r
-\r
-       - From this release only plugins required by tests are loaded at\r
-         VPP initialization time. Previously all plugins were loaded for\r
-         all tests;\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
-Measured improvements are in line with VPP code optimizations listed in\r
-`VPP-18.01 release notes\r
-<https://docs.fd.io/vpp/18.01/release_notes_1801.html>`_.\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 | Vic1385 and Vic1227 low performance.            | VPP-664    | Low NDR performance.                                            |\r
-|   |                                                 |            |                                                                 |\r
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-| 2 | 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
-| 3 | Lower than expected NDR throughput with         | CSIT-571   | Suspected NIC firmware or DPDK driver issue affecting NDR and   |\r
-|   | xl710 and x710 NICs, compared to x520 NICs.     |            | PDR throughput. Applies to XL710 and X710 NICs.                 |\r
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-| 4 | QAT IPSec scale with 1000 tunnels (interfaces)  | VPP-1121   | VPP crashes during configuration of 1000 IPsec tunnels.         |\r
-|   | in 2t2c config, all tests are failing.          |            | 1t1c tests are not affected                                     |\r
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+\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 improvements of continuous
+     performance trending, anomaly detection and analysis.
+
+#. TEST FRAMEWORK OPTIMIZATIONS
+
+   - **General Code Housekeeping**: Ongoing RF keywords optimizations,
+     removal of redundant RF keywords.
+
+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.                                |
++---+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+