diff options
Diffstat (limited to 'docs/userguides')
| -rw-r--r-- | docs/userguides/index.rst | 10 | ||||
| -rwxr-xr-x | docs/userguides/installation.rst | 21 | ||||
| -rwxr-xr-x | docs/userguides/quickstart.rst | 37 |
3 files changed, 68 insertions, 0 deletions
diff --git a/docs/userguides/index.rst b/docs/userguides/index.rst new file mode 100644 index 0000000..a03372f --- /dev/null +++ b/docs/userguides/index.rst @@ -0,0 +1,10 @@ +****************************** +OVSNFV Guides and Installation +****************************** + +.. toctree:: + :numbered: + :maxdepth: 3 + + quickstart.rst + installation.rst diff --git a/docs/userguides/installation.rst b/docs/userguides/installation.rst new file mode 100755 index 0000000..c2a0cd2 --- /dev/null +++ b/docs/userguides/installation.rst @@ -0,0 +1,21 @@ +============================= +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. diff --git a/docs/userguides/quickstart.rst b/docs/userguides/quickstart.rst new file mode 100755 index 0000000..b226110 --- /dev/null +++ b/docs/userguides/quickstart.rst @@ -0,0 +1,37 @@ +=========================== +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. |