X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=76d673e39207bb26ce281cb4e54af6444035fc43;hb=69f664024c3c053ff879768e0f3738c9205fff90;hp=9dc4b8bb517e5e9c38541621a762036d53c7f28d;hpb=ea715211fab899b1fbe71e981b313ef6de71fa5a;p=nonrtric.git diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 9dc4b8bb..76d673e3 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -7,12 +7,12 @@ 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 -------------------------------------------------------------- -The A1 Policy Management Service is implemented in ONAP. For documentation see `ONAP CCSDK documentation `_ +The A1 Policy Management Service is implemented in ONAP. For documentation see `ONAP CCSDK documentation `_. and `wiki `_. Information Coordinator Service @@ -35,6 +35,13 @@ 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 +++++++++++++++ @@ -51,15 +58,39 @@ Then start the container by running the following command: | docker run nonrtric-information-coordinator-service | +--------------------------------------------------------------------+ -Initial Non-RT-RIC App Catalogue --------------------------------- +DMaaP Adaptor Service +--------------------- + +This Java implementation is run in the same way as the Information Coordinator Service. + +The following properties in the application.yaml file have to be modified: +* server.ssl.key-store=./config/keystore.jks +* app.webclient.trust-store=./config/truststore.jks +* app.configuration-filepath=./src/test/resources/test_application_configuration.json + +DMaaP Mediator Producer +----------------------- + +To build and run this Go implementation, see the README.md file under the folder "dmaap-mediator-producer" in the "nonrtric" repo. -See the README.md file in the *r-app-catalogue* directory in the Gerrit repo for more details how to run the component. +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 `_. 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 `_. +