From 124d429e97cb57c31735ba596900d6cab50d6458 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 --- docs/all/index.rst | 38 ------------------------------ docs/configguide/index.rst | 13 +++++++++++ docs/configguide/installation.rst | 25 ++++++++++++++++++++ docs/etc/conf.py | 48 -------------------------------------- docs/etc/opnfv-logo.png | Bin 2829 -> 0 bytes docs/index.rst | 35 +++++++++++++++++++++++++++ docs/userguide/index.rst | 13 +++++++++++ docs/userguide/quickstart.rst | 48 ++++++++++++++++++++++++++++++++++++++ docs/userguides/index.rst | 14 ----------- docs/userguides/installation.rst | 25 -------------------- docs/userguides/quickstart.rst | 48 -------------------------------------- 11 files changed, 134 insertions(+), 173 deletions(-) delete mode 100755 docs/all/index.rst create mode 100644 docs/configguide/index.rst create mode 100755 docs/configguide/installation.rst delete mode 100644 docs/etc/conf.py delete mode 100644 docs/etc/opnfv-logo.png create mode 100755 docs/index.rst create mode 100644 docs/userguide/index.rst create mode 100755 docs/userguide/quickstart.rst delete mode 100644 docs/userguides/index.rst delete mode 100755 docs/userguides/installation.rst delete mode 100755 docs/userguides/quickstart.rst diff --git a/docs/all/index.rst b/docs/all/index.rst deleted file mode 100755 index f4b1738..0000000 --- a/docs/all/index.rst +++ /dev/null @@ -1,38 +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 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/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. diff --git a/docs/etc/conf.py b/docs/etc/conf.py deleted file mode 100644 index b8b9aff..0000000 --- a/docs/etc/conf.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright 2016 Open Platform for NFV Project, Inc. and its contributors -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -import datetime -import sys -import os - -try: - __import__('imp').find_module('sphinx.ext.numfig') - extensions = ['sphinx.ext.numfig'] -except ImportError: - # 'pip install sphinx_numfig' - extensions = ['sphinx_numfig'] - -# numfig: -number_figures = True -figure_caption_prefix = "Fig." - -source_suffix = '.rst' -master_doc = 'index' -pygments_style = 'sphinx' -html_use_index = False - -pdf_documents = [('index', u'OPNFV', u'OPNFV Project', u'OPNFV')] -pdf_fit_mode = "shrink" -pdf_stylesheets = ['sphinx','kerning','a4'] -#latex_domain_indices = False -#latex_use_modindex = False - -latex_elements = { - 'printindex': '', -} - -project = u'OPNFV: Template documentation config' -copyright = u'%s, OPNFV' % datetime.date.today().year -version = u'1.0.0' -release = u'1.0.0' diff --git a/docs/etc/opnfv-logo.png b/docs/etc/opnfv-logo.png deleted file mode 100644 index 1519503..0000000 Binary files a/docs/etc/opnfv-logo.png and /dev/null differ diff --git a/docs/index.rst b/docs/index.rst new file mode 100755 index 0000000..4721498 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,35 @@ +.. 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 for NFV Documentation master file. + +==================== +Open vSwitch for NFV +==================== +Welcome to OVSNFV's documentation! + +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 + + ./configguide/index.rst + ./userguide/index.rst + + +Indices +======= +* :ref:`search` + diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst new file mode 100644 index 0000000..c2f593d --- /dev/null +++ b/docs/userguide/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 + + quickstart.rst diff --git a/docs/userguide/quickstart.rst b/docs/userguide/quickstart.rst new file mode 100755 index 0000000..d8cbe60 --- /dev/null +++ b/docs/userguide/quickstart.rst @@ -0,0 +1,48 @@ +.. 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/userguides/index.rst b/docs/userguides/index.rst deleted file mode 100644 index 6809c8e..0000000 --- a/docs/userguides/index.rst +++ /dev/null @@ -1,14 +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 - -****************************** -OVSNFV Guides and Installation -****************************** - -.. toctree:: - :numbered: - :maxdepth: 3 - - quickstart.rst - installation.rst diff --git a/docs/userguides/installation.rst b/docs/userguides/installation.rst deleted file mode 100755 index ae67a94..0000000 --- a/docs/userguides/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/userguides/quickstart.rst b/docs/userguides/quickstart.rst deleted file mode 100755 index d8cbe60..0000000 --- a/docs/userguides/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