6f151cdb369081d1fa27f43f0bea5de71fa711d8
[nonrtric.git] / developer-guide.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. SPDX-License-Identifier: CC-BY-4.0
3 .. Copyright (C) 2020 Nordix
4
5 Developer Guide
6 ===============
7
8 Additional developer guides are available on the `O-RAN SC NONRTRIC Developer wiki <https://wiki.o-ran-sc.org/display/RICNR/Release+D>`_
9
10 A1 Policy Management Service & SDNC/A1 Controller & A1 Adapter
11 --------------------------------------------------------------
12
13 The A1 Policy Management Service is implemented in ONAP. For documentation see `ONAP CCSDK documentation <https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/index.html>`_ and `wiki <https://wiki.onap.org/pages/viewpage.action?pageId=84672221>`_.
14
15 Enrichment Coordinator Service
16 ------------------------------
17 The Enrichment Coordinator Service is a Java 11 web application built using the Spring Framework.
18 Using Spring Boot dependencies, it runs as a standalone application.
19
20 Its main functionality is to act as a data subscription broker and to decouple data 
21 producer from data consumers.
22
23 See the ./config/README file in the *enrichment-coordinator-service* directory Gerrit repo on how to create and setup the certificates and private keys needed for HTTPS. 
24
25 Initial Non-RT-RIC App Catalogue
26 --------------------------------
27
28 See the README.md file in the *r-app-catalogue* directory in the Gerrit repo for more details how to run the component.
29
30 Kubernetes deployment
31 =====================
32
33 Non-RT RIC can be also deployed in a Kubernetes cluster, `it/dep repository <https://gerrit.o-ran-sc.org/r/admin/repos/it/dep>`_ 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.
34 For more information see `Integration and Testing documentation on the O-RAN-SC wiki <https://docs.o-ran-sc.org/projects/o-ran-sc-it-dep/en/latest/index.html>`_