# Installing Open vSwitch

A collection of guides detailing how to install Open vSwitch in a variety of different environments and using different configurations.

## Installation from Source

- Open vSwitch on Linux, FreeBSD and NetBSD
  - Obtaining Open vSwitch Sources
  - Build Requirements
  - Installation Requirements
  - Bootstrapping
  - Configuring
  - Building
  - Starting
  - Starting OVS in container
  - Validating
  - Upgrading
  - Hot Upgrading
  - Reporting Bugs
- Open vSwitch on NetBSD
- Open vSwitch on Windows
  - Build Requirements
  - Install Requirements
  - Bootstrapping
  - Configuring
  - Building
  - Starting
  - Validating
  - Windows Services
  - Windows CI Service
  - TODO
- Open vSwitch without Kernel Support
  - Building and Installing
  - Using the Userspace Datapath with ovs-vswitchd
  - Firewall Rules
  - Other Settings
  - Reporting Bugs
- Open vSwitch with DPDK
  - Build requirements
  - Installing
  - Setup
  - Validating
  - Performance Tuning
  - Limitations
  - Reporting Bugs
- Open vSwitch with AF_XDP
  - Introduction
  - AF_XDP Netdev
  - Build requirements
  - Installing
  - Setup AF_XDP netdev
  - References
  - Performance Tuning
  - Example Script
  - Limitations/Known Issues
  - PVP using tap device
  - PVP using vhostuser device
  - PCP container using veth
  - Bug Reporting

## Installation from Packages

Open vSwitch is packaged on a variety of distributions. The tooling required to build these packages is included in the Open vSwitch tree. The instructions are provided below.

- Distributions packaging Open vSwitch
  - Debian / Ubuntu
  - Fedora
  - Red Hat
  - OpenSuSE
- Debian Packaging for Open vSwitch
  - Before You Begin
  - Building Open vSwitch Debian packages
  - Installing .deb Packages
  - Reporting Bugs
- Fedora, RHEL 7.x Packaging for Open vSwitch
  - Build Requirements
  - Bootstrapping
  - Configuring
  - Building
  - Installing
  - Reporting Bugs
- RHEL 5.6, 6.x Packaging for Open vSwitch
  - Prerequisites
  - Build Requirements
  - Bootstrapping and Configuring
  - Building
  - Red Hat Network Scripts Integration
  - Reporting Bugs

## Others

- Bash command-line completion scripts
  - ovs-appctl-bashcomp
  - ovs-vsctl-bashcomp
  - Usage
  - Tests
- Open vSwitch Documentation
  - Build Requirements
  - Configuring
  - Building