X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fapi-docs.rst;h=7c6b6c2561c423e16af63db66bc5715098ed37d5;hb=2918bef3d237c99e6cf7e9c1ab1722781128617b;hp=5177088b2c602d8dfa0c294811248a2f309b9120;hpb=448c3841f395c0927d83c7297491475e027f23c5;p=nonrtric.git diff --git a/docs/api-docs.rst b/docs/api-docs.rst index 5177088b..7c6b6c25 100644 --- a/docs/api-docs.rst +++ b/docs/api-docs.rst @@ -1,87 +1,86 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +.. Copyright (C) 2021 Nordix + +.. _api_docs: + +.. |swagger-icon| image:: ./images/swagger.png + :width: 40px + +.. |yaml-icon| image:: ./images/yaml_logo.png + :width: 40px ======== API-Docs ======== -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 +Here we describe the APIs to access the Non-RT RIC functions. -Dashboard -========= +The core Non-RT RIC consists of several parts, with available APIs described in the sections below: -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. +* The A1 Policy Management Service +* The Information Coordinator Service +* DMaaP Adaptor +* K8S Helm Chart LCM Manager (Initial) **** -See the README.md file in the nonrtric/dashboard repo for info about how to use it. +A1 Policy Management Service +============================ -API Functions -------------- +For information about the A1 Policy Management Service that is implemented in ONAP, see `ONAP docs `_ and `wiki `_. -To run the dashboard locally, you can follow these steps: +Information Coordinator Service +=============================== -- Fetch the latest code from `gerrit`_ +See `A1 Information Information Coordination Service API <./ics-api.html>`_ for full details of the API. -.. _gerrit: https://gerrit.o-ran-sc.org/r/admin/repos/nonrtric +The API is also described in Swagger-JSON and YAML: -- Before compiling, run the following commands:: +.. csv-table:: + :header: "API name", "|swagger-icon|", "|yaml-icon|" + :widths: 10,5,5 - git submodule init + "A1 Information Coordination Service API", ":download:`link <../information-coordinator-service/api/ics-api.json>`", ":download:`link <../information-coordinator-service/api/ics-api.yaml>`" - git submodule update +DMaaP Adaptor +============= -- Start the backend (you might have to build it first):: +The DMaaP Adaptor provides support for push delivery of any data received from DMaaP or Kafka. - mvn clean install +See `DMaaP Adaptor API <./dmaap-adaptor-api.html>`_ for full details of the API. - mvn -Dorg.oransc.ric.portal.dashboard=mock -Dtest=DashboardTestServer -DfailIfNoTests=false test +The API is also described in Swagger-JSON and YAML: -- Now you can open URL: `localhost:8080`_ in a browser. +.. csv-table:: + :header: "API name", "|swagger-icon|", "|yaml-icon|" + :widths: 10,5, 5 -.. _localhost:8080: localhost:8080 + "DMaaP Adaptor API", ":download:`link <../dmaap-adaptor-java/api/api.json>`", ":download:`link <../dmaap-adaptor-java/api/api.yaml>`" -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. +K8S Helm Chart LCM Manager (Initial) +==================================== -When the instances are listed, it is possible to edit or delete each instance from the expanded view. +**** -.. image:: ./images/non-RT_RIC_dashboard.png +See Also: Non-RT RIC Control Panel +================================== -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. +The Non-RT RIC Control Panel provides a user interface that allows the user to interact with the Non-RT RIC. -See the README.md file in the nonrtric/policy-agent repo for info about how to use it. +Documentation for the Control Panel can be found here: `Non-RT RIC Control Panel `_. -API Functins ------------- -See the following document for the Policy Agent API: nonrtric/policy-agent/docs/api.doc. +It can be downloaded from here: :: -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. + git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel". -See the README.md file in the nonrtric/near-rt-ric-simulator repo for info about how to use it. +See Also: A1 / Near-RT RIC simulator +==================================== -API Functions -------------- -See the admnistrative API in: nonrtric/near-rt-ric-simulator/ric-plt/a1/main.py. +The Near-RT RIC simulator simulates an A1 protocol termination endpoint. -Sdnc A1 Controller -================== -An ONAP SDNC Controller for the A1 interface. +Documentation for the simulator can be found here: `A1 Interface Simulator `_. -See the README.md file in the nonrtric/sdnc-a1-controller repo for info about how to use it. +It can be downloaded from here: :: + git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface"