Add info types for producer and consumer in rApp package

[nonrtric/plt/rappmanager.git] / README.md

diff --git a/README.md b/README.md
index ce1339b..f76e617 100755 (executable)
--- a/README.md
+++ b/README.md
@@ -1,10 +1,81 @@
-# 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.
 
-<mark>**Rapp packaging model used here is purely a prototype**</mark>
+<mark>**rApp packaging model used here is purely a prototype**</mark>
 
-# 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 (<mark>**It is a prototype**</mark>)
+
+![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.
+
+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 ---
+C:/Program Files/Git/mingw64/libexec/git-core\git-submodule: line 7: basename: command not found
+C:/Program Files/Git/mingw64/libexec/git-core\git-submodule: line 7: sed: command not found
+C:/Program Files/Git/mingw64/libexec/git-core\git-submodule: line 22: .: git-sh-setup: file not found
+```
+
+It is necessary to append additional paths listed below to the <strong>System</strong> environment variable
+named "<strong>PATH</strong>". These paths can vary based on the git installation location.
+
+```
+C:\Program Files\Git\usr\bin
+C:\Program Files\Git\mingw64\libexec\git-core
+```