+++ /dev/null
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. Copyright (C) 2021 Nordix
-
-.. _api_docs:
-
-========
-API-Docs
-========
-
-This document describes the API to access the Non-RT RIC Gateway.
-
-The Gateway acts as a mediator for services provided by the Non-RT RIC project. This means that users only need to
-know about one address to access the content of the Non-RT Ric.
-
-The default value for the Gateway port is 9090. There are different ways to find out which port that is actually used.
-
-If Kubernetes is used, run the following command:
-
- .. code-block:: bash
-
- kubectl get svc -n nonrtric | grep gateway
-
-With the name from the "NAME" column, run the following command:
-
- .. code-block:: bash
-
- kubectl describe svc -n nonrtric [name]
-
-If Docker is used, run the following command:
-
- .. code-block:: bash
-
- docker ps | grep gateway
-
-Look under the "PORTS" column to see the port used by the Gateway.
-
-The Gateway supports calls to the A1 Policy Management Service and A1 Enrichment Information Coordinator.
-See `A1 Policy Management Service API <https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric/en/latest/api-docs.html#a1-policy-management-service>`__
-and `A1 Enrichment Information Coordinator API <https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric/en/latest/api-docs.html#enrichment-coordinator-service>`__.
-
-Some examples on how to call the gateway with CURL:
-
- .. code-block:: bash
-
- curl localhost:9090/a1-policy/v2/policy-instances
- curl localhost:9090/data-producer/v1/info-types
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 Enrichment Information coordinator service can be viewed.
+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.
.. image:: ./images/non-RT_RIC_controlpanel_ric_config.PNG
-From the main page, click on the "Enrichment 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 EI service,
+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,
.. image:: ./images/non-RT_RIC_controlpanel_EI.PNG
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=34963461
\ No newline at end of file
+.. _guide: https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=34963461
:caption: Contents:
./overview.rst
- ./developer-guide.rst
- ./api-docs.rst
+ ./developer-guide.rst
./installation-guide.rst
./release-notes.rst
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.
+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 A1 Enrichment Information Coordinator, they
+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 <https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric/en/latest/index.html>`__
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 Enrichment Coordinator Service.
+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 Enrichment Information Coordinator Service
+ 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
* 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 Enrichment coordinator service
+* 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 Enrichment Information Coordinator
+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.
expect(browser.getCurrentUrl()).toEqual("http://localhost:4200/policy");
});
- it("should reach enrichment information coordinator page when clicking on the enrichment information coordinator card", async () => {
+ it("should reach information coordinator page when clicking on the information coordinator card", async () => {
await element(by.id('eicCard')).click();
expect(browser.getCurrentUrl()).toEqual("http://localhost:4200/ei-coordinator");
});
expect(browser.getCurrentUrl()).toEqual("http://localhost:4200/ric-config");
});
- it("should reach enrichment information coordinator page when clicking in the side bar", async () => {
+ it("should reach information coordinator page when clicking in the side bar", async () => {
await element(by.id('eicLink')).click();
expect(browser.getCurrentUrl()).toEqual("http://localhost:4200/ei-coordinator");
});
});
});
-describe("Enrichment information coordinator page", () => {
+describe("Information coordinator page", () => {
beforeEach(() => {
browser.get("http://localhost:4200/ei-coordinator");
});
- it("should reach back to home from enrichment information coordinator page when clicking in the side bar", async () => {
+ it("should reach back to home from information coordinator page when clicking in the side bar", async () => {
await element(by.id('Menu_Burger_Icon')).click();
await element(by.id('homeLink')).click();
expect(browser.getCurrentUrl()).toEqual("http://localhost:4200/");
limitations under the License.
========================LICENSE_END===================================
-->
-
<div class="ei__card" routerLink="/ei-coordinator" [ngClass]="{'add__card-dark': darkMode}">
-
<div class="header__container">
- <span id="eicCard" class="card__title">Enrichment Information Coordinator</span>
+<div class="ei__card" routerLink="/ei-coordinator" [ngClass]="{'add__card-dark': darkMode}">
+ <div class="header__container">
+ <span id="eicCard" class="card__title">Information Coordinator</span>
<div class="body__container">
- <img src="assets/oran-logo.png" width="250px"/>
+ <img src="assets/oran-logo.png" width="250px" />
</div>
- </div>
+ </div>
\ No newline at end of file
-->
<div fxLayout="row">
- <div class="nrcp-global-page-title">Enrichment Information Coordinator</div>
+ <div class="nrcp-global-page-title">Information Coordinator</div>
<div class="refresh-button">
<button id="refreshButton" mat-icon-button color="primary" (click)="refreshTables()">
<mat-icon>refresh</mat-icon>
<mat-icon>home</mat-icon> <span class="nav-caption">Home</span>
</a>
<a mat-list-item id="policyToggle" (click)="toggle()">
- <mat-icon>dashboard</mat-icon> <span class="nav-caption">Policy</span>
- <mat-icon *ngIf="showSubMenu">expand_more</mat-icon>
- <mat-icon *ngIf="!showSubMenu">chevron_right</mat-icon>
+ <mat-icon>dashboard</mat-icon> <span class="nav-caption">Policy</span>
+ <mat-icon *ngIf="showSubMenu">expand_more</mat-icon>
+ <mat-icon *ngIf="!showSubMenu">chevron_right</mat-icon>
</a>
<mat-nav-list [ngClass]="{'dark': darkMode}" *ngIf="showSubMenu">
<a mat-list-item id="policyLink" routerLink="/policy" (click)="onSidenavClose()">
</a>
</mat-nav-list>
<a mat-list-item id="eicLink" routerLink="/ei-coordinator" (click)="onSidenavClose()">
- <mat-icon>dashboard</mat-icon> <span class="nav-caption">Enrichment Information Coordinator</span>
-</a>
-</mat-nav-list>
+ <mat-icon>dashboard</mat-icon> <span class="nav-caption">Information Coordinator</span>
+ </a>
+</mat-nav-list>
\ No newline at end of file
Code Review / portal / nonrtric-controlpanel.git / commitdiff