docs: Add initial documentation

Change-Id: Ie08ee783093fcb4df91601aa3b2ee4b1b8468154
Signed-off-by: Billy O'Mahony <billy.o.mahony@intel.com>

diff --git a/.gitignore b/.gitignore
new file mode 100644 (file)
index 0000000..e7c25c1
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,3 @@
+/docs_build/
+/docs_output/
+/releng/

diff --git a/docs/all/index.rst b/docs/all/index.rst
new file mode 100755 (executable)
index 0000000..7917dbc
--- /dev/null
+++ b/docs/all/index.rst
@@ -0,0 +1,34 @@
+.. 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:
+
+* To modify 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 to 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/how-to-use-docs/documentation-example.rst b/docs/how-to-use-docs/documentation-example.rst
deleted file mode 100644 (file)
index afcf758..0000000
--- a/docs/how-to-use-docs/documentation-example.rst
+++ /dev/null
@@ -1,86 +0,0 @@
-.. two dots create a comment. please leave this logo at the top of each of your rst files.
-.. image:: ../etc/opnfv-logo.png 
-  :height: 40
-  :width: 200
-  :alt: OPNFV
-  :align: left
-.. these two pipes are to seperate the logo from the first title
-|
-|
-How to create documentation for your OPNFV project
-==================================================
-
-this is the directory structure of the docs/ directory that can be found in the root of your project directory
-
-.. code-block:: bash
-
-    ./etc
-    ./etc/opnfv-logo.png
-    ./etc/conf.py
-    ./how-to-use-docs
-    ./how-to-use-docs/documentation-example.rst
-    ./how-to-use-docs/index.rst
-
-To create your own documentation, Create any number of directories (depending on your need) and place in each of them an index.rst.
-This index file must refence your other rst files.
-
-* Here is an example index.rst
-
-.. code-block:: bash
-
-  Example Documentation table of contents
-  =======================================
-
-  Contents:
-
-  .. toctree::
-     :numbered:
-     :maxdepth: 4
-
-     documentation-example.rst
-
-  Indices and tables
-  ==================
-
-  * :ref:`search`
-
-  Revision: _sha1_
-
-  Build date: |today|
-
-
-The Sphinx Build
-================
-
-When you push documentation changes to gerrit a jenkins job will create html documentation.
-
-* Verify Jobs
-For verify jobs a link to the documentation will show up as a comment in gerrit for you to see the result.
-
-* Merge jobs
-
-Once you are happy with the look of your documentation you can submit the patchset the merge job will 
-copy the output of each documentation directory to http://artifacts.opnfv.org/$project/docs/$name_of_your_folder/index.html
-
-Here are some quick examples of how to use rst markup
-
-This is a headline::
-
-  here is some code, note that it is indented
-
-links are easy to add: Here is a link to sphinx, the tool that we are using to generate documetation http://sphinx-doc.org/
-
-* Bulleted Items
-
-  **this will be bold**
-
-.. code-block:: bash
-
-  echo "Heres is a code block with bash syntax highlighting"
-
-
-Leave these at the bottom of each of your documents they are used internally
-
-Revision: _sha1_
-
-Build date: |today|

diff --git a/docs/how-to-use-docs/index.rst b/docs/how-to-use-docs/index.rst
deleted file mode 100644 (file)
index 36710b3..0000000
--- a/docs/how-to-use-docs/index.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. OPNFV Release Engineering documentation, created by
-   sphinx-quickstart on Tue Jun  9 19:12:31 2015.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-.. image:: ../etc/opnfv-logo.png
-  :height: 40
-  :width: 200
-  :alt: OPNFV
-  :align: left
-
-Example Documentation table of contents
-=======================================
-
-Contents:
-
-.. toctree::
-   :numbered:
-   :maxdepth: 4
-
-   documentation-example.rst
-
-Indices and tables
-==================
-
-* :ref:`search`
-
-Revision: _sha1_
-
-Build date: |today|

diff --git a/docs/release/NEWS.rst b/docs/release/NEWS.rst
new file mode 100755 (executable)
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 (file)
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 (file)
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 (executable)
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 (executable)
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.
+