X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=61c63196590c8c410d61c0e88e7446ca2333a96a;hb=b2ef1d832b94af02c7a3acefb4c8c5e4db03242b;hp=9dc4b8bb517e5e9c38541621a762036d53c7f28d;hpb=ea715211fab899b1fbe71e981b313ef6de71fa5a;p=nonrtric.git diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 9dc4b8bb..61c63196 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -7,59 +7,21 @@ 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 `_ +Additional developer guides are available on the `O-RAN SC NONRTRIC Developer wiki `_. -A1 Policy Management Service & SDNC/A1 Controller & A1 Adapter --------------------------------------------------------------- +O-DU & O-RU fronthaul recovery +------------------------------ -The A1 Policy Management Service is implemented in ONAP. For documentation see `ONAP CCSDK documentation `_ -and `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 | - +-----------------------------+ - -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. +See the page in Wiki: `O-RU Fronthaul Recovery usecase `_. Kubernetes deployment -===================== +--------------------- -Non-RT RIC can be also deployed in a Kubernetes cluster, `it/dep repository `_ +Non-RT RIC can be also deployed in a Kubernetes cluster, `it/dep repository `_. 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 `_. + For more information see `Integration and Testing documentation on the O-RAN-SC wiki `_. +