Der VereinNATS Setup
NATS ist eine zentrale Komponente der Architektur. NATS ist ein verteiltes Messaging-System, welches häufig für Microservices verwendet wird.
Unser Backend (oder auch andere Systeme) publizieren Events in NATS, die dann beispielsweise in N8n über ein Trigger konsumiert werden.
Grundlagen
Übersicht
NATS kann grob in zwei Varianten unterteilt werden, NATS Core und NATS JetStream.
NATS Core ist das Grundsystem von NATS und bietet schnelle, leichtgewichtige Kommunikationsmöglichkeiten wie Publish/Subscribe, Request/Reply und Queueing. Dabei werden Nachrichten in der Regel nur flüchtig übertragen: Geht ein Empfänger offline, gehen die Nachrichten verloren. Der Fokus liegt auf extrem niedriger Latenz und hoher Performance.
NATS JetStream erweitert NATS Core um Funktionen wie Persistenz, wiederholtes Lesen von Nachrichten und zeitversetzte Verarbeitung. Nachrichten können gespeichert werden, was eine zuverlässige Zustellung, Wiederholungen und komplexe Workflows ermöglicht. JetStream ist damit besonders geeignet für Szenarien, in denen eine dauerhafte Verarbeitung oder Event-Sourcing erforderlich ist, während Core eher für schnelle, vorübergehende Nachrichtenübertragung optimiert ist.
Accounts
Accounts sind eine Möglichkeit, Mandanten oder Anwendungen innerhalb eines Clusters oder NATS Servers voneinander abzugrenzen. Jeder Account besitzt einen eigenen Namespace für Subjekte, verwaltet seine Benutzer und deren Berechtigungen und bietet so eine klare Trennung zwischen unterschiedlichen Workloads. Gleichzeitig lassen sich über Exports und Imports bestimmte Subjekte gezielt mit anderen Accounts teilen, sodass Kommunikation zwischen getrennten Bereichen möglich bleibt. Auf diese Weise stellen Accounts die Grundlage für Multi-Tenancy, Sicherheit und flexible Skalierung in NATS dar.
Wir verwenden zwei verschiedene Accounts:
Account | Berechtigungen | Beschreibung |
|---|---|---|
SYS | SYSTEM Account | Wird für administrative Tätigkeiten wie beispielsweise Troubleshooting oder das Auslesen von Informationen verwendet |
MKSP | Regulärer Account | Regulärer Account für Daten |
Benutzer können jeweils nur einem Account zugeordnet werden.
Authentifizierung
Die Kommunikation ist TLS verschlüsselt, es kommen die TLS Zertifikate aus HashiCorp KeyVault zum Einsatz. Diese werden dann einzelnen Accounts zugewiesen. Der NATS Server validiert das Zertifikat an Hand der Zertifikatskette und mapt dann die Zertifikatsinformationen zu einem User. Üblicherweise wird dabei ein SAN (Subject Alternative Name) in Form einer Mail-Adresse verwendet. Diese gibt es in unserem Fall nicht, sodass das Subject verwendet wird. Wichtig ist, dass das Subject in RFC2253 Form verwendet werden muss.
Certificate:
Data:
...
Subject: CN=backend.mksp-da.de,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE
Diese Subject wird dann dem Account zugeordnet:
accounts: {
MKSP: {
jetstream: enabled
users: [
{
user: "CN=backend.mksp-da.de,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE"
},
{
user: "CN=n8n.mksp-da.de,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE"
},
{
user: "CN=js-admin.mksp-da.de,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE"
},
]
}
SYS: {
users: [
{user: "CN=admin.mksp-da.de,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE"}
]
}
}
Da ein User nur einem Account zugeordnet werden kann, gibt es einen admin User für administrative Tätigkeiten sowie einen JetStream Admin User für die Account-Verwaltung.
NATS Core mit Accounts
Damit die NATS Core Messages auch weiterhin funktionieren müssen publish und subscribe Berechtigungen vergeben werden. NATS wird neben dem Eventmanagement auch noch für die Task Queue mit Taskiq eingesetzt, hier werden zur Zeit noch Core Funktionalitäten verwendet. Daher muss die Berechtigung für den backend User erweitert werden:
MKSP: {
users: [
{
user: "CN=backend.mksp-da.de,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE"
permissions: {
publish: [">"]
subscribe: [">"]
}
},
...
Wichtig sind hier die zusätzlichen Permissions, die den Zugriff auf Core Events regeln.
JetStream Konfiguration
In unserem Fall ist Persistenz auch bei einem zeitweisen Ausfall der Internetverbindung im Makerspace notwendig, sodass wir JetStream mit Message Retention verwenden. Dabei müssen die wichtigen Komponenten vorab angelegt werden.
NATS CLI konfigurieren
Zur Administration bietet sich die Verwendung der NATS CLI an. Diese muss einmalig eingerichtet werden, dafür sind die entsprechenden Zertifikatsdateien notwendig. Wir legen zwei Kontexte an, einen für den Cluster Admin, einen für den JetStream Admin:
nats context add mksp-jsadmin --server ds-hetzner.mksp-da.de:4222 --description "MKSP NATS JetStream" --tlscert /path/to/jsadmin.mksp-da.de.crt --tlskey /path/to/jsadmin.mksp-da.de.key --tlsca /path/to/mksp_root_x1_ca.crt
Anschließend wählen wir den richtigen Kontext aus, in diesem Fall den JetStream Admin Context:
JetStream initialisieren
JetStream ist in so genannte Streams unterteilt, welche bestimmte Subjects in einem Stream zusammenfassen. Wir nutzen für alle Events einen gemeinsamen Präfix (mksp), sodass wir den Stream hierfür erstellen. Die NATS Dokumentation selbst beschreibt die Konzepte sehr gut:
- JetStream im Allgemeinen: https://docs.nats.io/nats-concepts/jetstream
- JetStream Streams: https://docs.nats.io/nats-concepts/jetstream/streams
Wir legen nun also ein Stream namens backend_events an:
JetStream Consumer
Consumer sind eine Auswahl / Ansicht von Teilen eines Streams. Details finden sich wieder in der NATS Dokumentation: https://docs.nats.io/nats-concepts/jetstream/consumers
Consumer können entweder persistent sein (dauerhaft, ein Client kann dann den bestehenden Consumer neben) oder flüchtig (ephemeral), in diesem Fall wird der Consumer beim Erstellen des Clients (beispielsweise durch N8n) angelegt. In der Regel werden Consumer durch einen Filter auf bestimmte Subjects beschränkt, diese dürfen sich nicht überschneiden. Da die NATS JavaScript Client Library (die von n8n verwendet wird) es leider nicht sinnvoll erlaubt, ephemeral Consumer anzulegen verwenden wir dauerhafte Consumer-Namen.
Backend Event | Consumer Name | Schema |
|---|---|---|
mksp.backend.briefing.offer.cancelled
| backend_briefing_offer_cancelled | BriefingOfferEvent |
mksp.backend.briefing.offer.created
| backend_briefing_offer_created | BriefingOfferEvent |
mksp.backend.briefing.offer.updated | backend_briefing_offer_updated | BriefingOfferEvent |
mksp.backend.briefing.created
| backend_briefing_created | BriefingEvent |
mksp.backend.key.assigned | backend_key_assigned | KeyEvent |
mksp.backend.key.unassigned | backend_key_unassigned | KeyEvent |
mksp.backend.storage.reserved | backend_storage_reserved | StorageSpaceEvent |
mksp.backend.storage.released | backend_storage_released | StorageSpaceEvent |
mksp.backend.storage.expired | backend_storage_expired | StorageSpaceEvent |
mksp.backend.user.converted_to_member | backend_user_converted_to_member | UserEvent |
mksp.backend.user.converted_to_guest | backend_user_converted_to_guest | UserEvent |
mksp.docuseal.document.signed | docuseal_document_signed | SignatureEvent |
Die Consumer können dann wie folgt angelegt werden:
# Beispiel
nats consumer add backend_events backend_briefing_offer_cancelled --pull --filter="mksp.backend.briefing.offer.cancelled" --defaults
nats consumer add backend_events backend_key_assigned --pull --filter="mksp.backend.key.assigned" --defaults
Troubleshooting
Man kann über die NATS CLI mit dem Server interagieren.
JetStream
Streams
Man kann sich die vorhandenen Streams und die Anzahl der Nachrichten anschauen. Die Anzahl sollte üblicherweise 0 sein, wenn die Zahl höher ist, werden Events nicht richtig abgearbeitet.
$ nats stream ls
╭─────────────────────────────────────────────────────────────────────────────────────╮
│ Streams │
├────────────────┬─────────────┬─────────────────────┬──────────┬──────┬──────────────┤
│ Name │ Description │ Created │ Messages │ Size │ Last Message │
├────────────────┼─────────────┼─────────────────────┼──────────┼──────┼──────────────┤
│ backend_events │ │ 2025-09-08 08:36:19 │ 0 │ 0 B │ never │
╰────────────────┴─────────────┴─────────────────────┴──────────┴──────┴──────────────╯
Ebenso kann man sich - falls vorhandenen - die Nachrichten im Stream anzeigen lassen:
$ nats stream view backend_events
[1] Subject: mksp.backend.storage.reserved Received: 2025-09-08 09:06:00
{"timestamp":"2025-09-08T09:06:00.062358","stora
Consumer
Die bestehenden Consumer kann man sich ebenfalls im Jetstream Context anzeigen lassen:
╭──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ Consumers │
├──────────────────────────────────┬─────────────┬─────────────────────┬─────────────┬─────────────┬───────────────┤
│ Name │ Description │ Created │ Ack Pending │ Unprocessed │ Last Delivery │
├──────────────────────────────────┼─────────────┼─────────────────────┼─────────────┼─────────────┼───────────────┤
│ backend_briefing_created │ │ 2025-09-10 08:30:12 │ 0 │ 12 │ never │
│ backend_briefing_offer_cancelled │ │ 2025-09-10 08:21:02 │ 0 │ 0 │ never │
│ backend_briefing_offer_created │ │ 2025-09-10 08:28:25 │ 0 │ 0 │ never │
│ backend_briefing_offer_updated │ │ 2025-09-10 08:29:19 │ 0 │ 0 │ never │
│ backend_key_assigned │ │ 2025-09-10 08:21:04 │ 0 │ 0 │ never │
╰──────────────────────────────────┴─────────────┴─────────────────────┴─────────────┴─────────────┴───────────────╯
In dieser Tabelle sieht man bereits die "unprocessed" Nachrichten. Ist diese Zahl größer als 0 s sieht also gut, wenn n8n die Nachrichten nicht korrekt verarbeitet. Man kann sich ebenfalls die Details eines Consumers anzeigen lassen:
Information for Consumer backend_events > backend_briefing_offer_cancelled created 2025-09-09 22:53:26
Configuration:
Name: backend_briefing_offer_cancelled
Pull Mode: true
Filter Subject: mksp.backend.briefing.offer.cancelled
Deliver Policy: All
Ack Policy: Explicit
Ack Wait: 30.00s
Replay Policy: Instant
Max Ack Pending: 1,000
Max Waiting Pulls: 512
State:
Host Version: 2.11.8
Required API Level: 0 hosted at level 1
Last Delivered Message: Consumer sequence: 0 Stream sequence: 10
Acknowledgment Floor: Consumer sequence: 0 Stream sequence: 0
Outstanding Acks: 0 out of maximum 1,000
Redelivered Messages: 0
Unprocessed Messages: 0
Waiting Pulls: 1 of maximum 512
Insbesondere die letzten beiden Zeilen sind wichtig:
- Unprocessed Messages sind Nachrichten, die noch nicht abgerufen wurden. Dies sollte immer 0 sein
- Waiting Pulls: die Anzahl der verbundenen Clients. Üblicherweise sollte das nur n8n sein, also immer 1.
Server
Man kann sich ebenfalls die aktiven Verbindungen anzeigen:
$ nats server report connections
╭─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ Top 6 Connections out of 6 by subs │
├─────┬──────────────────────────┬──────────────┬─────────┬───────────────────┬─────────┬──────────┬─────────┬──────────┬──────────┬───────────┬──────┤
│ CID │ Name │ Server │ Cluster │ IP │ Account │ Uptime │ In Msgs │ Out Msgs │ In Bytes │ Out Bytes │ Subs │
├─────┼──────────────────────────┼──────────────┼─────────┼───────────────────┼─────────┼──────────┼─────────┼──────────┼──────────┼───────────┼──────┤
│ 83 │ backend_kicker │ mksp-nats-01 │ │ 172.18.0.33:52808 │ MKSP │ 2h24m18s │ 0 │ 0 │ 0 B │ 0 B │ 0 │
│ 93 │ backend_scheduler │ mksp-nats-01 │ │ 172.18.0.29:47620 │ MKSP │ 2h23m23s │ 0 │ 0 │ 0 B │ 0 B │ 0 │
│ 82 │ backend_fastapi │ mksp-nats-01 │ │ 172.18.0.33:52798 │ MKSP │ 2h24m18s │ 1 │ 1 │ 345 B │ 838 B │ 1 │
│ 94 │ backend_worker │ mksp-nats-01 │ │ 172.18.0.37:53550 │ MKSP │ 2h23m23s │ 0 │ 0 │ 0 B │ 0 B │ 1 │
│ 95 │ backend_worker │ mksp-nats-01 │ │ 172.18.0.37:53554 │ MKSP │ 2h23m23s │ 0 │ 0 │ 0 B │ 0 B │ 1 │
│ 111 │ NATS CLI Version 0.2.4 │ mksp-nats-01 │ │ 10.1.253.1:50712 │ SYS │ 0s │ 2 │ 1 │ 210 B │ 944 B │ 1 │
├─────┼──────────────────────────┼──────────────┼─────────┼───────────────────┼─────────┼──────────┼─────────┼──────────┼──────────┼───────────┼──────┤
│ │ Totals for 6 connections │ │ │ │ │ │ 3 │ 2 │ 555 B │ 1.7 KiB │ 4 │
╰─────┴──────────────────────────┴──────────────┴─────────┴───────────────────┴─────────┴──────────┴─────────┴──────────┴──────────┴───────────┴──────╯
╭──────────────────────────────────────╮
│ Connections per server │
├──────────────┬─────────┬─────────────┤
│ Server │ Cluster │ Connections │
├──────────────┼─────────┼─────────────┤
│ mksp-nats-01 │ │ 6 │
╰──────────────┴─────────┴─────────────╯
Der Name ist hierbei frei vergeben, in unserem Fall im Backend Code. Wir erwarten die folgenden Clients:
Client | Anzahl | Komponente | Art | Beschreibung |
|---|---|---|---|---|
backend_kicker | 1 | Taskiq | Core | Gibt dem Backend die Möglichkeit, asynchrone Tasks an das Taskiq backend zu delegieren |
backend_scheduler | 1 | Taskiq | Core | Komponente welches die regelmäßigen Jobs überwacht und triggert |
backend_fastapi | 1 | FastAPI | JetStream | Das Backend kann hiermit Events ausgeben, die dann von N8n abgearbeitet werden. |
backend_worker | 2 | Taskiq | Core | Worker für asynchrone Tasks |
Man kann sich ebenfalls die Subscriptions der jeweiligen Connections anschauen. Hierfür muss die Ausgabe auf JSON umgestellt werden:
$ nats server report connections -j
[
{
"cid": 95,
"kind": "Client",
"type": "nats",
"ip": "172.18.0.37",
"port": 53554,
"start": "2025-09-08T13:35:37.398441269Z",
"last_activity": "2025-09-08T13:35:37.434868631Z",
"rtt": "479µs",
"uptime": "2h27m5s",
"idle": "2h27m5s",
"pending_bytes": 0,
"in_msgs": 0,
"out_msgs": 0,
"in_bytes": 0,
"out_bytes": 0,
"subscriptions": 1,
"name": "backend_worker",
"lang": "python3",
"version": "2.11.0",
"tls_version": "1.3",
"tls_cipher_suite": "TLS_AES_128_GCM_SHA256",
"tls_peer_certs": [
{
"subject": "CN=backend.mksp-da.de,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE",
"spki_sha256": "1c7826ac936267622a5bfec0359304e795a4fd552b4d76556d7fcbddf51f43fb",
"cert_sha256": "e25dd3084b13f5f3cb81ebb9291627bcd0a25ab51325f1cc627a2b758f03d1ca"
},
{
"subject": "CN=MKSP NATS Issuing CA,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE",
"spki_sha256": "af16c3490475a4ba65d273b7dae825622b4c1eeca5f3da808df14b3c298627a7",
"cert_sha256": "10ccebe5826128f50f7b007537fa8b832326d4bb14b1676588abac9a10bf7585"
}
],
"authorized_user": "CN=backend.mksp-da.de,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE",
"account": "MKSP",
"subscriptions_list": [
"taskiq_tasks"
],
"name_tag": "MKSP",
"server": {
"name": "mksp-nats-01",
"host": "0.0.0.0",
"id": "NDH7ZAPFJ5EORJKZDJGOUNN3NDMTLWR6V7BGBOYUIG5UE7VEIK76F6WH",
"ver": "2.11.6",
"jetstream": true,
"flags": 7,
"seq": 2937,
"time": "2025-09-08T16:02:42.888686229Z"
}
},
]