Methodology: Update MLRsearch descriptions

[csit.git] / docs / report / introduction / methodology_data_plane_throughput / methodology_data_plane_throughput.rst

diff --git a/docs/report/introduction/methodology_data_plane_throughput/methodology_data_plane_throughput.rst b/docs/report/introduction/methodology_data_plane_throughput/methodology_data_plane_throughput.rst
index 762a7c2..4af9db6 100644 (file)
--- a/docs/report/introduction/methodology_data_plane_throughput/methodology_data_plane_throughput.rst
+++ b/docs/report/introduction/methodology_data_plane_throughput/methodology_data_plane_throughput.rst
@@ -1,3 +1,5 @@
+.. _data_plane_throughput:
+

 Data Plane Throughput Tests
 ---------------------------
 
 Data Plane Throughput Tests
 ---------------------------
 


@@ -11,6 +13,9 @@ Following throughput test methods are used:
 - MRR - Maximum Receive Rate
 - PLRsearch - Probabilistic Loss Ratio search
 
 - MRR - Maximum Receive Rate
 - PLRsearch - Probabilistic Loss Ratio search
 

+..
+    TODO: Add RECONF.
+

 Description of each test method is followed by generic test properties
 shared by all methods.
 
 Description of each test method is followed by generic test properties
 shared by all methods.
 


@@ -22,10 +27,10 @@ Description
 
 Multiple Loss Ratio search (MLRsearch) tests discover multiple packet
 throughput rates in a single search, reducing the overall test execution
 
 Multiple Loss Ratio search (MLRsearch) tests discover multiple packet
 throughput rates in a single search, reducing the overall test execution

-time compared to a binary search. Each rate associated with a distinct
-Packet Loss Ratio (PLR) criteria. In FD.io CSIT two throughput rates are
-discovered: Non-Drop Rate (NDR, with zero packet loss, PLR=0) and
-Partial Drop Rate (PDR, with PLR<0.5%). MLRsearch is compliant with
+time compared to a binary search. Each rate is associated with a
+distinct Packet Loss Ratio (PLR) criteria. In FD.io CSIT two throughput
+rates are discovered: Non-Drop Rate (NDR, with zero packet loss, PLR=0)
+and Partial Drop Rate (PDR, with PLR<0.5%). MLRsearch is compliant with

 :rfc:`2544`.
 
 Usage
 :rfc:`2544`.
 
 Usage


@@ -47,8 +52,8 @@ Details
 ~~~~~~~
 
 See :ref:`mlrsearch_algorithm` section for more detail. MLRsearch is
 ~~~~~~~
 
 See :ref:`mlrsearch_algorithm` section for more detail. MLRsearch is

-being standardized in IETF in `draft-vpolak-mkonstan-mlrsearch
-<https://tools.ietf.org/html/draft-vpolak-mkonstan-bmwg-mlrsearch>`_.
+being standardized in IETF in `draft-ietf-bmwg-mlrsearch
+<https://datatracker.ietf.org/doc/html/draft-ietf-bmwg-mlrsearch-01>`_.

 
 MRR Tests
 ^^^^^^^^^
 
 MRR Tests
 ^^^^^^^^^


@@ -65,6 +70,9 @@ offered by traffic generator (dependent on link type and NIC model) over
 a set trial duration, regardless of packet loss. Maximum load for
 specified Ethernet frame size is set to the bi-directional link rate.
 
 a set trial duration, regardless of packet loss. Maximum load for
 specified Ethernet frame size is set to the bi-directional link rate.
 

+Usage
+~~~~~
+

 MRR tests are much faster than MLRsearch as they rely on a single trial
 or a small set of trials with very short duration. It is this property
 that makes them suitable for continuous execution in daily performance
 MRR tests are much faster than MLRsearch as they rely on a single trial
 or a small set of trials with very short duration. It is this property
 that makes them suitable for continuous execution in daily performance


@@ -72,7 +80,7 @@ trending jobs enabling detection of performance anomalies (regressions,
 progressions) resulting from data plane code changes.
 
 MRR tests are also used for VPP per patch performance jobs verifying
 progressions) resulting from data plane code changes.
 
 MRR tests are also used for VPP per patch performance jobs verifying

-patch performance vs. parent. CSIT reports include MRR throughput
+patch performance vs parent. CSIT reports include MRR throughput

 comparisons between releases and test environments. Small frame sizes
 only (64b/78B, IMIX).
 
 comparisons between releases and test environments. Small frame sizes
 only (64b/78B, IMIX).
 


@@ -108,13 +116,13 @@ PLRsearch are run to discover a sustained throughput for PLR=10^-7
 frame sizes (64b/78B) are presented in packet throughput graphs (Box
 Plots) for a small subset of baseline tests.
 
 frame sizes (64b/78B) are presented in packet throughput graphs (Box
 Plots) for a small subset of baseline tests.
 

-Each soak test lasts 2hrs and is executed at least twice. Results are
+Each soak test lasts 30 minutes and is executed at least twice. Results are

 compared against NDR and PDR rates discovered with MLRsearch.
 
 Details
 ~~~~~~~
 
 compared against NDR and PDR rates discovered with MLRsearch.
 
 Details
 ~~~~~~~
 

-See :ref:`plrsearch_algorithm` section for more detail. PLRsearch is
+See :ref:`plrsearch` methodology section for more detail. PLRsearch is

 being standardized in IETF in `draft-vpolak-bmwg-plrsearch
 <https://tools.ietf.org/html/draft-vpolak-bmwg-plrsearch>`_.
 
 being standardized in IETF in `draft-vpolak-bmwg-plrsearch
 <https://tools.ietf.org/html/draft-vpolak-bmwg-plrsearch>`_.