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