X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Foverview.rst;h=f75c6f215751ed7de7d05e020272421bab4c18fd;hb=0b6b29e39fcdf832eb199782b88d4d276f2be5b4;hp=04bb0d3a1e5768b858dd8db5b568b1f7025d3772;hpb=4d20befe82e7817f853d63ca1969a51c89e66601;p=nonrtric.git diff --git a/docs/overview.rst b/docs/overview.rst index 04bb0d3a..f75c6f21 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -1,8 +1,9 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. SPDX-License-Identifier: CC-BY-4.0 -.. Copyright (C) 2021 Nordix +.. Copyright (C) 2021-2023 Nordix Foundation. All rights Reserved +.. Copyright (C) 2023 OpenInfra Foundation Europe. All Rights Reserved -.. |archpic| image:: ./images/nonrtric-architecture-H.png +.. |archpic| image:: ./images/nonrtric-architecture-I.png :alt: Image: O-RAN SC - NONRTRIC Overall Architecture Summary @@ -12,39 +13,42 @@ The Non-RealTime RIC (RAN Intelligent Controller) is an Orchestration and Automa The primary goal of the Non-RealTime RIC is to support non-real-time radio resource management, higher layer procedure optimization, policy optimization in RAN, and providing guidance, parameters, policies and AI/ML models to support the operation of near-RealTime RIC functions in the RAN to achieve higher-level non-real-time objectives. -Non-RealTime RIC functions include service and policy management, RAN analytics and model-training for the near-RealTime RICs. +Non-RealTime RIC functions include service and policy management and RAN analytics for the RAN. The Non-RealTime RIC platform hosts and coordinates rApps (Non-RT RIC applications) to perform Non-RealTime RIC tasks. The Non-RealTime RIC also hosts the new R1 interface (between rApps and SMO/Non-RealTime-RIC services). The O-RAN-SC (OSC) NONRTRIC project provides concepts, architecture and reference implementations as defined and described by the `O-RAN Alliance `_ architecture. The OSC NONRTRIC implementation communicates with near-RealTime RIC elements in the RAN via the A1 interface. Using the A1 interface the NONRTRIC will facilitate the provision of policies for individual UEs or groups of UEs; monitor and provide basic feedback on policy state from near-RealTime RICs; provide enrichment information as required by near-RealTime RICs; and facilitate ML model training, distribution and inference in cooperation with the near-RealTime RICs. +The OSC NONRTRIC hosts rApps, and coordinates all interactions between the rApp and underlying SMo by way of the R1 Interface. |archpic| -Find detailed description of the NONRTRIC project see the `O-RAN SC NONRTRIC Project Wiki `_. +Find detailed description of the NONRTRIC project see the `O-RAN SC NONRTRIC Project Wiki `_. NONRTRIC components ------------------- These are the components that make up the Non-RT-RIC: -* `Non-RT-RIC Control Panel <#non-rt-ric-control-panel-nonrtric-dashboard>`_. :doc:`Documentation site `. -* `Information Coordinator Service <#information-coordination-service>`_. :doc:`Documentation site `. -* `A1 Policy Management Service <#a1-policy-management-service-from-onap-ccsdk>`_. :doc:`Documentation site `. +* `Non-RT-RIC Control Panel <#non-rt-ric-control-panel-nonrtric-dashboard>`_. (:doc:`Documentation site `). +* `Information Coordinator Service <#information-coordination-service>`_. (:doc:`Documentation site `). +* `A1 Policy Management Service <#a1-policy-management-service-from-onap-ccsdk>`_. (:doc:`Documentation site `). * `A1 Policy Controller / Adapter <#a1-sdnc-controller-a1-adapter-controller-plugin>`_. -* `Near-RT RIC A1 Simulator <#a1-interface-near-rt-ric-simulator>`_. :doc:`Documentation site `. +* `Near-RT RIC A1 Simulator <#a1-interface-near-rt-ric-simulator>`_. (:doc:`Documentation site `). * `Non-RT-RIC (Spring Cloud) Service Gateway <#spring-cloud-service-gateway>`_. -* `Non-RT-RIC Service Exposure Security Architecture Prototyping <#service-exposure-security-architecture-prototyping>`_. :doc:`Documentation site `. -* `DMaaP/Kafka Information Producer Adapters <#dmaap-information-producer-adapters-kafka>`_. :doc:`Documentation site adapter `. :doc:`Documentation site mediator `. -* `Initial Non-RT-RIC App Catalogue <#initial-app-catalogue>`_. :doc:`Documentation site `. -* `Initial K8S Helm Chart LCM Manager <#initial-kubernetes-helm-chart-lcm-manager>`_. :doc:`Documentation site `. -* `Service Management & Exposure (SME) <#service-management-and-exposure>`_. :doc:`Documentation site `. +* `Non-RT-RIC Service Exposure Security Architecture Prototyping <#service-exposure-security-architecture-prototyping>`_. (:doc:`Documentation site `). +* `DMaaP/Kafka Information Producer Adapters <#dmaap-information-producer-adapters-kafka>`_. (:doc:`Documentation site adapter `), (:doc:`Documentation site mediator `). +* `Initial Non-RT-RIC App Catalogue <#initial-app-catalogue>`_. (:doc:`Documentation site `). +* `Initial K8S Helm Chart LCM Manager <#initial-kubernetes-helm-chart-lcm-manager>`_. (:doc:`Documentation site `). +* `Service Management & Exposure (SME) (CAPIF) <#service-management-and-exposure-capif>`_. (:doc:`Documentation site `). * `Authentication Support <#authentication-support-keycloak>`_. +* `RApp Manager Service <#rapp-manager-service>`_. (:doc:`Documentation site `). +* `RAN Performance Monitoring Functions (File-based PM) <#ran-performance-monitoring-functions-file-based-pm>`_ (:doc:`Documentation site `). * `Test Framework <#non-rt-ric-test-framework>`_. * `Use Cases: <#non-rt-ric-use-cases>`_ - * "Helloworld" O-RU Fronthaul Recovery use case. :doc:`Documentation site `. - * "Helloworld" O-DU Slice Assurance use case. :doc:`Documentation site `. + * "Helloworld" O-RU Fronthaul Recovery use case. (:doc:`Documentation site `). + * "Helloworld" O-DU Slice Assurance use case. (:doc:`Documentation site `). Non-RT-RIC Control Panel / NONRTRIC Dashboard @@ -62,7 +66,6 @@ Implementation: - Frontend: Angular framework - Repo: *portal/nonrtric-controlpanel* -- `Wiki `_ to set up in your local environment. - Documentation at the :doc:`NONRTRIC-Portal documentation site `. Information Coordination Service @@ -117,6 +120,7 @@ Implementation: A1/SDNC Controller & A1 Adapter (Controller plugin) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Mediation point for A1 interface termination in SMO/NONRTRIC. - Implemented as CCSDK OSGI Feature/Bundles. @@ -168,7 +172,9 @@ Support Apps to use NONRTRIC, SMO and other App interfaces. A building block for coming releases as the R1 Interface concept matures . - Support dynamic registration and exposure of service interfaces to Non-RT-RIC applications (& NONRTRIC Control panel). -- The architecture and componets are defined in :doc:`Non-RT RIC Security Architecture Prototyping (Documentation site) `. +- The architecture and components are defined in :doc:`Non-RT RIC Security Architecture Prototyping (Documentation site) `. +- Works with the CAPIF `Service Management & Exposure (SME) <#service-management-and-exposure>`_. :doc:`Documentation site ` functions. + DMaaP Information Producer Adapters (Kafka) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -197,17 +203,17 @@ Register for Non-RT-RIC Apps. Implementation: -- Implemented as a Java Spring Boot application. +- Implemented as a Java Spring Boot application and in Python. - Repo: *nonrtric/plt/rappcatalogue* - Documentation at the :doc:`rApp Catalogue documentation site `. Initial Kubernetes Helm Chart LCM Manager ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Onboard, start, stop, and modify Non-RT-RIC App µServices as Helm Charts. +Onboard, start, stop, and modify Non-RT-RIC App µServices as Helm Charts. *A building block for coming releases as the R-APP concept matures*. -- Interfaces that accepts Non-RT-RIC App µServices Helm Charts. +- Interfaces that accepts Non-RT-RIC App µServices Helm Charts. - Support basic LCM operations. - Onboard, Start, Stop, Modify, Monitor. - Initial version co-developed with v. similar functions in ONAP. @@ -219,8 +225,8 @@ Implementation: - Repo: *nonrtric/plt/helmmanager* - Documentation at the :doc:`Helm Manager documentation site `. -Service Management and Exposure -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Service Management and Exposure (CAPIF) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ An initial implementation of the CAPIF Core service. It implements the following CAPIF APIs: @@ -265,6 +271,22 @@ The auth-token-fetch is configured by the following environment variables. * AUTH_SERVICE_URL - the URL to the authentication service (Keycloak) * REFRESH_MARGIN_SECONDS - how long in advance before the authorization token expires it is refreshed +RApp Manager Service +~~~~~~~~~~~~~~~~~~~~ + +Early version of a service to manage rApps and rApp instances. + +- Manages the entire lifecycle and state of rApp and thie instances +- Integrated with NONRTRIC Data Management & Exposure functions (ICS) +- Integrates with NONRTRIC Service registration and discovery functions (SME CAPIF) +- Also add new ONAP ACM participants to handle rApp composition elements + +Implementation: + +- Implemented as a Java Spring Boot application. +- Repo: *nonrtric/plt/rappmanager* +- Documentation at the :doc:`Non-RT RIC rApp Manager documentation site `. + RAN Performance Monitoring Functions (File-based PM) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~