Improve documentation
[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 *  Interacts with the Policy agent’s NBI (REST API)
12 *  Graphical A1 policy creation/editing is model-driven, based on policy type’s JSON schema
13 *  View and manage producers and jobs for the Enrichment coordinator service
14 *  Configure A1 Policy Management Service (e.g. add/remove near-rt-rics)
15 *  Interacts with the A1-PolicyManagementService & A1-EI-Coordinator (REST NBIs) via Service Exposure gateway
16
17 The Control Panel consists of a frontend and a gateway. The frontend is developed using the Angular framework.
18 The Gateway is a Spring Cloud Gateway that provides an API Gateway for all the Non-RT-RIC Components.
19
20 .. note::
21    It is fully supported in Firefox and Chrome. Minor issues in Safari.
22    Not supported in Microsoft Edge and IE.
23
24 Control Panel architecture
25 --------------------------
26
27 The architecture of the Control Panel is as shown on the following picture:
28
29 .. image:: ./images/ControlPanel_architecture.png
30    :scale: 50 %
31
32 The Control Panel  can be deployed following the instructions in the README.md file in the repo.