Non-RT RIC Control Panel¶
Non-RT RIC Control Panel Overview¶
Graphical user interface with the following capabilities:
View and Manage A1 policies in the RAN (near-RT-RICs)
Graphical A1 policy creation/editing is model-driven, based on policy type’s JSON schema
View producers and jobs for the Information coordinator service
Configure A1 Policy Management Service (add/remove near-rt-rics)
The Control Panel frontend interacts with the A1 Policy Management Service and A1 Information Coordinator (REST NBIs) via a service exposure gateway, the Nonrtric Gateway. The 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:
The Control Panel can be deployed following the instructions in the Installation Guide.
This product is a part of NONRTRIC.
Developer Guide¶
This document provides a quick start for developers of the Non-RT RIC Control Panel.
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. It is also possible to change the configuration of available RICs, provided that Consul is not used.
Additionally, producers and jobs for the Information coordinator service can be viewed.
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, follow the steps below.
First, fetch the latest code from gerrit and go in to the frontend folder in the repo:
cd nonrtric-controlpanel/webapp-frontend
The Control Panel can be started with mock data to make it easy to develop the GUI without the need to start all services. Run the following command to start with mock data:
npm run start:mock
Open the URL: localhost:4200 in a browser to access the Control Panel with mock information.
To start the frontend to get real information from Non-RT RIC services the following services need to be started first:
ControlPanel API Gateway
Policy Management Service,
EI Service.
By pulling the nonrtric repo and using the script “PM_EI_DEMO.sh” in the folder “test/autotest”, the above services will be started and populated with data. It requires Docker to run. To run this script with a local version of the Control Panel, a docker image of the Control Panel must first be created. To do this, run the following command:
docker build -t o-ran-sc/nonrtric-controlpanel:2.2.0-SNAPSHOT .
Then run the following command to start the script with the local image:
sudo ./PM_EI_DEMO.sh remote-remove docker –env-file ../common/test_env-oran-d-release.sh –use-local-image CP
When the above servers are started and populated with data, run the following command:
npm start
Open the URL: localhost:8080 in a browser to access the Control Panel with real information.
From the main page, click on the “Policy Control” card or use the menu on the left hand side of the page. 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.
It is also possible to manage the configuration of available RICs, provided that Consul is not used, from the Control Panel. From the menu on the left hand side, select “Policy -> RIC Config”.
From the main page, click on the “Information information coordinator” card or use the menu on the left hand side of the page. From here it is possible to view producers and jobs from the Information service,
End-to-end call¶
In order to make a complete end-to-end call, follow the instructions given in this guide.
Installation Guide¶
Abstract¶
This document describes how to install the Non-RT RIC Control Panel, its dependencies and required system resources.
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 Information coordinator service.
Preface¶
Since the control Panel depends on the A1 Policy Management Service and Information Coordinator, they must be installed to make it work. See Non-RT RIC for how to install and set them up.
This guide is to install both the NonRtRIC Control Panel and the NonRtRIC Service Gateway.
The installation of the NonRtRIC Service Gateway is needed as it exposes A1 Policy Management Service and Information Coordinator Service.
Software Installation and Deployment¶
Note
It is important to note that all the route configurations are provided in the application.yaml file of the gateway. So in case domain name and port for Policy Management Service and Information Coordinator Service are not the default ones, the application.yaml file must be modified.
Install with Docker¶
Docker compose files are provided, in the “docker-compose” folder, to install the frontend and gateway. Run the following command to start the Control Panel:
docker-compose -f docker-compose.yaml -f control-panel/docker-compose.yaml -f nonrtric-gateway/docker-compose.yaml
Install with Helm¶
Helm charts and an example recipe are provided in the it/dep repo, under “nonrtric”. By modifying the variables named “installXXX” in the beginning of the example recipe file, which components that will be installed can be controlled. Then the components can be installed and started by running the following comand:
bin/deploy-nonrtric -f nonrtric/RECIPE_EXAMPLE/example_recipe.yaml
Release-Notes¶
This document provides the release notes for the release of the Non-RT RIC Control Panel.
Version history Control Panel¶
Date |
Ver. |
Author |
Comment |
2020-03-27 |
0.1.0 |
Henrik Andersson |
First draft |
2020-06-12 |
2.0.0 |
Henrik Andersson |
Bronze Release |
2020-12-03 |
2.1.0 |
Henrik Andersson |
Cherry Release |
2021-06-25 |
2.2.0 |
Henrik Andersson |
D Release |
2021-12-13 |
2.3.0 |
Henrik Andersson |
E Release |
2022-12-15 |
2.4.0 |
Henrik Andersson |
G Release |
2023-06-16 |
2.5.0 |
John Keeney |
H Release |
Release Data Control Panel¶
Bronze¶
Project |
Non-RT RIC Control Panel |
Repo/commit-ID |
nonrtric-controlpanel/78b4e0838484299ed807c86412ec7109d88447be |
Release designation |
Bronze |
Release date |
2020-06-12 |
Purpose of the delivery |
Introducing Non-RT RIC Control Panel |
Cherry¶
Project |
Non-RT RIC Control Panel |
Repo/commit-ID |
nonrtric-controlpanel/9d99a37374c9266f3d11ff0a19c2d068571159ba |
Release designation |
Cherry |
Release date |
2020-12-03 |
Purpose of the delivery |
Introducing Enrichment Controller Service |
D Release¶
Project |
Non-RT RIC Control Panel |
Repo/commit-ID |
nonrtric-controlpanel/cb87bb89109dfb04fb82bfe2fc63ef7fd1a848d7 |
Release designation |
D |
Release date |
2021-06-25 |
Purpose of the delivery |
Replaced backend with Non-RT RIC Gateway Introduced sorting and filtering in tables |
E Release¶
Project |
Non-RT RIC Control Panel |
Repo/commit-ID |
nonrtric-controlpanel/9359e032f879b383fea7d4f6c898c30033ab5edb |
Release designation |
E |
Release date |
2021-12-13 |
Purpose of the delivery |
Minor improvements |
G Release¶
Project |
Non-RT RIC Control Panel |
Repo/commit-ID |
nonrtric-controlpanel/194e3b4e567f276383e3fb96b828f7509793ad1f |
Release designation |
G |
Release date |
2022-12-15 |
Purpose of the delivery |
Non root user in Docker image |
H Release¶
Project |
Non-RT RIC Control Panel |
Repo/commit-ID |
nonrtric-controlpanel/c0da752efda3032c0b83986c43c52b24c61323f1 |
Release designation |
H |
Release date |
2023-06-16 |
Purpose of the delivery |
|
Fully supported in Firefox and Chrome. Minor issues in Safari. Not supported in Microsoft Edge and IE.
Version history Gateway¶
Date |
Ver. |
Author |
Comment |
2021-06-25 |
1.0.0 |
Henrik Andersson |
D Release |
2023-06-16 |
1.2.0 |
John Keeney |
H Release |
Release Data Gateway¶
D Release¶
Project |
Non-RT RIC Gateway |
Repo/commit-ID |
nonrtric-controlpanel/78b4e0838484299ed807c86412ec7109d88447be |
Release designation |
D |
Release date |
2021-06-25 |
Purpose of the delivery |
Introducing Non-RT RIC Gateway |
Project |
Non-RT RIC Gateway |
Repo/commit-ID |
nonrtric-controlpanel/c0da752efda3032c0b83986c43c52b24c61323f1 |
Release designation |
H |
Release date |
2023-06-16 |
Purpose of the delivery |
|