Update docs for SON-Handler MS for Frankfurt release
Issue-ID: DCAEGEN2-2104
Signed-off-by: Reshmasree <reshmasree.chamarthi2@wipro.com>
Change-Id: Ic1ad13859d2862e9b223c3af39be98307f8925a5
diff --git a/docs/sections/services/son-handler/index.rst b/docs/sections/services/son-handler/index.rst
index 79bcb2d..80f52c7 100644
--- a/docs/sections/services/son-handler/index.rst
+++ b/docs/sections/services/son-handler/index.rst
@@ -9,8 +9,9 @@
**SON-Handler MS** is introduced in ONAP for implementing the pre-processing and co-ordination actions of various RAN SON use cases.
-As of now PCI optimization and ANR updates are handled in Dublin release.
-OOF, SON Handler MS, DCAE, VES Collector, Policy, DMaaP and SDNR are involved in this use case implementation.
+PCI optimization and centralized ANR updates are handled in Frankfurt release.
+
+OOF, DCAE - SON Handler MS and VES Collector, Policy, DMaaP and SDN-C (SDN-R) are involved in the realization of this use case.
.. image:: flowdiagram.jpg
diff --git a/docs/sections/services/son-handler/installation.rst b/docs/sections/services/son-handler/installation.rst
index edfcb39..17f6e74 100644
--- a/docs/sections/services/son-handler/installation.rst
+++ b/docs/sections/services/son-handler/installation.rst
@@ -55,11 +55,20 @@
Deployment steps
~~~~~~~~~~~~~~~~
+1.Using DCAE Dashboard
+ - Login to DCAE Dashboard
+ - Go to Inventory --> Blueprints
+ - Upload son-handler blueprint which can be found under blueprints repo (https://gerrit.onap.org/r/dcaegen2/platform/blueprints)
+ - Click on Deploy Action for son-handler blueprint
+ - Deployment logs can be viewed under Deployments section
+
+2.Using cloudify commands
+
- Login to the bootstrap container
kubectl exec -ti --namespace onap <bootstrap pod name> bash
-- Copy the blueprints and inputs file to the bootstrap container. The blueprint and a sample input file can be found under dpo/blueprints directory of son-hanler project. (https://gerrit.onap.org/r/dcaegen2/services/son-handler)
+- The blueprint can be found under dcaegen2 blueprint repo and is part of bootstrap container. (https://gerrit.onap.org/r/dcaegen2/platform/blueprints)
- Deploy the microservice into the cloudify using the following command
- cfy install -d sonhms -b sonhms -i <inputs file path> <blueprint file path>
+ cfy install -d sonhms -b sonhms <blueprint file path>
- Deployment status of the microservice can be found from kubernetes pods status (MS will be deployed as a k8s pod in the kubernetes environment under the same namespace as the DCAE environment).
kubectl get pods --namespace onap
- To uninstall the microservice
@@ -119,4 +128,3 @@
+-------------------------------+------------------------------------------------+
|sonhandler.optimizers | Optimizer to trigger in OOF |
+-------------------------------+------------------------------------------------+
-
diff --git a/docs/sections/services/son-handler/son_handler_overview.rst b/docs/sections/services/son-handler/son_handler_overview.rst
index 41dbd84..62dc12a 100644
--- a/docs/sections/services/son-handler/son_handler_overview.rst
+++ b/docs/sections/services/son-handler/son_handler_overview.rst
@@ -28,15 +28,30 @@
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.
+In Frankfurt release, adaptive SON functionality was introduced for PCI optimization. While determining the optimum PCI values to resolve PCI collision and confusion, the optimizer also takes into consideration a set of cells whose PCI values may not be changed during the optimization. Such situations could arise, for example, when the PCI value of a cell could not be updated in the past (due to whatever reason), or configuration policy specifies that certain cells’ PCI values should never be changed. So, the SON-Handler MS keeps track of cells whose PCI values cannot be changed. When triggering OOF for PCI optimization, the SON-Handler MS also provides the list of cells whose PCI values cannot be changed.
+
+
+Details of Frankfurt implementation are available in https://wiki.onap.org/display/DW/SON-Handler+MS+%28DCAE%29+Impacts.
+
+
Database
~~~~~~~~
This is a PostgreSQL DB, and is intended to persist information such as the following:
+
- PCI-Handler MS Config information (e.g., thresholds, timer values, OOF algorithm name, etc.)
+
- Pre-processing results and other related information (e.g., neighbor list)
+
- Buffered notifications (i.e., notifications not yet processed at all)
+
- State information
+
- Association between PNF-name and CellId
-- PM/FM data
+
+- Aggregated PM/FM data
+
+- List of cells whose PCI values are fixed
+
- Etc.
DMaaP Client
@@ -45,8 +60,9 @@
Deployment aspects
------------------
-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.
+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.Details of the installation steps are available at ./installation.rst. Further details can be obtained from https://wiki.onap.org/pages/viewpage.action?pageId=76875778.
Known Issues and Resolutions
----------------------------
-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
+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.
+The enhancements and limitations in Frankfurt release are documented in the SON use case page for Frankfurt - https://wiki.onap.org/display/DW/OOF+%28SON%29+in+R5+El+Alto%2C+OOF+%28SON%29+in+R6+Frankfurt.