From 497a0acff887dc0339b4ab9b79fded18a17ebe59 Mon Sep 17 00:00:00 2001 From: Billy O'Mahony Date: Tue, 9 Feb 2016 13:23:18 +0000 Subject: 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 Reviewed-by: Mark D. Gray Reviewed-by: Thomas F Herbert Reviewed-by: Michal Ptacek Reviewed-by: Chris Price (cherry picked from commit 124d429e97cb57c31735ba596900d6cab50d6458) --- docs/configguide/index.rst | 13 +++++++++++++ docs/configguide/installation.rst | 25 +++++++++++++++++++++++++ 2 files changed, 38 insertions(+) create mode 100644 docs/configguide/index.rst create mode 100755 docs/configguide/installation.rst (limited to 'docs/configguide') 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 " +* On the Fuel UI, re-deploy the environment. -- cgit 1.2.3-korg