X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;ds=sidebyside;f=README.md;h=f76e617fc50599266404489b13947ec30f23bbe5;hb=4a9eca242a06d57fb9dca16b1a59cab2d6250c7b;hp=fae2730e8154f108ea2ff96a88d343422d82ade3;hpb=3ba4f286d13c1d3fa7ae7894533b073fb1087858;p=nonrtric%2Fplt%2Frappmanager.git diff --git a/README.md b/README.md index fae2730..f76e617 100755 --- a/README.md +++ b/README.md @@ -1,15 +1,64 @@ -# 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 Package (**It is a prototype**) + +![Image](docs/images/rApp-package.png "Rapp package") + +### 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") + +### rApp Entity Relationship + +![Image](docs/images/rApp-entity-relationship.png "Rapp Entity Relationship") + +## 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) + +### Integration of DME (ICS) + +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) + +## 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 +78,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 +```