scottk/wlan-cloud-ucentralsec
1
0
Fork 0
mirror of https://github.com/Telecominfraproject/wlan-cloud-ucentralsec.git synced 2025-10-29 18:02:29 +00:00
Code Issues Packages Projects Releases 10 Wiki Activity

initial

Browse Source
This commit is contained in:
stephb9959
2021-06-28 23:45:50 -07:00
parent 9b378ed042
commit 36093d3e54
1 changed files with 46 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
docs/design/kafka_topics.md Normal file
View File

@@ -0,0 +1,46 @@
# Kafka topics for micro-services.
Here are some of the topics going on the kafka bus to maintain the microservice architecture
## `service_events` topic
### Payload
#### Service joins the stack
Upon starting up, a service needs to send this message.
```json
{
"event" : "join",
"id" : 1,
"type" : "ucentral/security/firmware/prov/topology/other",
"endPoint" : "https://endpoint.com:16001",
"key" : "access-key",
"version": "1.0.0"
}
```
#### Service leaves the stack
Upon going down, a service should send this notice.
```json
{
"event" : "leave",
"id" : 1,
"type" : "ucentral/security/firmware/prov/topology/other",
"endPoint" : "https://endpoint.com:16001",
"key" : "access-key",
"version": "1.0.0"
}
```
#### Service heartbeat
Sent every minute by all services.
```json
{
"event" : "keep-alive",
"id" : 1,
"type" : "ucentral/security/firmware/prov/topology/other",
"endPoint" : "https://endpoint.com:16001",
"key" : "access-key",
"version": "1.0.0"
}
```