1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. SPDX-License-Identifier: CC-BY-4.0
3 .. Copyright (C) 2021 Nordix
8 This document provides a quickstart for developers of the Non-RT RIC parts.
10 Additional developer guides are available on the `O-RAN SC NONRTRIC Developer wiki <https://wiki.o-ran-sc.org/display/RICNR/Release+E>`_.
12 Information Coordinator Service
13 -------------------------------
14 The Information Coordinator Service is a Java 11 web application built using the Spring Framework. Using Spring Boot
15 dependencies, it runs as a standalone application.
17 Its main functionality is to act as a data subscription broker and to decouple data producer from data consumers.
19 See the ./config/README file in the *information-coordinator-service* directory Gerrit repo on how to create and setup
20 the certificates and private keys needed for HTTPS.
25 The project uses Maven. To start the Information Coordinator Service as a freestanding application, run the following
26 command in the *information-coordinator-service* directory:
28 +-----------------------------+
29 | mvn spring-boot:run |
30 +-----------------------------+
32 There are a few files that needs to be available to run. These are referred to from the application.yaml file.
33 The following properties have to be modified:
35 * server.ssl.key-store=./config/keystore.jks
36 * app.webclient.trust-store=./config/truststore.jks
37 * app.vardata-directory=./target
42 To build and deploy the Information Coordinator Service, go to the "information-coordinator-service" folder and run the
45 +-----------------------------+
47 +-----------------------------+
49 Then start the container by running the following command:
51 +--------------------------------------------------------------------+
52 | docker run nonrtric-information-coordinator-service |
53 +--------------------------------------------------------------------+
55 O-DU & O-RU fronthaul recovery
56 ------------------------------
58 See the page in Wiki: `O-RU Fronthaul Recovery usecase <https://wiki.o-ran-sc.org/display/RICNR/O-RU+Fronthaul+Recovery+usecase>`_.
63 See the page in Wiki: `Release E <https://wiki.o-ran-sc.org/display/RICNR/Release+E>`_.
68 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>`_.
69 hosts deployment and integration artifacts. Instructions and helm charts to deploy the Non-RT-RIC functions in the
70 OSC NONRTRIC integrated test environment can be found in the *./nonrtric* directory.
72 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>`_.
74 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>`_.