2 # NFVbench default configuration file
4 # This configuration file is ALWAYS loaded by NFVbench and should never be modified by users.
5 # To specify your own property values, always define them in a separate config file
6 # and pass that file to the script using -c or --config <file>
7 # Property values in that config file will override the default values in the current file
10 # IMPORTANT CUSTOMIZATION NOTES
11 # There are roughly 2 types of NFVbench config based on the OpenStack encaps used:
12 # - VLAN (OVS, OVS-DPDK, ML2/VPP)
13 # Many of the fields to customize are relevant to only 1 of the 2 encaps
14 # These will be clearly labeled "VxLAN only" or "VLAN only"
15 # Fields that are not applicable will not be used by NFVbench and can be left empty
17 # All fields are applicable to all encaps/traffic generators unless explicitly marked otherwise.
18 # Fields that can be over-ridden at the command line are marked with the corresponding
19 # option, e.g. "--interval"
22 # The OpenStack openrc file to use - must be a valid full pathname. If running
23 # in a container, this path must be valid in the container.
25 # The only case where this field can be empty is when measuring a system that does not run
26 # OpenStack or when OpenStack APIs are not accessible or OpenStack APis use is not
27 # desirable. In that case the EXT service chain must be used.
30 # Forwarder to use in nfvbenchvm image. Available options: ['vpp', 'testpmd']
33 # By default (empty) NFVbench will try to locate a VM image file
34 # from the package root directory named "nfvbench-<version>.qcow2" and
35 # upload that file. The image name will be "nfvbench-<version>"
36 # This can be overridden by specifying here a pathname of a file
37 # that follows the same naming convention.
38 # In most cases, this field should be left empty as the packaging should
39 # include the proper VM image file
42 # Name of the flavor to use for the loopback VMs
44 # If the provided name is an exact match to a flavor name known by OpenStack
45 # (as shown from 'nova flavor-list'), that flavor will be reused.
46 # Otherwise, a new flavor will be created with attributes listed below.
47 flavor_type: 'nfvbench.medium'
49 # Custom flavor attributes
51 # Number of vCPUs for the flavor
53 # Memory for the flavor in MB
55 # Size of local disk in GB
57 # metadata are supported and can be added if needed, optional
58 # note that if your openstack does not have NUMA optimization
59 # (cpu pinning and huge pages)
60 # you must comment out extra_specs completely otherwise
61 # loopback VM creation will fail
63 "hw:cpu_policy": dedicated
64 "hw:mem_page_size": large
66 # Name of the availability zone to use for the test VMs
67 # Must be one of the zones listed by 'nova availability-zone-list'
68 # availability_zone: 'nova'
70 # To force placement on a given hypervisor, set the name here
71 # (if multiple names are provided, the first will be used)
72 # Leave empty to let openstack pick the hypervisor
75 # Type of service chain to run, possible options are PVP, PVVP and EXT
76 # PVP - port to VM to port
77 # PVVP - port to VM to VM to port
78 # EXT - external chain used only for running traffic and checking traffic generator counters,
79 # all other parts of chain must be configured manually
80 # Can be overriden by --service-chain
83 # Total number of service chains, every chain has own traffic stream
84 # Can be overriden by --service-chain-count
85 service_chain_count: 1
87 # Specifies if all chains share the same right/left/middle networks
88 service_chain_shared_net: false
90 # Total number of traffic flows for all chains and directions generated by the traffic generator.
91 # Minimum is '2 * service_chain_count', it is automatically adjusted if too small
92 # value was configured. Must be even.
93 # Every flow has packets with different IPs in headers
94 # Can be overriden by --flow-count
97 # set to true if service chains should use SRIOV
98 # This requires SRIOV to be available on compute nodes
101 # Perform port to port loopback (direct or through switch)
102 # Should be used with EXT service chain and no ARP (no_arp: true)
103 # When enabled, the vlans property must contain the same VLAN id for all chains.
104 # Can be overriden by --l2-loopback
107 # Resources created by NFVbench will not be removed
108 # Can be overriden by --no-cleanup
111 # Configuration for traffic generator
113 # Name of the traffic generator, only for informational purposes
114 host_name: 'nfvbench_tg'
115 # this is the default traffic generator profile to use
116 # the name must be defined under generator_profile
117 # you can override the traffic generator to use using the
118 # -g or --traffic-gen option at the command line
119 default_profile: trex-local
121 # IP addresses for L3 traffic.
122 # This section describes the addresses to use to fill in the UDP packets sent by the
123 # traffic generator. If you VNFs are L2 forwarders, these fields below do not need to change.
124 # If your VNFs are L3 routers, the fields below must match the static routes in your VNFs
125 # so that UDP packets can be routed back to the peer port of the traffic generator.
127 # All of the IPs are used as base for IP sequence computed based on chain or flow count.
128 # (sim-devices-left)---(tg-gateway-left)---(vnf-left)- ...
129 # -(vnf-right)---(tg-gateway-right)---(sim-devices-right)
131 # `ip_addrs` base IPs used as src and dst in packet header, quantity depends on flow count
132 # these are used for addressing virtual devices simulated by the traffic generator
133 # and be a different subnet than tg_gateway_ip_addrs and gateway_ip_addrs
134 # `ip_addrs_step`: step for generating IP sequence. Use "random" for random patterns, default is 0.0.0.1.
135 ip_addrs: ['10.0.0.0/8', '20.0.0.0/8']
136 ip_addrs_step: 0.0.0.1
137 # `tg_gateway_ip_addrs` base IP for traffic generator ports in the left and right networks to the VNFs
138 # chain count consecutive IP addresses spaced by tg_gateway_ip_addrs_step will be used
139 # `tg_gateway_ip_addrs__step`: step for generating traffic generator gateway sequences. default is 0.0.0.1
140 tg_gateway_ip_addrs: ['1.1.0.100', '2.2.0.100']
141 tg_gateway_ip_addrs_step: 0.0.0.1
142 # `gateway_ip_addrs`: base IPs of VNF router gateways (left and right), quantity used depends on chain count
143 # must correspond to the public IP on the left and right networks
144 # for each left-most and right-most VNF of every chain.
145 # must be the same subnet but not same IP as tg_gateway_ip_addrs.
146 # chain count consecutive IP addresses spaced by gateway_ip_addrs_step will be used
147 # `gateway_ip_addrs_step`: step for generating router gateway sequences. default is 0.0.0.1
148 gateway_ip_addrs: ['1.1.0.2', '2.2.0.2']
149 gateway_ip_addrs_step: 0.0.0.1
150 # `udp_src_port`: the source port for sending UDP traffic, default is picked by TRex (53)
151 # `udp_dst_port`: the destination port for sending UDP traffic, default is picked by TRex (53)
155 # VxLAN only: optionally specify what VLAN tag to use for the VxLAN overlay
156 # This is used if the vxlan tunnels are running on a specific VLAN.
157 # Leave empty if there is no VLAN tagging required, or specify the VLAN id to use
158 # for all VxLAN tunneled traffic
160 # VxLAN only: VNI range for VXLAN encapsulation [start_vni, end_vni] [5000, 6000]
161 # VNI can have a value from range 5000-16777216
162 # For PVP, VNIs are allocated consecutively - 2 per each chain
163 # Chain 1: 5000, 5001; Chain 2: 5002, 5003; Chain X: 5000+x, 5000+x+1
164 # For PVVP scenario VNIs allocated consecutively - 3 per each chain
165 # Chain 1: 5000, 5001, 5002; Chain 2: 5003, 5004, 5005; Chain X: 5000+x, 5000+x+1, 5000+x+1
167 # VxLAN only: local/source vteps IP addresses for port 0 and 1 ['10.1.1.230', '10.1.1.231']
169 # VxLAN only: remote IP address of the remote VTEPs that terminate all tunnels originating from local VTEPs
172 # L2 ADDRESSING OF UDP PACKETS
173 # Lists of dest MAC addresses to use on each traffic generator port (one dest MAC per chain)
174 # Leave empty for PVP, PVVP, EXT with ARP
175 # Only used when `service_chain` is EXT and `no_arp` is true.
176 # - If both lists are empty the far end MAC of the traffic generator will be used for left and right
177 # (this is typicaly used to loop back on the first hop switch or using a loopback cable)
178 # - The length of each list must match the number of chains being used!
179 # - The index of each list must correspond to the chain index to ensure proper pairing.
180 # - Below is an example of using two chains:
181 # - mac_addrs_left: ['00:00:00:00:01:00', '00:00:00:00:02:00']
182 # - mac_addrs_right: ['00:00:00:00:01:01', '00:00:00:00:02:01']
183 # UDP packets sent on port 0 will use dest MAC '00:00:00:00:01:00' for chain #0 and
184 # dest MAC '00:00:00:00:02:00' for chain #1
185 # UDP packets sent on port 1 will use dest MAC '00:00:00:00:01:01' for chain #0 and
186 # dest MAC '00:00:00:00:02:01' for chain #1
187 # It is expected that the looping device (L2 forwarder) will rewrite the src and dst MAC
188 # of the looping UDP packet so that it can reach back to the peer port of the traffic
194 # Traffic Generator Profiles
195 # In case you have multiple testbeds or traffic generators,
196 # you can define one traffic generator profile per testbed/traffic generator.
197 # In most cases you only need to fill in the pci address for the 2 ports used by the
198 # traffic generator and leave all other fields unchanged
200 # Generator profiles are listed in the following format:
201 # `name`: Traffic generator profile name (use a unique name, no space or special character)
202 # DFo not change this field
203 # `tool`: Traffic generator tool to be used (currently supported is `TRex`).
204 # Do not change this field
205 # `ip`: IP address of the traffic generator.
206 # The default loopback address is used when the traffic generator runs on the same host
208 # `cores`: Specify the number of cores for running the TRex traffic generator.
209 # ONLY applies to trex-local.
210 # `software_mode`: Advice TRex to use software mode which provides the best compability. But
211 # note that TRex will not use any hardware acceleration technology under
212 # software mode, therefore the performance of TRex will be significantly
213 # lower. ONLY applies to trex-local.
214 # Recommended to leave the default value (false)
215 # `interfaces`: Configuration of traffic generator interfaces.
216 # `interfaces.port`: The port of the traffic generator to be used (leave as 0 and 1 resp.)
217 # `interfaces.switch_port`: Leave empty (deprecated)
218 # `interfaces.pci`: The PCI address of the intel NIC interface associated to this port
219 # This field is required and cannot be empty
220 # Use lspci to list the PCI address of all devices
221 # Example of value: "0000:5e:00.0"
222 # `intf_speed`: The speed of the interfaces used by the traffic generator (per direction).
223 # Empty value (default) to use the speed discovered by the traffic generator.
224 # Recommended to leave this field empty.
225 # Do not use unless you want to override the speed discovered by the
226 # traffic generator. Expected format: 10Gbps
243 # Simpler override for trex core count and mbuf multilier factor
244 # if empty defaults to the one specified in generator_profile.cores
247 # mbuffer ratio to use for TRex (see TRex documentation for more details)
250 # -----------------------------------------------------------------------------
251 # These variables are not likely to be changed
253 # Number of seconds to wait for VMs to pass traffic in both directions
254 check_traffic_time_sec: 200
256 # General retry count
257 generic_retry_count: 100
259 # General poll period
262 # name of the loop VM
263 loop_vm_name: 'nfvbench-loop-vm'
265 # Default names, subnets and CIDRs for PVP/PVVP networks
266 # If a network with given name already exists it will be reused.
267 # - PVP only uses left and right
268 # - PVVP uses left, middle and right
269 # - for EXT chains, this structure is not relevant - refer to external_networks
270 # Otherwise a new internal network will be created with that name, subnet and CIDR.
272 # segmentation_id can be set to enforce a specific VLAN id - by default (empty) the VLAN id
273 # will be assigned by Neutron.
274 # Must be unique for each network
275 # physical_network can be set to pick a specific phsyical network - by default (empty) the
276 # default physical network will be picked
277 # In the case of SR-IOV, both physical_network and segmentation ID must be provided
278 # For example to setup PVP using 2 different SR-IOV ports, you must put the appropriate physnet
279 # names under left.physical_network and right.physical_network.
280 # For multi-chaining and non shared networks,
281 # Example of override configuration to force PVP to run on 2 SRIOV ports (phys_sriov0 and phys_sriov1)
282 # using VLAN ID 2000 and 2001:
285 # segmentation_id: 2000
286 # physical_network: phys_sriov0
288 # segmentation_id: 2001
289 # physical_network: phys_sriov1
290 # For multi-chaining and non shared network mode:
292 # - the segmentation_id field if provided must be a list of values (as many as chains)
293 # - the physical_network can be a single name (all VFs to be allocated on same physnet)
294 # of a list of physnet names to use different PFs
298 name: 'nfvbench-lnet'
299 subnet: 'nfvbench-lsubnet'
300 cidr: '192.168.1.0/24'
305 name: 'nfvbench-rnet'
306 subnet: 'nfvbench-rsubnet'
307 cidr: '192.168.2.0/24'
312 name: 'nfvbench-mnet'
313 subnet: 'nfvbench-msubnet'
314 cidr: '192.168.3.0/24'
319 # In the scenario of PVVP + SRIOV, there is choice of how the traffic will be
320 # handled in the middle network. The default (false) will use vswitch, while
321 # SRIOV can be used by toggling below setting.
322 use_sriov_middle_net: false
324 # EXT chain only. Prefix names of edge networks which will be used to send traffic via traffic generator.
326 # If service_chain_shared_net is true, the left and right networks must pre-exist and match exactly by name.
328 # If service_chain_shared_net is false, each chain must have its own pre-existing left and right networks.
329 # An index will be appended to each network name to form the final name:
330 # ext-lnet0 ext-rnet0 for chain #0
331 # ext-lnet1 ext-rnet1 for chain #1
337 # Use 'true' to enable VXLAN encapsulation support and sent by the traffic generator
338 # When this option enabled internal networks 'network type' parameter value should be 'vxlan'
341 # Use 'true' to enable VLAN tagging of packets generated and sent by the traffic generator
342 # Leave empty or set to false if you do not want the traffic generator to insert the VLAN tag (this is
343 # needed for example if VLAN tagging is enabled on switch (access mode) or if you want to hook
344 # directly to a NIC).
345 # By default is set to true (which is the nominal use case with TOR and trunk mode to Trex ports)
346 # If VxLAN is enabled, this option should be set to false (vlan tagging for encapsulated packets
347 # is not supported). Use the vtep_vlan option to enable vlan tagging for the VxLAN overlay network.
350 # Used only in the case of EXT chain and no openstack to specify the VLAN IDs to use.
351 # This property is ignored when OpenStakc is used or in the case of l2-loopback.
352 # If OpenStack is used leave the list empty, VLAN IDs are retrieved from OpenStack networks using Neutron API.
353 # If networks are shared across all chains (service_chain_shared_net=true), the list should have exactly 2 values
354 # If networks are not shared across chains (service_chain_shared_net=false), the list should have
356 # In the special case of l2-loopback the list should have the same VLAN id for all chains
358 # [1998, 1999] left network uses vlan 1998 right network uses vlan 1999
359 # [[1,2],[3,4]] chain 0 left vlan 1, right vlan 2 - chain 1 left vlan 3 right vlan 4
360 # [1010, 1010] same VLAN id with l2-loopback enabled
364 # ARP is used to discover the MAC address of VNFs that run L3 routing.
365 # Used only with EXT chain.
366 # False (default): ARP requests are sent to find out dest MAC addresses.
367 # True: do not send ARP but use provisioned dest macs instead
368 # (see mac_addrs_left and mac_addrs_right)
372 # You can add here more profiles as needed
373 # `l2frame_size` can be specified in any none zero integer value to represent the size in bytes
374 # of the L2 frame, or "IMIX" to represent the standard 3-packet size mixed sequence (IMIX1).
376 - name: traffic_profile_64B
378 - name: traffic_profile_IMIX
379 l2frame_size: ['IMIX']
380 - name: traffic_profile_1518B
381 l2frame_size: ['1518']
382 - name: traffic_profile_3sizes
383 l2frame_size: ['64', 'IMIX', '1518']
385 # Traffic Configuration
386 # bidirectional: to have traffic generated from both direction, set bidirectional to true
387 # profile: must be one of the profiles defined in traffic_profile
388 # The traffic profile can be overriden with the options --frame-size and --uni-dir
391 profile: traffic_profile_64B
393 # Check config and connectivity only - do not generate traffic
394 # Can be overriden by --no-traffic
399 # The rate pps for traffic going in reverse direction in case of unidirectional flow. Default to 1.
400 unidir_reverse_traffic_pps: 1
402 # The rate specifies if NFVbench should determine the NDR/PDR
403 # or if NFVbench should just generate traffic at a given fixed rate
404 # for a given duration (called "single run" mode)
405 # Supported rate format:
406 # NDR/PDR test: `ndr`, `pdr`, `ndr_pdr` (default)
407 # Or for single run mode:
408 # Packet per second: pps (e.g. `50pps`)
409 # Bits per second: bps, kbps, Mbps, etc (e.g. `1Gbps`, `1000bps`)
410 # Load percentage: % (e.g. `50%`)
411 # Can be overridden by --rate
414 # Default run duration (single run at given rate only)
415 # Can be overridden by --duration
418 # Interval between intermediate reports when interval reporting is enabled
419 # Can be overridden by --interval
422 # Default pause between iterations of a binary search (NDR/PDR)
425 # NDR / PDR configuration
427 # Drop rates represent the ratio of dropped packet to the total number of packets sent.
428 # Values provided here are percentages. A value of 0.01 means that at most 0.01% of all
429 # packets sent are dropped (or 1 packet every 10,000 packets sent)
431 # No Drop Rate in percentage; Default to 0.001%
433 # Partial Drop Rate in percentage; NDR should always be less than PDR
435 # The accuracy of NDR and PDR as a percnetage of line rate; The exact NDR
436 # or PDR should be within `load_epsilon` line rate % from the one calculated.
437 # For example, with a value 0.1, and a line rate of 10Gbps, the accuracy
438 # of NDR and PDR will be within 0.1% Of 10Gbps or 10Mbps.
439 # The lower the value the more iterations and the longer it will take to find the NDR/PDR.
440 # In practice, due to the precision of the traffic generator it is not recommended to
441 # set it to lower than 0.1
444 # Location where to store results in a JSON format. Must be container specific path.
445 # Can be overriden by --json
448 # Location where to store results in the NFVbench standard JSON format:
449 # <service-chain-type>-<service-chain-count>-<flow-count>-<packet-sizes>.json
450 # Example: PVP-1-10-64-IMIX.json
451 # Must be container specific path.
452 # Can be overriden by --std-json
455 # Prints debug messages (verbose mode)
456 # Can be overriden by --debug
459 # Set to a valid path name if logging to file is to be enabled
460 # Defaults to disabled
463 # When enabled, all results and/or logs will be sent to a fluentd servers at the requested IPs and ports
464 # A list of one or more fluentd servers identified by their IPs and port numbers should be given.
465 # For each recipient it is possible to enable both sending logs and performance
466 # results, or enable either logs or performance results. For enabling logs or results logging_tag or
467 # result_tag should be set.
470 # by default (logging_tag is empty) nfvbench log messages are not sent to fluentd
471 # to enable logging to fluents, specify a valid fluentd tag name to be used for the
475 # by default (result_tag is empty) nfvbench results are not sent to fluentd
476 # to enable sending nfvbench results to fluentd, specify a valid fluentd tag name
477 # to be used for the results records, which is different than logging_tag
480 # IP address of the server, defaults to loopback
483 # port # to use, by default, use the default fluentd forward port
486 # by default (logging_tag is empty) nfvbench log messages are not sent to fluentd
487 # to enable logging to fluents, specify a valid fluentd tag name to be used for the
490 # Module and class name of factory which will be used to provide classes dynamically for other components.
491 factory_module: 'nfvbench.factory'
492 factory_class: 'BasicFactory'
494 # Custom label added for every perf record generated during this run.
495 # Can be overriden by --user-label
499 # THESE FIELDS SHOULD BE USED VERY RARELY
501 # Skip vswitch configuration and retrieving of stats
502 # Can be overriden by --no-vswitch-access
503 # Should be left to the default value (false)
504 no_vswitch_access: false