X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=9e83177636d3590112bce9b18e6170a8051c0a53;hb=HEAD;hp=af206e7e5cbb797260580723cea2161233661f00;hpb=df5eeb6e3fe42f87ac399f624edef20c87d1e475;p=nonrtric.git diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index af206e7e..9e831776 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -1,101 +1,23 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. SPDX-License-Identifier: CC-BY-4.0 -.. Copyright (C) 2021 Nordix +.. Copyright (C) 2021-2023 Nordix Foundation. All rights Reserved +.. Copyright (C) 2023 OpenInfra Foundation Europe. All Rights Reserved 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 `_. - -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 - -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. - -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 `_. +Additional developer guides are available on the `O-RAN SC NONRTRIC Developer wiki `_. 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 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 `_. +For more information see `Integration and Testing documentation in the O-RAN-SC `_.