Add first simple version of repository supervision
[nonrtric.git] / 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
4
5 ..please write your project overview
6 ..please delete this content after editing
7
8
9 Non-RT RIC Overview
10 ===================
11
12 Find detailed description of what Non-RT RIC is on this `page`_.
13
14 .. _page: https://wiki.o-ran-sc.org/display/RICNR/
15
16 A-release architecture
17 ----------------------
18
19 The architecture is as shown on the following picture:
20
21 .. image:: ./images/architecture.png
22    :scale: 50 %
23
24 The A1 controller is located in SDNC, an ONAP component. It communicates with ORAN via the A1 interface with the Near-RT RIC simulator.
25
26 On the other end, it is accessible via a dashboard, that allows to interact with policies. The dashboard itself is split into the backend and the frontend, and can be deployed following the instructions on the `human interfaces page`_.
27
28 .. _human interfaces page: ./human-interfaces.html
29
30 Requirements for the Non-RT RIC project
31 ---------------------------------------
32
33 There are functional requirements emitted by O-RAN WG2 for the Non-RT RIC, which are the following:
34
35 1. Non-RT RIC shall support data retrieval and analysis; the data may include performance, configuration or other data related to the application (recommended data shown in required data section for  different use cases).
36 2. Non-RT RIC shall support relevant AI/ML model training based on the data in 1. for non-real-time optimization of configuration parameters in RAN or Near-RT RIC, as applicable for the use case.
37 3. Non-RT RIC shall support relevant AI/ML model training based on the data in 1. for generating/optimizing policies and intents to guide the behavior of applications in Near-RT RIC or RAN, as applicable for the use case.
38 4. Non-RT RIC shall support training of relevant AI/ML models based on the data in 1. to be deployed/updated in Near-RT RIC as required by the applications.
39 5. Non-RT RIC shall support performance monitoring and evaluation.
40 6. Non-RT RIC shall support a fallback mechanism to prevent drastic degradation/fluctuation of performance, e.g. to restore to the previous policy or configuration.
41
42 The non-functional requirements are the following ones:
43
44 1. Non-RT RIC shall not update the same policy or configuration parameter for a given near-RT RIC or RAN function more often than once per second.
45 2. Non-RT RIC shall be able to update policies in several near-RT RICs.
46
47 Moreover, there are functional requirements regarding the A1 interface:
48
49 1. A1 interface shall support communication of policies/intents from Non-RT RIC to Near-RT RIC.
50 2. A1 interface shall support AI/ML model deployment and update from Non-RT RIC to Near-RT RIC.
51 3. A1 interface shall support communication of enrichment information from Non-RT RIC to Near-RT RIC.
52 4. A1 interface shall support feedback from Near-RT RIC for monitoring AI/ML model performance.
53 5. A1 interface shall support the policy/intents feedback from Near-RT RIC to Non-RT RIC.
54
55 .. _a1_policy_procedure:
56
57 A1 policy procedure
58 -------------------
59
60 As for A-release, the methods are as follows:
61
62 +---------------------+--------------------------+--------------------------+
63 | A1 policy procedure | Single policy method     | Multiple policies method |
64 +---------------------+--------------------------+--------------------------+
65 | Create policy       | PUT                      |                          |
66 +---------------------+--------------------------+--------------------------+
67 | Query policy        | GET                      | GET (sequence of \*)     |
68 +---------------------+--------------------------+--------------------------+
69 | Update policy       | PUT                      |                          |
70 +---------------------+--------------------------+--------------------------+
71 | Delete policy       | DELETE                   |                          |
72 +---------------------+--------------------------+--------------------------+
73 | Notify policy       | POST                     | POST                     |
74 +---------------------+--------------------------+--------------------------+