e2040ace8aa088a80ee23971f2787bebb6b3150d
[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
4
5 Controlpanel Overview
6 =====================
7
8 The Non-RT RIC Controlpanel is a graphical user  user interface that enables the user to manage the Policies in the
9 network. The Controlpanel interacts with the Policy agent via a REST API.
10 The Controlpanel generates its GUI from JSON schemas in a model driven fashion.
11
12 The Controlpanel consists of a back end implemented as a Java Spring Boot application and a fronted developed using the
13 Angular framework.
14
15 Controlpanel architecture
16 -------------------------
17
18 The architecture of the Controlpanel is as shown on the following picture:
19
20 .. image:: ./images/architecture.png
21    :scale: 50 %
22
23 The Controlpanel 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.