From b654d55346110e60f0025c125925900c865860ea Mon Sep 17 00:00:00 2001
From: dlaskaratos <79975730+dlaskaratos@users.noreply.github.com>
Date: Wed, 25 Jun 2025 12:57:23 +0300
Subject: [PATCH] Update README.md
---
README.md | 20 +++++++++++++++++---
1 file changed, 17 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index fd843a2..7f3c32c 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,12 @@
# 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/)
## 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.
-SRM support the following CAMARA functions:
+SRM supports the following CAMARA functions:
@@ -18,3 +18,17 @@ SRM support the following CAMARA functions:
| Application Instantiation | Create TrafficeInfluence Resource |
| Application Instance Retrieval | Remove TrafficeInfluence Resource |
| Application Instance Removal | Retrieve TrafficeInfluence Resource |
+
+## 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.
+
+| Edge Cloud Management API | Description |
+| ------------- | ------------- |
+| KUBERNETES_MASTER_IP | Root url of the Kubernetes apiserver (eg. 10.10.10.10)|
+| KUBERNETES_MASTER_PORT | Port of the Kubernetes apiserver (eg. 16443)|
+| EMP_STORAGE_URI | Root url of the management database, if deployed |
+| KUBERNETES_MASTER_TOKEN | Token with which all access to K8s apiserver will authenticated |
+| ARTIFACT_MANAGER_ADDRESS | Address of the Artefact Manager |
+| EDGE_CLOUD_ADAPTER_NAME | The adapter SRM is going to use throughout its lifecycle. For direct access to K8s just type 'kubernetes' |
+|PLATFORM_PROVIDER| The Edge Cloud infrastructure provider|
--
GitLab