Update doc/faq and config comments

[nfvbench.git] / nfvbench / cfg.default.yaml

diff --git a/nfvbench/cfg.default.yaml b/nfvbench/cfg.default.yaml
index 8766d53..ed6ead8 100644 (file)
--- a/nfvbench/cfg.default.yaml
+++ b/nfvbench/cfg.default.yaml
@@ -260,9 +260,10 @@ external_networks:
     left: 'nfvbench-net0'
     right: 'nfvbench-net1'
 
-# Use 'true' to enable VLAN tagging of packets coming from traffic generator
-# Leave empty if VLAN tagging is enabled on switch or if you want to hook directly to a NIC
-# Else by default is set to true (which is the nominal use case with TOR and trunk mode to Trex)
+# Use 'true' to enable VLAN tagging of packets generated and sent by the traffic generator
+# Leave empty you do not want the traffic generator to insert the VLAN tag. This is 
+# needed for example if VLAN tagging is enabled on switch (trunk mode) or if you want to hook directly to a NIC
+# By default is set to true (which is the nominal use case with TOR and trunk mode to Trex)
 vlan_tagging: true
 
 # Specify only when you want to override VLAN IDs used for tagging with own values (exactly 2).
@@ -330,7 +331,7 @@ duration_sec: 60
 # Can be overridden by --interval
 interval_sec: 10
 
-# NDR / PDR configuration ZZ
+# NDR / PDR configuration
 measurement:
     # Drop rates represent the ratio of dropped packet to the total number of packets sent.
     # Values provided here are percentages. A value of 0.01 means that at most 0.01% of all
@@ -340,8 +341,13 @@ measurement:
     NDR: 0.001
     # Partial Drop Rate in percentage; NDR should always be less than PDR
     PDR: 0.1
-    # The accuracy of NDR and PDR load percentiles; The actual load percentile that match NDR
-    # or PDR should be within `load_epsilon` difference than the one calculated.
+    # The accuracy of NDR and PDR as a percnetage of line rate; The exact NDR
+    # or PDR should be within `load_epsilon` line rate % from the one calculated.
+    # For example, with a value 0.1, and a line rate of 10Gbps, the accuracy
+    # of NDR and PDR will be within 0.1% Of 10Gbps or 10Mbps.
+    # The lower the value the more iterations and the longer it will take to find the NDR/PDR.
+    # In practice, due to the precision of the traffic generator it is not recommended to
+    # set it to lower than 0.1
     load_epsilon: 0.1
 
 # Location where to store results in a JSON format. Must be container specific path.