summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBilly O'Mahony <billy.o.mahony@intel.com>2016-01-18 14:13:54 +0000
committerMark D. Gray <mark.d.gray@intel.com>2016-01-18 15:02:36 +0000
commit8e8c96144edf1bbdb373ffecbf7f5dd5f8d12bd7 (patch)
tree325a396025b88cae5b7c756d03f167517c06a498
parent23603146c2502c54ac451f85cffc0d5cc49ecede (diff)
docs: Add initial documentation
Change-Id: Ia6d2724b11d034f46bc3a3698d0a0bfc08b83884 Signed-off-by: Billy O'Mahony <billy.o.mahony@intel.com>
-rwxr-xr-xdocs/all/index.rst33
-rwxr-xr-xdocs/release/NEWS.rst4
-rw-r--r--docs/release/index.rst9
-rw-r--r--docs/userguides/index.rst10
-rwxr-xr-xdocs/userguides/installation.rst21
-rwxr-xr-xdocs/userguides/quickstart.rst37
6 files changed, 114 insertions, 0 deletions
diff --git a/docs/all/index.rst b/docs/all/index.rst
new file mode 100755
index 0000000..96f79f7
--- /dev/null
+++ b/docs/all/index.rst
@@ -0,0 +1,33 @@
+.. Open vSwitch for NFV Documentation master file.
+
+====================
+Open vSwitch for NFV
+====================
+Welcome to OVSNFV's documentation !
+
+.. _OVSNFV: https://wiki.opnfv.org/open_vswitch_for_nfv
+.. _REPO: https://opnfv.org/gerrit/ovsnfv
+OVSNFV_ is an OPNFV collaborative development project.
+
+The OVSNFV project proposes:
+
+* Modifying the OPNFV build to include a deployment option for the
+ software-accelerated userspace Open vSwitch build. This change will
+ significantly improve the performance of the NFVI for network I/O.
+* Future work that will encompass collaborative development within the Open
+ vSwitch project to improve the performance of the software-accelerated
+ userspace Open vSwitch and increasing its suitability for Telco NFV
+ deployments.
+
+.. toctree::
+ :maxdepth: 3
+ :numbered: 5
+
+ http://artifacts.opnfv.org/ovsnfv/docs/userguides/index.html
+ http://artifacts.opnfv.org/ovsnfv/docs/release/index.html
+
+
+Indices
+=======
+* :ref:`search`
+
diff --git a/docs/release/NEWS.rst b/docs/release/NEWS.rst
new file mode 100755
index 0000000..ce0e550
--- /dev/null
+++ b/docs/release/NEWS.rst
@@ -0,0 +1,4 @@
+January 2016
+============
+
+- Initial Release of OVSNFV Fuel Plugin.
diff --git a/docs/release/index.rst b/docs/release/index.rst
new file mode 100644
index 0000000..68faf3e
--- /dev/null
+++ b/docs/release/index.rst
@@ -0,0 +1,9 @@
+***********
+OVSNFV News
+***********
+
+.. toctree::
+ :numbered:
+ :maxdepth: 3
+
+ NEWS.rst
diff --git a/docs/userguides/index.rst b/docs/userguides/index.rst
new file mode 100644
index 0000000..a03372f
--- /dev/null
+++ b/docs/userguides/index.rst
@@ -0,0 +1,10 @@
+******************************
+OVSNFV Guides and Installation
+******************************
+
+.. toctree::
+ :numbered:
+ :maxdepth: 3
+
+ quickstart.rst
+ installation.rst
diff --git a/docs/userguides/installation.rst b/docs/userguides/installation.rst
new file mode 100755
index 0000000..c2a0cd2
--- /dev/null
+++ b/docs/userguides/installation.rst
@@ -0,0 +1,21 @@
+=============================
+Installing OVSNFV Fuel Plugin
+=============================
+
+* On the Fuel UI, create a new environment.
+* In Settings > Userspace OVS support, check "Userspace OVS support".
+* Continue with environment configuration and deployment as normal.
+
+Upgrading the plugin
+--------------------
+
+From time to time new versions of the plugin may become available.
+
+The plugin cannot be upgraded if an active environment is using the plugin.
+
+In order to upgrade the plugin:
+
+* Copy the updated plugin file to the fuel-master.
+* On the Fuel UI, reset the environment.
+* On the Fuel CLI "fuel plugins --update <fuel-plugin-file>"
+* On the Fuel UI, re-deploy the environment.
diff --git a/docs/userguides/quickstart.rst b/docs/userguides/quickstart.rst
new file mode 100755
index 0000000..b226110
--- /dev/null
+++ b/docs/userguides/quickstart.rst
@@ -0,0 +1,37 @@
+===========================
+Getting Started with OVSNFV
+===========================
+
+Fuel Plugin Overview
+--------------------
+
+OVSNFV Fuel plugin 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
+
+Requirements
+~~~~~~~~~~~~
+
+Currently not all installers are supported.
+
+Limitations
+~~~~~~~~~~~
+
+Limitataions
+------------
+
+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.
+* There may be issues assigning floating and public ip address to VMs.