Commit afdf7041 authored by Dimitrios Gogos's avatar Dimitrios Gogos
Browse files

docs(platform): add FM DataBus subjects, the Portal and capability ids to the glossary 

OOP_TASKS, OOP_EVENTS and WorkQueue now name command.fm.service.* and
event.fm.operation.completed (ADR-0053). Service instance ids also serve
as the QoD sessionId and the trafficInfluenceID (ADR-0033). The Portal
gets a row from portal A.1.

Co-Authored-By: default avatarClaude Opus 5.5 <noreply@anthropic.com>
parent 21fd6e28

platform/glossary.md

+5 −4
Changes for platform/glossary.md: 5 added lines, 4 removed lines.
Original line number Diff line number Diff line
@@ -26,6 +26,7 @@ This is the single glossary for all Open Operator Platform (OOP) architecture do 
| **TF-SDK** | Transformation Function SDK — a Python adapter library that translates SRM's normalized commands into vendor-specific infrastructure calls. Runs inside SRM as an in-process library. |

| **oop-commons** | Shared Python library providing auth middleware, logging, database helpers, and other cross-cutting utilities |

| **NATS / DataBus** | The internal messaging system (NATS JetStream) used for asynchronous commands and events between OOP services |

| **Portal** | OOP's web UI: one container whose backend serves the React app and forwards calls to OEG with the user's access token. The browser holds only the session cookie; tokens stay in the backend (ADR-0064, ADR-0065). See [portal/overview-and-architecture.md](/portal/overview-and-architecture.md). |

| **AI² (AI squared)** | OOP's AI component: an agent that takes a natural-language request and an MCP server whose tools call OEG's CAMARA APIs with the caller's own token. See [ai2/overview-and-architecture.md](/ai2/overview-and-architecture.md). |

| **Data Lab (DL)** | OOP's data- and AI-asset component. In release 0.1.0: the dataspace metadata catalogue — piveau-hub with the Data Lab UI and API — describing datasets, distributions and data quality per the 6G-DALI MAP. Future: dataspace connector, object storage, DataOps/MLOps pipelines. See [data-lab/overview-and-architecture.md](/data-lab/overview-and-architecture.md). |
@@ -33,9 +34,9 @@ This is the single glossary for all Open Operator Platform (OOP) architecture do 


| Term | Meaning |

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

| **`OOP_TASKS`** | The named DataBus work stream that carries mutating `command.srm.*` commands such as `command.srm.service.deploy`, `command.srm.service.scale`, `command.srm.service.terminate`, and `command.srm.network.capability.activate` / `.update` / `.deactivate` |

| **`OOP_EVENTS`** | The named DataBus event stream that carries published events such as `event.srm.operation.completed`, `event.srm.operation.status`, `event.srm.catalog.updated`, and `event.srm.inventory.drift_detected` / `.drift_resolved` |

| **WorkQueue** | The queue-style DataBus delivery model used for mutating `command.srm.*` commands |

| **`OOP_TASKS`** | The named DataBus work stream that carries mutating `command.srm.*` commands such as `command.srm.service.deploy`, `command.srm.service.scale`, `command.srm.service.terminate`, and `command.srm.network.capability.activate` / `.update` / `.deactivate`, plus `command.fm.service.deploy` / `command.fm.service.terminate`, which SRM sends FM when the target is partner-hosted (ADR-0053) |

| **`OOP_EVENTS`** | The named DataBus event stream that carries published events such as `event.srm.operation.completed`, `event.srm.operation.status`, `event.srm.catalog.updated`, and `event.srm.inventory.drift_detected` / `.drift_resolved`, plus `event.fm.operation.completed`, FM's outcome of a partner hand-off (ADR-0053) |

| **WorkQueue** | The queue-style DataBus delivery model used for mutating `command.srm.*` and `command.fm.*` commands |



## Telecom and Standards
@@ -83,7 +84,7 @@ This is the single glossary for all Open Operator Platform (OOP) architecture do 
| **Reconciliation** | Periodically comparing SRM's recorded inventory with the real infrastructure state to find drift |

| **Capacity (no stored reservations)** | SRM holds no capacity reservations in v1 (ADR-0002). Capacity truth is delegated to the backend (e.g. the Kubernetes scheduler), which enforces admission at execution time; a `capacity_snapshot` table is deferred. |

| **Service order** | The persisted record (`service_order`) of a mutating command such as deploy, scale, terminate, or network capability; keyed by `operation_id` |

| **Service instance** | The runtime root object (`service_instance`) of a service that SRM is creating, running, scaling, or terminating, scoped to one zone. Its id is the caller-facing `appInstanceId` (ADR-0005). One deploy operation targeting N zones yields N service instances. |

| **Service instance** | The runtime root object (`service_instance`) of a service that SRM is creating, running, scaling, or terminating, scoped to one zone. Its id is the caller-facing `appInstanceId` (ADR-0005), or for a network capability the QoD `sessionId` or the Traffic Influence `trafficInfluenceID` (ADR-0033). One deploy operation targeting N zones yields N service instances. |

| **appInstanceId** | The CAMARA caller-facing identity of one deployed app instance in one zone. **OEG-minted** (at request time) and adopted by SRM as the `service_instance_id`; **equal to `service_instance_id`** (a UUID, distinct from the client-supplied `name`); ADR-0005. `POST /appinstances` (single zone) returns it in the 202; for multi-zone `POST /deployments` the ids are read back via `GET /deployments?appDeploymentId=...` (ADR-0007). OEG maps it to the originating operation in `app_instances`. |

| **appDeploymentId** | The CAMARA caller-facing identity of a multi-zone **deployment** aggregate (`POST /deployments`). OEG-minted; groups the N `appInstanceId`s produced across the requested `edgeCloudZones`. Durable handle for `GET /deployments?appDeploymentId=...` (ADR-0007) and `PATCH`/`DELETE /deployments/{appDeploymentId}`; stored in OEG's `app_deployments` (ADR-0005). |

| **Capability instance** | SRM's record (`capability_instance`) of one realized capability under a service instance — holds the backend `external_id`, the backend realization ref `external_ref`, and the canonical `parameters_snapshot`/`result_summary`. It carries no caller-facing identity: that lives on `service_instance.id` for every family (ADR-0005, ADR-0033). |