From 67a5d606ecf520cc2fc11d35540b8c0fce4d56db Mon Sep 17 00:00:00 2001 From: ChristopherPrice Date: Mon, 22 Feb 2016 19:53:54 +0100 Subject: Adjusting the filenames to incorporate the material into the composite docs. ACTION: need to include Feature Configuration sections for ovs4nfv Simona states the ovs4nfv docs may be ready and we should check from the opnfvdocs repo Also adjusted the heading levels for readability. Change-Id: Icd7616b7d9453490147fd361b013c3c8a3b5e79d Signed-off-by: ChristopherPrice (cherry picked from commit e2a47bd00369ee30a4ffed6c446f0c76faf662e4) --- docs/configguide/featureconfig.rst | 24 +++++++++++++++++++ docs/configguide/index.rst | 7 +++--- docs/configguide/installation.rst | 25 -------------------- docs/index.rst | 1 + docs/release/NEWS.rst | 1 + docs/release/index.rst | 4 ++-- docs/userguide/featureusage.rst | 46 ++++++++++++++++++++++++++++++++++++ docs/userguide/index.rst | 7 +++--- docs/userguide/quickstart.rst | 48 -------------------------------------- 9 files changed, 82 insertions(+), 81 deletions(-) create mode 100755 docs/configguide/featureconfig.rst delete mode 100755 docs/configguide/installation.rst create mode 100755 docs/userguide/featureusage.rst delete mode 100755 docs/userguide/quickstart.rst diff --git a/docs/configguide/featureconfig.rst b/docs/configguide/featureconfig.rst new file mode 100755 index 0000000..1cbb56e --- /dev/null +++ b/docs/configguide/featureconfig.rst @@ -0,0 +1,24 @@ +.. 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. diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst index 6f84c19..70bb4a4 100644 --- a/docs/configguide/index.rst +++ b/docs/configguide/index.rst @@ -2,12 +2,13 @@ .. 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 + featureconfig.rst + diff --git a/docs/configguide/installation.rst b/docs/configguide/installation.rst deleted file mode 100755 index ae67a94..0000000 --- a/docs/configguide/installation.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. 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. diff --git a/docs/index.rst b/docs/index.rst index 4721498..8b6fe79 100755 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,6 +7,7 @@ ==================== Open vSwitch for NFV ==================== + Welcome to OVSNFV's documentation! OVSNFV is an OPNFV collaborative development project. diff --git a/docs/release/NEWS.rst b/docs/release/NEWS.rst index a4c62ea..4e87aa0 100755 --- a/docs/release/NEWS.rst +++ b/docs/release/NEWS.rst @@ -6,3 +6,4 @@ January 2016 ============ - Initial Release of OVSNFV Fuel Plugin. + diff --git a/docs/release/index.rst b/docs/release/index.rst index b130db5..9af026a 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -2,9 +2,9 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright (c) 2016 Open Platform for NFV Project, Inc. and its contributors -*********** +=========== OVSNFV News -*********** +=========== .. toctree:: :numbered: diff --git a/docs/userguide/featureusage.rst b/docs/userguide/featureusage.rst new file mode 100755 index 0000000..a26e2e9 --- /dev/null +++ b/docs/userguide/featureusage.rst @@ -0,0 +1,46 @@ +.. 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 + +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. + diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst index c2f593d..7181e5b 100644 --- a/docs/userguide/index.rst +++ b/docs/userguide/index.rst @@ -2,12 +2,13 @@ .. 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 - quickstart.rst + featureusage.rst + diff --git a/docs/userguide/quickstart.rst b/docs/userguide/quickstart.rst deleted file mode 100755 index d8cbe60..0000000 --- a/docs/userguide/quickstart.rst +++ /dev/null @@ -1,48 +0,0 @@ -.. 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 - -============ -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. - -- cgit 1.2.3-korg