From 5873e97dfcaef89df13b49b6a53c4fe3d6637fac Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Wed, 11 May 2016 17:30:17 +0100 Subject: [PATCH] devref: Cleanup OVS vHost User Guide There are some formatting issues with this document. Fix them. Change-Id: I8fad16fb8dc11d87b1fc185be80046d1778d7b93 --- doc/source/devref/ovs_vhostuser.rst | 34 +++++++++++++++-------------- 1 file changed, 18 insertions(+), 16 deletions(-) diff --git a/doc/source/devref/ovs_vhostuser.rst b/doc/source/devref/ovs_vhostuser.rst index 769ad7745dc..e30d4a117df 100644 --- a/doc/source/devref/ovs_vhostuser.rst +++ b/doc/source/devref/ovs_vhostuser.rst @@ -20,7 +20,6 @@ ''''''' Heading 4 (Avoid deeper levels because they do not render well.) - Neutron Open vSwitch vhost-user support ======================================= @@ -34,23 +33,26 @@ installation and passes that information over RPC via the agent 'configurations' dictionary. The ML2 driver uses this information to select the proper VIF type and binding details. -Neutron+OVS+DPDK platform requirements --------------------------------------- -OVS 2.4.0+ -DPDK 2.0+ +Platform requirements +--------------------- -Neutron OVS+DPDK vhost-user config ----------------------------------- +* OVS 2.4.0+ +* DPDK 2.0+ -[OVS] -datapath_type=netdev -vhostuser_socket_dir=/var/run/openvswitch +Configuration +------------- -When OVS is running with DPDK support enabled, and the datapath_type is set to -"netdev", then the OVS ML2 driver will use the vhost-user VIF type and pass -the necessary binding details to use OVS+DPDK and vhost-user sockets. This -includes the vhostuser_socket_dir setting, which must match the directory -passed to ovs-vswitchd on startup. +.. code-block:: ini + + [OVS] + datapath_type=netdev + vhostuser_socket_dir=/var/run/openvswitch + +When OVS is running with DPDK support enabled, and the ``datapath_type`` is +set to ``netdev``, then the OVS ML2 driver will use the ``vhost-user`` VIF +type and pass the necessary binding details to use OVS+DPDK and vhost-user +sockets. This includes the ``vhostuser_socket_dir`` setting, which must match +the directory passed to ``ovs-vswitchd`` on startup. What about the networking-ovs-dpdk repo? ---------------------------------------- @@ -58,5 +60,5 @@ What about the networking-ovs-dpdk repo? The networking-ovs-dpdk repo will continue to exist and undergo active development. This feature just removes the necessity for a separate ML2 driver and OVS agent in the networking-ovs-dpdk repo. The networking-ovs-dpdk project -also provides a devstack plugin which also allows automated CI, a puppet +also provides a devstack plugin which also allows automated CI, a Puppet module, and an OpenFlow-based security group implementation.