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-F.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 <#non-rt-ric-control-panel-nonrtric-dashboard>`_. :doc:`Documentation site <controlpanel:index>`.
  32 * `Information Coordinator Service <#information-coordination-service>`_. :doc:`Documentation site <informationcoordinatorservice:index>`.
  33 * `A1 Policy Management Service <#a1-policy-management-service-from-onap-ccsdk>`_. :doc:`Documentation site <a1policymanagementservice:index>`.
  34 * `A1 Policy Controller / Adapter <#a1-sdnc-controller-a1-adapter-controller-plugin>`_.
  35 * `Near-RT RIC A1 Simulator <#a1-interface-near-rt-ric-simulator>`_. :doc:`Documentation site <simulator:index>`.
  36 * `Non-RT-RIC (Spring Cloud) Service Gateway <#non-rt-ric-spring-cloud-service-gateway>`_.
  37 * `Non-RT-RIC (Kong) Service Exposure Prototyping <#non-rt-ric-kong-service-exposure-prototyping>`_.
  38 * `DMaaP/Kafka Information Producer Adapters <#dmaap-kafka-information-producer-adapters>`_. :doc:`Documentation site adapter <dmaapadapter:index>`. :doc:`Documentation site mediator <dmaapmediatorproducer:index>`.
  39 * `Initial Non-RT-RIC App Catalogue <#initial-non-rt-ric-app-catalogue>`_. :doc:`Documentation site <rappcatalogue:index>`.
  40 * `Initial K8S Helm Chart LCM Manager <#id5>`_. :doc:`Documentation site <helmmanager:index>`.
  41 * `Authentication Support <#id6>`_. :doc:`Documentation site <authtokenfetch:index>`.
  42 * `Service Management & Exposure (SME) <#service-management-and-exposure>`_. :doc:`Documentation site <sme:index>`.
  43 * `Test Framework <#id7>`_.
  44 * `Use Cases: <#non-rt-ric-use-cases>`_
  45
  46   * "Helloworld" O-RU Fronthaul Recovery use case. :doc:`Documentation site <orufhrecovery:index>`.
  47   * "Helloworld" O-DU Slice Assurance use case. :doc:`Documentation site <ransliceassurance:index>`.
  48
  49
  50 Non-RT-RIC Control Panel / NONRTRIC Dashboard
  51 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  52
  53 Graphical user interface.
  54
  55 - View and Manage A1 policies in the RAN (near-RT-RICs)
  56 - Graphical A1 policy creation/editing is model-driven, based on policy type's JSON schema
  57 - View and manage producers and jobs for the Information coordinator service
  58 - Configure A1 Policy Management Service (e.g. add/remove near-rt-rics)
  59 - Interacts with the A1-Policy Management Service & Information Coordination Service (REST NBIs) via Service Exposure gateway
  60
  61 Implementation:
  62
  63 - Frontend: Angular framework
  64 - Repo: *portal/nonrtric-controlpanel*
  65 - `Wiki <https://wiki.o-ran-sc.org/display/RICNR/>`_ to set up in your local environment.
  66 - Documentation at the :doc:`NONRTRIC-Portal documentation site <controlpanel:index>`.
  67
  68 Information Coordination Service
  69 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  70
  71 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.
  72
  73 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.
  74
  75 Maintains a registry of:
  76 - Information Types / schemas
  77 - Information Producers
  78 - Information Consumers
  79 - Information Jobs
  80
  81 The service is not involved in data delivery and hence does not put restrictions on this.
  82
  83 Implementation:
  84
  85 - Implemented as a Java Spring Boot application.
  86 - Repo: *nonrtric/plt/informationcoordinatorservice*.
  87 - Documentation at the :doc:`Information Coordination Service site <informationcoordinatorservice:index>`.
  88
  89 A1 Policy Management Service (from ONAP CCSDK)
  90 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  91
  92 A1 Controller Service above A1 Controller/Adapter that provides:
  93
  94 - Unified REST & DMaaP NBI APIs for managing A1 Policies in all near-RT-RICs.
  95
  96   - Query A1 Policy Types in near-RT-RICs.
  97   - Create/Query/Update/Delete A1 Policy Instances in near-RT-RICs.
  98   - Query Status for A1 Policy Instances.
  99
 100 Maintains (persistent) cache of RAN's A1 Policy information.
 101
 102 - Support RAN-wide view of A1 Policy information.
 103 - Streamline A1 traffic.
 104 - Enable (optional) re-synchronization after inconsistencies / near-RT-RIC restarts.
 105 - Supports a large number of near-RT-RICs (& multi-version support).
 106
 107 - Converged ONAP & O-RAN-SC A1 Adapter/Controller functions in ONAP SDNC/CCSDK (Optionally deploy without A1 Adapter to connect direct to near-RT-RICs).
 108 - 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.
 109
 110 Implementation:
 111
 112 - Implemented as a Java Spring Boot application.
 113 - Wiki: `A1 Policy Management Service in ONAP <https://wiki.onap.org/pages/viewpage.action?pageId=84672221>`_ .
 114 - Repo: *nonrtric/plt/a1policymanagementservice*.
 115 - Documentation at the :doc:`A1 Policy Management Service documentation site <a1policymanagementservice:index>`.
 116
 117 A1/SDNC Controller & A1 Adapter (Controller plugin)
 118 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 119 Mediation point for A1 interface termination in SMO/NONRTRIC.
 120
 121 - Implemented as CCSDK OSGI Feature/Bundles.
 122 - A1 REST southbound.
 123 - RESTCONF Northbound.
 124 - NETCONF YANG > RESTCONF adapter.
 125 - SLI Mapping logic supported.
 126 - Can be included in an any controller based on ONAP CCSDK.
 127
 128 Implementation:
 129
 130 - Repo: *nonrtric/plt/sdnca1controller*
 131 - Wiki: `A1 Adapter/Controller Functions in ONAP <https://wiki.onap.org/pages/viewpage.action?pageId=84672221>`_ .
 132
 133 A1 Interface / Near-RT-RIC Simulator
 134 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 135
 136 Stateful A1 test stub.
 137
 138 - Used to create multiple stateful A1 providers (simulated near-rt-rics).
 139 - Supports A1-Policy and A1-Enrichment Information.
 140 - Swagger-based northbound interface, so easy to change the A1 profile exposed (e.g. A1 version, A1 Policy Types, A1-E1 consumers, etc).
 141 - All A1-AP versions supported.
 142
 143 Implementation:
 144
 145 - Implemented as a Python application.
 146 - Repo: *sim/a1-interface*.
 147 - Documentation at the :doc:`A1 Simulator documentation site <simulator:index>`.
 148
 149 Non-RT-RIC (Spring Cloud) Service Gateway
 150 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 151 Support Apps to use A1 Services.
 152
 153 - `Spring Cloud Gateway <https://cloud.spring.io/spring-cloud-gateway>`_ provides the library to build a basic API gateway.
 154 - Exposes A1 Policy Management Service & Information Coordinator Service.
 155 - Additional predicates can be added in code or preferably in the Gateway yaml configuration.
 156
 157 Implementation:
 158
 159 - Implemented as a Java Spring Cloud application.
 160 - Repo: *portal/nonrtric-controlpanel*.
 161
 162
 163 Non-RT-RIC (Kong) Service Exposure Prototyping
 164 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 165
 166 Support Apps to use NONRTRIC, SMO and other App interfaces.
 167 A building block for coming releases as the R1 Interface concept matures .
 168
 169 - Support dynamic registration and exposure of service interfaces to Non-RT-RIC applications (& NONRTRIC Control panel).
 170 - Extends a static gateway function specifically for NONRTRIC Control panel (described above).
 171 - Initial version based on `Kong API Gateway <https://docs.konghq.com/gateway-oss>`_ function.
 172 - Initial exposure candidates include A1 (NONRTRIC) services & O1 (OAM/SMO) services.
 173
 174 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.
 175
 176 DMaaP/Kafka Information Producer Adapters
 177 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 178
 179 Configurable mediators to take information from DMaaP and Kafka and present it as a coordinated Information Producer.
 180
 181 These mediators/adapters are generic information producers, which register themselves as information producers of defined information types in Information Coordination Service (ICS).
 182 The information types are defined in a configuration file.
 183 Information jobs defined using ICS then allow information consumers to retrieve data from DMaaP MR or Kafka topics (accessing the ICS API).
 184
 185 There are two alternative implementations to allow Information Consumers to consume DMaaP or Kafka events as coordinated Information Jobs.
 186
 187 Implementation:
 188
 189 - Implementation in Java Spring (DMaaP Adapter), repo: *nonrtric/plt/dmaapadapter*, see :doc:`DMaaP Adapter documentation site <dmaapadapter:index>`.
 190 - Implementation in Go (DMaaP Mediator Producer), repo: *nonrtric/plt/dmaapmediatorproducer*, see :doc:`DMaaP Mediator Producer documentation site <dmaapmediatorproducer:index>`.
 191
 192 Initial Non-RT-RIC App Catalogue
 193 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 194
 195 Register for Non-RT-RIC Apps.
 196
 197 - Non-RT-RIC Apps can be registered / queried.
 198 - Limited functionality/integration for now.
 199 - *More work required in coming releases as the rApp concept matures*.
 200
 201 Implementation:
 202
 203 - Implemented as a Java Spring Boot application.
 204 - Repo: *nonrtric/plt/rappcatalogue*
 205 - Documentation at the :doc:`rApp Catalogue documentation site <rappcatalogue:index>`.
 206
 207 Initial K8S Helm Chart LCM Manager
 208 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 209
 210 Onboard, start, stop, and modify Non-RT-RIC App µServices as Helm Charts.
 211 *A building block for coming releases as the R-APP concept matures*.
 212
 213 - Interfaces that accepts Non-RT-RIC App µServices Helm Charts.
 214 - Support basic LCM operations.
 215 - Onboard, Start, Stop, Modify, Monitor.
 216 - Initial version co-developed with v. similar functions in ONAP.
 217 - *Limited functionality/integration for now*.
 218
 219 Implementation:
 220
 221 - Implemented as a Java Spring Boot application.
 222 - Repo: *nonrtric/plt/helmmanager*
 223 - Documentation at the :doc:`Helm Manager documentation site <helmmanager:index>`.
 224
 225 Service Management and Exposure
 226 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 227
 228 An initial implementation of the CAPIF Core service. It implements the following CAPIF APIs:
 229
 230 - API Provider Management
 231 - Publish Service
 232 - Discover Service
 233 - API Invoker Management
 234 - Security
 235 - Events
 236
 237 Implementation:
 238
 239 - Implemented in Go
 240 - Repo: *nonrtric/plt/sme*
 241 - Documentation at the :doc:`Service Management & Exposure (SME) documentation site <sme:index>`.
 242
 243 Authentication Support
 244 ~~~~~~~~~~~~~~~~~~~~~~
 245
 246 The auth-token-fetch provides support for authentication.
 247 It is intended to be used as a sidecar and does the authentication procedure, gets and saves the access token
 248 in the local file system. This includes refresh of the token before it expires.
 249 This means that the service only needs to read the token from a file.
 250
 251 It is tested using Keycloak as authentication provider.
 252
 253 .. image:: ./AuthSupport.png
 254    :width: 500pt
 255
 256 So, a service just needs to read the token file and for instance insert it in the authorization header when using HTTP.
 257 The file needs to be re-read if it has been updated.
 258
 259 The auth-token-fetch is configured by the following environment variables.
 260
 261 * CERT_PATH - the file path of the cert to use for TSL, example: security/tls.crt
 262 * CERT_KEY_PATH - the file path of the private key file for the cert, example: "security/tls.key"
 263 * ROOT_CA_CERTS_PATH - the file path of the trust store.
 264 * CREDS_GRANT_TYPE - the grant_type used for authentication, example: client_credentials
 265 * CREDS_CLIENT_SECRET - the secret/private shared key used for authentication
 266 * CREDS_CLIENT_ID - the client id used for authentication
 267 * OUTPUT_FILE - the path where the fetched authorization token is stored, example: "/tmp/authToken.txt"
 268 * AUTH_SERVICE_URL - the URL to the authentication service (Keycloak)
 269 * REFRESH_MARGIN_SECONDS - how long in advance before the authorization token expires it is refreshed
 270
 271 Test Framework
 272 ~~~~~~~~~~~~~~
 273
 274 A full test environment with extensive test cases/scripts can be found in the ``test`` directory in the *nonrtric* source code.
 275
 276 Non-RT-RIC Use Cases
 277 ~~~~~~~~~~~~~~~~~~~~
 278
 279 "Helloworld" O-RU Fronthaul Recovery use case
 280 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 281
 282 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'.
 283
 284 Implementation:
 285
 286 - One version implemented in Python, one in Go as an Information Coordination Service Consumer, and one as an apex policy.
 287 - Repo: *nonrtric/rapp/orufhrecovery*
 288 - Documentation at the :doc:`O-RU Fronthaul Recovery documentation site <orufhrecovery:index>`.
 289
 290 "Helloworld" O-DU Slice Assurance use case
 291 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 292
 293 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'.
 294
 295 Implementation:
 296
 297 - One version implemented in Go as a micro service, one in Go as an Information Coordination Service Consumer.
 298 - Repo: *nonrtric/rapp/ransliceassurance*
 299 - Documentation at the :doc:`O-DU Slice Assurance documentation site <ransliceassurance:index>`.