.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
+.. Copyright (C) 2020 Nordix
+.. _api_docs:
+========
API-Docs
========
:depth: 3
:local:
-API Introduction
------------------
+The Non-RT RIC consists of three parts, described in the sections below:
+ * The Policy Agent
+ * The SDNC A1 Controller
+ * The rAPP Catalogue
+
+
+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.
-The Non-RT RIC dashboard is an interface that allows human users to create, edit and delete policy instances, for each existing policy type. The policy types are owned by the Near-RT RIC, Non-RT RIC can just query them, so it's not possible to act on them.
+See :ref:`policy-agent-api` for how to use the API.
+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/onap/oran/docs/offeredapis/swagger/pms-api.yaml
+
+SDNC A1 Controller
+==================
+
+An ONAP SDNC Controller for the A1 interface.
+
+See :ref:`sdnc-a1-controller-api` for how to use the API.
-To run the dashboard locally, you can follow these steps:
+See the README.md file in the nonrtric/sdnc-a1-controller repo for info about how to use it.
-- Fetch the latest code from `gerrit`_
+rAPP Catalogue
+==============
-.. _gerrit: https://gerrit.nordix.org/c/oransc/nonrtric/+/2747/
+The Non RT-RIC Service Catalogue provides a way for services to register themselves for other services to discover.
-- Before compiling, run the following commands::
+See `RAC API <./rac-api.html>`_ for how to use the API.
- git submodule init
+.. |swagger-icon| image:: ./images/swagger.png
+ :width: 40px
- git submodule update
+.. |yaml-icon| image:: ./images/yaml_logo.png
+ :width: 40px
-- Start the backend (you might have to build it first)::
- mvn clean install
+.. csv-table::
+ :header: "API name", "|swagger-icon|", "|yaml-icon|"
+ :widths: 10,5, 5
- mvn -Dorg.oransc.ric.portal.dashboard=mock -Dtest=DashboardTestServer -DfailIfNoTests=false test
+ "RAC API", ":download:`link <../r-app-catalogue/api/rac-api.json>`", ":download:`link <../r-app-catalogue/api/rac-api.yaml>`"
+Complementary tools
+===================
-- Now you can open URL: `localhost:8080`_ in a browser.
+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.
-.. _localhost:8080: localhost:8080
+The Non-RT RIC Control Panel provides a user interface that allows the user to interact with the Non-RT RIC.
+Documentation for the Control Panel can be found here:
+:doc:`Non-RT RIC Control Panel <nonrtric-controlpanel:index>`.
+It can be downloaded from here: ::
-From the main page, click on the "Policy Control" card. From here, it is possible to create or list instances for each existing policy type.
+ git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel".
-When the instances are listed, it is possible to edit or delete each instance from the expanded view.
+The Near-RT RIC simulator simulates an A1 protocol termination endpoint. Documentation for the simulator can be found
+here: :doc:`A1 Interface Simulator <sim-a1-interface:index>`. It can be downloaded from here: ::
-.. image:: ./images/non-RT_RIC_dashboard.png
\ No newline at end of file
+ git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface"
Code Review / nonrtric.git / blobdiff