diff --git a/doc/source/user/plugins/linux-bridge.rst b/doc/source/user/plugins/linux-bridge.rst index f9e4c1ba..bd9c20e5 100644 --- a/doc/source/user/plugins/linux-bridge.rst +++ b/doc/source/user/plugins/linux-bridge.rst @@ -2,17 +2,16 @@ Linux Bridge ============ -The Linux Bridge plugin, ``vif_plug_linux_bridge``, is an `os-vif` VIF plugin +The Linux Bridge plugin, ``vif_plug_linux_bridge``, is an *os-vif* VIF plugin for the Linux Bridge network backend. It is one of three plugins provided as part -of `os-vif` itself, the others being :doc:`ovs` and :doc:`noop`. +of *os-vif* itself, the others being :doc:`ovs` and :doc:`noop`. Supported VIF Types -=================== +------------------- The Linux Bridge plugin provides support for the following VIF types: -`VIFBridge` - +``VIFBridge`` Configuration where a guest is connected to a Linux bridge via a TAP device. This is the only supported configuration for this plugin. diff --git a/doc/source/user/plugins/noop.rst b/doc/source/user/plugins/noop.rst index b1bce47f..bc224c5c 100644 --- a/doc/source/user/plugins/noop.rst +++ b/doc/source/user/plugins/noop.rst @@ -2,20 +2,19 @@ no-op ===== -The no-op plugin, ``vif_plug_noop``, is an `os-vif` VIF plugin -for use with network backends that do not require pluging of network interfaces. -It is one of three plugins provided as part of `os-vif` itself, the others -being :doc:`ovs` and :doc:`linux-bridge`. +The no-op plugin, ``vif_plug_noop``, is an *os-vif* VIF plugin for use with +network backends that do not require plugging of network interfaces. It is one +of three plugins provided as part of *os-vif* itself, the others being +:doc:`ovs` and :doc:`linux-bridge`. Supported VIF Types -=================== +------------------- The no-op plugin provides support for the following VIF types: -`VIFVHostUser` - +``VIFVHostUser`` Configuration where a guest exposes a UNIX socket for its control plane. This - configuration is used with a userspace dataplane such as vpp or snabb switch. + configuration is used with a userspace dataplane such as VPP or Snabb switch. Refer to :ref:`vif-vhostuser` for more information. diff --git a/doc/source/user/plugins/ovs.rst b/doc/source/user/plugins/ovs.rst index 60968236..59ff4fdd 100644 --- a/doc/source/user/plugins/ovs.rst +++ b/doc/source/user/plugins/ovs.rst @@ -2,38 +2,34 @@ Open vSwitch ============ -The Open vSwitch plugin, `vif_plug_ovs`, is an `os-vif` VIF plugin for the Open -vSwitch network backend. It is one of three plugins provided as part of `os-vif` -itself, the others being :doc:`linux-bridge` and :doc:`noop`. +The Open vSwitch plugin, ``vif_plug_ovs``, is an *os-vif* VIF plugin for the +Open vSwitch network backend. It is one of three plugins provided as part of +*os-vif* itself, the others being :doc:`linux-bridge` and :doc:`noop`. Supported VIF Types ------------------- The Open vSwitch plugin provides support for the following VIF types: -`VIFOpenVSwitch` - +``VIFOpenVSwitch`` Configuration where a guest is directly connected an Open vSwitch bridge. Refer to :ref:`vif-openvswitch` for more information. -`VIFBridge` - +``VIFBridge`` Configuration where a guest is connected to a Linux bridge via a TAP device, and that bridge is connected to the Open vSwitch bridge. This allows for the use of ``iptables`` rules for filtering traffic. Refer to :ref:`vif-bridge` for more information. -`VIFVHostUser` - +``VIFVHostUser`` Configuration where a guest exposes a UNIX socket for its control plane. This configuration is used with the `DPDK datapath of Open vSwitch`__. Refer to :ref:`vif-vhostuser` for more information. -`VIFHostDevice` - +``VIFHostDevice`` Configuration where an :term:`SR-IOV` PCI device :term:`VF` is passed through to a guest. The ``hw-tc-offload`` feature should be enabled on the SR-IOV :term:`PF` using ``ethtool``: