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