X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=9dc4b8bb517e5e9c38541621a762036d53c7f28d;hb=7fcc9f920202f6ffaf00a9bb7498f2babe50cd0e;hp=43ac2d1531fc6e430a32cf98464f735d25281e9b;hpb=8eba6113957d3d9ee9e019789bf4e54c0dcc9caa;p=nonrtric.git diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 43ac2d15..9dc4b8bb 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 -------------------------------------------------------------- @@ -15,21 +15,21 @@ 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 `_. -Enrichment Coordinator Service ------------------------------- -The Enrichment Coordinator Service is a Java 11 web application built using the Spring Framework. Using Spring Boot +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 *enrichment-coordinator-service* directory Gerrit repo on how to create and setup +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 Enrichment Coordinator Service as a freestanding application, run the following -command in the *enrichment-coordinator-service* directory: +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 | @@ -38,7 +38,7 @@ command in the *enrichment-coordinator-service* directory: Start in Docker +++++++++++++++ -To build and deploy the Enrichment Coordinator Service, go to the "enrichment-coordinator-service" folder and run the +To build and deploy the Information Coordinator Service, go to the "information-coordinator-service" folder and run the following command: +-----------------------------+ @@ -48,7 +48,7 @@ following command: Then start the container by running the following command: +--------------------------------------------------------------------+ - | docker run nonrtric-enrichment-coordinator-service | + | docker run nonrtric-information-coordinator-service | +--------------------------------------------------------------------+ Initial Non-RT-RIC App Catalogue