X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=README.md;h=f76e617fc50599266404489b13947ec30f23bbe5;hb=4a9eca242a06d57fb9dca16b1a59cab2d6250c7b;hp=fa7818fc388f3b7d83dbe15de8a9266486a844ed;hpb=aea6e6c2bce2204ff8a46f904127a65bb6739d1c;p=nonrtric%2Fplt%2Frappmanager.git diff --git a/README.md b/README.md index fa7818f..f76e617 100755 --- a/README.md +++ b/README.md @@ -1,36 +1,48 @@ -# 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") -### Rapp States +### rApp Package (**It is a prototype**) -![Image](docs/images/rapp-states.png "Rapp States") +![Image](docs/images/rApp-package.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 @@ -38,13 +50,13 @@ This integration is based on the CAPIF function developed as part of ORAN-SC. It ![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