Update OOF_SON use case documentation
[integration.git] / docs / docs_5G_oof_pci.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0
2
3    International License. http://creativecommons.org/licenses/by/4.0
4
5
6 .. contents::
7
8    :depth: 3
9
10 ..
11
12 .. _docs_5G_oof_pci:
13
14
15 OOF-PCI
16 --------
17
18
19 Description
20 ~~~~~~~~~~~
21
22 The 5G OOF-PCI use case is an implementation of a SON (Self-Organizing Networks) algorithm
23
24 for Physical Cell ID (PCI) optimization and the centralized Automatic Neighbor Relations
25
26 (ANR) function (blacklisting a neighbor for handovers) in a 4G/5G network using the ONAP
27
28 Optimization Framework (OOF). This use case began with the implementation of PCI
29
30 optimization in Casablanca. In Dublin release, the SON-Handler MS was onboarded asa
31
32 micro-service in DCAE. Enhancements were made to Policy and SDN-C components. Further
33
34 details of Dublin release scope and impacts for this use case are described in:
35
36 https://docs.onap.org/en/dublin/submodules/integration.git/docs/docs_5G_oof_pci.html#docs-5g-oof-pci
37
38
39 In Frankfurt release, the following are the main enhancements:
40
41 - Introduction of Control Loop Coordination functionality, wherein a second control loop execution is
42   denied by Policy component when another control loop is in progress.
43 - Introduction of adaptive SON, wherein a set of cells whose PCI values are fixed (i.e., cannot be changed
44   during PCI optimization) are considered during the PCI optimization.
45 - In addition, the first step towards O-RAN alignment is being taken with SDN-C (R) being able to receive a DMaaP
46   message containing configuration updates (which would be triggered when a neighbor-list-change occurs in the RAN
47   and is communicated to ONAP over VES).
48
49
50 As part of this use case work, a RAN Simulator providing a simulated Radio Access Network
51 (RAN) with a number of netconf servers simulating PNF elements has been implemented. The
52 functionality of the RAN Simulator includes:
53
54 - Generation of neighbor-list-update messages
55 - Generation of alarms for PCI collision/confusion and
56 - Generation of handover metrics for different neighbor pairs (for the ANR use case).
57
58 All above functionality are enabled using a simple UI.
59
60 All details regarding the use case for Frankfurt can be found here:
61
62 https://wiki.onap.org/display/DW/OOF+%28SON%29+in+R5+El+Alto%2C+OOF+%28SON%29+in+R6+Frankfurt
63
64 The main use case page is:
65
66 https://wiki.onap.org/display/DW/5G+-+OOF+%28ONAP+Optimization+Framework%29+and+PCI+%28Physical+Cell+ID%29+Optimization
67
68
69 How to Use
70 ~~~~~~~~~~
71
72 The OOF-PCI use case is implemented in the Rutgers University (Winlab) ONAP Wireless Lab (OWL).
73
74 For details, please see: https://wiki.onap.org/pages/viewpage.action?pageId=45298557.
75
76 This page includes instructions for access to the lab. Setup and testing is done manually up to now.
77
78 For all instructions about installing the components, please see:
79
80 Installation: https://wiki.onap.org/display/DW/Demo+setup+steps
81
82
83 Son-Handler installation:
84
85 https://onap.readthedocs.io/en/latest/submodules/dcaegen2.git/docs/sections/services/son-handler/installation.html
86
87
88 Test Status and Plans
89 ~~~~~~~~~~~~~~~~~~~~~
90
91 For Frankfurt release, the enhancements described above were implemented. OOF was enhanced
92
93 with handling cells with fixed PCI values during the optimization, SON-Handler MS was
94
95 functionally enhanced for adaptive SON functionality, SDN-C (R) was enhanced to include
96
97 handling of DMaaP message for config changes in the RAN, and Policy was also enhanced with
98
99 Control Loop Co-ordination function.
100
101 To see information about test plans, please see https://wiki.onap.org/display/DW/Testing.
102
103
104 Known Issues and Resolutions
105 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
106
107 (a) It is intended to have the RAN Simulator support sufficient Honeycomb netconf server instances to simulate 2000 cells.
108     However, this number may be lower if there are hardware limitatons.
109 (b) For Control Loop Co-ordination, the denial of a second Control Loop based on Target Lock (i.e., when a second Control
110     Loop tries to operate on the same target (in this case, a PNF) is successfully tested. The CLC is also applied at Control
111     Loop level only. However, some code updates are required in Policy to properly update the Operations History DB entry, and
112     to check the existence of active Control Loops by Policy. This will be addressed in Guilin release, and tracked via
113     https://jira.onap.org/browse/POLICY-2581 and https://jira.onap.org/browse/POLICY-2583.
114 (c) For Adaptive SON, the functionality in SON-Handler and OOF is implemented, however the OOF functionality is not
115     fully tested (this was anyhow a stretch goal). Further, the DCAE-CL-RSP message is not sent by Policy in Frankfurt release.
116     This is tracked via https://jira.onap.org/browse/POLICY-2580 and shall be part of Guilin release.