Update Read the Docs for NonRtRic Control Panel
[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 The Non-RT RIC Control Panel is a graphical user interface that enables the user to manage the Policies in the
9 network and also view producers and jobs for the Enrichement coordinator service.
10
11 The Control Panel generates its GUI from JSON schemas in a model driven fashion.
12
13 The Control Panel consists of a frontend and a gateway. Frontend is developed using the Angular framework. 
14 The Gateway is a Spring Cloud Gateway that provides an API Gateway for all the Non-RT-RIC Components.
15
16 .. note::
17    It is fully supported in Firefox and Chrome. Minor issues in Safari. 
18    Not supported in Microsoft Edge and IE.
19
20 Control Panel architecture
21 --------------------------
22
23 The architecture of the Control Panel is as shown on the following picture:
24
25 .. image:: ./images/ControlPanel_architecture.png
26    :scale: 50 %
27
28 The Control Panel  can be deployed following the instructions in the README.md file in the repo.