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