diff options
| author |   Billy O'Mahony <billy.o.mahony@intel.com> | 2016-02-09 13:23:18 +0000 |
|---|---|---|
| committer | Billy O'Mahony <billy.o.mahony@intel.com> | 2016-02-11 17:44:10 +0000 |
| commit | 124d429e97cb57c31735ba596900d6cab50d6458 (patch) | |
| tree | 2d8a8acd9794d64e75ea20579e74cf27b289b899 /docs/userguide | |
| parent | 9e423f6b53784b231ecb3c244bd7f279e94b5ffb (diff) | |
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 <billy.o.mahony@intel.com>
Reviewed-by: Mark D. Gray <mark.d.gray@intel.com>
Reviewed-by: Thomas F Herbert <therbert@redhat.com>
Reviewed-by: Michal Ptacek <michalx.ptacek@intel.com>
Reviewed-by: Chris Price <christopher.price@ericsson.com>
Diffstat (limited to 'docs/userguide')
| -rw-r--r-- | docs/userguide/index.rst | 13 | ||||
| -rwxr-xr-x | docs/userguide/quickstart.rst | 48 |
2 files changed, 61 insertions, 0 deletions
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. + |