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 <billy.o.mahony@intel.com>
Change-Id: I21bfca06e4a8d117bb10b7b79504eb20aa62d4b7
Signed-off-by:Christopher Price <christopher.price@ericsson.com>

6 files changed, 99 insertions, 58 deletions

diff --git a/docs/design/specs/High-Priority-Traffic-Path.rst b/docs/design/specs/High-Priority-Traffic-Path.rst
index 6243cbe..4000133 100644
--- a/docs/design/specs/High-Priority-Traffic-Path.rst
+++ b/docs/design/specs/High-Priority-Traffic-Path.rst
@@ -1,8 +1,6 @@
-..
- This work is licensed under a Creative Commons Attribution 3.0 Unported
- License.
-
- http://creativecommons.org/licenses/by/3.0/legalcode
+.. This work is licensed under a Creative Commons Attribution 3.0 Unported
+.. License.
+.. http://creativecommons.org/licenses/by/3.0/legalcode
 
 ==========================================
 High Priority Traffic Path
@@ -207,7 +205,7 @@ prioritization scheme that is developed.
 Tests should be performed for each combination of:
 
 * Packet Sizes in (64, 512)
-* Total Offered Rate in (80, 120, 150) 
+* Total Offered Rate in (80, 120, 150)
 * rate_ingress_b(n) / rate_ingress_a(n) in (0.1, 0.2, 0.5)
 
 For each set, the following metrics should be collected for each traffic
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
+
diff --git a/docs/userguide/feature.userguide.rst b/docs/userguide/feature.userguide.rst
new file mode 100644
index 0000000..5741f2d
--- /dev/null
+++ b/docs/userguide/feature.userguide.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
+
+OVSNFV description
+=====================
+Open vSwtich (OVS) is a software switch commonly used in OPNFV deployments.
+OVSNFV project supplies a Fuel Plugin to upgrade DPDK enabled Open vSwitch on
+an OPNFV to 2.5.90.
+
+
+OVSNFV capabilities and usage
+================================
+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.
+
diff --git a/docs/userguide/featureusage.rst b/docs/userguide/featureusage.rst
deleted file mode 100755
index d948d69..0000000
--- a/docs/userguide/featureusage.rst
+++ /dev/null
@@ -1,46 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. Copyright (c) 2016 Open Platform for NFV Project, Inc. and its contributors
-
-Open vSwitch
-============
-
-Open vSwtich (OVS) is a software switch commonly used in OpenStack deployments
-to replace Linux bridges as it offers advantages in terms of mobility, hardware
-integration and use by network controllers.
-
-Supported OPNFV Installers
---------------------------
-
-Currently not all installers are supported.
-
-Fuel Installer
-~~~~~~~~~~~~~~
-
-OVSNFV project supplies a Fuel Plugin to upgrades Open vSwitch on an OPNFV
-installation to use user-space datapath.
-
-As part of the upgrade the following changes are also made:
-
-* change libvirt on compute node to 1.2.12
-* change qemu on compute node to 2.2.1
-* installs DPDK 2.0.0
-* installs OVS 2.1 (specifically git tag 1e77bbe)
-* removes existing OVS neutron plugin
-* installs new OVS plugin as part of networking_ovs_dpdk OpenStack plugin
-  version stable/kilo
-* work around _set_device_mtu issue
-
-Limitations
-~~~~~~~~~~~
-
-This release should be considered experimental. In particular:
-
-* performance will be addressed specifically in subsequent releases.
-* OVS and other components are updated only on compute nodes.
-
-Bugs
-~~~~
-
-* There may be issues assigning floating and public ip address to VMs.
-
diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
index 7181e5b..1566bf6 100644
--- a/docs/userguide/index.rst
+++ b/docs/userguide/index.rst
@@ -1,14 +1,24 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
-.. Copyright (c) 2016 Open Platform for NFV Project, Inc. and its contributors
+.. (c) Intel Corporation
+
+=================
+OVSNFV user guide
+=================
+
+.. The feature user guide should provide an OPNFV user with enough information to
+.. use the features provided by the feature project in the supported scenarios.
+.. This guide should walk a user through the usage of the features once a scenario
+.. has been deployed and is active according to the installation guide provided
+.. by the installer project.
 
-==============================
-OVSNFV Guides and Installation
-==============================
 
 .. toctree::
-   :numbered:
    :maxdepth: 3
 
-   featureusage.rst
+   ./feature.userguide.rst
+
+.. The feature.userguide.rst file should contain the text for this document
+.. additional documents can be added to this directory and added in the right order
+.. to this file as a list below.