blob: a98672addc4fcfc42ba5935931396aa12100f087 [file] [log] [blame]
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
========
API-Docs
========
This is the API-docs of Non-RT RIC.
.. contents::
:depth: 3
:local:
The Non-RT RIC consists of two parts, described in the sections below:
* The Policy Agent
* The SDNC A1 Controller
Policy Agent
============
The Policy Agent provides common functionality useful for R-Apps, for instance:
* A repository of available Near-RT RICs, their policy types and policy instances.
* An A1 connection to the Near-RT RICs.
See the README.md file in the nonrtric/policy-agent repo for info about how to use it.
API Functions
-------------
See the following document for the Policy Agent API: nonrtric/policy-agent/docs/api.yaml
SDNC A1 Controller
==================
An ONAP SDNC Controller for the A1 interface.
See the README.md file in the nonrtric/sdnc-a1-controller repo for info about how to use it.
Complementary tools
===================
There are two additional tools that can be used together with the Non-RT RIC, namely the control panel and the Near-RT RIC simulator.
The Non-RT RIC Control panel provides a user interface that allows the user to interact with the Non-RT RIC.
It can be downloaded using: git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel"
The Near-RT RIC simulator does what its name suggests, and can be downloaded here: git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface"