X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fapi-docs.rst;h=ef234a5661f603c785a6530598865c737fea4b4c;hb=2445c936d194565d989e196299dd8dd27183a5cd;hp=acfe38cf6b5a981ad6c59923f6fc79ed29746844;hpb=a538ca7e0b840e8dc20e85c1864697823ad96ae0;p=nonrtric.git diff --git a/docs/api-docs.rst b/docs/api-docs.rst index acfe38cf..ef234a56 100644 --- a/docs/api-docs.rst +++ b/docs/api-docs.rst @@ -1,91 +1,86 @@ .. 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 -======== - -This is the API-docs of Non-RT RIC. - -.. contents:: - :depth: 3 - :local: +.. |swagger-icon| image:: ./images/swagger.png + :width: 40px -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 +.. |yaml-icon| image:: ./images/yaml_logo.png + :width: 40px -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-Docs +======== -API Functions -------------- +Here we describe the APIs to access the Non-RT RIC functions. -To run the dashboard locally, you can follow these steps: +The core Non-RT RIC consists of several parts, with available APIs described in the sections below: -- Fetch the latest code from `gerrit`_ +* The A1 Policy Management Service +* The Enrichment Coordinator Service +* The Non-RT-RIC App Catalogue +* K8S Helm Chart LCM Manager (Initial) **** -.. _gerrit: https://gerrit.o-ran-sc.org/r/admin/repos/nonrtric +A1 Policy Management Service +============================ -- Before compiling, run the following commands:: +For information about the A1 Policy Management Service that is implemented in ONAP, see `ONAP docs `_ and `wiki `_. - git submodule init +Enrichment Coordinator Service +============================== - git submodule update +See `A1 Enrichment Information Coordination Service API <./ecs-api.html>`_ for full details of the API. -- Start the backend (you might have to build it first):: +The API is also described in Swagger-JSON and YAML: - 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 + "A1 Enrichment Information Coordination Service API", ":download:`link <../enrichment-coordinator-service/api/ecs-api.json>`", ":download:`link <../enrichment-coordinator-service/api/ecs-api.yaml>`" +Non-RT-RIC App Catalogue (Initial) +================================== -- Now you can open URL: `localhost:8080`_ in a browser. +The Service Catalogue provides a way for services to register themselves for other services to discover. -.. _localhost:8080: localhost:8080 +See `Service Catalogue API <./rac-api.html>`_ for full details of the API. -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. +The API is also described in Swagger-JSON and YAML: -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 +.. csv-table:: + :header: "API name", "|swagger-icon|", "|yaml-icon|" + :widths: 10,5, 5 -Policy Agent -============ + "Service Catalogue API", ":download:`link <../r-app-catalogue/api/rac-api.json>`", ":download:`link <../r-app-catalogue/api/rac-api.yaml>`" -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. +K8S Helm Chart LCM Manager (Initial) +==================================== -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 +See Also: Non-RT RIC Control Panel +================================== -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. -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. +Documentation for the Control Panel can be found here: `Non-RT RIC Control Panel `_. -See the README.md file in the nonrtric/near-rt-ric-simulator repo for info about how to use it. +It can be downloaded from here: :: -API Functions -------------- + git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel". -See the admnistrative API in: nonrtric/near-rt-ric-simulator/ric-plt/a1/main.py. +See Also: A1 / Near-RT RIC simulator +==================================== -Sdnc A1 Controller -================== +The Near-RT RIC simulator simulates an A1 protocol termination endpoint. -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"