Added OVSDB M4 draft

Change-Id: I47ff08439b0f112d4351a1675ad0a8a81bffefe6
Signed-off-by: Gabriel Robitaille-Montpetit <[email protected]>

Author: Gabriel Robitaille-Montpetit

manuals/developer-guide/src/main/asciidoc/ovsdb/ovsdb-northbound-developer.adoc

@@ -1,19 +1,31 @@
 == OVSDB Northbound Developer Guide
 
 === Overview
-TBD
+The OVSDB Northbound feature's goal is to give low level access to
+an OVS instance. For instance, one would like to be able to directly create, read, update and delete rows into an OVS instance by using RESTCONF.
+
+The target audience for this feature is one that needs low level
+access to an OVS instance from inside OpenDaylight
 
 === OVSDB Northbound Developer Architecture
-TBD
+The northbound bundle architecture is as follow:
 
-=== Key APIs and Interfaces
-TBD
+- mdsal-northbound-aggregator
+
+- mdsal-northbound-api
 
-==== API Group 1
-TBD
+- mdsal-northbound-impl
 
-==== API Group 2
-TBD
+- mdsal-northbound-features
 
-=== API Reference Documentation
-TBD
+
+=== Key APIs and Interfaces
+[width="80%",cols="10%,10%,10%,70%"]
+|=======
+|Type | Action | Input | URL
+|PUT | Insert Row |Row Data | restconf/config/network-topology:network-topology/topology/ovsdb:1/\{nodeId\}/tables/\{tableName\}/rows
+|GET | Show Row |N/A | restconf/config/network-topology:network-topology/topology/ovsdb:1/\{nodeId\}/tables/\{tableName\}/rows/\{rowUuid\}
+|GET | Show All Row |N/A | restconf/config/network-topology:network-topology/topology/ovsdb:1/\{nodeId\}/tables/\{tableName\}/rows
+|PUT | Update Row |Row Data | restconf/config/network-topology:network-topology/topology/ovsdb:1/\{nodeId\}/tables/\{tableName\}/rows/\{rowUuid\}
+|DELETE | Delete Row |N/A | restconf/config/network-topology:network-topology/topology/ovsdb:1/\{nodeId\}/tables/\{tableName\}/rows/\{rowUuid\}
+|=======

manuals/developer-guide/src/main/asciidoc/ovsdb/ovsdb-openstack-developer.adoc

@@ -1,10 +1,32 @@
 == OVSDB Openstack Developer Guide
 
 === Overview
-TBD
+The Open vSwitch database (OVSDB) Plugin component for OpenDaylight implements
+the OVSDB  https://tools.ietf.org/html/rfc7047[RFC 7047] management protocol
+that allows the southbound configuration of switches that support OVSDB.The
+component comprises a library and a plugin usages. The OVSDB protocol
+uses JSON-RPC calls to manipulate a physical or virtual switch that supports OVSDB. 
+Many vendors support OVSDB on various hardware platforms.
+The OpenDaylight controller uses the library project to interact with an OVS
+instance.
+
+http://www.openstack.org[OpenStack] is a popular open source infrastructure
+as a service project, covering compute, storage and network management.
+OpenStack can use OpenDaylight as its network management provider through the
+Neutron API, which acts as a northbound for OpenStack. The providers for
+the Neutron API are in the OVSDB Net-virt piece of OVSDB.
+OpenDaylight manages the network flows for the OpenStack compute nodes via
+the OVSDB project, with the south-bound plugin. This section describes how to
+set that up, and how to tell when everything is working.
 
 === OVSDB Openstack Architecture
-TBD
+The OpenStack integration architecture uses the following technologies: +
+
+* https://tools.ietf.org/html/rfc7047[RFC 7047] and http://datatracker.ietf.org/doc/rfc7047/[The Open vSwitch Database Management Protocol]
+* https://www.opennetworking.org/images/stories/downloads/sdn-resources/onf-specifications/openflow/openflow-spec-v1.3.1.pdf[OpenFlow v1.3]
+* https://wiki.openstack.org/wiki/Neutron/ML2[OpenStack Neutron ML2 Plugin]
+
+image:openstack_integration.png[Openstack Integration]
 
 === Key APIs and Interfaces
 TBD

manuals/developer-guide/src/main/resources/images/openstack_integration.png

@@ -1,4 +1,2 @@
 
