Update OOF PCI document
[integration.git] / docs / docs_5G_oof_pci.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0
2    International License. http://creativecommons.org/licenses/by/4.0
3
4 .. contents::
5    :depth: 3
6 ..
7 .. _docs_5G_oof_pci:
8
9
10 OOF-PCI
11 --------
12
13 Description
14 ~~~~~~~~~~~
15
16 The 5G OOF-PCI use case is an implementation of a SON (Self-Organizing Networks) algorithm
17 for Physical Cell ID (PCI) optimization and the centralized Automatic Neighbor Relations
18 (ANR) function (blacklisting a neighbor for handovers) in a 4G/5G network using the ONAP
19 Optimization Framework (OOF). This use case began with the implementation of PCI
20 optimization in Casablanca. In Dublin release, the SON-Handler MS was onboarded as a
21 micro-service in DCAE. Enhancements were made to Policy and SDN-C components. Further
22 details of Dublin release scope and impacts for this use case are described in:
23 https://docs.onap.org/en/dublin/submodules/integration.git/docs/docs_5G_oof_pci.html#docs-5g-oof-pci
24
25 .. image:: https://wiki.onap.org/download/attachments/81401601/image2020-3-26_5-40-10.png?version=1&modificationDate=1585219211000&api=v2
26     :alt: OOF-PCI
27
28 In Frankfurt release, the following are the main enhancements:
29
30 - Introduction of Control Loop Coordination functionality, wherein a second control loop execution is
31   denied by Policy component when another control loop is in progress.
32 - Introduction of adaptive SON, wherein a set of cells whose PCI values are fixed (i.e., cannot be changed
33   during PCI optimization) are considered during the PCI optimization.
34 - In addition, the first step towards O-RAN alignment is being taken with SDN-C (R) being able to receive a DMaaP
35   message containing configuration updates (which would be triggered when a neighbor-list-change occurs in the RAN
36   and is communicated to ONAP over VES). Details of this implementation is available at:
37   https://wiki.onap.org/display/DW/CM+Notification+Support+in+ONAP
38
39
40 In Guilin release, the main enhancement was related to taking the first steps for enabling Machine-Learning (ML) based
41 SON functionality. Training is assumed to be done offline, and the ML model is then onboarded to ONAP as part
42 of OOF. The ML model provides additional inputs (based on the handover PM data) to the optimizer about cells
43 whose PCI values should not be modified during the PCI optimization process. To be able to do this, the ML model
44 that is part of OOF fetches historical PM data from a data base/data lake using the DES micro-service (in DCAE)
45 APIs. This is a new capability introduced in OOF which can be extended further for other scenarios. To be backward
46 compatible, the functionality in OOF to invoke the ML model for additional inputs before PCI optimization is
47 performed is configurable.
48
49 The end-to-end setup for the use case requires a Config DB which stores the cell related details of the RAN. This is
50 updated by SDN-C (R), and is accessed by SON-Handler MS and OOF for fetching, e.g., neighbor list, PNF id, etc.
51
52 The Config DB implementation is available at:
53 https://github.com/onap-oof-pci-poc/sdnc/tree/master/ConfigDB/Dublin
54
55 Swagger JSON API documentation can be found at:
56 https://github.com/onap-oof-pci-poc/sdnc/blob/master/ConfigDB/Dublin/SDNC_ConfigDB_API_v3.0.0.json
57
58 As part of this use case work, a RAN Simulator providing a simulated Radio Access Network (RAN) with a number of
59 netconf servers simulating PNF elements has been implemented. The functionality of the RAN Simulator includes:
60
61 - Generation of neighbor-list-update messages
62 - Generation of alarms for PCI collision/confusion and
63 - Generation of handover metrics for different neighbor pairs (for the ANR use case).
64
65 All above functionality are enabled using a simple UI.
66 All details regarding the use case for Guilin can be found here:
67 https://wiki.onap.org/display/DW/R7+OOF+SON+Use+Case
68
69 All details regarding the use case for Frankfurt can be found here:
70 https://wiki.onap.org/display/DW/OOF+%28SON%29+in+R5+El+Alto%2C+OOF+%28SON%29+in+R6+Frankfurt
71
72 The main use case page is:
73 https://wiki.onap.org/display/DW/5G+-+OOF+%28ONAP+Optimization+Framework%29+and+PCI+%28Physical+Cell+ID%29+Optimization
74
75 How to Use
76 ~~~~~~~~~~
77
78 The OOF-PCI use case is set up in the Rutgers University (Winlab) ONAP Wireless Lab (OWL). For details, please see:
79 https://wiki.onap.org/pages/viewpage.action?pageId=45298557.
80
81 This page includes instructions for access to the lab. Setup and testing is done manually up to now.
82
83 For all instructions about installing the components, please see:
84
85 - Frankfurt Installation: https://wiki.onap.org/display/DW/Demo+setup+steps+for+Frankfurt
86 - Guilin Installation: https://wiki.onap.org/display/DW/SON+use+case+demo+setup+steps+for+Guilin
87 - Son-Handler installation: https://docs.onap.org/projects/onap-dcaegen2/en/frankfurt/sections/services/son-handler/installation.html?highlight=dcaegen2
88
89 Test Status and Plans
90 ~~~~~~~~~~~~~~~~~~~~~
91
92 For Guilin release, the enhancements described above were implemented. OOF was enhanced with invoking the onboarded
93 ML model for additional inputs on cells with fixed PCI values during the optimization.
94
95 To see information about test plans, please see https://wiki.onap.org/display/DW/Integration+Test+for+Guilin.
96
97 Known Issues and Resolutions
98 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
99
100 (a) It is intended to have the RAN Simulator support sufficient Honeycomb netconf server instances to simulate 2000 cells.
101     However, this number may be lower if there are hardware limitatons.
102 (b) For Control Loop Co-ordination, the denial of a second Control Loop based on Target Lock (i.e., when a second Control
103     Loop tries to operate on the same target (in this case, a PNF) is successfully tested.
104     The CLC is also applied at Control Loop level only.
105 (c) There are some limitations in the DES APIs with respect to supporting generic queries. These will be addressed in
106     Honolulu release and beyond.