docs/overview.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. Copyright (C) 2021 Nordix
   4
   5 .. |archpic| image:: ./images/nonrtric-architecture-E.png
   6   :alt: Image: O-RAN SC - NONRTRIC Overall Architecture
   7
   8 Summary
   9 -------
  10
  11 The Non-RealTime RIC (RAN Intelligent Controller) is an Orchestration and Automation function described by the O-RAN Alliance for non-real-time intelligent management of RAN (Radio Access Network) functions.
  12
  13 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.
  14
  15 Non-RealTime RIC functions include service and policy management, RAN analytics and model-training for the near-RealTime RICs.
  16 The Non-RealTime RIC platform hosts and coordinates rApps (Non-RT RIC applications) to perform Non-RealTime RIC tasks.
  17 The Non-RealTime RIC also hosts the new R1 interface (between rApps and SMO/Non-RealTime-RIC services).
  18
  19 The O-RAN-SC (OSC) NONRTRIC project provides concepts, architecture and reference implementations as defined and described by the `O-RAN Alliance <https://www.o-ran.org>`_ architecture.
  20 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.
  21
  22 |archpic|
  23
  24 Find detailed description of the NONRTRIC project see the `O-RAN SC NONRTRIC Project Wiki <https://wiki.o-ran-sc.org/display/RICNR/>`_.
  25
  26 NONRTRIC components
  27 -------------------
  28
  29 These are the components that make up the Non-RT-RIC:
  30
  31 * Non-RT-RIC Control Panel
  32 * Information Coordinator Service
  33 * A1 Policy Management Service
  34 * A1 Policy Controller / Adapter
  35 * Near-RT RIC A1 Simulator
  36 * Non-RT-RIC (Spring Cloud) Service Gateway
  37 * Non-RT-RIC (Kong) Service Exposure Prototyping
  38 * DMaaP/Kafka Information Producer Adapters
  39 * Initial Non-RT-RIC App Catalogue
  40 * Initial K8S Helm Chart LCM Manager
  41 * Test Framework
  42 * Use Cases
  43
  44   + "Helloworld" O-RU Fronthaul Recovery use case
  45   + "Helloworld" O-DU Slice Assurance use case
  46
  47 The source code for "E" Release is in the `NONRTRIC <https://gerrit.o-ran-sc.org/r/admin/repos/nonrtric>`_, `NONRTRIC-ControlPanel <https://gerrit.o-ran-sc.org/r/admin/repos/portal/nonrtric-controlpanel>`_, and `Near-RT-RIC A1-Simulator <https://gerrit.o-ran-sc.org/r/admin/repos/sim/a1-interface>`_ Gerrit source repositories (E-Release Branch).
  48
  49 Non-RT-RIC Control Panel / NONRTRIC Dashboard
  50 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  51
  52 Graphical user interface.
  53
  54 * View and Manage A1 policies in the RAN (near-RT-RICs)
  55 * Graphical A1 policy creation/editing is model-driven, based on policy type's JSON schema
  56 * View and manage producers and jobs for the Information coordinator service
  57 * Configure A1 Policy Management Service (e.g. add/remove near-rt-rics)
  58 * Interacts with the A1-Policy Management Service & Information Coordination Service (REST NBIs) via Service Exposure gateway
  59
  60 Implementation:
  61
  62 * Frontend: Angular framework
  63 * Repo: *portal/nonrtric-controlpanel*
  64
  65 Please refer the developer guide and the `Wiki <https://wiki.o-ran-sc.org/display/RICNR/>`_ to set up in your local environment.
  66
  67 More details available at the `NONRTRIC-Portal documentation site <https://docs.o-ran-sc.org/projects/o-ran-sc-portal-nonrtric-controlpanel>`_.
  68
  69 Information Coordination Service
  70 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  71
  72 The ICS is a data subscription service which decouples data producers from data consumers. A data consumer can create a data subscription (Information Job) without any knowledge of its data producers (one subscription may involve several data producers). A data producer has the ability to produce one or several types of data (Information Type). One type of data can be produced by zero to many producers.
  73
  74 A data consumer can have several active data subscriptions (Information Job). One Information Job consists of the type of data to produce and additional parameters, which may be different for different data types. These parameters are not defined or limited by this service.
  75
  76 * Maintains a registry of:
  77
  78   + Information Types / schemas
  79   + Information Producers
  80   + Information Consumers
  81   + Information Jobs
  82
  83 The service is not involved in data delivery and hence does not put restrictions on this.
  84
  85 Implementation:
  86
  87 * Implemented as a Java Spring Boot application.
  88 * Repo: *nonrtric/plt/informationcoordinatorservice*.
  89
  90 More details available at the `Information Coordination Service site <https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-informationcoordinatorservice/en/latest/>`_
  91
  92 A1 Policy Management Service (from ONAP CCSDK)
  93 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  94
  95 A1 Controller Service above A1 Controller/Adaptor that provides:
  96
  97 * Unified REST & DMaaP NBI APIs for managing A1 Policies in all near-RT-RICs.
  98
  99   + Query A1 Policy Types in near-RT-RICs.
 100   + Create/Query/Update/Delete A1 Policy Instances in near-RT-RICs.
 101   + Query Status for A1 Policy Instances.
 102
 103 * Maintains (persistent) cache of RAN's A1 Policy information.
 104
 105   * Support RAN-wide view of A1 Policy information.
 106   * Streamline A1 traffic.
 107   * Enable (optional) re-synchronization after inconsistencies / near-RT-RIC restarts.
 108   * Supports a large number of near-RT-RICs (& multi-version support).
 109
 110 * Converged ONAP & O-RAN-SC A1 Adapter/Controller functions in ONAP SDNC/CCSDK (Optionally deploy without A1 Adaptor to connect direct to near-RT-RICs).
 111 * Support for different Southbound connectors per near-RT-RIC - e.g. different A1 versions, different near-RT-RIC version, different A1 adapter/controllers supports different or proprietary A1 controllers/EMSs.
 112
 113 See also: `A1 Policy Management Service in ONAP <https://wiki.onap.org/pages/viewpage.action?pageId=84672221>`_ .
 114
 115 Implementation:
 116
 117 * Implemented as a Java Spring Boot application.
 118
 119 A1/SDNC Controller & A1 Adapter (Controller plugin)
 120 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 121 Mediation point for A1 interface termination in SMO/NONRTRIC.
 122
 123 * Implemented as CCSDK OSGI Feature/Bundles.
 124 * A1 REST southbound.
 125 * RESTCONF Northbound.
 126 * NETCONF YANG > RESTCONF adapter.
 127 * SLI Mapping logic supported.
 128 * Can be included in an any controller based on ONAP CCSDK.
 129
 130 Implementation:
 131
 132 * Repo: *nonrtric/plt/sdnca1controller*
 133
 134 See also: `A1 Adapter/Controller Functions in ONAP <https://wiki.onap.org/pages/viewpage.action?pageId=84672221>`_ .
 135
 136 A1 Interface / Near-RT-RIC Simulator
 137 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 138
 139 Stateful A1 test stub.
 140
 141 * Used to create multiple stateful A1 providers (simulated near-rt-rics).
 142 * Supports A1-Policy and A1-Enrichment Information.
 143 * Swagger-based northbound interface, so easy to change the A1 profile exposed (e.g. A1 version, A1 Policy Types, A1-E1 consumers, etc).
 144 * All A1-AP versions supported.
 145
 146 Implementation:
 147
 148 * Implemented as a Python application.
 149 * Repo: *sim/a1-interface*.
 150
 151 More details available at the `A1 Simulator documentation site <https://docs.o-ran-sc.org/projects/o-ran-sc-sim-a1-interface>`_
 152
 153 Non-RT-RIC (Spring Cloud) Service Gateway
 154 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 155 Support Apps to use A1 Services.
 156
 157 * `Spring Cloud Gateway <https://cloud.spring.io/spring-cloud-gateway>`_ provides the library to build a basic API gateway.
 158 * Exposes A1 Policy Management Service & Information Coordinator Service.
 159 * Additional predicates can be added in code or preferably in the Gateway yaml configuration.
 160
 161 Implementation:
 162
 163 * Implemented as a Java Spring Cloud application.
 164 * Repo: *portal/nonrtric-controlpanel*.
 165
 166
 167 Non-RT-RIC (Kong) Service Exposure Prototyping
 168 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 169
 170 Support Apps to use NONRTRIC, SMO and other App interfaces.
 171 A building block for coming releases as the R1 Interface concept matures .
 172
 173 * Support dynamic registration and exposure of service interfaces to Non-RT-RIC applications (& NONRTRIC Control panel).
 174 * Extends a static gateway function specifically for NONRTRIC Control panel (described above).
 175 * Initial version based on `Kong API Gateway <https://docs.konghq.com/gateway-oss>`_ function.
 176 * Initial exposure candidates include A1 (NONRTRIC) services & O1 (OAM/SMO) services.
 177
 178 NONRTRIC Kubernetes deployment - including Kong configurations can be found in the OSC `it/dep <https://gerrit.o-ran-sc.org/r/gitweb?p=it/dep.git;a=tree;f=nonrtric/helm/nonrtric>`_ Gerrit repo.
 179
 180 DMaaP/Kafka Information Producer Adapters
 181 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 182
 183 Configurable mediators to take information from DMaaP and Kafka and present it as a coordinated Information Producer.
 184
 185 These mediators/adapters are generic information producers, which register themselves as information producers of defined information types in Information Coordination Service (ICS).
 186 The information types are defined in a configuration file.
 187 Information jobs defined using ICS then allow information consumers to retrieve data from DMaaP MR or Kafka topics (accessing the ICS API).
 188
 189 There are two alternative implementations to allow Information Consumers to consume DMaaP or Kafka events as coordinated Information Jobs.
 190
 191 1. A version implemented in Java Spring (DMaaP Adaptor Service), repo: *nonrtric/plt/dmaapadapter*, see `DMaaP Adapter documentation site <https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-dmaapadapter/en/latest/>`_.
 192 2. A version implemented in Go (DMaaP Mediator Producer), repo: *nonrtric/plt/dmaapmediatorproducer*, see `DMaaP Mediator Producer documentation site <https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-dmaapmediatorproducer>`_.
 193
 194 Initial Non-RT-RIC App Catalogue
 195 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 196
 197 Register for Non-RT-RIC Apps.
 198
 199 * Non-RT-RIC Apps can be registered / queried.
 200 * Limited functionality/integration for now.
 201 * *More work required in coming releases as the rApp concept matures*.
 202
 203 Implementation:
 204
 205 * Repo: *nonrtric/plt/rappcatalogue*
 206
 207 More details available at the `rApp Catalogue documentation site <https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-rappcatalogue>`_.
 208
 209 Initial K8S Helm Chart LCM Manager
 210 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 211
 212 Onboard, start, stop, and modify Non-RT-RIC App µServices as Helm Charts.
 213 *A building block for coming releases as the R-APP concept matures*.
 214
 215 * Interfaces that accepts Non-RT-RIC App µServices Helm Charts.
 216 * Support basic LCM operations.
 217 * Onboard, Start, Stop, Modify, Monitor.
 218 * Initial version co-developed with v. similar functions in ONAP.
 219 * *Limited functionality/integration for now*.
 220
 221 Implementation:
 222
 223 * Implemented as a Java Spring Boot application.
 224 * Repo: *nonrtric/plt/helmmanager*
 225
 226 More details available at the `Helm Manager documentation site <https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-helmmanager>`_.
 227
 228 Test Framework
 229 ~~~~~~~~~~~~~~
 230
 231 A full test environment with extensive test cases/scripts can be found in the ``test`` directory in the *nonrtric* source code.
 232
 233 Use Cases
 234 ~~~~~~~~~
 235
 236 "Helloworld" O-RU Fronthaul Recovery use case
 237 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 238
 239 A very simplified closed-loop rApp use case to re-establish front-haul connections between O-DUs and O-RUs if they fail. Not intended to to be 'real-world'.
 240
 241 "Helloworld" O-DU Slice Assurance use case
 242 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 243
 244 A very simplified closed-loop rApp use case to re-prioritize a RAN slice's radio resource allocation priority if sufficient throughput cannot be maintained. Not intended to to be 'real-world'.
 245 * Repo: *nonrtric/rapp/ransliceassurance*
 246
 247 More details available at the `documentation site <https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-rapp-ransliceassurance>`__.