Merge "Adding a few tests in the EI part of the frontend"
diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst
index afe1a24..5804f23 100644
--- a/docs/developer-guide.rst
+++ b/docs/developer-guide.rst
@@ -10,10 +10,12 @@
The Non-RT RIC Control Panel is an interface that allows human users to create, edit and delete policy instances, for
each existing policy type. The policy types and their definitions are retrieved from each Near-RT RIC.
-See the README.md file in the nonrtric-controlpanel repo for info about how to use it.
+Additionally, producers and jobs for the Enrichment Information coordinator service can be viewed and managed.
+
+See the README.md file in the nonrtric-controlpanel repo for information about how to use it.
Start the Control Panel for development
-=======================================
+---------------------------------------
To run the Control Panel locally for development with simulated services, follow these steps:
@@ -21,39 +23,50 @@
.. _gerrit: https://gerrit.o-ran-sc.org/r/admin/repos/portal/nonrtric-controlpanel
-Start the frontend:
+- Start the frontend:
- cd webapp-frontend
-
- To start the frontend with Mock data:
-
- npm run start:mock
-
- To start the UI:
-
- You need to start the ControlPanel API Gateway, Policy Management Service & EI Service for the UI to list policy & EI information
-
- ./ng serve --proxy-config proxy.conf.json
-
- OR
-
- npm start
+ +------------------------------+
+ | cd webapp-frontend |
+ +------------------------------+
-- Now you can open URL: `localhost:4200`_ in a browser to access the Control Panel.
+ - To start the frontend with Mock data:
-.. _localhost:4200: http://localhost:4200
+ +------------------------------+
+ | npm run start:mock |
+ +------------------------------+
+
+ - To start the UI:
+
+ - You need to start the ControlPanel API Gateway, Policy Management Service & EI Service for the UI to list policy & EI information
+
+ +---------------------------------------------------+
+ | ./ng serve --proxy-config proxy.conf.json |
+ +---------------------------------------------------+
+
+ OR
+
+ +---------------------+
+ | npm start |
+ +---------------------+
+
+ - Now you can open URL: `localhost:4200`_ in a browser to access the Control Panel.
+
+ .. _localhost:4200: http://localhost:4200
From the main page, click on the "Policy Control" card. From here, it is possible to create or list instances for each
existing policy type.
When the instances are listed, it is possible to edit or delete each instance from the expanded view.
-.. image:: ./images/non-RT_RIC_controlpanel.png
+.. image:: ./images/non-RT_RIC_controlpanel_Policy.PNG
+In order to view producers and jobs from the EI service, from the main page, click on the "Enrichment information coordinator" card or use the menu on the left hand side of the page.
+
+.. image:: ./images/non-RT_RIC_controlpanel_EI.PNG
End-to-end call
-===============
+---------------
In order to make a complete end-to-end call, follow the instructions given in this `guide`_.
-.. _guide: https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=12157166
\ No newline at end of file
+.. _guide: https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=34963461
\ No newline at end of file
diff --git a/docs/images/ControlPanel_architecture.png b/docs/images/ControlPanel_architecture.png
new file mode 100644
index 0000000..5d7d534
--- /dev/null
+++ b/docs/images/ControlPanel_architecture.png
Binary files differ
diff --git a/docs/images/architecture.png b/docs/images/architecture.png
deleted file mode 100644
index c94d591..0000000
--- a/docs/images/architecture.png
+++ /dev/null
Binary files differ
diff --git a/docs/images/non-RT_RIC_controlpanel.png b/docs/images/non-RT_RIC_controlpanel.png
deleted file mode 100644
index 7d28f45..0000000
--- a/docs/images/non-RT_RIC_controlpanel.png
+++ /dev/null
Binary files differ
diff --git a/docs/images/non-RT_RIC_controlpanel_EI.PNG b/docs/images/non-RT_RIC_controlpanel_EI.PNG
new file mode 100644
index 0000000..cd0bf01
--- /dev/null
+++ b/docs/images/non-RT_RIC_controlpanel_EI.PNG
Binary files differ
diff --git a/docs/images/non-RT_RIC_controlpanel_Policy.PNG b/docs/images/non-RT_RIC_controlpanel_Policy.PNG
new file mode 100644
index 0000000..bc76899
--- /dev/null
+++ b/docs/images/non-RT_RIC_controlpanel_Policy.PNG
Binary files differ
diff --git a/docs/index.rst b/docs/index.rst
index 2ca5b08..bd1c093 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -9,9 +9,9 @@
:maxdepth: 2
:caption: Contents:
+ ./overview.rst
./developer-guide.rst
./installation-guide.rst
- ./overview.rst
./release-notes.rst
diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst
index a2817e7..056ae89 100644
--- a/docs/installation-guide.rst
+++ b/docs/installation-guide.rst
@@ -5,10 +5,6 @@
Installation Guide
==================
-.. contents::
- :depth: 3
- :local:
-
Abstract
--------
@@ -17,6 +13,7 @@
This work is in progress. For now, it is possible to use the Non-RT RIC Control Panel.
Version history
+---------------
+--------------------+--------------------+--------------------+--------------------+
| **Date** | **Ver.** | **Author** | **Comment** |
@@ -25,13 +22,57 @@
| 2020-03-27 | 0.1.0 | Henrik Andersson | First draft |
| | | | |
+--------------------+--------------------+--------------------+--------------------+
-| | 0.1.1 | | |
-| | | | |
+| 2021-04-27 | 2.2.0 | Yennifer Chacon | Update |
+| | | | documentation |
+--------------------+--------------------+--------------------+--------------------+
-| | 1.0 | | |
+| | | | |
| | | | |
| | | | |
+--------------------+--------------------+--------------------+--------------------+
+The Non-RT RIC Control Panel is a graphical user interface that enables the user to view and manage the A1 policies in the RAN and also view producers and jobs for the Enrichement Information coordinator service.
+
+- To create docker image for the control panel:
+
+ .. code-block:: bash
+
+ cd nonrtric-controlpanel/webapp-frontend
+ docker build -t o-ran-sc/nonrtric-controlpanel .
+
+- Nonrtric gateway is also needed because all the request from the gui are passed through this API gateway.
+
+ .. code-block:: bash
+
+ cd nonrtric-controlpanel/nonrtric-gateway
+ docker build -t o-ran-sc/nonrtric-gateway .
+
+.. note::
+ It is important to note that all the route configurations are provided in application.yaml,
+ so in case domain name and port for Policy Management Service & Enrichment Information Coordinator
+ Service are not the default ones, application.yaml file must be modified.
+
+Docker images for Policy Management and Enrichment Information Coordinator are needed as well in order to view information and data on the interface. These images can be found in the nexus repository or can be built manually as well.
+
+ - nexus3.o-ran-sc.org:10004/o-ran-sc/nonrtric-enrichment-coordinator-service
+ - nexus3.o-ran-sc.org:10004/o-ran-sc/nonrtric-policy-agent
+
+`Wiki page <https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=20878049>`_ contain detail information about how to build this images and add some sample data.
+
+
+- Using docker compose:
+
+ Another alternative is to use docker compose. In the `nonrtric project <https://gerrit.o-ran-sc.org/r/admin/repos/nonrtric>`_ under the folder docker-compose, instructions can be found in the README file.
+
+ It will start all necessary services and provided sample data that can be viewed in the interface using docker compose command:
+
+ .. code-block:: bash
+
+ docker-compose -f docker-compose.yaml
+ -f control-panel/docker-compose.yaml
+ -f nonrtric-gateway/docker-compose.yaml
+ -f policy-service/docker-compose.yaml
+ -f ecs/docker-compose.yaml
+ -f a1-sim/docker-compose.yaml up
+
diff --git a/docs/overview.rst b/docs/overview.rst
index ec14eb6..7e128bc 100644
--- a/docs/overview.rst
+++ b/docs/overview.rst
@@ -2,23 +2,27 @@
.. SPDX-License-Identifier: CC-BY-4.0
.. Copyright (C) 2020 Nordix
-Control Panel Overview
-======================
+Non-RT RIC Control Panel Overview
+==================================
The Non-RT RIC Control Panel is a graphical user interface that enables the user to manage the Policies in the
-network. The Control Panel interacts with the Policy Agent via a REST API.
+network and also view producers and jobs for the Enrichement coordinator service.
+
The Control Panel generates its GUI from JSON schemas in a model driven fashion.
-The Control Panel consists of a back end implemented as a Java Spring Boot application and a fronted developed using the
-Angular framework.
+The Control Panel consists of a frontend and a gateway. Frontend is developed using the Angular framework.
+The Gateway is a Spring Cloud Gateway that provides an API Gateway for all the Non-RT-RIC Components.
+
+.. note::
+ It is fully supported in Firefox and Chrome. Minor issues in Safari.
+ Not supported in Microsoft Edge and IE.
Control Panel architecture
--------------------------
The architecture of the Control Panel is as shown on the following picture:
-.. image:: ./images/architecture.png
+.. image:: ./images/ControlPanel_architecture.png
:scale: 50 %
-The Control Panel itself is split into the backend and the frontend, and can be deployed following the instructions in
-the README.md file in the repo.
\ No newline at end of file
+The Control Panel can be deployed following the instructions in the README.md file in the repo.
\ No newline at end of file
diff --git a/nonrtric-gateway/config/application.yaml b/nonrtric-gateway/config/application.yaml
index 98fd7d5..715e689 100644
--- a/nonrtric-gateway/config/application.yaml
+++ b/nonrtric-gateway/config/application.yaml
@@ -31,7 +31,7 @@
predicates:
- Path=/a1-policy/**
- id: A1-EI
- uri: https://localhost:8433
+ uri: https://localhost:8434
predicates:
- Path=/ei-producer/**
management:
diff --git a/webapp-frontend/README.md b/webapp-frontend/README.md
index 7ac722a..09a1641 100644
--- a/webapp-frontend/README.md
+++ b/webapp-frontend/README.md
@@ -3,7 +3,8 @@
## Development server
Run `./ng serve --proxy-config proxy.conf.json` or `npm start` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
-You may also need to Start the Control Panel Gateway,Policy Management Service & EI Coordinator if you want to view the data in UI.
+
+You may also need to Start the Control Panel Gateway, Policy Management Service & EI Coordinator if you want to view the data in UI.
## Development server with Mock Data
Run `npm run start:mock` for a dev server with mock data. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files. This enables the developer to test the UI without the need of backend.
