X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=6f151cdb369081d1fa27f43f0bea5de71fa711d8;hb=01b64b350211e0bfc16af343402dedc55020917b;hp=5358fe3c3a9357531da8b7b681f00d124f3b83ce;hpb=d1702a33a3527cf46527c7cd61f435bd7ed08522;p=nonrtric.git diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 5358fe3c..6f151cdb 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -5,24 +5,30 @@ Developer Guide =============== -This document provides a quickstart for developers of the Non-RT RIC. +Additional developer guides are available on the `O-RAN SC NONRTRIC Developer wiki `_ -A1 Policy Management Service ----------------------------- +A1 Policy Management Service & SDNC/A1 Controller & A1 Adapter +-------------------------------------------------------------- -The Policy Management is implemented in ONAP. For documentation see `readthedocs`_ and `wiki`_. +The A1 Policy Management Service is implemented in ONAP. For documentation see `ONAP CCSDK documentation `_ and `wiki `_. -.. _readthedocs: https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/index.html -.. _wiki: https://wiki.onap.org/pages/viewpage.action?pageId=84644984 +Enrichment Coordinator Service +------------------------------ +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. -rAPP Catalogue --------------- +Its main functionality is to act as a data subscription broker and to decouple data +producer from data consumers. -See the README.md file in the r-app-catalogue folder for how to run the component. +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. -End-to-end call ---------------- +Initial Non-RT-RIC App Catalogue +-------------------------------- -In order to make a complete end-to-end call, follow the instructions given in this `guide`_. +See the README.md file in the *r-app-catalogue* directory in the Gerrit repo for more details how to run the component. -.. _guide: https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=12157166 +Kubernetes deployment +===================== + +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