Cleanup requirements & tox config, update pylint

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

diff --git a/nfvbench/cfg.default.yaml b/nfvbench/cfg.default.yaml
index 4491097..c76e738 100644 (file)
--- a/nfvbench/cfg.default.yaml
+++ b/nfvbench/cfg.default.yaml
@@ -30,8 +30,25 @@
 # - availability_zone
 # - hypervisor_hostname
 # - vlans
+# WARNING: Not used if clouds_detail is sets
 openrc_file:
 
+# The OpenStack clouds configuration from clouds.yaml file to use.
+# clouds.yaml file must be in one of the following paths:
+# - ~/.config/openstack
+# - /etc/openstack
+# Note: If running in a container, this path must be valid in the container.
+# The only case where this field can be empty is when measuring a system that does not run
+# OpenStack or when OpenStack APIs are not accessible or OpenStack APis use is not
+# desirable. In that case the EXT service chain must be used.
+#
+# If user is not admin some parameters are mandatory and must be filled with valid values in config file such as :
+# - availability_zone
+# - hypervisor_hostname
+# - vlans
+# If a value is sets, this parameter disable the use of openrc file
+clouds_detail:
+
 # Forwarder to use in nfvbenchvm image. Available options: ['vpp', 'testpmd']
 vm_forwarder: testpmd
 
@@ -367,6 +384,19 @@ cache_size: 0
 # The cache size is actually limited by the number of 64B mbufs configured in the trex platform configuration (see Trex manual 6.2.2. Memory section configuration)
 # Note that the resulting value is finally capped to 10000, whatever the requested size is (by design limitation).
 
+# Specification of the TRex behaviour dealing with the i40e network card driver issue: Trex-528
+#   see https://trex-tgn.cisco.com/youtrack/issue/trex-528
+#       This issue states that if other ports, in the same card,
+#       are in kernel mode, they could impair traffic counting.      
+# Can be overridden by --i40e-mixed
+# Values can be:
+#  ignore - don't consider the case (default)
+#  exit   - should the case arise, exit (TRex default behaviour)
+#  unbind - unbind kernel bound ports (the former NFVbench behaviour)
+# The 'ignore' option might be OK as soon as the issue has been fixed in the driver.
+# The 'unbind' option should not be used! who knows the current use of other ports?
+i40e_mixed:
+
 # Trex will use 1 x 64B mbuf per pre-built cached packet, assuming 1 pre-built cached packet per flow, it means for very large number of flows, the number of configured mbuf_64 will need to be set accordingly.
 mbuf_64:
 
@@ -738,6 +768,14 @@ no_traffic: false
 # Can be overriden by --l3-router
 l3_router: false
 
+# If l3_router is true and depending on ARP stale time SUT configuration
+# Gratuitous ARP (GARP) from TG port to the router is needed to keep traffic up
+# Default value: 1 packet per second
+# This value needs to be defined inferior to SUT ARP stale time to avoid GARP packets drop
+# in case of high load traffic
+periodic_gratuitous_arp: false
+gratuitous_arp_pps: 1
+
 # Test configuration
 
 # The rate pps for traffic going in reverse direction in case of unidirectional flow. Default to 1.