Move the rApp to COMMISSIONED state when chart upload fails
[nonrtric/plt/rappmanager.git] / 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 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 * rappmanager.acm.baseurl=http://policy-clamp-runtime-acm.default:6969/onap/policy/clamp/acm/v2/
31 * rappmanager.sme.baseurl=http://capifcore:8090
32 * rappmanager.dme.baseurl=http://informationservice:9082
33
34
35 Start in Docker
36 +++++++++++++++
37
38 To build and deploy the rApp Manager, go to the *rappmanager/rapp-manager-application* folder and run the
39 following command:
40
41     +-----------------------------+
42     | mvn clean install           |
43     +-----------------------------+
44
45 Then start the container by running the following command:
46
47     +-------------------------------------+
48     | docker run nonrtric-plt-rappmanager |
49     +-------------------------------------+
50
51 Kubernetes deployment
52 +++++++++++++++++++++
53
54 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>`_.
55 hosts deployment and integration artifacts. Instructions and helm charts to deploy the Non-RT-RIC functions in the
56 OSC NONRTRIC integrated test environment can be found in the *./nonrtric* directory.
57
58 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>`_.
59
60 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>`_.
61