From 33c5e8c359ed51349a3810f68886a25f6fc10f79 Mon Sep 17 00:00:00 2001 From: ChristopherPrice Date: Thu, 18 Aug 2016 11:04:38 +0200 Subject: Adding ovsnfv scenario docs Copied these docs from https://gerrit.opnfv.org/gerrit/#/c/18563/ These should be in the feature/scenarion project repo for better information control by the projects. Added some notes to the installer links indicating they need to be updated when the final URL's are available. co-author: Billy O'Mahony Change-Id: I21bfca06e4a8d117bb10b7b79504eb20aa62d4b7 Signed-off-by:Christopher Price --- docs/scenarios/os-nosdn-ovs/index.rst | 17 ++++++++ .../os-nosdn-ovs/scenario.description.rst | 45 ++++++++++++++++++++++ 2 files changed, 62 insertions(+) create mode 100644 docs/scenarios/os-nosdn-ovs/index.rst create mode 100644 docs/scenarios/os-nosdn-ovs/scenario.description.rst (limited to 'docs/scenarios/os-nosdn-ovs') diff --git a/docs/scenarios/os-nosdn-ovs/index.rst b/docs/scenarios/os-nosdn-ovs/index.rst new file mode 100644 index 0000000..145d0ae --- /dev/null +++ b/docs/scenarios/os-nosdn-ovs/index.rst @@ -0,0 +1,17 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Intel Corporation + +.. This document will be used to provide a description of the scenario for an end user. +.. You should explain the purpose of the scenario, the types of capabilities provided and +.. the unique components that make up the scenario including how they are used. + +===================================== +os-nosdn-ovs overview and description +===================================== + +.. toctree:: + :maxdepth: 3 + + ./scenario.description.rst + diff --git a/docs/scenarios/os-nosdn-ovs/scenario.description.rst b/docs/scenarios/os-nosdn-ovs/scenario.description.rst new file mode 100644 index 0000000..03e732c --- /dev/null +++ b/docs/scenarios/os-nosdn-ovs/scenario.description.rst @@ -0,0 +1,45 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Intel Corporation + +Introduction +============ +This scenario installs the latest DPDK-enabled Open vSwitch component, +version - 2.5.90 based on DPDK 16.07. + +Scenario components and composition +=================================== +This scenario is currently able to be installed using the Fuel and Apex installers. +For details on how to install the ovsnfv scenarion using these installer tools +please refer to the installation instructions at: + * Fuel installation instruction: http://artifacts.opnfv.org/colorado/fuel/docs/installation-instruction.html + * Apex installation instruction: http://artifacts.opnfv.org/colorado/apex/docs/installation-instruction/index.html + +.. Above links need to be updated with the eventual release URL's. This will need to be done closer to the +.. release date once the project and docs team have a solution ready and the final version of the installation +.. documents are done. + +Scenario usage overview +======================= +After installation use of the scenario requires no further action by the user. +Traffic on the private network will automatically be processed by the upgraded +DPDK datapath. + +Limitations, Issues and Workarounds +=================================== +The same limitations that apply to using Fuel DPDK-enabled interfaces also apply +when using this scenario. Including: + +* Fuel9 OVS-DPDK support works only for VLAN segmentation. +* Only interfaces running the private network (and no other network) can be + supported so each node needs a separate interface dedicated to the private network. +* The nodes with dpdk enabled interfaces will need to have hugepages + configured and some cores reserved for dpdk. + + +References +========== + +For more information on the OPNFV Colorado release, please visit +http://www.opnfv.org/colorado + -- cgit 1.2.3-korg