ec14eb637f955f58085ff8ccf2214f0bd900247c
[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 Control Panel Overview
6 ======================
7
8 The Non-RT RIC Control Panel is a graphical user interface that enables the user to manage the Policies in the
9 network. The Control Panel interacts with the Policy Agent via a REST API.
10 The Control Panel generates its GUI from JSON schemas in a model driven fashion.
11
12 The Control Panel consists of a back end implemented as a Java Spring Boot application and a fronted developed using the
13 Angular framework.
14
15 Control Panel architecture
16 --------------------------
17
18 The architecture of the Control Panel is as shown on the following picture:
19
20 .. image:: ./images/architecture.png
21    :scale: 50 %
22
23 The Control Panel itself is split into the backend and the frontend, and can be deployed following the instructions in
24 the README.md file in the repo.