X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Fscenarios%2Fos-nosdn-ovs%2Fscenario.description.rst;fp=docs%2Fscenarios%2Fos-nosdn-ovs%2Fscenario.description.rst;h=03e732ca94ad5c4baff94310c435db1c4a4113e7;hb=33c5e8c359ed51349a3810f68886a25f6fc10f79;hp=0000000000000000000000000000000000000000;hpb=55ef39e7796633029e5a3e061532e0984c2be798;p=ovsnfv.git

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
+