From: aravind.est Date: Fri, 22 Sep 2023 09:26:56 +0000 (+0100) Subject: Update documentation for DME integration X-Git-Tag: 0.0.1~38 X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F14%2F11814%2F2;p=nonrtric%2Fplt%2Frappmanager.git Update documentation for DME integration Documentation updates for DME integration. Issue-ID: NONRTRIC-913 Signed-off-by: aravind.est Change-Id: Ia94c9ff03d14b3d2cee1523268b0f6a2aa5f978c --- diff --git a/README.md b/README.md index 2d8fa3c..f76e617 100755 --- a/README.md +++ b/README.md @@ -7,17 +7,25 @@ rApp manager is an application which lifecycle manages the 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") +![Image](docs/images/rApp-states.png "Rapp States") ### rApp Instance States -![Image](docs/images/rapp-instance-states.png "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") +![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 @@ -32,6 +40,10 @@ ONAP ACM related details can be found [here](https://docs.onap.org/projects/onap 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 @@ -40,11 +52,11 @@ This integration is based on the CAPIF function developed as part of O-RAN SC. I ### rApp Flow -![Image](docs/images/rapp-flow.png "Rapp Flow") +![Image](docs/images/rApp-flow.png "Rapp 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 diff --git a/docs/drawio/rApp-manager.drawio b/docs/drawio/rApp-manager.drawio new file mode 100755 index 0000000..d874480 --- /dev/null +++ b/docs/drawio/rApp-manager.drawio @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/drawio/rapp-manager.drawio b/docs/drawio/rapp-manager.drawio deleted file mode 100755 index 25a2419..0000000 --- a/docs/drawio/rapp-manager.drawio +++ /dev/null @@ -1,439 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/images/architecture.png b/docs/images/architecture.png index e76519b..b473ea4 100755 Binary files a/docs/images/architecture.png 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..938e80e 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..aaf9f0b 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..1f4ecc0 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 similarity index 100% rename from docs/images/rapp-instance-states.png rename to docs/images/rApp-instance-states.png diff --git a/docs/images/rApp-package.png b/docs/images/rApp-package.png new file mode 100755 index 0000000..e485b86 Binary files /dev/null and b/docs/images/rApp-package.png differ diff --git a/docs/images/rApp-state-events.png b/docs/images/rApp-state-events.png new file mode 100755 index 0000000..92e8f76 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 similarity index 100% rename from docs/images/rapp-states.png rename to docs/images/rApp-states.png diff --git a/docs/images/rapp-entity-relationship.png b/docs/images/rapp-entity-relationship.png deleted file mode 100755 index 8bd6918..0000000 Binary files a/docs/images/rapp-entity-relationship.png and /dev/null differ diff --git a/docs/images/rapp-flow.png b/docs/images/rapp-flow.png deleted file mode 100755 index 56e2ffa..0000000 Binary files a/docs/images/rapp-flow.png and /dev/null differ diff --git a/docs/images/rapp-instance-flow.png b/docs/images/rapp-instance-flow.png deleted file mode 100755 index 3f1796f..0000000 Binary files a/docs/images/rapp-instance-flow.png and /dev/null differ diff --git a/docs/images/rapp-state-events.png b/docs/images/rapp-state-events.png deleted file mode 100755 index a429add..0000000 Binary files a/docs/images/rapp-state-events.png and /dev/null differ diff --git a/docs/ppt/rapp-manager.pptx b/docs/ppt/rapp-manager.pptx deleted file mode 100755 index a6516f8..0000000 Binary files a/docs/ppt/rapp-manager.pptx and /dev/null differ diff --git a/docs/uml/rapp-flow.puml b/docs/uml/rApp-flow.puml similarity index 87% rename from docs/uml/rapp-flow.puml rename to docs/uml/rApp-flow.puml index 758a786..682003b 100755 --- a/docs/uml/rapp-flow.puml +++ b/docs/uml/rApp-flow.puml @@ -5,6 +5,7 @@ actor "API User" participant "rApp Manager" collections "File System" participant "ACM Runtime" +participant "ICS" group Create rApp "API User"->"rApp Manager": Create rApp @@ -16,6 +17,8 @@ group Create rApp "ACM Runtime"->"rApp Manager": Create ACM composition Status "rApp Manager"->"ACM Runtime": Prime ACM composition "ACM Runtime"->"rApp Manager": Prime ACM composition Status +"rApp Manager"->"ICS": Check information type availability +"ICS"->"rApp Manager": Information type availability Status end autonumber diff --git a/docs/uml/rapp-instance-flow.puml b/docs/uml/rApp-instance-flow.puml similarity index 70% rename from docs/uml/rapp-instance-flow.puml rename to docs/uml/rApp-instance-flow.puml index 1f3bc7c..3507b4a 100755 --- a/docs/uml/rapp-instance-flow.puml +++ b/docs/uml/rApp-instance-flow.puml @@ -9,6 +9,7 @@ participant "A1PMS Participant" participant "Kserve Participant" participant "K8s Participant" participant "CAPIF" +participant "ICS" autonumber group Create rApp Instance @@ -32,9 +33,17 @@ group Deploy rApp Instance 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 + "rApp Manager"->"CAPIF": Create CAPIF entities + "CAPIF"->"CAPIF": Create the entities as provided + "rApp Manager"<-"CAPIF": Response of CAPIF entities creation + end + group DME Deploy + "rApp Manager"->"ICS": Create Info types for producer and consumer + "rApp Manager"<--"ICS": Response + "rApp Manager"->"ICS": Create Info producer + "rApp Manager"<--"ICS": Response + "rApp Manager"->"ICS": Create Info consumer + "rApp Manager"<--"ICS": Response end "API User"<-"rApp Manager": Deploy rApp Instance Status end @@ -57,9 +66,15 @@ group Undeploy rApp Instance 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 + "rApp Manager"->"CAPIF": Delete CAPIF entities + "CAPIF"->"CAPIF": Delete the entities as provided + "rApp Manager"<-"CAPIF": Response of CAPIF entities Deletion + end + group DME Undeploy + "rApp Manager"->"ICS": Delete Info consumer + "rApp Manager"<-"ICS": Response + "rApp Manager"->"ICS": Delete Info producer + "rApp Manager"<-"ICS": Response end "API User"<-"rApp Manager": Undeploy rApp Instance Status end