Architecture introduction
Overall architecture (not component-specific)
Installing the near-RT RIC
Outdated: Bronze release (Jun-21-2020) Getting Started → Near Realtime RIC Installation (but similar sequence is used in Cherry and Dawn)
Generally the latest instructions: https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-ric-dep/en/latest/ → Installing Near Realtime RIC in RIC Cluster
List of Dawn release docker images: Near-RT RIC (D release). Old list of cherry docker images: Near-RT RIC
Guides
An example xApp using the Golang xApp framework: link
Also check the "md" files in the base directory of many of the RIC repositories by name in gerrit.
Also check the currently still somewhat empty information in readthedocs
Xapp frameworks in general: see item with same name "Xapp frameworks in general:" in the "external interfaces" section below.
External interfaces
The RIC platform has the following external interfaces
O1:
- Support for netconf "Hello exchange" (incl. capability exchange)
- Alarms as VES events as per RIC Alarm System
- get E2 stats (on number of packets over E2) via the path E2T->Prometheus->VESPA→(ONAP). Requires setting the environment variable VESMGR_PLT_CFG_FILE which contains the VESPA mapping for this path: Prometheus->VESPA
O2: Support for O2 use case "Deploy xApp in near-RT RIC" in WG6's O-RAN orchestration use cases v2.0. This is done as per the CLI that is in this commit https://gerrit.o-ran-sc.org/r/c/ric-plt/appmgr/+/5816
A1: (2021-05-25) Support for A1-Policy and A1-EI (RIC-129)
- Best checked from here: https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-a1/en/latest/user-guide-api.html
E2: (2021-05-25) implementing E2APv1.0, excl. the three features added in E2APv1.1. Also no support for RIC-784 (timer handling in E2 control messages), RIC-785 (error indication handling) and no E2 Reset.
Xapp Frameworks
- Xapp frameworks in general: See xapp writers guide xApp_Writer_s_Guide_v2.pdf attached to this wiki page (Dawn onwards). The earlier xapp_Writer_s_guide.pdf is not to be used anymore. Generally, we are in the process of moving the app writing guide to https://docs.o-ran-sc.org.).
- Xapp framework for Go: as per link under "xApp framework for Go" in Near Realtime RAN Intelligent Controller (RIC)
- Xapp framework for python: as per link under "xApp framework for python" in Near Realtime RAN Intelligent Controller (RIC)
- Xapp framework for C++: as per link under "xApp framework for CXX" in Near Realtime RAN Intelligent Controller (RIC)
RMR: Check the read-the-docs page: https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-lib-rmr/en/latest/rel-notes.html Additionally you might read RIC Message Router (RMR)
Subscription manager: https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-submgr/en/latest/user-guide.html and REST API: link
SDL API: https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-sdl/en/latest/user-guide.html
Xapp onboarding and deployment: check section "RIC applications" in https://docs.o-ran-sc.org/projects/o-ran-sc-it-dep/en/latest/installation-guides.html#ric-applications on how to use the dms_cli to onboard and deploy xApps. Onboarding is the act of generating a Helm chart for the xApp from the its xApp descriptor. Using the generated helm chart (which is specific to a particular RIC instance) the xApp can be deployed.
Generally check the read-the-docs pages: https://docs.o-ran-sc.org/en/latest/projects.html#near-realtime-ran-intelligent-controller-ric