X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Foverview.rst;h=10a03dacc62be254a4f752e0311b7e8ca48455d1;hb=c7b1f0574e207d4b3f62422cdea7ea685520cff6;hp=f74e91f300c8793814a1e339c3be4712f6325835;hpb=01b64b350211e0bfc16af343402dedc55020917b;p=nonrtric.git diff --git a/docs/overview.rst b/docs/overview.rst index f74e91f3..10a03dac 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -1,8 +1,8 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. SPDX-License-Identifier: CC-BY-4.0 -.. Copyright (C) 2020 Nordix +.. Copyright (C) 2021 Nordix -.. |archpic| image:: ./images/nonrtric-architecture-D.png +.. |archpic| image:: ./images/nonrtric-architecture-E.png :alt: Image: O-RAN SC - NONRTRIC Overall Architecture Summary @@ -24,13 +24,14 @@ These are the components that make up the Non-RT-RIC: * Non-RT-RIC Control Panel / Dashboard * A1 Policy Management Service (developed in ONAP) * A1/SDNC Controller & A1 Adapter (Controller plugin) -* Enrichment Information Coordinator +* Information Coordinator Service * Non-RT-RIC (Spring Cloud) Service Gateway * Non-RT-RIC (Kong) Service Exposure Prototyping * Initial Non-RT-RIC App Catalogue * Near-RT-RIC A1 Simulator +* DMaap Adaptor -The code base for "D" Release is in the `NONRTRIC `_, `NONRTRIC-ControlPanel `_, and `Near-RT-RIC A1-Simulator `_ , Gerrit source repositories (D Branch). +The code base for "E" Release is in the `NONRTRIC `_, `NONRTRIC-ControlPanel `_, and `Near-RT-RIC A1-Simulator `_ , Gerrit source repositories (E-Release Branch). Non-RT-RIC Control Panel / NONRTRIC Dashboard ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -40,7 +41,7 @@ Graphical user interface * View and Manage A1 policies in the RAN (near-RT-RICs) * Interacts with the Policy agent’s NBI (REST API) * Graphical A1 policy creation/editing is model-driven, based on policy type’s JSON schema -* View and manage producers and jobs for the Enrichment coordinator service +* View and manage producers and jobs for the Information coordinator service * Configure A1 Policy Management Service (e.g. add/remove near-rt-rics) * Interacts with the A1-PolicyManagementService & A1-EI-Coordinator (REST NBIs) via Service Exposure gateway @@ -76,6 +77,10 @@ A1 Controller Service above A1 Controller/Adaptor that provides: See also: `A1 Policy Management Service in ONAP `_ + +Implementation: +* Implemented as a Java Spring Boot application + A1/SDNC Controller & A1 Adapter (Controller plugin) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Mediation point for A1 interface termination in SMO/NONRTRIC @@ -90,8 +95,8 @@ Mediation point for A1 interface termination in SMO/NONRTRIC See also: `A1 Adapter/Controller Functions in ONAP `_ -Enrichment Information Job Coordination Service -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Information Coordination Service +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Coordinate/Register A1-EI Types, Producers, Consumers, and Jobs. @@ -106,14 +111,31 @@ Coordinate/Register A1-EI Types, Producers, Consumers, and Jobs. * Query status of A1-EI jobs * Monitors all near-RT-RICs and recovers from inconsistencies * After EI-type/Producer/Consumer/Job is successfully registered delivery/flow can happen directly between A1-EI Producers (in SMO/NONRTRIC domain) and A1-EI consumers (near-RT-RICs in RAN domain) -* *Being extended to coordinate non-A1 Enrichment Information exchange between NONRTRIC Apps* +* *Being extended to coordinate non-A1 Information exchange between NONRTRIC Apps* + + +Implementation: + +* Implemented as a Java Spring Boot application + +Dmaap Adapter +~~~~~~~~~~~~~ + +Is a generic information producer, which registers itself as an information producer of information types (in Information Coordination Service). +The information types are defined in a configuration file. +Information jobs can retrieve data from DMaaP or Kafka topics and push this to data consumers (accessing the ICS API). + +Implementation: + +1. Implementation as a Java Spring Boot application +2. Implementation as a Go application Non-RT-RIC (Spring Cloud) Service Gateway ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Support Apps to use A1 Services * `Spring Cloud Gateway `_ provides the library to build a basic API gateway -* Exposes A1 Policy Management Service & Enrichment Coordinator Service. +* Exposes A1 Policy Management Service & Information Coordinator Service. * Additional predicates can be added in code or preferably in the Gateway yaml configuration. Implementation: @@ -162,13 +184,13 @@ A1 Interface / Near-RT-RIC Simulator Stateful A1 test stub. * Used to create multiple stateful A1 providers (simulated near-rt-rics) -* Supports A1-Policy and A1-EnrichmentInformation +* Supports A1-Policy and A1-Enrichment Information * Swagger-based northbound interface, so easy to change the A1 profile exposed (e.g. A1 version, A1 Policy Types, A1-E1 consumers, etc) * All A1-AP versions supported Implementation: * Implemented as a Python application -* Repo: *portal/nonrtric-controlpanel* +* Repo: *sim/a1-interface* More details available at the `A1 Simulator documentation site `_