summaryrefslogtreecommitdiffstats
path: root/docs/configguide
diff options
context:
space:
mode:
authorBilly O'Mahony <billy.o.mahony@intel.com>2016-02-09 13:23:18 +0000
committerBilly O'Mahony <billy.o.mahony@intel.com>2016-02-11 17:44:10 +0000
commit124d429e97cb57c31735ba596900d6cab50d6458 (patch)
tree2d8a8acd9794d64e75ea20579e74cf27b289b899 /docs/configguide
parent9e423f6b53784b231ecb3c244bd7f279e94b5ffb (diff)
docs: Reformat docs to rel/b standard.
This patch is only to comply with https://wiki.opnfv.org/documentation any other documention short-comings should be dealt with in a further patch. Change-Id: Ib770c192f9ad60907b923c9d99fa351d7621c7f2 Signed-off-by: Billy O'Mahony <billy.o.mahony@intel.com> Reviewed-by: Mark D. Gray <mark.d.gray@intel.com> Reviewed-by: Thomas F Herbert <therbert@redhat.com> Reviewed-by: Michal Ptacek <michalx.ptacek@intel.com> Reviewed-by: Chris Price <christopher.price@ericsson.com>
Diffstat (limited to 'docs/configguide')
-rw-r--r--docs/configguide/index.rst13
-rwxr-xr-xdocs/configguide/installation.rst25
2 files changed, 38 insertions, 0 deletions
diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst
new file mode 100644
index 0000000..6f84c19
--- /dev/null
+++ b/docs/configguide/index.rst
@@ -0,0 +1,13 @@
+.. 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
+
+******************************
+OVSNFV Guides and Installation
+******************************
+
+.. toctree::
+ :numbered:
+ :maxdepth: 3
+
+ installation.rst
diff --git a/docs/configguide/installation.rst b/docs/configguide/installation.rst
new file mode 100755
index 0000000..ae67a94
--- /dev/null
+++ b/docs/configguide/installation.rst
@@ -0,0 +1,25 @@
+.. 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
+
+=============================
+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.