X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=README.md;h=fa7818fc388f3b7d83dbe15de8a9266486a844ed;hb=refs%2Fchanges%2F90%2F11590%2F2;hp=fae2730e8154f108ea2ff96a88d343422d82ade3;hpb=3ba4f286d13c1d3fa7ae7894533b073fb1087858;p=nonrtric%2Fplt%2Frappmanager.git diff --git a/README.md b/README.md index fae2730..fa7818f 100755 --- a/README.md +++ b/README.md @@ -3,13 +3,50 @@ Rapp manager is an application which lifecycle manages the Rapp. **Rapp packaging model used here is purely a prototype** -# Integration of ONAP ACM +## Architecture + +![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 ORAN-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 +```