1d281bb70c
The spec [1] recommends the following sections: - install - contributor - configuration - cli - admin - user - reference Only two of these are useful here: - user - reference Add these and populate them. [1] specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration Change-Id: Ieab6ad5ef43a172743053a1cffc8d46deb235277
38 lines
823 B
ReStructuredText
38 lines
823 B
ReStructuredText
======
|
|
os-vif
|
|
======
|
|
|
|
`os-vif` is a library for plugging and unplugging virtual interfaces (VIFs) in
|
|
OpenStack. It provides:
|
|
|
|
- Versioned objects that represent various types of virtual interfaces and
|
|
their components
|
|
|
|
- Base VIF plugin class that supplies a ``plug()`` and ``unplug()`` interface
|
|
|
|
- Plugins for two networking backends - Open vSwitch and Linux Bridge
|
|
|
|
`os-vif` is intended to define a common model for representing VIF types in
|
|
OpenStack. With the exception of the two included plugins, all plugins for
|
|
other networking backends are maintained in separate code repositories.
|
|
|
|
Usage Guide
|
|
-----------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
user/usage
|
|
user/vif-types
|
|
user/host-info
|
|
user/plugins/ovs
|
|
user/plugins/linux-bridge
|
|
|
|
Reference
|
|
---------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
reference/glossary
|