Add developer doc outline for OVSDB MDSAL southbound

Did not think the MDSAL southbound needed an installation
or user guide.

v2 - add to the bk-developers-guide.adoc as a chapter

Change-Id: I200bb1d47350f7aed242b10443ca32657143bf3c
Signed-off-by: Eric Multanen <eric.w.multanen@intel.com>

diff --git a/manuals/developer-guide/src/main/asciidoc/bk-developers-guide.adoc b/manuals/developer-guide/src/main/asciidoc/bk-developers-guide.adoc
index 891da874361ca54096db116d0fdbd8c23dfb108a..ff48629d79ce22cc332138749f89c45c67104b5d 100644 (file)
--- a/manuals/developer-guide/src/main/asciidoc/bk-developers-guide.adoc
+++ b/manuals/developer-guide/src/main/asciidoc/bk-developers-guide.adoc
@@ -72,6 +72,8 @@ include::openflowplugin.adoc[]
 
 include::ovsdb.adoc[]
 
+include::ovsdb/ovsdb-southbound-developer.adoc[]
+
 include::pcmm.adoc[]
 
 include::plugin2oc.adoc[]

diff --git a/manuals/developer-guide/src/main/asciidoc/ovsdb/ovsdb-southbound-developer.adoc b/manuals/developer-guide/src/main/asciidoc/ovsdb/ovsdb-southbound-developer.adoc
new file mode 100644 (file)
index 0000000..b1dfa8e
--- /dev/null
+++ b/manuals/developer-guide/src/main/asciidoc/ovsdb/ovsdb-southbound-developer.adoc
@@ -0,0 +1,21 @@
+== OVSDB MDSAL Southbound Plugin Developer Guide
+
+=== Overview
+The OVSDB MDSAL Southbound provides an MDSAL interface to interact
+with OVSDB nodes.
+
+=== OVSDB MDSAL Southbound Plugin Architecture
+This describes the architecture of the OVSDB MDSAL southbound plugin.
+
+=== Key APIs and Interfaces
+
+==== OVSDB Model
+Provide a description of what the API does and some examples of how to
+use it.
+
+==== Tunnel Overlay Model
+Provide a description of what the API does and some examples of how to
+use it.
+
+=== API Reference Documentation
+Provide links to JavaDoc, REST API documentation, etc.