X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fapi-docs.rst;h=a98672addc4fcfc42ba5935931396aa12100f087;hb=eaaee91b1defd671d06bcdfb69047e356956b77f;hp=acfe38cf6b5a981ad6c59923f6fc79ed29746844;hpb=1b8d76de3262675c5afe45351929b0d5d2c0bab1;p=nonrtric.git diff --git a/docs/api-docs.rst b/docs/api-docs.rst index acfe38cf..a98672ad 100644 --- a/docs/api-docs.rst +++ b/docs/api-docs.rst @@ -12,57 +12,17 @@ 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 two parts, described in the sections below: * The Policy Agent - * The Near-RT RIC simulator - * The Sdnc A1 Controller + * 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):: - - mvn clean install - - mvn -Dorg.oransc.ric.portal.dashboard=mock -Dtest=DashboardTestServer -DfailIfNoTests=false test - - -- Now you can open URL: `localhost:8080`_ in a browser. - -.. _localhost:8080: localhost:8080 - -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. - -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 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. + * A repository of available Near-RT RICs, their policy types and policy instances. + * An A1 connection to the Near-RT RICs. See the README.md file in the nonrtric/policy-agent repo for info about how to use it. @@ -70,22 +30,19 @@ API Functions ------------- See the following document for the Policy Agent API: nonrtric/policy-agent/docs/api.yaml -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. - -See the README.md file in the nonrtric/near-rt-ric-simulator repo for info about how to use it. - -API Functions -------------- - -See the admnistrative API in: nonrtric/near-rt-ric-simulator/ric-plt/a1/main.py. - -Sdnc A1 Controller +SDNC A1 Controller ================== An ONAP SDNC Controller for the A1 interface. See the README.md file in the nonrtric/sdnc-a1-controller repo for info about how to use it. +Complementary tools +=================== + +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. + +The Non-RT RIC Control panel provides a user interface that allows the user to interact with the Non-RT RIC. +It can be downloaded using: git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel" + +The Near-RT RIC simulator does what its name suggests, and can be downloaded here: git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface"