Improve hoststack methodology pages
[csit.git] / docs / report / introduction / methodology_hoststack_testing / methodology_tcp_with_iperf3.rst
index 1355a3c..e0d3e24 100644 (file)
@@ -1,5 +1,5 @@
-Hoststack Throughput Testing over TCP/IP with iperf3
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+TCP/IP with iperf3
+^^^^^^^^^^^^^^^^^^
 
 `iperf3 goodput measurement tool <https://github.com/esnet/iperf>`_
 is used for measuring the maximum attainable goodput of the VPP Host
@@ -26,18 +26,23 @@ The test configuration is as follows:
 
 where,
 
- 1. iperf3 server attaches to VPP2 and LISTENs on VPP2:TCP port 5201.
- 2. iperf3 client attaches to VPP1 and opens one or more stream
-    connections to VPP2:TCP port 5201.
- 3. iperf3 client transmits a uni-directional stream as fast as the
-    VPP Host Stack allows to the iperf3 server for the test duration.
- 4. At the end of the test the iperf3 client emits the goodput
-    measurements for all streams and the sum of all streams.
-
- Test cases include 1 and 10 Streams with a 20 second test duration
- with the VPP Host Stack configured to utilize the Cubic TCP
- congestion algorithm.
-
- Note: iperf3 is single threaded, so it is expected that the 10 stream
- test does not show any performance improvement due to
- multi-thread/multi-core execution.
+1. iperf3 server attaches to VPP2 and LISTENs on VPP2:TCP port 5201.
+2. iperf3 client attaches to VPP1 and opens one or more stream
+   connections to VPP2:TCP port 5201.
+3. iperf3 client transmits a uni-directional stream as fast as the
+   VPP Host Stack allows to the iperf3 server for the test duration.
+4. At the end of the test the iperf3 client emits the goodput
+   measurements for all streams and the sum of all streams.
+
+Test cases include 1 and 10 Streams with a 20 second test duration
+with the VPP Host Stack configured to utilize the Cubic TCP
+congestion algorithm.
+
+Note: iperf3 is single threaded, so it is expected that the 10 stream
+test does not show any performance improvement due to
+multi-thread/multi-core execution.
+
+There are also variations of these test cases which use the VPP Network
+Simulator (NSIM) plugin to test the VPP Hoststack goodput with 1 percent
+of the traffic being dropped at the output interface of VPP1 thereby
+simulating a lossy network.