Commit 169dd08f authored by Dimitrios Gogos's avatar Dimitrios Gogos
Browse files

fix: minor readme changes

parent b8710546
Loading
Loading
Loading
Loading
Loading
+9 −8
Original line number Diff line number Diff line
# Service Resource Manager

The Service Resource Manager (SRM) is a web service written in Python and and based on the Flask micro we framework. It implements the Service Resource manager role of the Operator Platform, defined by the  [GSMA Operator Platform Group (OPG)](https://www.gsma.com/solutions-and-impact/technologies/networks/gsma_resources/gsma-operator-platform-group-september-2024-publications/)
The Service Resource Manager (SRM) is a web service written in Python and based on the Flask micro web framework. It implements the Service Resource manager role of the Operator Platform, defined by the  [GSMA Operator Platform Group (OPG)](https://www.gsma.com/solutions-and-impact/technologies/networks/gsma_resources/gsma-operator-platform-group-september-2024-publications/)

## Description

The Service Resource Manager facilitates the North-South Bound Interface (NSBI) specification of GSMA, by acting as an interconenction link between the CAMARA-defined API exposed by the Open Exposure Gateway, and the transformation functions that expose the underlying infrastructure techology. Since a principal goal of the SUNRISE6G Operator Platform is the exposure of diverse technology stacks, SRM seamlessly handles the Application Provider's request for infrastructure access by selecting the appropriate transformation function. 
The Service Resource Manager facilitates the North-South Bound Interface (NSBI) specification of GSMA, by acting as an interconnection link between the CAMARA-defined API exposed by the Open Exposure Gateway, and the transformation functions that expose the underlying infrastructure techology. SRM seamlessly handles the Application Provider's request for infrastructure access by selecting the appropriate transformation function. 

SRM supports the following CAMARA functions:

@@ -15,13 +15,14 @@ SRM supports the following CAMARA functions:
| Application Metadata registration  | Create QoD Session  |
| App Metadata Removal  | Remove QoD Session  |
| App Metadata Retrieval  | Retrieve QoD Session  |
| Application Instantiation  | Create TrafficeInfluence Resource  |
| Application Instance Retrieval  | Remove TrafficeInfluence Resource  |
| Application Instance Removal  | Retrieve TrafficeInfluence Resource  |
| Application Instantiation  | Create Traffic Influence Resource  |
| Application Instance Retrieval  | Remove Traffic Influence Resource  |
| Application Instance Removal  | Retrieve Traffic Influence Resource  |
|  | Retrieve Location  |

## Deployment

SRM can be deployed in a Kubernetes cluster by executing the file _srm-deployment.yaml_ located in the root folder. This file will create a SRM Deployment resource and its supporting native K8s Service. The following table contains the necesssary environment variables for the Kubernetes adapter. If you have defined a custom adapter, include your variables accordingly.
SRM can be deployed in a Kubernetes cluster. When deployment manifests (e.g. _srm-deployment.yaml_) are provided, they create a SRM Deployment resource and its supporting native K8s Service. The following table contains the necessary environment variables for the Kubernetes adapter. If you have defined a custom adapter, include your variables accordingly.

### Adapter environment variables

@@ -35,7 +36,7 @@ SRM can be deployed in a Kubernetes cluster by executing the file _srm-deploymen
| Name | Description|
| ------------- | ------------- |
| ADAPTER_BASE_URL| Base address for the edge cloud adapter |
| ARTIFACT_MANAGER_ADDRESS |  Address of the Artefact Manager |
| ARTIFACT_MANAGER_ADDRESS |  Address of the Artifact Manager |
| EDGE_CLOUD_ADAPTER_NAME  | The adapter SRM is going to use throughout its lifecycle.|
| PLATFORM_PROVIDER| The Edge Cloud infrastructure provider|
| NETWORK_ADAPTER_NAME | The Network function exposure adapter|
@@ -43,7 +44,7 @@ SRM can be deployed in a Kubernetes cluster by executing the file _srm-deploymen

## Usage

Assuming an instance of Open Exposure Gateway (OEG) is running so that CAMARA APIs are accessible, here are a few request examples with responses, all CAMARA compatible:
Assuming an instance of Open Exposure Gateway (OEG) is running so that CAMARA APIs are accessible, here are a few request examples with responses, all CAMARA compatible. These examples call the OEG (which may forward to SRM); SRM itself exposes the backend APIs (e.g. `/serviceFunction`, `/deployedServiceFunction` for edge cloud, `/sessions`, `/traffic-influences`, `/location/retrieve` for network exposure).

### Get all registered apps