From: maximesson Date: Thu, 26 Mar 2020 15:43:27 +0000 (+0100) Subject: Documentation reorganisation X-Git-Tag: 2.0.0~98^2 X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F24%2F3024%2F2;p=nonrtric.git Documentation reorganisation Change-Id: I8db9e11ba1f979970c189f81c743f6009dcda8f0 Issue-ID: NONRTRIC-166 Signed-off-by: maximesson --- 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" diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index b3651f43..54023287 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -7,7 +7,7 @@ Developer Guide This document provides a quickstart for developers of the Non-RT RIC. SDNC A1 Controller -================================== +================== Prerequisites ------------- @@ -45,8 +45,9 @@ The SDNC url to access the Northbound API, Credentials: admin/Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U Policy Agent -============================ -The O-RAN NonRT RIC PolicyAgent provides a REST API for management of policices. It provides support for: +============ + +The O-RAN Non-RT RIC Policy Agent provides a REST API for management of policices. It provides support for: * Supervision of clients (R-APPs) to eliminate stray policies in case of failure * Consistency monitoring of the SMO view of policies and the actual situation in the RICs @@ -57,39 +58,12 @@ The O-RAN NonRT RIC PolicyAgent provides a REST API for management of policices. * Query functions that can find all policies in a RIC, all policies owned by a service (R-APP), all policies of a type etc. * Maps O1 resources (ManagedElement) as defined in O1 to the controlling RIC. -| The PolicyAgent can be accessed over the REST API or through the DMaaP Interface. The REST API is documented in the -| *nonrtric/policy-agent/docs/api.yaml* file. Please refer to the README file of PolicyAgent to know more about the API's. - - -Near-RT RIC Simulator -===================================== - - -Prerequisites -------------- - 1. Java development kit (JDK), version 8 - 2. Maven dependency-management tool, version 3.4 or later - -Build and run -------------- - -Go to the near-rt-ric-simulator/ric-plt-a1/ directory and run this command:: - mvn clean install -The docker image can be built using:: - docker build -t {desiredImageName} . -The image can be run using the command:: - docker run -it -p {desiredPort}:8085 {desiredImageName} - -The functions written in *a1.py* are the ones matching the requests listed in the A1 open api yaml file. The functions written in *main.py* are the ones used for development purpose. - -Different error codes can be thrown back according to the yaml file. In order to simulate an error code, simply add the query ?code={desiredCodeNumber} at the end of the address in the curl request. - -For running the simulator outside of a docker container, run ./run_me.sh. It is possible to use the port of your choice, by adding it in the command: ./run_me.sh {desiredPort}. -After that, it is the exact same use with or without a container. +| The Policy Agent can be accessed over the REST API or through the DMaaP Interface. The REST API is documented in the +| *nonrtric/policy-agent/docs/api.yaml* file. Please refer to the README file of Policy Agent to know more about the API's. End-to-end call =============== In order to make a complete end-to-end call, follow the instructions given in this `guide`_. -.. _guide: https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=12157166 \ No newline at end of file +.. _guide: https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=12157166 diff --git a/docs/images/architecture.png b/docs/images/architecture.png deleted file mode 100644 index c94d5918..00000000 Binary files a/docs/images/architecture.png and /dev/null differ diff --git a/docs/images/non-RT_RIC_dashboard.png b/docs/images/non-RT_RIC_dashboard.png deleted file mode 100644 index b69ba4da..00000000 Binary files a/docs/images/non-RT_RIC_dashboard.png and /dev/null differ diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index 995f4ebd..973319b5 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -13,13 +13,45 @@ Installation Guide Abstract -------- -This document describes how to install the Non-RT RIC dashboard, its dependencies and required system resources. +This document describes how to install the Non-RT RIC SDNC A1 Controller, its dependencies and required system resources. -This work is in progress. For now, it is possible to use the Non-RT RIC dashboard. Please visit the `api-docs page`_ for more on how to deploy it and use it. +This work is in progress. Please visit the `api-docs page`_ for more information about the SDNC A1 Controller and the Policy Agent. .. _api-docs page: ./api-docs.html +Installation +------------ + +Download the SDNC repo: + + git clone "https://gerrit.o-ran-sc.org/r/nonrtric" + +The SDNC A1 Controller could be found in this repo. + +Build SDNC project: + + Enter into the sdnc-a1-controller project, northbound and oam project will located there. + + cd sdnc-a1-controller + + Build northbound project with command: + + mvn clean install -Dmaven.test.skip=true + + Build oam project with command: + + mvn clean install -Dmaven.test.skip=true -P docker + + Enter into this directory: + + cd nonrtric/sdnc-a1-controller/oam/installation/src/main/yaml + + and run the command: + + MTU=1500 docker-compose up a1-controller + Version history +--------------- +--------------------+--------------------+--------------------+--------------------+ | **Date** | **Ver.** | **Author** | **Comment** | @@ -28,7 +60,7 @@ Version history | 2019-11-12 | 0.1.0 | Maxime Bonneau | First draft | | | | | | +--------------------+--------------------+--------------------+--------------------+ -| | 0.1.1 | | | +| 2020-03-24 | 0.1.1 | Maxime Bonneau | Second draft | | | | | | +--------------------+--------------------+--------------------+--------------------+ | | 1.0 | | | diff --git a/docs/overview.rst b/docs/overview.rst index 3824f317..339de802 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -53,13 +53,13 @@ As for A-release, the methods are as follows: Policy Agent Overview ======================= -The Policy Agent maintains a transient ropository of the following items to support R-Apps: +The Policy Agent maintains a transient repository of the following items to support R-Apps: - * All NearRT RICs in the network. This information is configured using the ONAP CDS database (which is using the Cloudify Consul database). + * All Near-RT RICs in the network. This information is configured using the ONAP CDS database (which is using the Cloudify Consul database). * All Policy types for all NearRT RICs * All configured Policy instances in the network -It provides an NBI for the R-Apps (and for the dashboard) for policy management. This is a REST API. +It provides an NBI for the R-Apps (and for the control panel) for policy management. This is a REST API. As an option, policy management can also be done via asynchronous messages through ONAP/Dmaap. The NBI provides support for an R-APP to locate the correct NearRT RIC based on identifiers as defined in O1. @@ -69,10 +69,10 @@ The R-Apps can be monitored so that their Policies can be automatically removed On its southbound side the agent can connect to a number of different A1 providers: - * Directly to the NonRT RIC: + * Directly to the Non-RT RIC: - OSC API, which is influenced by the A1 standard - - The NonRT RIC simulator, which supports the A1 standard with a number of not yet CRs included. + - The Non-RT RIC simulator, which supports the A1 standard with a number of not yet CRs included. * To an ONAP style controller. Amber release Policy Agent architecture @@ -83,26 +83,6 @@ Amber release Policy Agent architecture NonRT RIC components: - #. Non-RT RIC Dashboard - #. Policy agent + #. Policy Agent #. SDNC A1 Controller - #. Near-RT RIC Simulator -Dashboard Overview -=================== - -The NonRT RIC Dashboard is a graphical user user interface that enables the user to manage the Policies in the network. The dashboard interacts with the Policy agent via a REST API. -The dashboard generates its GUI from JSON schemas in a model driven fashion. - -The dashboards consists of a back end implemented as a Java Springboot application and a fronted developed using the Angular framework. - -Amber release Dashboard architecture ------------------------------------------ - -The architecture of the dashboardis as shown on the following picture: - -.. image:: ./images/architecture.png - :scale: 50 % - -The dashboard itself is split -into the backend and the frontend, and can be deployed following the instructions in the README.md file in the repo. \ No newline at end of file