drsybren/Flamenco
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

Website: add MQTT prefix to table of MQTT topics

Browse Source
This commit is contained in:
Sybren A. Stüvel 2024-03-13 19:16:40 +01:00
parent bd3dd90303
commit 1fee086cef
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
web/project-website/content/usage/manager-configuration/mqtt.md
View File

@ -47,18 +47,18 @@ mqtt:
## MQTT Topics
The following topics will be used by Flamenco:
The following topics will be used by Flamenco. The `flamenco` prefix for the topics is configurable.
| Description | MQTT topic | JSON event payload |
|----------------------------------|----------------------------------|---------------------------|
| Manager startup/shutdown | `/lifecycle` | `EventLifeCycle` |
| Farm status | `/status` | `EventFarmStatus` |
| Job update | `/jobs` | `EventJobUpdate` |
| Task update | `/jobs/{job UUID}` | `EventTaskUpdate` |
| Worker update | `/workers` | `EventWorkerUpdate` |
| Worker Tag update | `/workertags` | `EventWorkerTagUpdate` |
| Last rendered image | `/last-rendered` | `EventLastRenderedUpdate` |
| Job-specific last rendered image | `/jobs/{job UUID}/last-rendered` | `EventLastRenderedUpdate` |
| Description | MQTT topic | JSON event payload |
|----------------------------------|------------------------------------------|---------------------------|
| Manager startup/shutdown | `flamenco/lifecycle` | `EventLifeCycle` |
| Farm status | `flamenco/status` | `EventFarmStatus` |
| Job update | `flamenco/jobs` | `EventJobUpdate` |
| Task update | `flamenco/jobs/{job UUID}` | `EventTaskUpdate` |
| Worker update | `flamenco/workers` | `EventWorkerUpdate` |
| Worker Tag update | `flamenco/workertags` | `EventWorkerTagUpdate` |
| Last rendered image | `flamenco/last-rendered` | `EventLastRenderedUpdate` |
| Job-specific last rendered image | `flamenco/jobs/{job UUID}/last-rendered` | `EventLastRenderedUpdate` |
For the specification of the JSON sent in the MQTT events, use the above table
and then look up the type description in the [OpenAPI specification][oapi].