From: aravind.est Date: Mon, 13 May 2024 15:13:08 +0000 (+0100) Subject: Documentation update for service manager usage X-Git-Tag: 0.1.0~7 X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;ds=sidebyside;h=ac8a5c02130e1b84352508d9c47c696aa212088a;p=nonrtric%2Fplt%2Frappmanager.git Documentation update for service manager usage Documentation updated to replace CAPIF with Service Manager Issue-ID: NONRTRIC-981 Change-Id: I67f3f0c1e57fe22573c18a8b44bd098b68e9e355 Signed-off-by: aravind.est --- diff --git a/README.md b/README.md index 233c17b..02f43bc 100755 --- a/README.md +++ b/README.md @@ -37,9 +37,9 @@ ONAP ACM is used here as a backend of rApp manager to lifecycle manage the deplo 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) +### Integration of SME (Service Manager) -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) +This integration is based on the Service Manager function developed as part of O-RAN SC. It is available [here](https://github.com/o-ran-sc/nonrtric-plt-sme/blob/master/servicemanager/README.md) ### Integration of DME (ICS) diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index e1dea3c..a947c68 100755 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. SPDX-License-Identifier: CC-BY-4.0 -.. Copyright (C) 2023 OpenInfra Foundation Europe. All rights reserved. +.. Copyright (C) 2023-2024 OpenInfra Foundation Europe. All rights reserved. Developer Guide =============== @@ -28,8 +28,9 @@ There are a few service endpoints that needs to be available to run. These are r The following properties have to be modified: * rappmanager.acm.baseurl=http://policy-clamp-runtime-acm.default:6969/onap/policy/clamp/acm/v2/ -* rappmanager.sme.baseurl=http://capifcore:8090 +* rappmanager.sme.baseurl=http://servicemanager:8095 * rappmanager.dme.baseurl=http://informationservice:9082 +* rappmanager.rapps.env.smeDiscoveryEndpoint=http://servicemanager:8095/service-apis/v1/allServiceAPIs Start in Docker diff --git a/docs/images/application-lifecycle.png b/docs/images/application-lifecycle.png index 583143a..727acbd 100755 Binary files a/docs/images/application-lifecycle.png and b/docs/images/application-lifecycle.png differ diff --git a/docs/overview.rst b/docs/overview.rst index 1d8c5bc..6bfb31f 100755 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. SPDX-License-Identifier: CC-BY-4.0 -.. Copyright (C) 2023 OpenInfra Foundation Europe. All rights reserved. +.. Copyright (C) 2023-2024 OpenInfra Foundation Europe. All rights reserved. rApp Manager ~~~~~~~~~~~~ @@ -60,10 +60,12 @@ Information type, and Data producer/consumer information can be provided as part SME --- +Service Manager is a Go implementation of a service that calls the CAPIF Core function. When publishing a service it creates a Kong route and Kong service. + The CAPIF stands for Common API framework and it was developed by 3GPP to enable a unified Northbound API framework across 3GPP network functions, and to ensure that there is a single and harmonized approach for API development. More details about SME can be found in `SME `_. -It is integrated with rApp manager to enable the rApp to expose/access/discover endpoints. +Service Manager is integrated with rApp manager to enable the rApp to expose/access/discover endpoints. Service exposure/access related configurations can be provided as part of rApp package and the package structure can be found in `Sample rApp package structure`_. diff --git a/docs/uml/application-lifecycle.puml b/docs/uml/application-lifecycle.puml index 3a13740..51b23ea 100755 --- a/docs/uml/application-lifecycle.puml +++ b/docs/uml/application-lifecycle.puml @@ -1,18 +1,18 @@ @startuml participant "rApp Manager" participant "ACM Runtime" -participant "CAPIF" +participant "SME" autonumber group Application Startup -"rApp Manager"->"CAPIF": Create "rApp Manager" as AMF +"rApp Manager"->"SME": Create "rApp Manager" as AMF end autonumber group Application Stop -"rApp Manager"->"CAPIF": Delete "rApp Manager" as AMF +"rApp Manager"->"SME": Delete "rApp Manager" as AMF end @enduml \ No newline at end of file