Commit 16631438 authored by George Papathanail's avatar George Papathanail
Browse files

Edit README.md

parent 3f268770

helm/README.md

+19 −95
Original line number Diff line number Diff line
@@ -47,85 +47,9 @@ The solution deploys the following components inside a single KIND cluster: 


---



## 3. High-Level Architecture

## 3. Prerequisites



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            |

|                                 |

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

|  | Open Exposure Gateway     |  |

|  | (OEG)                     |  |

|  | - REST APIs               |  |

|  | - MongoDB                 |  |

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

|                                 |

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

|  | Service Resource Manager  |  |

|  | (SRM)                     |  |

|  | - Artefact Manager        |  |

|  | - MongoDB (PV/PVC)        |  |

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

|                                 |

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



```



---



## 4. Repository Structure



```



.

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

├── kind-oop-config.yaml           # KIND cluster configuration

├── RUN_THIS_NOW.txt               # Minimal quick start

├── KIND_QUICK_START.txt

├── KIND_DEPLOYMENT_GUIDE.md

└── oop-platform-chart/

├── Chart.yaml                 # Umbrella Helm chart

├── values.yaml                # Central configuration

├── README.md

├── QUICK_DEPLOY.md

├── VERIFICATION.txt

└── charts/

├── oeg/                   # Open Exposure Gateway chart

└── srm/                   # Service Resource Manager chart



````



---



## 5. Prerequisites



### 5.1 Required Software

### 3.1 Required Software



| Tool | Minimum Version |

|---|---|
@@ -135,7 +59,7 @@ The Open Operator Platform is deployed as a set of cooperating services within a 
| Helm | v3+ |

| Bash | 4+ |



### 5.2 Verify Installation

### 3.2 Verify Installation



```bash

docker --version
@@ -146,7 +70,7 @@ helm version 


---



## 6. Deployment Methods

## 4. Deployment Methods



Two deployment approaches are supported:
@@ -155,9 +79,9 @@ Two deployment approaches are supported: 


---



## 7. Automatic Deployment (Recommended)

## 5. Automatic Deployment (Recommended)



### 7.1 Description

### 5.1 Description



The automatic deployment method:
@@ -167,14 +91,14 @@ The automatic deployment method: 


All steps are executed by a single script.



### 7.2 Steps

### 5.2 Steps



```bash

chmod +x deploy-on-kind.sh

./deploy-on-kind.sh

```



### 7.3 What This Script Does

### 5.3 What This Script Does



1. Creates a KIND cluster using `kind-oop-config.yaml`

2. Configures `kubectl` context
@@ -183,9 +107,9 @@ chmod +x deploy-on-kind.sh 


---



## 8. Manual Deployment (Step-by-Step)

## 6. Manual Deployment (Step-by-Step)



### 8.1 Create the KIND Cluster

### 6.1 Create the KIND Cluster



```bash

kind create cluster \
@@ -201,7 +125,7 @@ kubectl cluster-info 


---



### 8.2 Deploy OOP Using Helm

### 6.2 Deploy OOP Using Helm



From the repository root:
@@ -217,7 +141,7 @@ helm upgrade oop-platform ./oop-platform-chart 


---



### 8.3 Verify Deployment

### 6.3 Verify Deployment



```bash

kubectl get pods -A
@@ -228,7 +152,7 @@ All pods should reach `Running` or `Completed` state. 


---



## 9. Configuration

## 7. Configuration



All configuration parameters are centralized in:
@@ -252,7 +176,7 @@ helm upgrade oop-platform ./oop-platform-chart 


---



## 10. Accessing Services

## 8. Accessing Services



Services are exposed via Kubernetes `Service` objects.
@@ -270,7 +194,7 @@ kubectl port-forward svc/oegcontroller 8080:8080 


---



## 11. Verification & Health Checks

## 9. Verification & Health Checks



```bash

kubectl get deployments -A
@@ -286,15 +210,15 @@ oop-platform-chart/VERIFICATION.txt 


---



## 12. Cleanup

## 10. Cleanup



### 12.1 Remove Helm Deployment

### 10.1 Remove Helm Deployment



```bash

helm uninstall oop-platform

```



### 12.2 Delete KIND Cluster

### 10.2 Delete KIND Cluster



```bash

kind delete cluster --name oop
@@ -302,7 +226,7 @@ kind delete cluster --name oop 


---



## 13. Troubleshooting

## 11. Troubleshooting



### Pods Not Starting