Author: Saravanan A <saravanan.a75@wipro.com>

[dcaegen2.git] / docs / sections / services / son-handler / son_handler_overview.rst

diff --git a/docs/sections/services/son-handler/son_handler_overview.rst b/docs/sections/services/son-handler/son_handler_overview.rst
new file mode 100644 (file)
index 0000000..23abbaa
--- /dev/null
+++ b/docs/sections/services/son-handler/son_handler_overview.rst
@@ -0,0 +1,52 @@
+.. This work is licensed under a Creative Commons Attribution 4.0\r
+   International License. http://creativecommons.org/licenses/by/4.0\r
+   \r
+.. _docs_SON_Handler_MS:\r
+\r
+Architecture\r
+------------\r
+The architecture below depicts the SON-Handler MS as a part of DCAE. Only the relevant interactions and components are shown.\r
+\r
+.. image:: ./dcae_new.jpg\r
+\r
+The internal architecture of SON-Handler MS is shown below.\r
+\r
+.. image:: ./son_handler.jpg\r
+\r
+Description\r
+~~~~~~~~~~~\r
+The SON-Handler MS has a REST interface towards OOF as well as DMaaP interface towards Policy, VES-Collector and SDN-R. It has a database and core logic.\r
+\r
+Core logic\r
+~~~~~~~~~~\r
+The core logic is implemented as 3 threads - main thread, child thread(s) for handling neighbor-list updates and collision/confusion alarms from the RAN (via SDN-R), and a separate child for handling handover measurements (PM) inputs from the RAN (via VES-Collector). The Main Thread is responsible for spawning and terminating the Child Threads. The core logic is responsible for:\r
+(a) Performing all the pre-processing that is required before triggering OOF for PCI as well as PCI/ANR joint-optimization\r
+(b) Autonomously taking actions for ANR updates\r
+(c) Preparing the message contents required by SDN-R to re-configure the RAN nodes with PCI/ANR updates\r
+\r
+The logic may not be 100% fool-proof (i.e., cover all possible scenarios and boundary-counditions as in real field deployments), as well as the most efficient one. An attempt has been made to balance the usefulness for a PoC versus the complexity of handling all possible scenarios. It is intended to provide a good base for the community/users to enhance it further as required.\r
+\r
+The details of the state machines of all the threads in the core logic are available in https://wiki.onap.org/pages/viewpage.action?pageId=56131985.\r
+\r
+Database\r
+~~~~~~~~\r
+This is a PostgreSQL DB, and is intended to persist information such as the following:\r
+- PCI-Handler MS Config information (e.g., thresholds, timer values, OOF algorithm name, etc.)\r
+- Pre-processing results and other related information (e.g., neighbor list)\r
+- Buffered notifications (i.e., notifications not yet processed at all)\r
+- State information\r
+- Association between PNF-name and CellId\r
+- PM/FM data\r
+- Etc.\r
+\r
+DMaaP Client\r
+~~~~~~~~~~~~\r
+This is responsible for registering with the DMaaP client for the DMaaP notifications from SDN-R and VES-Collector, and to Policy.\r
+\r
+Deployment aspects\r
+------------------\r
+The SON-Handler MS will be deployed on DCAE using the mechanism described in "Option 3 - On-Demand deployment through DCAE-Controller cli" at https://wiki.onap.org/display/DW/Dublin+Deployment+Strategy.\r
+\r
+Known Issues and Resolutions\r
+----------------------------\r
+The scope and scenarios addressed are documented in the SON use case page for Dublin - https://wiki.onap.org/display/DW/OOF-PCI+Use+Case+-+Dublin+Release+-+ONAP+based+SON+for+PCI+and+ANR.
\ No newline at end of file