c70d8bce85274923dad844327dabd740fbb06fc1
[docs.git] / manuals / developer-guide / src / main / asciidoc / ovsdb / ovsdb-openstack-developer.adoc
1 == OVSDB Openstack Developer Guide
2
3 === Overview
4 The Open vSwitch database (OVSDB) Plugin component for OpenDaylight implements
5 the OVSDB  https://tools.ietf.org/html/rfc7047[RFC 7047] management protocol
6 that allows the southbound configuration of switches that support OVSDB.The
7 component comprises a library and a plugin usages. The OVSDB protocol
8 uses JSON-RPC calls to manipulate a physical or virtual switch that supports OVSDB. 
9 Many vendors support OVSDB on various hardware platforms.
10 The OpenDaylight controller uses the library project to interact with an OVS
11 instance.
12
13 http://www.openstack.org[OpenStack] is a popular open source infrastructure
14 as a service project, covering compute, storage and network management.
15 OpenStack can use OpenDaylight as its network management provider through the
16 Neutron API, which acts as a northbound for OpenStack. The providers for
17 the Neutron API are in the OVSDB Net-virt piece of OVSDB.
18 OpenDaylight manages the network flows for the OpenStack compute nodes via
19 the OVSDB project, with the south-bound plugin. This section describes how to
20 set that up, and how to tell when everything is working.
21
22 === OVSDB Openstack Architecture
23 The OpenStack integration architecture uses the following technologies: +
24
25 * https://tools.ietf.org/html/rfc7047[RFC 7047] and http://datatracker.ietf.org/doc/rfc7047/[The Open vSwitch Database Management Protocol]
26 * https://www.opennetworking.org/images/stories/downloads/sdn-resources/onf-specifications/openflow/openflow-spec-v1.3.1.pdf[OpenFlow v1.3]
27 * https://wiki.openstack.org/wiki/Neutron/ML2[OpenStack Neutron ML2 Plugin]
28
29 image:openstack_integration.png[Openstack Integration]
30
31 === Key APIs and Interfaces
32 TBD
33
34 ==== API Group 1
35 TBD
36
37 ==== API Group 2
38 TBD
39
40 === API Reference Documentation
41 TBD