From: Mark D. Gray Date: Mon, 18 Jan 2016 15:04:23 +0000 (+0000) Subject: Revert "docs: Add initial documentation" X-Git-Tag: colorado.1.0~53 X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?p=ovsnfv.git;a=commitdiff_plain;h=b29797556682c8be8d33cf66fa2ae100a9c2bda7 Revert "docs: Add initial documentation" This reverts commit 8e8c96144edf1bbdb373ffecbf7f5dd5f8d12bd7. Change-Id: I8a1fb8d125922d1b5825b50a01bb082f827c8584 --- diff --git a/docs/all/index.rst b/docs/all/index.rst deleted file mode 100755 index 96f79f7..0000000 --- a/docs/all/index.rst +++ /dev/null @@ -1,33 +0,0 @@ -.. 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: - -* Modifying 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 that will 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/release/NEWS.rst b/docs/release/NEWS.rst deleted file mode 100755 index ce0e550..0000000 --- a/docs/release/NEWS.rst +++ /dev/null @@ -1,4 +0,0 @@ -January 2016 -============ - -- Initial Release of OVSNFV Fuel Plugin. diff --git a/docs/release/index.rst b/docs/release/index.rst deleted file mode 100644 index 68faf3e..0000000 --- a/docs/release/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -*********** -OVSNFV News -*********** - -.. toctree:: - :numbered: - :maxdepth: 3 - - NEWS.rst diff --git a/docs/userguides/index.rst b/docs/userguides/index.rst deleted file mode 100644 index a03372f..0000000 --- a/docs/userguides/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -****************************** -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 c2a0cd2..0000000 --- a/docs/userguides/installation.rst +++ /dev/null @@ -1,21 +0,0 @@ -============================= -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 b226110..0000000 --- a/docs/userguides/quickstart.rst +++ /dev/null @@ -1,37 +0,0 @@ -=========================== -Getting Started with OVSNFV -=========================== - -Fuel Plugin Overview --------------------- - -OVSNFV Fuel plugin 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 - -Requirements -~~~~~~~~~~~~ - -Currently not all installers are supported. - -Limitations -~~~~~~~~~~~ - -Limitataions ------------- - -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. -* There may be issues assigning floating and public ip address to VMs.