From: aravind.est Date: Wed, 26 Jul 2023 15:41:57 +0000 (+0100) Subject: Update readme and docs with rapp instance X-Git-Tag: 0.0.1~57 X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F26%2F11526%2F3;p=nonrtric%2Fplt%2Frappmanager.git Update readme and docs with rapp instance Update readme and docs with the rapp instance details. Issue-ID: NONRTRIC-897 Signed-off-by: aravind.est Change-Id: I526609e9c1b98b7cd596ff66ad558a647ea6f0c3 --- 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 +``` diff --git a/docs/drawio/rapp-manager.drawio b/docs/drawio/rapp-manager.drawio new file mode 100755 index 0000000..25a2419 --- /dev/null +++ b/docs/drawio/rapp-manager.drawio @@ -0,0 +1,439 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/images/application-lifecycle.png b/docs/images/application-lifecycle.png new file mode 100755 index 0000000..583143a Binary files /dev/null and b/docs/images/application-lifecycle.png differ diff --git a/docs/images/architecture.png b/docs/images/architecture.png new file mode 100755 index 0000000..e76519b Binary files /dev/null and b/docs/images/architecture.png differ diff --git a/docs/images/rapp-entity-relationship.png b/docs/images/rapp-entity-relationship.png new file mode 100755 index 0000000..8bd6918 Binary files /dev/null and b/docs/images/rapp-entity-relationship.png differ diff --git a/docs/images/rapp-flow.png b/docs/images/rapp-flow.png new file mode 100755 index 0000000..56e2ffa Binary files /dev/null and b/docs/images/rapp-flow.png differ diff --git a/docs/images/rapp-instance-flow.png b/docs/images/rapp-instance-flow.png new file mode 100755 index 0000000..3f1796f Binary files /dev/null and b/docs/images/rapp-instance-flow.png differ diff --git a/docs/images/rapp-instance-states.png b/docs/images/rapp-instance-states.png new file mode 100755 index 0000000..c9ee762 Binary files /dev/null and b/docs/images/rapp-instance-states.png differ diff --git a/docs/images/rapp-state-events.png b/docs/images/rapp-state-events.png new file mode 100755 index 0000000..a429add Binary files /dev/null and b/docs/images/rapp-state-events.png differ diff --git a/docs/images/rapp-states.png b/docs/images/rapp-states.png new file mode 100755 index 0000000..191da4e Binary files /dev/null and b/docs/images/rapp-states.png differ diff --git a/docs/ppt/rapp-manager.pptx b/docs/ppt/rapp-manager.pptx new file mode 100755 index 0000000..a6516f8 Binary files /dev/null and b/docs/ppt/rapp-manager.pptx differ diff --git a/docs/uml/application-lifecycle.puml b/docs/uml/application-lifecycle.puml new file mode 100755 index 0000000..3a13740 --- /dev/null +++ b/docs/uml/application-lifecycle.puml @@ -0,0 +1,18 @@ +@startuml +participant "rApp Manager" +participant "ACM Runtime" +participant "CAPIF" + +autonumber + +group Application Startup +"rApp Manager"->"CAPIF": Create "rApp Manager" as AMF +end + +autonumber + +group Application Stop +"rApp Manager"->"CAPIF": Delete "rApp Manager" as AMF +end + +@enduml \ No newline at end of file diff --git a/docs/uml/rapp-flow.puml b/docs/uml/rapp-flow.puml new file mode 100755 index 0000000..758a786 --- /dev/null +++ b/docs/uml/rapp-flow.puml @@ -0,0 +1,35 @@ +@startuml +autonumber + +actor "API User" +participant "rApp Manager" +collections "File System" +participant "ACM Runtime" + +group Create rApp +"API User"->"rApp Manager": Create rApp +"rApp Manager"->"rApp Manager": Validate rApp +"rApp Manager"->"File System": Store rApp Package +"rApp Manager"->"API User": Onboard rApp Status +"API User"->"rApp Manager": Prime rApp +"rApp Manager"->"ACM Runtime": Create ACM composition +"ACM Runtime"->"rApp Manager": Create ACM composition Status +"rApp Manager"->"ACM Runtime": Prime ACM composition +"ACM Runtime"->"rApp Manager": Prime ACM composition Status +end + +autonumber +group Delete rApp +"API User"->"rApp Manager": Deprime rApp +"rApp Manager"->"ACM Runtime": Deprime ACM composition +"ACM Runtime"->"rApp Manager": Deprime ACM composition Status +"rApp Manager"->"ACM Runtime": Delete ACM composition +"ACM Runtime"->"rApp Manager": Delete ACM composition Status +"API User"->"rApp Manager": Delete rApp +"rApp Manager"->"rApp Manager": Validate rApp Instances +"rApp Manager"->"API User": Delete rApp Status + +end + + +@enduml \ No newline at end of file diff --git a/docs/uml/rapp-instance-flow.puml b/docs/uml/rapp-instance-flow.puml new file mode 100755 index 0000000..1f3bc7c --- /dev/null +++ b/docs/uml/rapp-instance-flow.puml @@ -0,0 +1,73 @@ +@startuml +autonumber + +actor "API User" +participant "rApp Manager" +collections "File System" +participant "ACM Runtime" +participant "A1PMS Participant" +participant "Kserve Participant" +participant "K8s Participant" +participant "CAPIF" + +autonumber +group Create rApp Instance +"API User"->"rApp Manager": Create rApp Instance +"rApp Manager"->"API User": Create rApp Instance response +end + +autonumber +group Deploy rApp Instance +"API User"->"rApp Manager": Deploy rApp Instance +"rApp Manager"->"File System": Fetch rApp Package and Instance details + group ACM Deploy + "rApp Manager"->"ACM Runtime": Instantiate and Deploy ACM Instance + "ACM Runtime"->"A1PMS Participant": Deploy ACM Instance + "ACM Runtime"<--"A1PMS Participant": Response + "ACM Runtime"->"Kserve Participant": Deploy ACM Instance + "ACM Runtime"<--"Kserve Participant": Response + "ACM Runtime"->"K8s Participant": Deploy ACM Instance + "ACM Runtime"<--"K8s Participant": Response + "rApp Manager"->"ACM Runtime": ACM Deployment Status + end + + group SME Deploy + "rApp Manager"->"CAPIF": Create CAPIF entities + "CAPIF"->"CAPIF": Create the entities as provided + "rApp Manager"<-"CAPIF": Response of CAPIF entities creation + end +"API User"<-"rApp Manager": Deploy rApp Instance Status +end + +autonumber +group Undeploy rApp Instance +"API User"->"rApp Manager": Undeploy rApp Instance +"rApp Manager"->"File System": Fetch rApp Package and Instance details + group ACM Undeploy + "rApp Manager"->"ACM Runtime": Undeploy ACM Instance + "ACM Runtime"->"A1PMS Participant": Undeploy ACM Instance + "ACM Runtime"<--"A1PMS Participant": Response + "ACM Runtime"->"Kserve Participant": Undeploy ACM Instance + "ACM Runtime"<--"Kserve Participant": Response + "ACM Runtime"->"K8s Participant": Undeploy ACM Instance + "ACM Runtime"<--"K8s Participant": Response + "rApp Manager"->"ACM Runtime": ACM Undeployment Status + "rApp Manager"->"ACM Runtime": Delete ACM Instance + "rApp Manager"<-"ACM Runtime": Delete ACM Instance response + end + + group SME Undeploy + "rApp Manager"->"CAPIF": Delete CAPIF entities + "CAPIF"->"CAPIF": Delete the entities as provided + "rApp Manager"<-"CAPIF": Response of CAPIF entities Deletion + end +"API User"<-"rApp Manager": Undeploy rApp Instance Status +end + +autonumber +group Delete rApp Instance +"API User"->"rApp Manager": Delete rApp Instance +"rApp Manager"->"API User": Delete rApp Instance response +end + +@enduml