X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=61c63196590c8c410d61c0e88e7446ca2333a96a;hb=b2ef1d832b94af02c7a3acefb4c8c5e4db03242b;hp=94c7d2dd72bee89893a952f94c49f4558799c4f3;hpb=2918bef3d237c99e6cf7e9c1ab1722781128617b;p=nonrtric.git diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 94c7d2dd..61c63196 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -9,77 +9,13 @@ 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 `_. -A1 Policy Management Service & SDNC/A1 Controller & A1 Adapter --------------------------------------------------------------- - -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 | - +-----------------------------+ - -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 -+++++++++++++++ - -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 | - +--------------------------------------------------------------------+ - -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 - 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 `_. hosts deployment and integration artifacts. Instructions and helm charts to deploy the Non-RT-RIC functions in the