Documentation updates 42/7342/1
authorPatrikBuhr <patrik.buhr@est.tech>
Tue, 14 Dec 2021 07:48:59 +0000 (08:48 +0100)
committerPatrikBuhr <patrik.buhr@est.tech>
Tue, 14 Dec 2021 07:48:59 +0000 (08:48 +0100)
Renamed Enrichment Information Coordinator -> Information Coordinator

Signed-off-by: PatrikBuhr <patrik.buhr@est.tech>
Issue-ID: NONRTRIC-685
Change-Id: I5d0211ae4be1b3941d3c0398166acfdc3a05dab2

docs/api-docs.rst [deleted file]
docs/developer-guide.rst
docs/index.rst
docs/installation-guide.rst
docs/overview.rst
webapp-frontend/e2e/src/app.e2e-spec.ts
webapp-frontend/src/app/ei-coordinator/ei-card/ei-card.component.html
webapp-frontend/src/app/ei-coordinator/ei-coordinator.component.html
webapp-frontend/src/app/navigation/sidenav-list/sidenav-list.component.html

diff --git a/docs/api-docs.rst b/docs/api-docs.rst
deleted file mode 100644 (file)
index 85adbed..0000000
+++ /dev/null
@@ -1,47 +0,0 @@
-.. 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
index b550de2..2469d24 100644 (file)
@@ -11,7 +11,7 @@ The Non-RT RIC Control Panel is an interface that allows human users to create,
 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.
 
 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.
 
 
 See the README.md file in the nonrtric-controlpanel repo for information about how to use it.
 
@@ -84,8 +84,8 @@ From the menu on the left hand side, select "Policy -> RIC Config".
 .. image:: ./images/non-RT_RIC_controlpanel_ric_config.PNG
 
 
 .. 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
 
 
 .. image:: ./images/non-RT_RIC_controlpanel_EI.PNG
 
@@ -94,4 +94,4 @@ End-to-end call
 
 In order to make a complete end-to-end call, follow the instructions given in this `guide`_.
 
 
 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
index cd106f7..33134c7 100644 (file)
@@ -10,8 +10,7 @@ Non-RT RIC Control Panel
    :caption: Contents:
 
    ./overview.rst
    :caption: Contents:
 
    ./overview.rst
-   ./developer-guide.rst
-   ./api-docs.rst
+   ./developer-guide.rst  
    ./installation-guide.rst
    ./release-notes.rst
 
    ./installation-guide.rst
    ./release-notes.rst
 
index 8cd0161..83757b6 100644 (file)
@@ -12,25 +12,25 @@ This document describes how to install the Non-RT RIC Control Panel, its depende
 
 
 The Non-RT RIC Control Panel is a graphical user interface that enables the user to view and manage the A1 policies in
 
 
 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
 -------
 
 
 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.
 
 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.
 
 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
    are not the default ones, the application.yaml file must be modified.
 
 Install with Docker
index b7609f4..87821d0 100644 (file)
@@ -9,10 +9,10 @@ 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 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)
 
 *  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.
 
 (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.
 
index 4e01075..534e3db 100644 (file)
@@ -35,7 +35,7 @@ describe("Home page", () => {
     expect(browser.getCurrentUrl()).toEqual("http://localhost:4200/policy");
   });
 
     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");
   });
     await element(by.id('eicCard')).click();
     expect(browser.getCurrentUrl()).toEqual("http://localhost:4200/ei-coordinator");
   });
@@ -70,7 +70,7 @@ describe("Sidebar navigation", () => {
     expect(browser.getCurrentUrl()).toEqual("http://localhost:4200/ric-config");
   });
 
     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");
   });
     await element(by.id('eicLink')).click();
     expect(browser.getCurrentUrl()).toEqual("http://localhost:4200/ei-coordinator");
   });
@@ -127,13 +127,13 @@ describe("Policy types page", () => {
   });
 });
 
   });
 });
 
-describe("Enrichment information coordinator page", () => {
+describe("Information coordinator page", () => {
 
   beforeEach(() => {
     browser.get("http://localhost:4200/ei-coordinator");
   });
 
 
   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/");
     await element(by.id('Menu_Burger_Icon')).click();
     await element(by.id('homeLink')).click();
     expect(browser.getCurrentUrl()).toEqual("http://localhost:4200/");
index f59e7c8..3a8541a 100644 (file)
   limitations under the License.
   ========================LICENSE_END===================================
   -->
   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">
     <div class="body__container">
-      <img src="assets/oran-logo.png" width="250px"/>
+      <img src="assets/oran-logo.png" width="250px" />
     </div>
     </div>
-  </div>
+  </div>
\ No newline at end of file
index 3162772..fdc233d 100644 (file)
@@ -19,7 +19,7 @@ limitations under the License.
 -->
 
 <div fxLayout="row">
 -->
 
 <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>
   <div class="refresh-button">
     <button id="refreshButton" mat-icon-button color="primary" (click)="refreshTables()">
       <mat-icon>refresh</mat-icon>
index 09e0f47..f591d39 100644 (file)
@@ -25,9 +25,9 @@
     <mat-icon>home</mat-icon> <span class="nav-caption">Home</span>
   </a>
   <a mat-list-item id="policyToggle" (click)="toggle()">
     <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 [ngClass]="{'dark': darkMode}" *ngIf="showSubMenu">
     <a mat-list-item id="policyLink" routerLink="/policy" (click)="onSidenavClose()">
@@ -38,6 +38,6 @@
     </a>
   </mat-nav-list>
   <a mat-list-item id="eicLink" routerLink="/ei-coordinator" (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