Update OOF SON use case documentation

Issue-ID: INT-1466
Signed-off-by: Reshmasree <reshmasree.chamarthi2@wipro.com>
Change-Id: I9d2dfac1d7244971553f79359466b2b3c104066d

1 files changed, 44 insertions, 14 deletions

diff --git a/docs/docs_5G_oof_pci.rst b/docs/docs_5G_oof_pci.rst
index 31cfecb0e..04254bc53 100644
--- a/docs/docs_5G_oof_pci.rst
+++ b/docs/docs_5G_oof_pci.rst
@@ -1,6 +1,9 @@
 .. This work is licensed under a Creative Commons Attribution 4.0
    International License. http://creativecommons.org/licenses/by/4.0
-   
+
+.. contents::
+   :depth: 3
+..
 .. _docs_5G_oof_pci:
 
 OOF-PCI
@@ -8,36 +11,63 @@ OOF-PCI
 
 Description
 ~~~~~~~~~~~
-The 5G OOF-PCI use case is an implementation of a SON (Self-Organizing Networks) algorithm for Physical Cell ID (PCI) optimization and the centralized Automatic Neighbor Relations (ANR) function (blacklisting a neighbor for handovers) in a 4G/5G network using the ONAP Optimization Framework (OOF). This use case began with just PCI optimization use case in Casablanca. Further details of Casablanca scope and impacts are described in https://docs.onap.org/en/casablanca/submodules/integration.git/docs/docs_5G_oof_pci.html#docs-5g-oof-pci
+The 5G OOF-PCI use case is an implementation of a SON (Self-Organizing Networks) algorithm
+for Physical Cell ID (PCI) optimization and the centralized Automatic Neighbor Relations
+(ANR) function (blacklisting a neighbor for handovers) in a 4G/5G network using the ONAP
+Optimization Framework (OOF). This use case began with the implementation of PCI
+optimization in Casablanca. In Dublin release, the SON-Handler MS was onboarded asa
+micro-service in DCAE. Enhancements were made to Policy and SDN-C components. Further
+details of Dublin release scope and impacts for this use case are described in:
+https://docs.onap.org/en/dublin/submodules/integration.git/docs/docs_5G_oof_pci.html#docs-5g-oof-pci
+
+In Frankfurt release, the following are the main enhancements:
+
+- Introduction of Control Loop Coordination functionality, wherein a second control loop execution is denied by Policy component when another control loop is in progress.
+
+- Introduction of adaptive SON, wherein a set of cells whose PCI values are fixed (i.e., cannot be changed during PCI optimization) are considered during the PCI optimization.
+
+- In addition, the first step towards O-RAN alignment is being taken with SDN-C (R) being able to receive a DMaaP message containing configuration updates (which would be triggered when a neighbor-list-change occurs in the RAN and is communicated to ONAP over VES).
 
-For Dublin release, the earlier PCI-Handler MS which was a standalone MS is renamed as SON-Handler MS and onboarded as a micro-service in DCAE. Enhancements were made to Policy and SDN-C. The Config DB functionality (containing configuration details of the RAN), and some of the additions/fixes done to SDN-C are not part of the official Dublin release functionality, but are part of the full use case are only a Proof Of Concept (POC). These code changes in SDN-C are targeted for submission in El Alto release.
+As part of this use case work, a RAN Simulator providing a simulated Radio Access Network
+(RAN) with a number of netconf servers simulating PNF elements has been implemented. The
+functionality of the RAN Simulator includes:
 
-In addition, the POC also has a RAN Simulator providing a simulated Radio Access Network (RAN) with a number of netconf servers simulating PNF elements. The functionality of the RAN Simulator has also been enhanced from the Casablanca use case to (a) generate alarms for PCI collision/confusion and (b) generate handover metrics for the different neighbor pairs (for the ANR use case). 
+- Generation of neighbor-list-update messages
 
-All details regarding the use case for Dublin can be found here:
-https://wiki.onap.org/display/DW/OOF-PCI+Use+Case+-+Dublin+Release+-+ONAP+based+SON+for+PCI+and+ANR
+- Generation of alarms for PCI collision/confusion and
+
+- Generation of handover metrics for different neighbor pairs (for the ANR use case).
+
+All above functionality are enabled using a simple UI.
+
+All details regarding the use case for Frankfurt can be found here:
+https://wiki.onap.org/display/DW/OOF+%28SON%29+in+R5+El+Alto%2C+OOF+%28SON%29+in+R6+Frankfurt
 
 The main use case page is https://wiki.onap.org/display/DW/5G+-+OOF+%28ONAP+Optimization+Framework%29+and+PCI+%28Physical+Cell+ID%29+Optimization
 
 
 How to Use
 ~~~~~~~~~~
-The OOF-PCI use case is implemented in the Rutgers University (Winlab) ONAP Wireless Lab (OWL). For details, please see: https://wiki.onap.org/pages/viewpage.action?pageId=45298557 .
-This page includes instructions for access to the lab. Since this is a POC at this stage, testing is done manually. 
+The OOF-PCI use case is implemented in the Rutgers University (Winlab) ONAP Wireless Lab (OWL).
+For details, please see: https://wiki.onap.org/pages/viewpage.action?pageId=45298557.
+This page includes instructions for access to the lab. Setup and testing is done manually up to now.
 
-For all instructions about installing the components and test plans, please see:
+For all instructions about installing the components, please see:
 
-https://wiki.onap.org/display/DW/Installation+Aspects
-Son-handler installation -  https://onap.readthedocs.io/en/latest/submodules/dcaegen2.git/docs/sections/services/son-handler/installation.html
+Installation - https://wiki.onap.org/display/DW/Demo+setup+steps
 
+Son-handler installation -  https://onap.readthedocs.io/en/latest/submodules/dcaegen2.git/docs/sections/services/son-handler/installation.html
 
 
 Test Status and Plans
 ~~~~~~~~~~~~~~~~~~~~~
-For Dublin release, the OOF-PCI use case is a Proof of Concept (POC). OOF was enhanced with joint PCI-ANR optimization, SON-Handler MS was functionally enhanced and also onboarded on to DCAE, and Policy was also enhanced with a new control loop for ANR and control loop extension to receive feedback of actions. The pairwise testing was done in Windriver lab (https://wiki.onap.org/display/DW/Integration+Testing). Other non-release functions are all tested as part of the PoC in the Rutgers University (Winlab) ONAP Wireless Lab (OWL). To see information about test plans, please see https://wiki.onap.org/display/DW/Functional+Testing and https://wiki.onap.org/display/DW/Use+case+testing.
+For Frankfurt release, the enhancements described above were implemented. OOF was enhanced
+with handling cells with fixed PCI values during the optimization, SON-Handler MS was
+functionally enhanced for adaptive SON functionality, SDN-C (R) was enhanced to include
+handling of DMaaP message for config changes in the RAN, and Policy was also enhanced with
+Control Loop Co-ordination function. To see information about test plans, please see https://wiki.onap.org/display/DW/Testing.
 
 
 Known Issues and Resolutions
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-(a) 2 known issues (Medium): CCSDK-1399 and CCSDK-1400
-(b) It is intended to have the RAN Simulator support sufficient Honeycomb netconf server instances to simulate 2000 cells. However, this number may be lower if there are hardware limitatons.
+It is intended to have the RAN Simulator support sufficient Honeycomb netconf server instances to simulate 2000 cells. However, this number may be lower if there are hardware limitatons.