.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. SPDX-License-Identifier: CC-BY-4.0
-.. Copyright (C) 2020 Nordix
+.. Copyright (C) 2021 Nordix
Developer Guide
===============
-This document provides a quickstart for developers of the Non-RT RIC.
+This document provides a quickstart for developers of the Non-RT RIC parts.
-A1 Policy Management Service
-----------------------------
+Additional developer guides are available on the `O-RAN SC NONRTRIC Developer wiki <https://wiki.o-ran-sc.org/display/RICNR/Release+E>`_
-The Policy Management is implemented in ONAP. For documentation see `readthedocs`_ and `wiki`_.
+A1 Policy Management Service & SDNC/A1 Controller & A1 Adapter
+--------------------------------------------------------------
-.. _readthedocs: https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/index.html
-.. _wiki: https://wiki.onap.org/pages/viewpage.action?pageId=84644984
+The A1 Policy Management Service is implemented in ONAP. For documentation see `ONAP CCSDK documentation <https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/index.html>`_
+and `wiki <https://wiki.onap.org/pages/viewpage.action?pageId=84672221>`_.
-rAPP Catalogue
---------------
+Information Coordinator Service
+-------------------------------
+The Information Coordinator Service is a Java 11 web application built using the Spring Framework. Using Spring Boot
+dependencies, it runs as a standalone application.
-See the README.md file in the r-app-catalogue folder for how to run the component.
+Its main functionality is to act as a data subscription broker and to decouple data producer from data consumers.
-End-to-end call
----------------
+See the ./config/README file in the *information-coordinator-service* directory Gerrit repo on how to create and setup
+the certificates and private keys needed for HTTPS.
-In order to make a complete end-to-end call, follow the instructions given in this `guide`_.
+Start standalone
+++++++++++++++++
+
+The project uses Maven. To start the Information Coordinator Service as a freestanding application, run the following
+command in the *information-coordinator-service* directory:
+
+ +-----------------------------+
+ | mvn spring-boot:run |
+ +-----------------------------+
+
+There are a few files that needs to be available to run. These are referred to from the application.yaml file.
+The following properties have to be modified:
+
+* server.ssl.key-store=./config/keystore.jks
+* app.webclient.trust-store=./config/truststore.jks
+* app.vardata-directory=./target
+
+Start in Docker
++++++++++++++++
+
+To build and deploy the Information Coordinator Service, go to the "information-coordinator-service" folder and run the
+following command:
+
+ +-----------------------------+
+ | mvn clean install |
+ +-----------------------------+
+
+Then start the container by running the following command:
+
+ +--------------------------------------------------------------------+
+ | docker run nonrtric-information-coordinator-service |
+ +--------------------------------------------------------------------+
+
+Initial Non-RT-RIC App Catalogue
+--------------------------------
+
+See the README.md file in the *r-app-catalogue* directory in the Gerrit repo for more details how to run the component.
+
+DMaaP Adaptor Service
+---------------------
+This is run in the same way as the Information Coordinator Service
+
+The following properties in the application.yaml file have to be modified:
+* server.ssl.key-store=./config/keystore.jks
+* app.webclient.trust-store=./config/truststore.jks
+* app.configuration-filepath=./src/test/resources/test_application_configuration.json
+
+O-DU & O-RU fronthaul recovery
+------------------------------
+
+See the page in Wiki: `O-RU Fronthaul Recovery usecase <https://wiki.o-ran-sc.org/display/RICNR/O-RU+Fronthaul+Recovery+usecase>`_
+
+O-DU Slicing use cases
+----------------------
+
+See the page in Wiki: `O-DU Slice Assurance usecase <https://wiki.o-ran-sc.org/display/RICNR/O-DU+Slice+Assurance+usecase>`_
+
+Helm Manager
+------------
+
+See the page in Wiki: `Release E <https://wiki.o-ran-sc.org/display/RICNR/Release+E>`_
+
+Kubernetes deployment
+=====================
+
+Non-RT RIC can be also deployed in a Kubernetes cluster, `it/dep repository <https://gerrit.o-ran-sc.org/r/admin/repos/it/dep>`_
+hosts deployment and integration artifacts. Instructions and helm charts to deploy the Non-RT-RIC functions in the
+OSC NONRTRIC integrated test environment can be found in the *./nonrtric* directory.
+
+For more information on installation of NonRT-RIC in Kubernetes, see `Deploy NONRTRIC in Kubernetes <https://wiki.o-ran-sc.org/display/RICNR/Deploy+NONRTRIC+in+Kubernetes>`_
+
+For more information see `Integration and Testing documentation on the O-RAN-SC wiki <https://docs.o-ran-sc.org/projects/o-ran-sc-it-dep/en/latest/index.html>`_.
-.. _guide: https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=12157166
Code Review / nonrtric.git / blobdiff