Commit 81a67a7c authored by George Papathanail's avatar George Papathanail
Browse files

docs(helm): document the 2.0 charts

parent 56287fb7

README.md

+1 −1
Changes for README.md: 1 added line, 1 removed line.
Original line number Diff line number Diff line
@@ -14,7 +14,7 @@ Intended for local development, integration testing, and demos. **Not for produc 
| Federation Manager | `oop` | Inter-operator federation (GSMA OPG.04 E/WBI) |

| Keycloak | `oop` | OAuth2/OIDC identity provider: realm `oop` (portal users, app providers, OEG tokens) and realm `federation` (FM partners) |

| PostgreSQL | `oop` | Shared instance; one database and role per component |

| NATS | `oop` | Message bus between OEG, SRM and FM (core NATS, no JetStream) |

| NATS | `oop` | Message bus between OEG, SRM and FM; JetStream on, used only by FM |

| AI2 MCP | `oop` | MCP server exposing CAMARA-compliant tools |

| AI2 AI Agent | `oop` | Natural language interface backed by Groq |

| Portal | `oop` | Developer portal: web UI and its backend (login, OEG and AI2 proxy, API clients) |

oop-platform-chart/charts/federation-manager/README.md

+20 −5
Changes for oop-platform-chart/charts/federation-manager/README.md: 20 added lines, 5 removed lines.
Original line number Diff line number Diff line
@@ -23,15 +23,30 @@ Keycloak there is no FM (no Deployment, Service or key Secret). 
|---|---|---|

| PostgreSQL | Database and role `fm`, password in Secret `postgres-credentials` → `fm-password` | `postgresql.databases` in the umbrella chart |

| Keycloak | Realm `federation` | keycloak chart |

| NATS **with JetStream** | `nats://oop-nats:4222` | `nats` dependency of the umbrella chart |

| NATS **with JetStream** | `nats://oop-nats:4222` (see [JetStream](#jetstream)) | `nats` dependency of the umbrella chart |

| SRM | `http://srm:8080` | srm chart |



### JetStream



FM 2.0 creates JetStream streams and a durable consumer (`nats.eventConsumerDurable`) when it

starts. The platform's NATS runs **without** JetStream (`nats.config.jetstream.enabled: false` in

the umbrella chart), so FM can't start against it yet. This has to be fixed in FM: the chart

won't turn JetStream on.

FM 2.0 creates two JetStream streams and durable consumers (named from

`nats.eventConsumerDurable`) when it starts, so the umbrella chart runs NATS with JetStream on.

FM is the only component that uses it; OEG and SRM use plain NATS.



| Stream | Subjects | Kept |

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

| `OOP_TASKS` | `command.srm.>`, `command.fm.>` | Until FM processes them, at most 24 hours |

| `OOP_EVENTS` | `event.srm.>`, `event.fm.>` | No limit |



A stream stores every message on its subjects, including those OEG and SRM send each other, so

OEG→SRM commands stay in `OOP_TASKS` for up to 24 hours and `OOP_EVENTS` keeps growing. The

JetStream volume is therefore capped at 2 GiB (`nats.config.jetstream.fileStore.pvc.size` and

`maxSize` in the umbrella chart). When it's full, NATS stops storing new messages and FM's own

publishes fail; plain NATS delivery to OEG and SRM goes on. Until FM limits `OOP_EVENTS`, check the

volume from time to time:



```bash

kubectl -n oop exec oop-nats-0 -c nats -- du -sh /data/jetstream

```



## Login (Keycloak realm `federation`)

oop-platform-chart/charts/oeg/README.md

+1 −1
Changes for oop-platform-chart/charts/oeg/README.md: 1 added line, 1 removed line.
Original line number Diff line number Diff line
@@ -22,7 +22,7 @@ below. 
|---|---|---|

| PostgreSQL | Database and role `oeg`, password in Secret `postgres-credentials` → `oeg-password` | `postgresql.databases` in the umbrella chart |

| Keycloak | Realm `oop`; tokens carry audience `oeg` | keycloak chart (skipped when `global.auth.enabled=false`) |

| NATS | `nats://oop-nats:4222`, core NATS (no JetStream) | `nats` dependency of the umbrella chart |

| NATS | `nats://oop-nats:4222`, plain NATS (JetStream is on for FM, unused here) | `nats` dependency of the umbrella chart |

| SRM | `http://srm:8080` | srm chart |

| Federation Manager | `http://federation-manager:8082` | federation-manager chart |

oop-platform-chart/charts/srm/README.md

+1 −1
Changes for oop-platform-chart/charts/srm/README.md: 1 added line, 1 removed line.
Original line number Diff line number Diff line
@@ -34,7 +34,7 @@ The chart is written for the image you get once both are fixed. 
| Dependency | What the chart expects | Where it comes from |

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

| PostgreSQL | Database and role `srm`, password in Secret `postgres-credentials` → `srm-password` | `postgresql.databases` in the umbrella chart |

| NATS | `nats://oop-nats:4222`, core NATS (no JetStream) | `nats` dependency of the umbrella chart |

| NATS | `nats://oop-nats:4222`, plain NATS (JetStream is on for FM, unused here) | `nats` dependency of the umbrella chart |

| Federation Manager | `http://federation-manager:8082` | federation-manager chart |



SRM has no login of its own: only OEG and Federation Manager call it, inside the cluster.