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.
   9
  10 A1 Policy Management Service
  11 ----------------------------
  12
  13 The Policy Management is implemented in ONAP. For documentation see `readthedocs`_ and `wiki`_.
  14
  15 .. _readthedocs: https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/index.html
  16 .. _wiki: https://wiki.onap.org/pages/viewpage.action?pageId=84644984
  17
  18 Enrichment Coordinator Service
  19 ------------------------------
  20 The Enrichment Coordinator Service is a Java 11 web application built using the Spring Framework.
  21 Using Spring Boot dependencies, it runs as a standalone application.
  22
  23 Its main functionality is to act as a data subscription broker and to decouple data
  24 producer from data consumers.
  25
  26 See the ./config/README file on how to create and setup the cerificates and private keys needed for HTTPS.
  27
  28
  29 rAPP Catalogue
  30 --------------
  31
  32 See the README.md file in the r-app-catalogue folder for how to run the component.
  33
  34 End-to-end call
  35 ---------------
  36
  37 In order to make a complete end-to-end call, follow the instructions given in this `guide`_.
  38
  39 .. _guide: https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=12157166