-include::ovsdb-northbound-install.adoc[]
-
 include::ovsdb-openstack-install.adoc[]

manuals/getting-started-guide/src/main/asciidoc/ovsdb/ovsdb-install.adoc

@@ -1,29 +1,67 @@
 == OVSDB Openstack Installation Guide
-TBD
 
 === Overview
-TBD
+This guide is geared towards installing OpenDaylight to use the OVSDB project to provide Neutron support for OpenStack.
+
+Open vSwitch (OVS) is generally accepted as the unofficial standard for Virtual Switching in the Open hypervisor based solutions.
+For information on OVS, see http://openvswitch.org/[Open vSwitch].
+
+With OpenStack within the SDN context, controllers and applications interact using two channels: OpenFlow and OVSDB. OpenFlow addresses the forwarding-side of the OVS functionality. OVSDB, on the other hand, addresses the management-plane.
+A simple and concise overview of Open Virtual Switch Database (OVSDB) is available at: http://networkstatic.net/getting-started-ovsdb/
 
 === Pre Requisites for Installing OVSDB Openstack
-TBD
+* JRE 1.7+
+* A distribution of OpenDaylight
 
 === Preparing for Installation
-TBD
+. Download a copy of the latest OpenDaylight release in a Pre-Build archive of your choosing.
+http://www.opendaylight.org/software/downloads[Download OpenDaylight]
+
 
 === Installing OVSDB Openstack
-TBD
+. Extract the OpenDaylight distribution somewhere.
+. Navigate to the /bin/ directory
+. Execute the karaf binary file, that should bring up the OpenDaylight console
+. Install the required features with these commands:
+feature:install odl-ovsdb-openstack
+
+===== Sample output from the Karaf console
+----
+opendaylight-user@root>feature:list | grep -i ovsdb
+odl-ovsdb-all                    | 1.0.0-SNAPSHOT      |           | ovsdb-1.0.0-SNAPSHOT
+OpenDaylight :: OVSDB :: all
+odl-ovsdb-library                | 1.0.0-SNAPSHOT      | x         | ovsdb-1.0.0-SNAPSHOT
+OVSDB :: Library
+odl-ovsdb-schema-openvswitch     | 1.0.0-SNAPSHOT      | x         | ovsdb-1.0.0-SNAPSHOT
+OVSDB :: Schema :: Open_vSwitch
+odl-ovsdb-schema-hardwarevtep    | 1.0.0-SNAPSHOT      | x         | ovsdb-1.0.0-SNAPSHOT
+OVSDB :: Schema :: hardware_vtep
+odl-ovsdb-plugin                 | 1.0.0-SNAPSHOT      | x         | ovsdb-1.0.0-SNAPSHOT
+OpenDaylight :: OVSDB :: Plugin
+odl-ovsdb-northbound             | 0.6.0-SNAPSHOT      |           | ovsdb-1.0.0-SNAPSHOT
+OpenDaylight :: OVSDB :: Northbound
+odl-ovsdb-openstack              | 1.0.0-SNAPSHOT      | x         | ovsdb-1.0.0-SNAPSHOT
+OpenDaylight :: OVSDB :: OpenStack Network Virtual
+odl-ovsdb-ovssfc                 | 0.0.1-SNAPSHOT      |           | ovsdb-0.0.1-SNAPSHOT
+OpenDaylight :: OVSDB :: OVS Service Function Chai
+odl-openflow-nxm-extensions      | 0.0.3-SNAPSHOT      | x         | ovsdb-0.0.3-SNAPSHOT
+OpenDaylight :: Openflow :: Nicira Extensions
+----
 
 === Verifying your Installation
-TBD
+To verify that the installation was successful, use the log:display command in karaf and check that there are no errors
+logs relating to odl-ovsdb-openstack.
 
 ==== Troubleshooting
-TBD
-
-=== Post Installation Configuration
-TBD
+There are no easy way to troubleshoot an installation of odl-ovsdb-openstack. Perhaps a combination of
+log:display | grep -i ovsdb in karaf, Open vSwitch commands (ovs-vsdctl) and openstack logs will be useful but will not
+explain everything.
 
 === Upgrading From a Previous Release
-TBD
+Upgrading from upstream
+
+Upgrading from release
 
 === Uninstalling OVSDB Openstack
-TBD
+. Shutdown the karaf instance: system:shutdown
+. Remove what is in the /data folder of the OpenDaylight Distribution.