os-vif/doc/source/index.rst
Ghanshyam Mann 725d430d5d [Community goal] Update contributor documentation
As the Ussuri goal we have an OpenStack project wide contributing
documentation template [1]. os-vif use its own bug or feature
tracking LP and core team is also not exactly same as nova so adding
its own contributor guide with keeping common links from nova
with os-vif specific information.

Also the top level CONTRIBUTING.rst template has been changed in the
cookiecutter repo[2]. So this patch updates the CONTRIBUTING.rst according
to the new template.

[1] https://opendev.org/openstack/cookiecutter/src/branch/master/%7b%7bcookiecutter.repo_name%7d%7d/$
[2] https://review.opendev.org/#/c/696001

Change-Id: I6017fdbb403d4cd90f4c3c2bd4a197dfbb67f6ec
Story: #2007236
Task: #38541
2020-04-30 21:46:35 +00:00

1022 B

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

user/usage user/vif-types user/host-info user/plugins/linux-bridge user/plugins/noop user/plugins/ovs

For Contributors

  • If you are a new contributor to os-vif please refer: contributor/contributing

contributor/contributing

Reference

reference/glossary