8609f8a803
This lets us keep all our docs in code where we can see them. Change-Id: Ibac3e94aa3d5018afbc331982e245951dc0ccd4b
51 lines
1.9 KiB
ReStructuredText
51 lines
1.9 KiB
ReStructuredText
============
|
|
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`.
|
|
|
|
Supported VIF Types
|
|
-------------------
|
|
|
|
The Open vSwitch plugin provides support for the following VIF types:
|
|
|
|
:mod:`~os_vif.objects.VIFOpenVSwitch`
|
|
Configuration where a guest is directly connected an Open vSwitch bridge.
|
|
|
|
:mod:`~os_vif.objects.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.
|
|
|
|
:mod:`~os_vif.objects.VIFVHostUser`
|
|
Configuration where a guest exposes a UNIX socket for its control plane. This
|
|
configuration is used with the `DPDK datapath of Open vSwitch`__.
|
|
|
|
__ http://docs.openvswitch.org/en/latest/howto/dpdk/
|
|
|
|
:mod:`~os_vif.objects.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 :command:`ethtool`:
|
|
|
|
.. code-block:: shell
|
|
|
|
ethtool -K <PF> hw-tc-offload
|
|
|
|
This will create a *VF representor* per VF. The VF representor plays the same
|
|
role as TAP devices in Para-Virtual (PV) setup. In this case the ``plug()``
|
|
method connects the VF representor to the OpenVSwitch bridge.
|
|
|
|
.. important::
|
|
|
|
Support for this feature requires Linux Kernel >= 4.8 and Open vSwitch
|
|
2.8. These add support for :term:`tc`-based hardware offloads for SR-IOV
|
|
VFs and offloading of OVS datapath rules using tc, respectively.
|
|
|
|
.. versionadded:: 1.5.0
|
|
|
|
For information on the VIF type objects, refer to :doc:`/user/vif-types`. Note
|
|
that only the above VIF types are supported by this plugin.
|