Documentation updates
[portal/nonrtric-controlpanel.git] / docs / overview.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. SPDX-License-Identifier: CC-BY-4.0
3 .. Copyright (C) 2020 Nordix
4
5 Non-RT RIC Control Panel Overview
6 =================================
7
8 Graphical user interface with the following capabilities:
9
10 *  View and Manage A1 policies in the RAN (near-RT-RICs)
11 *  Graphical A1 policy creation/editing is model-driven, based on policy type’s JSON schema
12 *  View producers and jobs for the Information coordinator service
13 *  Configure A1 Policy Management Service (add/remove near-rt-rics)
14
15 The Control Panel frontend interacts with the A1 Policy Management Service and A1 Information Coordinator
16 (REST NBIs) via a service exposure gateway, the Nonrtric Gateway. The frontend is developed using the Angular framework.
17 The Gateway is a Spring Cloud Gateway that provides an API Gateway for all the Non-RT-RIC Components.
18
19 .. note::
20    It is fully supported in Firefox and Chrome. Minor issues in Safari.
21    Not supported in Microsoft Edge and IE.
22
23 Control Panel architecture
24 --------------------------
25
26 The architecture of the Control Panel is as shown on the following picture:
27
28 .. image:: ./images/ControlPanel_architecture.png
29    :scale: 50 %
30
31 The Control Panel can be deployed following the instructions in the Installation Guide.