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-2024 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 rApp Manager.
   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 rApp Manager 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 lifecycle manage rApps.
  16
  17 Start standalone
  18 ++++++++++++++++
  19
  20 The project uses Maven. To start the rApp Manager as a freestanding application, run the following
  21 command in the *rappmanager/rapp-manager-application* 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 .. code-block:: yaml
  31
  32     rappmanager.acm.baseurl=http://policy-clamp-runtime-acm.default:6969/onap/policy/clamp/acm/v2/
  33     rappmanager.sme.baseurl=http://servicemanager:8095
  34     rappmanager.dme.baseurl=http://informationservice:9082
  35     rappmanager.rapps.env.smeDiscoveryEndpoint=http://servicemanager:8095/service-apis/v1/allServiceAPIs
  36
  37
  38 Start in Docker
  39 +++++++++++++++
  40
  41 To build and deploy the rApp Manager, go to the *rappmanager* folder and run the
  42 following command:
  43
  44     +-----------------------------+
  45     | mvn clean install           |
  46     +-----------------------------+
  47
  48 .. note::
  49     The rApp packages for the unit tests are generated as part of the build process at the rappmanager level.
  50
  51 Then start the container by running the following command:
  52
  53     +----------------------------------------------+
  54     | docker run o-ran-sc/nonrtric-plt-rappmanager |
  55     +----------------------------------------------+
  56
  57 Kubernetes deployment
  58 +++++++++++++++++++++
  59
  60 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>`_.
  61 hosts deployment and integration artifacts. Instructions and helm charts to deploy the Non-RT-RIC functions in the
  62 OSC NONRTRIC integrated test environment can be found in the *./nonrtric* directory.
  63
  64 The scripts located in *rappmanager/scripts/install* can be used for an automatic installation in the Kubernetes Cluster, see `Automatic Installation in Kubernetes <https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-rappmanager/en/latest/installation-guide.html>`_.
  65
  66 For more information on installation of NonRT-RIC in Kubernetes, see `Deploy NONRTRIC in Kubernetes <https://wiki.o-ran-sc.org/display/RICNR/Release+J+-+Run+in+Kubernetes>`_.
  67
  68 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>`_.
  69