From e6d25e7c64da9ffbe736de84d9f5b916780cfaad Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Mon, 24 Apr 2017 14:10:08 +0100 Subject: [PATCH] Add documentation for Linux Bridge plugin Change-Id: I66943e95de66da8b10d04e86f596167798efde15 --- doc/source/index.rst | 1 + doc/source/plugins/linux-bridge.rst | 22 ++++++++++++++++++++++ doc/source/plugins/ovs.rst | 2 +- 3 files changed, 24 insertions(+), 1 deletion(-) create mode 100644 doc/source/plugins/linux-bridge.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index bd17d3e0..91b4e737 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 diff --git a/doc/source/plugins/linux-bridge.rst b/doc/source/plugins/linux-bridge.rst new file mode 100644 index 00000000..37457fe4 --- /dev/null +++ b/doc/source/plugins/linux-bridge.rst @@ -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. diff --git a/doc/source/plugins/ovs.rst b/doc/source/plugins/ovs.rst index 7047021e..dc360526 100644 --- a/doc/source/plugins/ovs.rst +++ b/doc/source/plugins/ovs.rst @@ -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 -------------------