X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=9e83177636d3590112bce9b18e6170a8051c0a53;hb=30cbd4c1f33d1e97f9dca55731b9bf0811583be9;hp=82862f86b44251fcfe790bb379dbfe9710acf461;hpb=a5b0c057710ba2a4f13e73c2d1279f5ae9ec813c;p=nonrtric.git diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 82862f86..9e831776 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -1,66 +1,14 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. SPDX-License-Identifier: CC-BY-4.0 -.. Copyright (C) 2021 Nordix +.. Copyright (C) 2021-2023 Nordix Foundation. All rights Reserved +.. Copyright (C) 2023 OpenInfra Foundation Europe. All Rights Reserved Developer Guide =============== This document provides a quickstart for developers of the Non-RT RIC parts. -Additional developer guides are available on the `O-RAN SC NONRTRIC Developer wiki `_. - -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. - -Its main functionality is to act as a data subscription broker and to decouple data producer from data consumers. - -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. - -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 | - +--------------------------------------------------------------------+ - -O-DU & O-RU fronthaul recovery ------------------------------- - -See the page in Wiki: `O-RU Fronthaul Recovery usecase `_. - -Helm Manager ------------- - -See the page in Wiki: `Release E `_. +Additional developer guides are available on the `O-RAN SC NONRTRIC Developer wiki `_. Kubernetes deployment --------------------- @@ -69,7 +17,7 @@ Non-RT RIC can be also deployed in a Kubernetes cluster, `it/dep repository `_. +For more information on installation of NonRT-RIC in Kubernetes, see `Deploy NONRTRIC in Kubernetes `_. -For more information see `Integration and Testing documentation on the O-RAN-SC wiki `_. +For more information see `Integration and Testing documentation in the O-RAN-SC `_.