participants/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) 2023 OpenInfra Foundation Europe. All rights reserved.
   4
   5 Developer Guide
   6 ===============
   7
   8 This document provides a quickstart for developers of the Non-RT RIC DME Participant.
   9
  10 Additional developer guides are available on the `O-RAN SC NONRTRIC Developer wiki <https://wiki.o-ran-sc.org/display/RICNR/Release+I>`_.
  11
  12 The DME Participant is a Java 17 web application built using the Spring Framework. Using Spring Boot
  13 dependencies, it runs as a standalone application.
  14
  15 Its main functionality is to work with ACM to lifecycle manage DME.
  16
  17 Start standalone
  18 ++++++++++++++++
  19
  20 The project uses Maven. To start the DME Participant as a freestanding application, run the following
  21 command in the *rappmanager/participants/participant-impl-dme* directory:
  22
  23     +-----------------------------+
  24     | mvn spring-boot:run         |
  25     +-----------------------------+
  26
  27 There are a few service endpoints that needs to be available to run. These are referred to from the application.yaml file.
  28 The following properties have to be modified:
  29
  30 * dme.baseUrl=http://informationservice:9082
  31
  32
  33 Start in Docker
  34 +++++++++++++++
  35
  36 To build and deploy the DME Participant, go to the *rappmanager/participants/participant-impl-dme* folder and run the
  37 following command:
  38
  39     +-----------------------------+
  40     | mvn clean install           |
  41     +-----------------------------+
  42
  43 Then start the container by running the following command:
  44
  45     +----------------------------------------+
  46     | docker run nonrtric-plt-dmeparticipant |
  47     +----------------------------------------+
  48
  49 Kubernetes deployment
  50 +++++++++++++++++++++
  51
  52 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>`_.
  53 hosts deployment and integration artifacts. Instructions and helm charts to deploy the Non-RT-RIC functions in the
  54 OSC NONRTRIC integrated test environment can be found in the *./nonrtric* directory.
  55
  56 For more information on installation of NonRT-RIC in Kubernetes, see `Deploy NONRTRIC in Kubernetes <https://wiki.o-ran-sc.org/display/RICNR/Release+I+-+Run+in+Kubernetes>`_.
  57
  58 For more information see `Integration and Testing documentation in the O-RAN-SC <https://docs.o-ran-sc.org/projects/o-ran-sc-it-dep/en/latest/index.html>`_.
  59