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