More updates to docs for Euphrates
[apex.git] / docs / release / scenarios / os-nosdn-ovs_dpdk-ha / os-nosdn-ovs_dpdk-ha.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. (c) <optionally add copywriters name>
4
5 This document provides scenario level details for Euphrates 1.0 of
6 deployment with no SDN controller and DPDK enabled Open vSwitch.
7
8 Introduction
9 ============
10
11 NFV and virtualized high performance applications, such as video processing,
12 require Open vSwitch to be accelerated with a fast data plane solution that
13 provides both carrier grade forwarding performance, scalability and open
14 extensibility.
15
16 A key component of any NFV solution is the virtual forwarder, which should
17 consist of soft switch that includes an accelerated data plane component. For
18 this, any virtual switch should make use of hardware accelerators and optimized
19 cache operation to be run in user space.
20
21 Scenario components and composition
22 ===================================
23
24 This scenario enables high performance data plan acceleration by utilizing
25 DPDK enabled Open vSwitch (OVS).  This allows packet switching to be isolated
26 to particular hardware resources (CPUs, huge page memory allocation) without
27 kernel interrupt or context switching on the data plane CPU.
28
29 Tenant networking leverages Open vSwitch accelerated with a fast user space
30 data path such.  OVS with the Linux kernel module data path is used for all
31 other connectivity, such as connectivity to the external network (i.e. br-ex)
32 is performed via non-accelerated OVS.
33
34 Scenario Configuration
35 ======================
36
37 Due to the performance optimization done by this scenario, it is recommended to
38 set some performance settings in the deploy settings in order to ensure maximum
39 performance.  This is not necessary unless doing a baremetal deployment.  Note,
40 this scenario requires taking the NIC mapped to the tenant network on the
41 compute node and binding it to DPDK.  This means it will no longer be
42 accessible via the kernel.  Ensure the NIC that is mapped to the Compute
43 Tenant network supports DPDK.
44
45 Make a copy of the deploy settings file, os-nosdn-ovs_dpdk-ha.yaml.  Under the
46 kernel options for Compute, edit as follows:
47  - hugepagesz: the size of hugepages as an integer, followed by unit M
48    (megabyte) or G (gigabyte).
49  - hugepages: number of hugepages of hugepagesz size.  Huge page memory will be
50    used for OVS as well as each nova instance spawned.  It is a good idea to
51    allocate the maximum number possible, while still leaving some non-huge page
52    memory available to other processes (nova-compute, etc).
53  - isolcpus: comma-separated list of CPUs to isolate from the kernel.  Isolated
54    CPUs will be used for pinning OVS and libvirtd to.
55
56 Under the performance->Compute->ovs section, edit as follows:
57  - socket_memory: the amount of huge page memory in MB to allocate to allocate
58    per socket to OVS as a comma-separated list.  It is best to allocate the
59    memory to the socket which is closest to the PCI-Express bus of the NIC
60    to be used with OVS DPDK for tenant traffic.
61  - pmd_cores: comma-separated list of cores to pin to the poll-mode driver in
62    OVS.  OVS DPDK will spawn TX/RX PMD threads to handle forwarding packets.
63    This setting identifies which cores to pin these threads to.  For best
64    performance, dedicate at least 2 isolated cores on the same NUMA node where
65    socket_memory was assigned.
66  - dpdk_cores: comma-separated list of cores to pin OVS lcore threads to.
67    These threads do validation and control handling and it may not have any
68    impact on performance to include this setting.
69
70 Under the performance->Compute section.  Add a nova subsection and include
71 the following setting:
72  - libvirtpin: comma-separated list of CPUs to pin libvirt (nova) instances to.
73    For best results, set this to be one or more CPUs that are located on the
74    same NUMA node where OVS socket memory was dedicated.
75
76 Now deploy with the modified deploy settings file.
77
78 Limitations, Issues and Workarounds
79 ===================================
80
81 * _APEX-415 br-phy dpdk interfaces are not brought up by os-net-config
82
83 References
84 ==========
85
86 For more information on the OPNFV Euphrates release, please visit
87 http://www.opnfv.org/euphrates