X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=61c63196590c8c410d61c0e88e7446ca2333a96a;hb=b2ef1d832b94af02c7a3acefb4c8c5e4db03242b;hp=6f151cdb369081d1fa27f43f0bea5de71fa711d8;hpb=495008908a7062aa8367d7ecc7dc1b91038eed77;p=nonrtric.git diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 6f151cdb..61c63196 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -1,34 +1,27 @@ .. 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 =============== -Additional developer guides are available on the `O-RAN SC NONRTRIC Developer wiki `_ +This document provides a quickstart for developers of the Non-RT RIC parts. -A1 Policy Management Service & SDNC/A1 Controller & A1 Adapter --------------------------------------------------------------- +Additional developer guides are available on the `O-RAN SC NONRTRIC Developer wiki `_. -The A1 Policy Management Service is implemented in ONAP. For documentation see `ONAP CCSDK documentation `_ and `wiki `_. - -Enrichment Coordinator Service +O-DU & O-RU fronthaul recovery ------------------------------ -The Enrichment 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 page in Wiki: `O-RU Fronthaul Recovery usecase `_. -See the ./config/README file in the *enrichment-coordinator-service* directory Gerrit repo on how to create and setup the certificates and private keys needed for HTTPS. +Kubernetes deployment +--------------------- -Initial Non-RT-RIC App Catalogue --------------------------------- +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. -See the README.md file in the *r-app-catalogue* directory in the Gerrit repo for more details how to run the component. +For more information on installation of NonRT-RIC in Kubernetes, see `Deploy NONRTRIC in Kubernetes `_. -Kubernetes deployment -===================== +For more information see `Integration and Testing documentation on the O-RAN-SC wiki `_. -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 see `Integration and Testing documentation on the O-RAN-SC wiki `_ \ No newline at end of file