X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=docs%2Freport%2Fvpp_performance_tests%2Fcsit_release_notes.rst;h=58f0cc20cd7f2fc9f3d29aac8174bd4d9344abde;hp=d7c2bbc7d482d97240b7565f2a8a12d19dc3010b;hb=9b0de32a2b0f50f725bf635cc8cf302e9411f46c;hpb=898aeaa4efbbfcffea77471220ffa903600d3b06
diff --git a/docs/report/vpp_performance_tests/csit_release_notes.rst b/docs/report/vpp_performance_tests/csit_release_notes.rst
index d7c2bbc7d4..58f0cc20cd 100644
--- a/docs/report/vpp_performance_tests/csit_release_notes.rst
+++ b/docs/report/vpp_performance_tests/csit_release_notes.rst
@@ -4,38 +4,36 @@ CSIT Release Notes
Changes in CSIT |release|
-------------------------
-#. **Added VPP performance tests**
+#. **VPP performance tests**
- - **MRR tests** : New MRR tests measure the packet forwarding rate
- under the maximum load offered by traffic generator over a set
- trial duration, regardless of packet loss. Maximum load for
- specified Ethernet frame size is set to the bi-directional link
- rate. MRR tests are used for continuous performance trending and
- for comparison between releases.
+ - *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.
- - **Service Chaining with SRv6** : SRv6 (Segment Routing IPv6) proxy tests
- verifying performance of Endpoint to SR-unaware appliance via
- masquerading (End.AM), dynamic proxy (End.AD) or static proxy (End.AS)
- functions.
+ - *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.
-#. **Presentation and Analytics Layer (PAL)**
+#. **Presentation and Analytics Layer**
- - Added continuous performance measuring, trending and anomaly
- detection. Includes new PAL code and Jenkins jobs for Performance
- Trending (PT) and Performance Analysis (PA) producing performance
- trending dashboard and trendline graphs with summary and drill-
- down views across all specified tests that can be reviewed and
- inspected regularly by FD.io developers and users community.
+ - *Performance trending* - Added continuous performance trending and
+ analysis. New Performance Trending and Performance Analysis jobs
+ executed regular throughput tests, with results being subsequently
+ analysed and trend and anomalies summarized and presented in VPP
+ Performance Dashboard and trendline graphs.
#. **Test Framework Optimizations**
- - **Performance tests efficiency** : Qemu build/install
- optimizations, warmup phase handling, vpp restart handling.
- Resulted in improved stability and reduced total execution time by
- 30% for single pkt size e.g. 64B/78B.
+ - *Performance tests efficiency* - Qemu build/install optimizations,
+ warmup phase handling, vpp restart handling. Resulted in improved
+ stability and reduced total execution time by 30% for single pkt
+ size e.g. 64B/78B.
- - **General code housekeeping** : ongoing RF keywords
- optimizations, removal of redundant RF keywords.
+ - *General code housekeeping* - ongoing RF keywords optimizations,
+ removal of redundant RF keywords.
Performance Changes
-------------------
@@ -51,33 +49,45 @@ 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.
-NDR Throughput Changes
-~~~~~~~~~~~~~~~~~~~~~~
+NDR Changes
+~~~~~~~~~~~
-NDR small packet throughput changes between releases are available in a CSV and
-pretty ASCII formats:
+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>`_.
-PDR Throughput Changes
-~~~~~~~~~~~~~~~~~~~~~~
+.. note::
-NDR small packet throughput changes between releases are available in a CSV and
-pretty ASCII formats:
+ 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/>`_.
+
+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>`_.
-MRR Throughput Changes
-~~~~~~~~~~~~~~~~~~~~~~
+.. 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/>`_.
+
+MRR Changes
+~~~~~~~~~~~
-MRR changes between releases are available in a CSV and
-pretty ASCII formats:
+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>`_,
@@ -86,35 +96,55 @@ pretty ASCII formats:
- `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>`_.
+.. note::
+
+ Test results have been generated by
+ `FD.io test executor vpp mrr jobs `_
+ with Robot Framework result files csit-vpp-perf-mrr-daily-master__*__output.xml.gz
+ `archived here `_.
+
+Throughput Trending
+-------------------
+
+In addition to reporting throughput changes between VPP releases, CSIT
+provides continuous performance trending for VPP master branch:
+
+#. `VPP Performance Dashboard `_
+ - per VPP test case throughput trend, trend compliance and summary of
+ detected anomalies.
+
+#. `Trending Methodology `_
+ - throughput test metrics, trend calculations and anomaly
+ classification (progression, regression, outlier).
+
+#. `Trendline Graphs `_
+ - per VPP build MRR throughput measurements against the trendline
+ with anomaly highlights, with associated CSIT test jobs.
+
Known Issues
------------
-
-
-Here is the 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 |
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+
-| 1 | Vic1385 and Vic1227 low performance. | VPP-664 | Low NDR performance. |
-| | | | |
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+
-| 2 | Sporadic (1 in 200) NDR discovery test failures | CSIT-570 | DPDK reporting rx-errors, indicating L1 issue. Suspected issue |
++===+=================================================+============+=================================================================+
+| 1 | Sporadic (1 in 200) NDR discovery test failures | CSIT-570 | DPDK reporting rx-errors, indicating L1 issue. Suspected issue |
| | on x520. | | with HW combination of X710-X520 in LF testbeds. Not observed |
| | | | outside of LF testbeds. |
+---+-------------------------------------------------+------------+-----------------------------------------------------------------+
-| 3 | Lower than expected NDR throughput with | CSIT-571 | Suspected NIC firmware or DPDK driver issue affecting NDR and |
-| | xl710 and x710 NICs, compared to x520 NICs. | | PDR throughput. Applies to XL710 and X710 NICs. |
+| 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. | | |
+---+-------------------------------------------------+------------+-----------------------------------------------------------------+
-| 4 | rls1801 plugin related performance regression | CSIT-925 | With all plugins loaded NDR, PDR and MaxRates vary |
-| | | | intermittently from 3% to 5% across multiple test executions. |
-| | | | Requires plugin code bisecting. |
+| 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. |
+---+-------------------------------------------------+------------+-----------------------------------------------------------------+
-| 5 | rls1801 generic small performance regression | CSIT-926 | Generic performance regression of discovered NDR, PDR and |
-| | ip4base, l2xcbase, l2bdbase | | MaxRates of -3%..-1% vs. rls1710, affects ip4base, l2xcbase, |
-| | | | l2bdbase test suites. Not detected by CSIT performance trending |
-| | | | scheme as it was masked out by another issue CSIT-925. |
+| 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. |
+---+-------------------------------------------------+------------+-----------------------------------------------------------------+
-| 6 | rls1801 substantial NDR/PDR regression for | CSIT-928 | NDR regression of -7%..-15%, PDR regression of -3%..-15% |
-| | IPSec tunnel scale with HW QAT crypto-dev | | compared to rls1710. |
+| 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. |
+---+-------------------------------------------------+------------+-----------------------------------------------------------------+