Roll versions after J-Relase master -> 0.2.0
[nonrtric/plt/rappmanager.git] / README.md
1 # rApp Manager (This is a prototype)
2 rApp manager is an application which lifecycle manages the rApp.
3
4 <mark>**rApp packaging model used here is purely a prototype**</mark>
5
6 ## Architecture
7
8 ![Image](docs/images/architecture.png "rApp Manager Architecture")
9
10 ### rApp Package (<mark>**It is a prototype**</mark>)
11
12 ![Image](docs/images/rApp-package-1.png "rApp package")
13 ![Image](docs/images/rApp-package-2.png "rApp package")
14
15 ### rApp States
16
17 ![Image](docs/images/rApp-states.png "rApp States")
18
19 ### rApp Instance States
20
21 ![Image](docs/images/rApp-instance-states.png "rApp Instance States")
22
23 ### Events responsible for rApp Instance State Transition
24
25 ![Image](docs/images/rApp-state-events.png "rApp Manager State Events")
26
27 ### rApp Entity Relationship
28
29 ![Image](docs/images/rApp-entity-relationship.png "rApp Entity Relationship")
30
31 ## Integrations
32
33 ### ONAP ACM
34
35 ONAP ACM is used here as a backend of rApp manager to lifecycle manage the deployment items as part of rApp.
36
37 ONAP ACM related details can be found [here](https://docs.onap.org/projects/onap-policy-parent/en/london/clamp/clamp.html).
38
39
40 ### Integration of SME (Service Manager)
41
42 This integration is based on the Service Manager function developed as part of O-RAN SC. It is available [here](https://github.com/o-ran-sc/nonrtric-plt-sme/blob/master/servicemanager/README.md)
43
44 ### Integration of DME (ICS)
45
46 This integration is based on the ICS as part of O-RAN SC NONRTRIC. It is available [here](https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric/en/latest/overview.html#information-coordination-service)
47
48 ## Flow Diagrams
49
50 ### Application Lifecycle
51
52 ![Image](docs/images/application-lifecycle.png "rApp Manager Application Lifecycle")
53
54 ### rApp Flow
55
56 ![Image](docs/images/rApp-flow.png "rApp Flow")
57
58 ### rApp Instance Flow
59
60 ![Image](docs/images/rApp-instance-flow.png "rApp Instance Flow")
61
62
63 ## Maven Build
64
65 This build supports Linux and Windows environments.
66
67 In case of below error during the build in Windows environment:
68
69 ```
70 [INFO] --- exec-maven-plugin:3.1.0:exec (git submodule update) @ rapp-manager-sme ---
71 C:/Program Files/Git/mingw64/libexec/git-core\git-submodule: line 7: basename: command not found
72 C:/Program Files/Git/mingw64/libexec/git-core\git-submodule: line 7: sed: command not found
73 C:/Program Files/Git/mingw64/libexec/git-core\git-submodule: line 22: .: git-sh-setup: file not found
74 ```
75
76 It is necessary to append additional paths listed below to the <strong>System</strong> environment variable
77 named "<strong>PATH</strong>". These paths can vary based on the git installation location.
78
79 ```
80 C:\Program Files\Git\usr\bin
81 C:\Program Files\Git\mingw64\libexec\git-core
82 ```