Overall architecture (not component-specific)
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
There's a demo video which shows how to deploy the near-RT RIC, connect an E2 node (gNB simulator) to it and how to deploy an xApp using the DMS CLI:
List of release docker images:
see here: E2 Simulator#Buildingdockerimageandrunningsimulatorinstance
An example xApp using the Golang xApp framework: link and the xApp_Writer_s_Guide_v2.pdf
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 component-by-component.
Xapp frameworks in general: see item with same name "Xapp frameworks in general:" in the "external interfaces" section below.
The RIC platform has the following external interfaces. Note that additional per-component documentation can be found here: link
(2023-06-30) Since the F release we support E2APv2.0. The older protocol versions - E2APv1.1 and E2AP1.0 - are not supported anymore (use old OSC near-RT RIC releases if needed (The E release has E2APv1.1 and is backwards compatible with E2APv1.0); or upgrade). Some features that are worthwhile to point out as supported:
Not supported
Note that the RIC platform is generally independent of E2SMs (E2 service models) and E2APv1.0, 1.1, 2.0 work with the various E2SMs as there are no dependencies.
https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-sdl/en/latest/user-guide.html
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
(2021-05-25) Support for A1-Policy and A1-EI as per A1APv3.0 and A1APv3.1. Note that the A1 mediator in the RIC platform is independent of A1TD (A1 type definitions) and passes them as opaque blobs to xApps. Also A1 mediator only handles numeric policy types and not as in the standard a string.
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
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