X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=README.md;h=233c17b43a9c78aedbb53f18b38fc15bdaa850e9;hb=65e1da472f81364372b6c5eccb60b1bcf2ef3976;hp=fa7818fc388f3b7d83dbe15de8a9266486a844ed;hpb=aea6e6c2bce2204ff8a46f904127a65bb6739d1c;p=nonrtric%2Fplt%2Frappmanager.git diff --git a/README.md b/README.md index fa7818f..233c17b 100755 --- a/README.md +++ b/README.md @@ -1,57 +1,70 @@ -# 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** ## Architecture -![Image](docs/images/architecture.png "Rapp Manager Architecture") +![Image](docs/images/architecture.png "rApp Manager Architecture") -### Rapp States +### rApp Package (**It is a prototype**) -![Image](docs/images/rapp-states.png "Rapp States") +![Image](docs/images/rApp-package-1.png "rApp package") +![Image](docs/images/rApp-package-2.png "rApp package") -### Rapp Instance States +### rApp States -![Image](docs/images/rapp-instance-states.png "Rapp Instance States") +![Image](docs/images/rApp-states.png "rApp States") -### Events responsible for Rapp Instance State Transition +### rApp Instance States -![Image](docs/images/rapp-state-events.png "Rapp Manager State Events") +![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 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) +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") +![Image](docs/images/application-lifecycle.png "rApp Manager Application Lifecycle") -### Rapp Flow +### rApp Flow -![Image](docs/images/rapp-flow.png "Rapp Flow") +![Image](docs/images/rApp-flow.png "rApp Flow") -### Rapp Instance Flow +### rApp Instance Flow -![Image](docs/images/rapp-instance-flow.png "Rapp Instance Flow") +![Image](docs/images/rApp-instance-flow.png "rApp Instance Flow") ## Maven Build This build supports Linux and Windows environments. -In case of below error during the build in Windows environment, +In case of below error during the build in Windows environment: ``` [INFO] --- exec-maven-plugin:3.1.0:exec (git submodule update) @ rapp-manager-sme ---