Report rls notes: added ref to trending docs.
[csit.git] / docs / report / vpp_performance_tests / csit_release_notes.rst
index d7c2bbc..0914d9f 100644 (file)
@@ -6,14 +6,14 @@ Changes in CSIT |release|
 \r
 #. **Added VPP performance tests**\r
 \r
-   - **MRR tests** : New MRR tests measure the packet forwarding rate\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
+   - *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
@@ -29,12 +29,12 @@ Changes in CSIT |release|
 \r
 #. **Test Framework Optimizations**\r
 \r
-     - **Performance tests efficiency** : Qemu build/install\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
+     - *General code housekeeping :* ongoing RF keywords\r
      optimizations, removal of redundant RF keywords.\r
 \r
 Performance Changes\r
@@ -86,35 +86,48 @@ pretty ASCII formats:
   - `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
-<to be updated before rls1804 release>\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
+| 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
-| 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
+| 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
-| 4 | rls1801 plugin related performance regression   | CSIT-925   | With all plugins loaded NDR, PDR and MaxRates vary              |\r
-|   |                                                 |            | intermittently from 3% to 5% across multiple test executions.   |\r
-|   |                                                 |            | Requires plugin code bisecting.                                 |\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
-| 5 | rls1801 generic small performance regression    | CSIT-926   | Generic performance regression of discovered NDR, PDR and       |\r
-|   | ip4base, l2xcbase, l2bdbase                     |            | MaxRates of -3%..-1% vs. rls1710, affects ip4base, l2xcbase,    |\r
-|   |                                                 |            | l2bdbase test suites. Not detected by CSIT performance trending |\r
-|   |                                                 |            | scheme as it was masked out by another issue CSIT-925.          |\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
-| 6 | rls1801 substantial NDR/PDR regression for      | CSIT-928   | NDR regression of -7%..-15%, PDR regression of -3%..-15%        |\r
-|   | IPSec tunnel scale with HW QAT crypto-dev       |            | compared to rls1710.                                            |\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