X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Fuserguides%2Fquickstart.rst;fp=docs%2Fuserguides%2Fquickstart.rst;h=d23085cb5ac7b2d04a1171228019f56bc9ec9294;hb=f941469a5d82c058290c4b4af0f23100294a0a49;hp=0000000000000000000000000000000000000000;hpb=5aa5bf29f814741f2aa62f51085c3ff1c9610ce8;p=ovsnfv.git

diff --git a/docs/userguides/quickstart.rst b/docs/userguides/quickstart.rst
new file mode 100755
index 0000000..d23085c
--- /dev/null
+++ b/docs/userguides/quickstart.rst
@@ -0,0 +1,44 @@
+============
+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.
+
+================
+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.
+