docs/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 This document provides a quickstart for developers of the Non-RT RIC parts.
   9
  10 Additional developer guides are available on the `O-RAN SC NONRTRIC Developer wiki <https://wiki.o-ran-sc.org/display/RICNR/Release+D>`_
  11
  12 A1 Policy Management Service & SDNC/A1 Controller & A1 Adapter
  13 --------------------------------------------------------------
  14
  15 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>`_
  16 and `wiki <https://wiki.onap.org/pages/viewpage.action?pageId=84672221>`_.
  17
  18 Enrichment Coordinator Service
  19 ------------------------------
  20 The Enrichment Coordinator Service is a Java 11 web application built using the Spring Framework. Using Spring Boot
  21 dependencies, it runs as a standalone application.
  22
  23 Its main functionality is to act as a data subscription broker and to decouple data producer from data consumers.
  24
  25 See the ./config/README file in the *enrichment-coordinator-service* directory Gerrit repo on how to create and setup
  26 the certificates and private keys needed for HTTPS.
  27
  28 Start standalone
  29 ++++++++++++++++
  30
  31 The project uses Maven. To start the Enrichment Coordinator Service as a freestanding application, run the following
  32 command in the *enrichment-coordinator-service* directory:
  33
  34     +-----------------------------+
  35     | mvn spring-boot:run         |
  36     +-----------------------------+
  37
  38 Start in Docker
  39 +++++++++++++++
  40
  41 To build and deploy the Enrichment Coordinator Service, go to the "enrichment-coordinator-service" folder and run the
  42 following command:
  43
  44     +-----------------------------+
  45     | mvn clean install           |
  46     +-----------------------------+
  47
  48 Then start the container by running the following command:
  49
  50     +--------------------------------------------------------------------+
  51     | docker run nonrtric-enrichment-coordinator-service                 |
  52     +--------------------------------------------------------------------+
  53
  54 Initial Non-RT-RIC App Catalogue
  55 --------------------------------
  56
  57 See the README.md file in the *r-app-catalogue* directory in the Gerrit repo for more details how to run the component.
  58
  59 Kubernetes deployment
  60 =====================
  61
  62 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>`_
  63 hosts deployment and integration artifacts. Instructions and helm charts to deploy the Non-RT-RIC functions in the
  64 OSC NONRTRIC integrated test environment can be found in the *./nonrtric* directory.
  65 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>`_.