Commit 3f268770 authored by George Papathanail's avatar George Papathanail
Browse files

Edit README.md

parent a57f5128

helm/README.md

+61 −19
Original line number Diff line number Diff line
@@ -27,20 +27,56 @@ The solution deploys the following components inside a single KIND cluster: 


  * Northbound API entry point for tenants/applications

  * Handles application onboarding and exposure workflows

  * Acts as the main entry point to the Operator Platform

  * Backed by MongoDB



* **Service Resource Manager (SRM)**



  * Manages application artefacts and lifecycle

  * Supports resource orchestration workflows

  * Interfaces with edge/cloud resources

  * Supports southbound orchestration workflows

  * Backed by MongoDB with PV/PVC support



* **Federation Manager (FM)**



  * Manages inter-operator federation workflows

  * Handles partner Operator (OP) discovery and onboarding

  * Supports federated artefact creation and exchange

  * Enables cross-domain and multi-operator edge deployments

  * Backed by MongoDB



---



## 3. High-Level Architecture



The Open Operator Platform is deployed as a set of cooperating services within a single KIND cluster. Each component has a distinct responsibility aligned with GSMA Operator Platform principles.



```

+---------------------------------+

+--------------------------------------+

|            KIND Cluster               |

|                                      |

|  +-------------------------------+   |

|  | Open Exposure Gateway (OEG)    |   |

|  | - Northbound APIs              |   |

|  | - Tenant entry point           |   |

|  +---------------+---------------+   |

|                  |                   |

|  +---------------v---------------+   |

|  | Service Resource Manager       |   |

|  | (SRM)                          |   |

|  | - App & resource lifecycle     |   |

|  +---------------+---------------+   |

|                  |                   |

|  +---------------v---------------+   |

|  | Federation Manager (FM)        |   |

|  | - Partner Operators            |   |

|  | - Federated artefacts          |   |

|  +-------------------------------+   |

|                                      |

+--------------------------------------+

```



---------------------------------+

|          KIND Cluster            |

|                                 |

|  +---------------------------+  |
@@ -58,6 +94,7 @@ The solution deploys the following components inside a single KIND cluster: 
|  +---------------------------+  |

|                                 |

+---------------------------------+



```



---
@@ -65,6 +102,7 @@ The solution deploys the following components inside a single KIND cluster: 
## 4. Repository Structure



```



.

├── deploy-on-kind.sh              # Automated deployment script

├── kind-oop-config.yaml           # KIND cluster configuration
@@ -80,7 +118,8 @@ The solution deploys the following components inside a single KIND cluster: 
└── charts/

├── oeg/                   # Open Exposure Gateway chart

└── srm/                   # Service Resource Manager chart

```



````



---
@@ -89,7 +128,7 @@ The solution deploys the following components inside a single KIND cluster: 
### 5.1 Required Software



| Tool | Minimum Version |

| ------- | --------------- |

|---|---|

| Docker | 20.x |

| KIND | 0.20 |

| kubectl | 1.25 |
@@ -103,7 +142,7 @@ docker --version 
kind --version

kubectl version --client

helm version

```

````



---
@@ -285,4 +324,7 @@ kind delete cluster --name oop 
./deploy-on-kind.sh

```



---