Documentation outline for DIDM

Patch Set 2: Rebased to master and removed *~ files.
Patch Set 3: Fixed a few typos and wrapped lines to 80 characters.
Patch Set 4: Merged edits from a fix up from Gunjan
Patch Set 5: Making a few final formatting fixes

Change-Id: I691e21d09b55cf87ba43c2419cfc14f44dfec5a6
Signed-off-by: gunjan5 <patelgunjan5@gmail.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 8012fd687d922a408f3ccfddb0995549f07626a2..436c98316e4688ea681b4584a85951946ba5b41c 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::ttp/ttp-model-dev.adoc[]
 
 include::ttp/ttp-cli-tools-dev.adoc[]
 
+include::didm/didm-dev.adoc[]
+
 :numbered!:
 
 ///////

diff --git a/manuals/developer-guide/src/main/asciidoc/didm/didm-dev.adoc b/manuals/developer-guide/src/main/asciidoc/didm/didm-dev.adoc
new file mode 100644 (file)
index 0000000..74a0bcf
--- /dev/null
+++ b/manuals/developer-guide/src/main/asciidoc/didm/didm-dev.adoc
@@ -0,0 +1,42 @@
+== DIDM Developer Guide
+
+=== Overview
+The Device Identification and Driver Management (DIDM) project addresses the
+need to provide device-specific functionality. Device-specific functionality is
+code that performs a feature, and the code is knowledgeable of the capability
+and limitations of the device. For example, configuring VLANs and adjusting
+FlowMods are features, and there may be different implementations for different
+device types. Device-specific functionality is implemented as Device Drivers.
+Device Drivers need to be associated with the devices they can be used with. To
+determine this association requires the ability to identify the device type.
+
+=== DIDM Architecture
+The DIDM project creates the infrastructure to support the following functions:
+
+ * *Discovery* - Determination that a device exists in the controller
+   management domain and connectivity to the device can be established. For
+   devices that support the OpenFlow protocol, the existing discovery
+   mechanism in OpenDaylight suffices. Devices that do not support OpenFlow
+   will be discovered through manual means such as the operator entering
+   device information via GUI or REST API.
+ * *Identification* – Determination of the device type.
+ * *Driver Registration* – Registration of Device Drivers as routed RPCs.
+ * *Synchronization* – Collection of device information, device configuration,
+   and link (connection) information.
+ * *Data Models for Common Features* – Data models will be defined to
+   perform common features such as VLAN configuration. For example,
+   applications can configure a VLAN by writing the VLAN data to the data store
+   as specified by the common data model.
+ * *RPCs for Common Features* – Configuring VLANs and adjusting
+   FlowMods are example of features. RPCs will be defined that specify the
+   APIs for these features. Drivers implement features for specific devices and
+   support the APIs defined by the RPCs. There may be different Driver
+   implementations for different device types.
+
+TODO: Add more info and diagram. 
+
+=== Key APIs and Interfaces
+TODO
+
+=== API Reference Documentation
+TODO: Provide links to JavaDoc, REST API documentation, etc.

diff --git a/manuals/user-guide/src/main/asciidoc/bk-user-guide.adoc b/manuals/user-guide/src/main/asciidoc/bk-user-guide.adoc
index 5b5b00e8e6d50c815e2bc08434946705bd5dde5c..1cdd9664bf24c8e346e554f4038af4c1464736b6 100644 (file)
--- a/manuals/user-guide/src/main/asciidoc/bk-user-guide.adoc
+++ b/manuals/user-guide/src/main/asciidoc/bk-user-guide.adoc
@@ -45,3 +45,5 @@ include::capwap/capwap-user.adoc[CAPWAP]
 include::tsdr/tsdr-hbase-user.adoc[]
 
 include::tsdr/tsdr-h2-user.adoc[]
+
+include::didm/didm-user.adoc[]

diff --git a/manuals/user-guide/src/main/asciidoc/didm/didm-user.adoc b/manuals/user-guide/src/main/asciidoc/didm/didm-user.adoc
new file mode 100644 (file)
index 0000000..fb4b2d9
--- /dev/null
+++ b/manuals/user-guide/src/main/asciidoc/didm/didm-user.adoc
@@ -0,0 +1,40 @@
+== DIDM User Guide
+
+=== Overview
+The Device Identification and Driver Management (DIDM) project addresses the
+need to provide device-specific functionality. Device-specific functionality is
+code that performs a feature, and the code is knowledgeable of the capability
+and limitations of the device. For example, configuring VLANs and adjusting
+FlowMods are features, and there may be different implementations for different
+device types. Device-specific functionality is implemented as Device Drivers.
+Device Drivers need to be associated with the devices they can be used with. To
+determine this association requires the ability to identify the device type.
+
+=== DIDM Architecture
+The DIDM project creates the infrastructure to support the following functions:
+
+ * *Discovery* - Determination that a device exists in the controller
+   management domain and connectivity to the device can be established. For
+   devices that support the OpenFlow protocol, the existing discovery
+   mechanism in OpenDaylight suffices. Devices that do not support OpenFlow
+   will be discovered through manual means such as the operator entering
+   device information via GUI or REST API.
+ * *Identification* – Determination of the device type.
+ * *Driver Registration* – Registration of Device Drivers as routed RPCs.
+ * *Synchronization* – Collection of device information, device configuration,
+   and link (connection) information.
+ * *Data Models for Common Features* – Data models will be defined to
+   perform common features such as VLAN configuration. For example,
+   applications can configure a VLAN by writing the VLAN data to the data store
+   as specified by the common data model.
+ * *RPCs for Common Features* – Configuring VLANs and adjusting
+   FlowMods are example of features. RPCs will be defined that specify the
+   APIs for these features. Drivers implement features for specific devices and
+   support the APIs defined by the RPCs. There may be different Driver
+   implementations for different device types.
+
+=== Configuring DIDM
+TODO
+
+=== Administering or Managing DIDM
+TODO