X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=43ac2d1531fc6e430a32cf98464f735d25281e9b;hb=refs%2Fheads%2Fdawn;hp=93182d31cff5bf6e233a2cafe1987a177e3c49db;hpb=330db2ab9b62777a96450527eb1978e15986a0d4;p=nonrtric.git diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 93182d31..43ac2d15 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -5,35 +5,61 @@ Developer Guide =============== -This document provides a quickstart for developers of the Non-RT RIC. +This document provides a quickstart for developers of the Non-RT RIC parts. -A1 Policy Management Service ----------------------------- +Additional developer guides are available on the `O-RAN SC NONRTRIC Developer wiki `_ -The Policy Management is implemented in ONAP. For documentation see `readthedocs`_ and `wiki`_. +A1 Policy Management Service & SDNC/A1 Controller & A1 Adapter +-------------------------------------------------------------- -.. _readthedocs: https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/index.html -.. _wiki: https://wiki.onap.org/pages/viewpage.action?pageId=84644984 +The A1 Policy Management Service is implemented in ONAP. For documentation see `ONAP CCSDK documentation `_ +and `wiki `_. 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. +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. +Its main functionality is to act as a data subscription broker and to decouple data producer from data consumers. -See the ./config/README file on how to create and setup the cerificates and private keys needed for HTTPS. +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. +Start standalone +++++++++++++++++ -rAPP Catalogue --------------- +The project uses Maven. To start the Enrichment Coordinator Service as a freestanding application, run the following +command in the *enrichment-coordinator-service* directory: -See the README.md file in the r-app-catalogue folder for how to run the component. + +-----------------------------+ + | mvn spring-boot:run | + +-----------------------------+ -End-to-end call ---------------- +Start in Docker ++++++++++++++++ -In order to make a complete end-to-end call, follow the instructions given in this `guide`_. +To build and deploy the Enrichment Coordinator Service, go to the "enrichment-coordinator-service" folder and run the +following command: -.. _guide: https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=12157166 + +-----------------------------+ + | mvn clean install | + +-----------------------------+ + +Then start the container by running the following command: + + +--------------------------------------------------------------------+ + | docker run nonrtric-enrichment-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. + +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 `_.