openstack/os-vif
Code Issues Proposed changes

Add documentation for Linux Bridge plugin

Browse Source 
Change-Id: I66943e95de66da8b10d04e86f596167798efde15
This commit is contained in:
Stephen Finucane 2017-04-24 14:10:08 +01:00 committed by Moshe Levi
parent 389743cc35
commit e6d25e7c64
3 changed files with 24 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/index.rst
View File

@ -8,6 +8,7 @@ os-vif
vif_types
host_info
plugins/ovs
plugins/linux-bridge
glossary
`os-vif` is a library for plugging and unplugging virtual interfaces (VIFs) in

22
doc/source/plugins/linux-bridge.rst Normal file
View File

@ -0,0 +1,22 @@
============
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 two plugins provided as part
of `os-vif` itself, the other being :doc:`ovs`.
Supported VIF Types
===================
The Linux Bridge plugin provides support for the following VIF types:
`VIFBridge`
Configuration where a guest is connected to a Linux bridge via a TAP device.
This is the only supported configuration for this plugin.
Refer to :ref:`vif-bridge` for more information.
For information on the VIF type objects, refer to :doc:`../vif_types`. Note
that only the above VIF types are supported by this plugin.

2
doc/source/plugins/ovs.rst
View File

@ -4,7 +4,7 @@ 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 two plugins provided as part of `os-vif`
itself, the other being `linux-bridge`.
itself, the other being :doc:`linux-bridge`.
Supported VIF Types
-------------------