docs: Add initial documentation
[ovsnfv.git] / docs / userguides / quickstart.rst
1 ============
2 Open vSwitch
3 ============
4
5 Open vSwtich (OVS) is a software switch commonly used in OpenStack deployments
6 to replace Linux bridges as it offers advantages in terms of mobility, hardware
7 integration and use by network controllers.
8
9 ================
10 OPNFV Installers
11 ================
12
13 Currently not all installers are supported.
14
15 Fuel Installer
16 --------------
17
18 OVSNFV project supplies a Fuel Plugin to upgrades Open vSwitch on an OPNFV
19 installation to use user-space datapath.
20
21 As part of the upgrade the following changes are also made:
22
23 * change libvirt on compute node to 1.2.12
24 * change qemu on compute node to 2.2.1
25 * installs DPDK 2.0.0
26 * installs OVS 2.1 (specifically git tag 1e77bbe)
27 * removes existing OVS neutron plugin
28 * installs new OVS plugin as part of networking_ovs_dpdk OpenStack plugin
29   version stable/kilo
30 * work around _set_device_mtu issue
31
32 Limitations
33 ~~~~~~~~~~~
34
35 This release should be considered experimental. In particular:
36
37 * performance will be addressed specifically in subsequent releases.
38 * OVS and other components are updated only on compute nodes.
39
40 Bugs
41 ~~~~
42
43 * There may be issues assigning floating and public ip address to VMs.
44