.. 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:
+
+.. |swagger-icon| image:: ./images/swagger.png
+ :width: 40px
+
+.. |yaml-icon| image:: ./images/yaml_logo.png
+ :width: 40px
========
This is the API-docs of Non-RT RIC.
-.. contents::
- :depth: 3
- :local:
-
-The Non-RT RIC consists of four parts, described in the sections below:
- * The Dashboard
- * The Policy Agent
- * The Near-RT RIC simulator
- * The Sdnc A1 Controller
-
-Dashboard
-=========
-
-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 the README.md file in the nonrtric/dashboard repo for info about how to use it.
-
-API Functions
--------------
-
-To run the dashboard locally, you can follow these steps:
-
-- Fetch the latest code from `gerrit`_
-
-.. _gerrit: https://gerrit.o-ran-sc.org/r/admin/repos/nonrtric
-
-- Before compiling, run the following commands::
-
- git submodule init
-
- git submodule update
-
-- Start the backend (you might have to build it first)::
+The Non-RT RIC consists of three parts, described in the sections below:
+ * The A1 Policy Management Service
+ * The Enrichment Coordinator Service
+ * The rAPP Catalogue
- mvn clean install
- mvn -Dorg.oransc.ric.portal.dashboard=mock -Dtest=DashboardTestServer -DfailIfNoTests=false test
+A1 Policy Management Service
+============================
+For information about the A1 Policy Management Service that is implemented in ONAP, see `readthedocs`_ and `wiki`_.
-- Now you can open URL: `localhost:8080`_ in a browser.
+.. _readthedocs: https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/index.html
+.. _wiki: https://wiki.onap.org/pages/viewpage.action?pageId=84644984
-.. _localhost:8080: localhost:8080
+Enrichment Coordinator Service
+==============================
-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.
+See `ECS API <./ecs-api.html>`_ for how to use the API.
-When the instances are listed, it is possible to edit or delete each instance from the expanded view.
+.. csv-table::
+ :header: "API name", "|swagger-icon|", "|yaml-icon|"
+ :widths: 10,5,5
-.. image:: ./images/non-RT_RIC_dashboard.png
+ "ECS API", ":download:`link <../enrichment-coordinator-service/api/ecs-api.json>`", ":download:`link <../enrichment-coordinator-service/api/ecs-api.yaml>`"
-Policy Agent
-============
-The Policy Agent provides common functionality useful for R-Apps, for instance:
- * A repository of available Near-T RICs, their policy types and policy instances.
- * An A1 connection to he Near-RT RICs.
+Service Catalogue
+=================
-See the README.md file in the nonrtric/policy-agent repo for info about how to use it.
+The Non RT-RIC Service Catalogue provides a way for services to register themselves for other services to discover.
-API Functions
--------------
-See the following document for the Policy Agent API: nonrtric/policy-agent/docs/api.yaml
+See `SC API <./rac-api.html>`_ for how to use the API.
-Near-RT RIC Simulator
-=====================
-A simulator that simulates a Near-RT RIC, with a termination of the A1 interface. It also provides an administrative API to manage types and instances so it can be programatically set up for use in tests.
+.. csv-table::
+ :header: "API name", "|swagger-icon|", "|yaml-icon|"
+ :widths: 10,5, 5
-See the README.md file in the nonrtric/near-rt-ric-simulator repo for info about how to use it.
+ "SC API", ":download:`link <../r-app-catalogue/api/rac-api.json>`", ":download:`link <../r-app-catalogue/api/rac-api.yaml>`"
-API Functions
--------------
+Complementary tools
+===================
-See the admnistrative API in: nonrtric/near-rt-ric-simulator/ric-plt/a1/main.py.
+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.
-Sdnc A1 Controller
-==================
+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: ::
-An ONAP SDNC Controller for the A1 interface.
+ git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel".
-See the README.md file in the nonrtric/sdnc-a1-controller repo for info about how to use it.
+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: ::
+ git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface"
Code Review / nonrtric.git / blobdiff