Merge "Sample consumer to get kafka broker from ICS"
[nonrtric.git] / docs / requirements.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 Requirements for the Non-RT RIC project
6 =======================================
7
8 Find detailed description of what Non-RT RIC is on this `page`_.
9
10 .. _page: https://wiki.o-ran-sc.org/display/RICNR/
11
12 The NONRTRIC project (and the O-RAN Non-RealTime RIC function) can be considered from a number of different viewpoints. This page presents some of these views:
13
14 **Scope 1: A1 Controller (Mediator, Endpoint)**
15
16 * Southbound: Provide termination point for A1 interface(s) - REST endpoint for messages to/from Near-RealTime RIC
17 * Northbound: Provide a more generic interface for A1 operations - provide interface to rApps, without the need for A1 message generation, addressing, coordination, mediation, etc.
18 * O1 interfaces do not terminate in NONRTRIC function (but may terminate in same controller host/instance)
19
20 **Scope 2: Coordinate/Host A1 Policy Management Services**
21
22 * Map high level RAN goal/intent directives to finely-scoped A1 Policies towards individual Near-RT RIC instances
23 * Informed by observed RAN context (provided over O1 via OAM functions), and other external context (via other SMO functions)
24 * Dynamically coordinate life cycles of A1 Policies in individual Near-RT RICs as contexts change
25
26 **Scope 3: Coordinate ML/AI Models - In RAN (“E2 nodes” & Near-RT RICs) and NONRTRIC (future)**
27
28 * Acts as model-training host
29 * May act as model-inference host (others: Near-RT RICs, “E2 nodes”)
30 * Dynamically coordinate ML/AI model lifecycle management (e.g. re-train, re-deploy, etc)
31 * Models are (always?) deployed over O1 interface
32
33 **Scope 4: Enrichment Data Coordinator**
34
35 * Additional context that is unavailable to Near-RT RICs (e.g. RAN data, SMO context, External context)
36 * Dynamically coordinate access and pass data to appropriate Near-RT RICs (e.g. for use in ML/AI model inference)
37
38 **Scope 5: rApp Host & rApp Coordinator**
39
40 * rApps may act as, or form part of, NONRTRIC- or SMO-level applications
41 * rApps, via rApp host function, may consume many other services - some from the NONRTRIC platform, some from the SMO platform, and some from other rApps
42 * Dynamically coordinate rApp lifecycle management
43
44 **Scope 6: Provide R1 interface for rApps**
45
46 * rApps may only consume services over the R1 interface (from NONRTRIC platform, or from SMO platform, or from other rApps)
47 * Platform services and services optionally provided by rApps must be exposed over the R1 Interface
48 * These services may be "standardized" R1 services or R1 extensions (some may be proprietary)