X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fapi-docs.rst;h=9b0608a6c959b42ebd9d66ea1e5b95676f8567b3;hb=7b36db6ef1b31daa41e115b7f199bb04f1cd0725;hp=acfe38cf6b5a981ad6c59923f6fc79ed29746844;hpb=1b8d76de3262675c5afe45351929b0d5d2c0bab1;p=nonrtric.git diff --git a/docs/api-docs.rst b/docs/api-docs.rst index acfe38cf..9b0608a6 100644 --- a/docs/api-docs.rst +++ b/docs/api-docs.rst @@ -1,5 +1,8 @@ .. 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: ======== @@ -12,80 +15,69 @@ This is the API-docs of Non-RT RIC. :depth: 3 :local: -The Non-RT RIC consists of four parts, described in the sections below: - * The Dashboard +The Non-RT RIC consists of three parts, described in the sections below: * 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`_ + * The SDNC A1 Controller + * The rAPP Catalogue -.. _gerrit: https://gerrit.o-ran-sc.org/r/admin/repos/nonrtric -- Before compiling, run the following commands:: - - git submodule init - - git submodule update +Policy Agent +============ -- Start the backend (you might have to build it first):: +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. - mvn clean install +See :ref:`policy-agent-api` for how to use the API. - mvn -Dorg.oransc.ric.portal.dashboard=mock -Dtest=DashboardTestServer -DfailIfNoTests=false test +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 -- Now you can open URL: `localhost:8080`_ in a browser. +SDNC A1 Controller +================== -.. _localhost:8080: localhost:8080 +An ONAP SDNC Controller for the A1 interface. -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 :ref:`sdnc-a1-controller-api` for how to use the API. -When the instances are listed, it is possible to edit or delete each instance from the expanded view. +See the README.md file in the nonrtric/sdnc-a1-controller repo for info about how to use it. -.. image:: ./images/non-RT_RIC_dashboard.png +rAPP Catalogue +============== -Policy Agent -============ +The Non RT-RIC Service Catalogue provides a way for services to register themselves for other services to discover. -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. +See `RAC API <./rac-api.html>`_ for how to use the API. -See the README.md file in the nonrtric/policy-agent repo for info about how to use it. +.. |swagger-icon| image:: ./images/swagger.png + :width: 40px -API Functions -------------- -See the following document for the Policy Agent API: nonrtric/policy-agent/docs/api.yaml +.. |yaml-icon| image:: ./images/yaml_logo.png + :width: 40px -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. + "RAC 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 `. +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 `. It can be downloaded from here: :: + git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface"