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