Merge "Sample rApp package for ics consumer"

[nonrtric/plt/rappmanager.git] / docs / overview.rst

diff --git a/docs/overview.rst b/docs/overview.rst
index 9a274c3..6bfb31f 100755 (executable)
--- 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
 ~~~~~~~~~~~~
@@ -42,10 +42,10 @@ ACM-R has the ability to support an unlimited number of participants and all the
 
 List of participants used by rApp manager sample rApp.
 
-* A1PMS Participant - It interacts with A1PMS of NONRTRIC. It is capable of lifecycle managing A1PMS service.
-* Kserve Participant - It interacts with Kserve. It is capable of lifecycle managing Kserve inference service.
-* Kubernetes Participant - It interacts with Helm/Kubernetes. It is capable of lifecycle managing Helm charts. It expects the helm charts to be available in the mentioned repository as it doesn't handle the helm chart creation in the chart repository.
-* DME Participant -  It interacts with DME(ICS) of NONRTRIC. It is capable of lifecycle managing DME entities.
+* `A1PMS Participant <https://docs.onap.org/projects/onap-policy-parent/en/latest/clamp/acm/design-impl/participants/a1pms-participant.html>`_ - It interacts with A1PMS of NONRTRIC. It is capable of lifecycle managing A1PMS service.
+* `Kserve Participant <https://docs.onap.org/projects/onap-policy-parent/en/latest/clamp/acm/design-impl/participants/kserve-participant.html>`_ - It interacts with Kserve. It is capable of lifecycle managing Kserve inference service.
+* `Kubernetes Participant <https://docs.onap.org/projects/onap-policy-parent/en/latest/clamp/acm/design-impl/participants/k8s-participant.html>`_ - It interacts with Helm/Kubernetes. It is capable of lifecycle managing Helm charts. It expects the helm charts to be available in the mentioned repository as it doesn't handle the helm chart creation in the chart repository.
+* :doc:`DME Participant <participants:index>` -  It interacts with DME(ICS) of NONRTRIC. It is capable of lifecycle managing DME entities.
 
 ACM composition and instance details can be provided as part of the rApp package and the package structure can be found in `Sample rApp package structure`_.
 
@@ -60,16 +60,22 @@ 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 <https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-sme/en/latest/overview.html>`_.
 
-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`_.
 
 *****************************
 Sample rApp package structure
 *****************************
+
+.. warning::
+    This packaging structure is a prototype and subject to change
+
 The sample rApp package structure shown below and the location of relevant files for each integration is provided.
 
 .. list-table::