X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=README.md;h=2d8fa3cd2394f43bf9f785fd21a5edd63e84e2f6;hb=fbc481ba674204cd9972c5c53563110fd0a1a1be;hp=fae2730e8154f108ea2ff96a88d343422d82ade3;hpb=3ba4f286d13c1d3fa7ae7894533b073fb1087858;p=nonrtric%2Fplt%2Frappmanager.git diff --git a/README.md b/README.md index fae2730..2d8fa3c 100755 --- a/README.md +++ b/README.md @@ -1,15 +1,52 @@ -# Rapp Manager (This is a prototype) -Rapp manager is an application which lifecycle manages the Rapp. +# rApp Manager (This is a prototype) +rApp manager is an application which lifecycle manages the rApp. -**Rapp packaging model used here is purely a prototype** +**rApp packaging model used here is purely a prototype** -# Integration of ONAP ACM +## Architecture -ONAP ACM is used here as a backend of Rapp manager to lifecycle manage the deployment items as part of Rapp. +![Image](docs/images/architecture.png "Rapp Manager Architecture") + +### rApp States + +![Image](docs/images/rapp-states.png "Rapp States") + +### rApp Instance States + +![Image](docs/images/rapp-instance-states.png "Rapp Instance States") + +### Events responsible for rApp Instance State Transition + +![Image](docs/images/rapp-state-events.png "Rapp Manager State Events") + +## Integrations + +### ONAP ACM + +ONAP ACM is used here as a backend of rApp manager to lifecycle manage the deployment items as part of rApp. ONAP ACM related details can be found [here](https://docs.onap.org/projects/onap-policy-parent/en/london/clamp/clamp.html). +### Integration of SME (CAPIF) + +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) + +## Flow Diagrams + +### Application Lifecycle + +![Image](docs/images/application-lifecycle.png "Rapp Manager Application Lifecycle") + +### rApp Flow + +![Image](docs/images/rapp-flow.png "Rapp Flow") + +### rApp Instance Flow + +![Image](docs/images/rapp-instance-flow.png "Rapp Instance Flow") + + ## Maven Build This build supports Linux and Windows environments. @@ -29,4 +66,4 @@ named "PATH". These paths can vary based on the git installatio ``` C:\Program Files\Git\usr\bin C:\Program Files\Git\mingw64\libexec\git-core -``` \ No newline at end of file +```