Open vSwitch Documentation

How the Documentation is Organised

The Open vSwitch documentation is organised into multiple sections:

Installation guides </intro/install/index> guide you through installing Open vSwitch (OVS) and Open Virtual Network (OVN) on a variety of different platforms
Tutorials </tutorials/index> take you through a series of steps to configure OVS and OVN in sandboxed environments
Topic guides </topics/index> provide a high level overview of OVS and OVN internals and operation
How-to guides </howto/index> are recipes or use-cases for OVS and OVN. They are more advanced than the tutorials.
Frequently Asked Questions </faq/index> provide general insight into a variety of topics related to configuration and operation of OVS and OVN.

Getting started with Open vSwitch (OVS) or Open Virtual Network (OVN) for Open vSwitch? Start here.

Overview: intro/what-is-ovs | intro/why-ovs
Install: intro/install/general | intro/install/userspace | intro/install/netbsd | intro/install/windows | intro/install/xenserver | intro/install/dpdk | Installation FAQs <faq/releases>
Tutorials: tutorials/faucet | tutorials/ovs-advanced | tutorials/ovn-sandbox | tutorials/ovn-openstack | tutorials/ovs-conntrack

Architecture topics/design | topics/openflow | topics/integration | topics/porting
DPDK howto/dpdk | topics/dpdk/vhost-user
Windows topics/windows
Integrations: topics/language-bindings
Reference Guides: ref/index
Testing topics/testing
Packaging: intro/install/debian | intro/install/rhel | intro/install/fedora

Learn more about the Open vSwitch project and about how you can contribute:

Community: internals/release-process | internals/authors | internals/mailing-lists | internals/patchwork | internals/bugs | internals/security
Contributing: internals/contributing/submitting-patches | internals/contributing/backporting-patches | internals/contributing/coding-style | internals/contributing/coding-style-windows
Maintaining: internals/charter | internals/maintainers | internals/committer-responsibilities | internals/committer-grant-revocation | internals/committer-emeritus-status
Documentation: internals/contributing/documentation-style | Building Open vSwitch Documentation <intro/install/documentation> | internals/documentation

Seeing an issue of potential bug? Report problems to bugs@openvswitch.org
Looking for specific information? Try the genindex, modindex or the detailed table of contents <contents>.