os-vif/doc/source/user/plugins/linux-bridge.rst
Stephen Finucane 8609f8a803 docs: Use sphinx.ext.autodoc for VIF types
This lets us keep all our docs in code where we can see them.

Change-Id: Ibac3e94aa3d5018afbc331982e245951dc0ccd4b
2019-02-26 10:19:14 +00:00

20 lines
690 B
ReStructuredText

============
Linux Bridge
============
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`.
Supported VIF Types
-------------------
The Linux Bridge plugin provides support for the following VIF types:
:mod:`~os_vif.objects.VIFBridge`
Configuration where a guest is connected to a Linux bridge via a TAP device.
This is the only supported configuration for this plugin.
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.