diff --git a/QoDProvisioning/README.md b/QoDProvisioning/README.md index b61372ce14393063ebd2cc1dea02630fbd12077b..3acc181ac161e5bb1dc25df9fe1be8e4bf48ff18 100644 --- a/QoDProvisioning/README.md +++ b/QoDProvisioning/README.md @@ -84,7 +84,25 @@ Therefore, OSL’s CAMARA APIs must offer the following TMF Service Characterist - camaraAPI.status - camaraAPI.results - +### Broker Connection + +This API has a *ServiceEventManager* class that communicates with OpenSlice's ActiveMQ broker through two topics: + +- `CATALOG.UPD.SERVICE`: Topic for catalog updates. +- `EVENT.SERVICE.ATTRCHANGED`: Topic for service attribute changes. + +#### CATALOG.UPD.SERVICE + +Whenever a new provisioning is created for an UE, the *ServiceEventManager*'s *update_service* method is called. This method sends a a service update message through OpenSlice's *CATALOG.UPD.SERVICE* topic. When OSL receives the request, it updates the Service with the new characteristics, which are then caught by the correspondent K8s Operator. After processing the request, the Operator adds the result to the Service-related CR *camaraResults* characteristic. + +#### EVENT.SERVICE.ATTRCHANGED + +The *ServiceEventManager* subscribes to this topic to obtain and process the update messages regarding the specified UE QoD Profile Enforcer OSL service. Whenever this service's characteristics are updated in OSL, this class catches the update message. Then, the class extracts the *camaraResults* characteristic, which contains all QoS provisionings applied to the UEs. + +These results are then processed by the *CamaraResultsProcessor* class, which updates each provisioning accordingly in the database. + + + ## How To / Demonstration