Release version 1.3.1

[ccsdk/features.git] / sdnr / wt / README.md

diff --git a/sdnr/wt/README.md b/sdnr/wt/README.md
index 1a8d1e9..2b19ff6 100644 (file)
--- a/sdnr/wt/README.md
+++ b/sdnr/wt/README.md
@@ -1,33 +1,60 @@
 # wt - wireless transport microservices
 
-## apigateway
+ODL version: aluminium sr1
 
-The API gateway provides WEB access to all wt related web service providers to prevent cross site requests. The Opendaylight default UI port is extendet by additonal URIs.
+## apigateway (osgi)
+
+The API gateway provides WEB access to all wt related web service providers to prevent cross site requests. The Opendaylight default Web server is extended by additional URIs.
 
   * /database to access elasticsearch
   * /aai to access AAI
-  * /ms to access mediator servers
 
-## devicemodel
+## common (osgi)
 
-Model classes, specified by ONF Model and provided as yang files for Java class generation for NETCONF devices.
+Common classes, included into most bundles
 
-## websocketmanager2
+## common-yang (osgi)
 
-Notification service for browser clients.
+yang files converted into jar bundles. Preferred way to include basic yang specs into a devicemanager project.
 
-## devicemanager
+## data-provider (osgi)
 
-Management application for NETCONF devices.
+Interface to devicemanager database. In Frankfurt database is elasticsearch.
 
-## odlux
+## devicemanager (osgi)
 
-Web applications for user operations for devices
+Devicemanager services, used by specfic devicemanagers for NETCONF devices.
+
+## devicemanager-specific (osgi)
 
-## helpserver
+Devicemanager implementation for specfic devicemodel.
+
+## featureaggregator (osgi)
+
+karaf features
+  * sdnr-wt-feature-aggregator to start all services
+  * sdnr-wt-feature-aggregator-devicemanager to start devicemanager service
+
+## helpserver (osgi)
 
 Providing help pages for related web applications
 
-## featureaggregator
+## netconfnode-state-provider (osgi)
+
+Provide netconf state information to devicemanager and mountpoint-state-provider
+
+## odlux (osgi)
+
+Web applications for user operations for devices
+
+## websocketmanager (osgi)
+
+Notification service for browser clients.
+
+## readthedocs
 
-karaf feature with name sdnr-wt-feature-aggregator to start all services.
+readthedocs - Providing documentation. Scripts to convert documentation within helpserver to the [ccsdk/features]/doc folder
+~
+~
+~
+~