diff options
Diffstat (limited to 'docs/userguide')
| -rw-r--r-- | docs/userguide/feature.userguide.rst | 17 | ||||
| -rwxr-xr-x | docs/userguide/featureusage.rst | 46 | ||||
| -rw-r--r-- | docs/userguide/index.rst | 22 |
3 files changed, 33 insertions, 52 deletions
diff --git a/docs/userguide/feature.userguide.rst b/docs/userguide/feature.userguide.rst new file mode 100644 index 0000000..5741f2d --- /dev/null +++ b/docs/userguide/feature.userguide.rst @@ -0,0 +1,17 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Intel Corporation + +OVSNFV description +===================== +Open vSwtich (OVS) is a software switch commonly used in OPNFV deployments. +OVSNFV project supplies a Fuel Plugin to upgrade DPDK enabled Open vSwitch on +an OPNFV to 2.5.90. + + +OVSNFV capabilities and usage +================================ +After installation use of the scenario requires no further action by the user. +Traffic on the private network will automatically be processed by the upgraded +DPDK datapath. + diff --git a/docs/userguide/featureusage.rst b/docs/userguide/featureusage.rst deleted file mode 100755 index d948d69..0000000 --- a/docs/userguide/featureusage.rst +++ /dev/null @@ -1,46 +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. - -Supported 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 7181e5b..1566bf6 100644 --- a/docs/userguide/index.rst +++ b/docs/userguide/index.rst @@ -1,14 +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 +.. (c) Intel Corporation + +================= +OVSNFV user guide +================= + +.. The feature user guide should provide an OPNFV user with enough information to +.. use the features provided by the feature project in the supported scenarios. +.. This guide should walk a user through the usage of the features once a scenario +.. has been deployed and is active according to the installation guide provided +.. by the installer project. -============================== -OVSNFV Guides and Installation -============================== .. toctree:: - :numbered: :maxdepth: 3 - featureusage.rst + ./feature.userguide.rst + +.. The feature.userguide.rst file should contain the text for this document +.. additional documents can be added to this directory and added in the right order +.. to this file as a list below. |