03e732ca94ad5c4baff94310c435db1c4a4113e7
[ovsnfv.git] / docs / scenarios / os-nosdn-ovs / scenario.description.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) Intel Corporation
4
5 Introduction
6 ============
7 This scenario installs the latest DPDK-enabled Open vSwitch component,
8 version - 2.5.90 based on DPDK 16.07.
9
10 Scenario components and composition
11 ===================================
12 This scenario is currently able to be installed using the Fuel and Apex installers.
13 For details on how to install the ovsnfv scenarion using these installer tools
14 please refer to the installation instructions at:
15   * Fuel installation instruction: http://artifacts.opnfv.org/colorado/fuel/docs/installation-instruction.html
16   * Apex installation instruction: http://artifacts.opnfv.org/colorado/apex/docs/installation-instruction/index.html
17
18 .. Above links need to be updated with the eventual release URL's.  This will need to be done closer to the
19 .. release date once the project and docs team have a solution ready and the final version of the installation
20 .. documents are done.
21
22 Scenario usage overview
23 =======================
24 After installation use of the scenario requires no further action by the user.
25 Traffic on the private network will automatically be processed by the upgraded
26 DPDK datapath.
27
28 Limitations, Issues and Workarounds
29 ===================================
30 The same limitations that apply to using Fuel DPDK-enabled interfaces also apply
31 when using this scenario. Including:
32
33 * Fuel9 OVS-DPDK support works only for VLAN segmentation.
34 * Only interfaces running the private network (and no other network) can be
35   supported so each node needs a separate interface dedicated to the private network.
36 * The nodes with dpdk enabled interfaces will need to have hugepages
37   configured and some cores reserved for dpdk.
38
39
40 References
41 ==========
42
43 For more information on the OPNFV Colorado release, please visit
44 http://www.opnfv.org/colorado
45