X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=0d950cd3436776457219c5d0134fef51c37343dc;hb=c621b96345d48a7ee70b7ead65a8ce166d71adde;hp=e0cb0809e2aab1dc1ba9546a60f51d96e35bd147;hpb=98ce5dc75fc222dadaf26a8a148788b0367bf6ca;p=nonrtric.git diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index e0cb0809..0d950cd3 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -1,13 +1,13 @@ .. 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 =============== 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 -------------------------------------------------------------- @@ -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 +++++++++++++++ @@ -56,10 +63,38 @@ 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. +DMaaP Adaptor Service +--------------------- +This 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 `_ + +O-DU Slicing use cases +---------------------- + +See the page in Wiki: `O-DU Slice Assurance 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 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 `_. +