4898e85c72c7693aafb48d5c861236c2d632231b
[nfvbench.git] / docs / testing / user / userguide / sriov.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. SPDX-License-Identifier: CC-BY-4.0
3 .. (c) Cisco Systems, Inc
4
5
6 Testing SR-IOV
7 ==============
8
9 NFVbench supports SR-IOV with the PVP packet flow (PVVP is not supported). SR-IOV support is not applicable for external chains since the networks have to be setup externally (and can themselves be pre-set to use SR-IOV or not).
10
11 Pre-requisites
12 --------------
13 To test SR-IOV you need to have compute nodes configured to support one or more SR-IOV interfaces (also knows as PF or physical function) and you need OpenStack to be configured to support SR-IOV.
14 You will also need to know:
15 - the name of the physical networks associated to your SR-IOV interfaces (this is a configuration in Nova compute)
16 - the VLAN range that can be used on the switch ports that are wired to the SR-IOV ports. Such switch ports are normally configured in trunk mode with a range of VLAN ids enabled on that port
17
18 For example, in the case of 2 SR-IOV ports per compute node, 2 physical networks are generally configured in OpenStack with a distinct name.
19 The VLAN range to use is is also allocated and reserved by the network administrator and in coordination with the corresponding top of rack switch port configuration.
20
21
22 Configuration
23 -------------
24 To enable SR-IOV test, you will need to provide the following configuration options to NFVbench (in the configuration file).
25 This example instructs NFVbench to create the left and right networks of a PVP packet flow to run on 2 SRIOV ports named "phys_sriov0" and "phys_sriov1" using resp. segmentation_id 2000 and 2001:
26
27 .. code-block:: bash
28
29     internal_networks:
30        left:
31            segmentation_id: 2000
32            physical_network: phys_sriov0
33        right:
34            segmentation_id: 2001
35            physical_network: phys_sriov1
36
37 The segmentation ID fields must be different.
38 In the case of PVVP, the middle network also needs to be provisioned properly.
39 The same physical network can also be shared by the virtual networks but with different segmentation IDs.
40
41
42 NIC NUMA socket placement and flavors
43 -------------------------------------
44 If the 2 selected ports reside on NICs that are on different NUMA sockets, you will need to explicitly tell Nova to use 2 numa nodes in the flavor used for the VMs in order to satisfy the filters, for example:
45
46 .. code-block:: bash
47
48     flavor:
49       # Number of vCPUs for the flavor
50       vcpus: 2
51       # Memory for the flavor in MB
52       ram: 8192
53       # Size of local disk in GB
54       disk: 0
55       extra_specs:
56           "hw:cpu_policy": dedicated
57           "hw:mem_page_size": large
58           "hw:numa_nodes": 2
59
60 Failure to do so might cause the VM creation to fail with the Nova error
61 "Instance creation error: Insufficient compute resources:
62 Requested instance NUMA topology together with requested PCI devices cannot fit the given host NUMA topology."
63