Änderungen von Dokument NATS - Technisches Setup

Zuletzt geändert von Daniel Herrmann am 2026/10/13 10:36

Verwalten
- Kopieren
Aktionen
- Exportieren
- Druckvorschau
Ansichten

Von 10.1 nach 11.1

Von Version

11.1

bearbeitet von Daniel Herrmann
am 2025/09/20 10:00

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Auf Version

25.1

bearbeitet von Daniel Herrmann
am 2026/10/13 10:36

Änderungskommentar: [AI] Taskiq Task Queue von NATS Core auf JetStream umgestellt (Stream MKSP_TASKS), Verbindungsübersicht aktualisiert

Rohform
Im Layout

Zusammenfassung

Seiteneigenschaften (3 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Titel

@@ -1,1 +1,1 @@
--NATS Setup
++NATS - Technisches Setup

Übergeordnete Seite

...	...	@@ -1,0 +1,1 @@
	1	+PROJ.Digitale Mitgliederverwaltung.Technische Dokumentation.WebHome

Inhalt

@@ -44,7 +44,7 @@
  == Authentifizierung ==
--Die Kommunikation ist TLS verschlüsselt, es kommen die TLS Zertifikate aus [[HashiCorp KeyVault>>doc:xwiki:IN.IT Infrastruktur.Kubernetes Cluster.Hashicorp Vault.WebHome]] 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.
++Die Kommunikation ist TLS verschlüsselt, es kommen die TLS Zertifikate aus [[HashiCorp KeyVault>>doc:xwiki:IN.IT Infrastruktur.Services.Hashicorp Vault.WebHome]] 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.
  {{code language="shell"}}
  $ openssl x509 -noout -text -nameopt RFC2253 -in backend.mksp-da.de.crt
@@ -83,9 +83,9 @@
  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 ==
++== Berechtigungen des Backend Users ==
--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:
++NATS wird neben dem Eventmanagement auch für die Task Queue mit Taskiq eingesetzt. Beides läuft über JetStream, NATS Core Subjects (früher ##taskiq_tasks## mit einer Queue Group) werden nicht mehr verwendet. Das Backend legt den Stream für die Task Queue selbst an und aktualisiert ihn (siehe [[Task Queue (Taskiq)>>||anchor="HTaskQueue28Taskiq29"]]), benötigt also Zugriff auf die JetStream API. Der backend User hat daher aktuell weiterhin weitreichende Berechtigungen:
  {{code}}
  accounts: {
@@ -101,7 +101,7 @@
  ...
  {{/code}}
--Wichtig sind hier die zusätzlichen Permissions, die den Zugriff auf Core Events regeln.
++Backend, Worker und Scheduler verwenden alle dasselbe Zertifikat und damit denselben User. Eine Einschränkung auf die tatsächlich benötigten Subjects (##mksp.>##, ##tasks.mksp.backend##, JetStream API für ##MKSP_TASKS##, ##_INBOX.>##) ist noch offen.
  == JetStream Konfiguration ==
@@ -112,9 +112,9 @@
  Zur Administration bietet sich die Verwendung der [[NATS CLI >>url:https://github.com/nats-io/natscli||shape="rect"]]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:
  {{code language="shell"}}
--nats context add mksp-sysadmin --server ds-hetzner.mksp-da.de:4222 --description "MKSP NATS SYS Admin" --tlscert /path/to/admin.mksp-da.de.crt --tlskey /path/to/admin.mksp-da.de.key --tlsca /path/to/mksp_root_x1_ca.crt
++nats context add mksp-sysadmin --server nats.mksp-da.de:4222 --description "MKSP NATS SYS Admin" --tlscert /path/to/admin.mksp-da.de.crt --tlskey /path/to/admin.mksp-da.de.key --tlsca /path/to/mksp_root_x1_ca.crt
--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
++nats context add mksp-jsadmin --server nats.mksp-da.de:4222 --description "MKSP NATS JetStream" --tlscert /path/to/js-admin.mksp-da.de.crt --tlskey /path/to/js-admin.mksp-da.de.key --tlsca /path/to/mksp_root_x1_ca.crt
  {{/code}}
  Anschließend wählen wir den richtigen Kontext aus, in diesem Fall den JetStream Admin Context:
@@ -136,6 +136,20 @@
  nats stream add backend_events --subjects "mksp.>" --retention work --max-age 7d --storage file --defaults
  {{/code}}
++=== Task Queue (Taskiq) ===
++
++Die asynchronen Tasks zwischen Backend und Worker laufen über einen eigenen Stream. Dieser wird **nicht** manuell angelegt: Backend, Worker und Scheduler legen ihn beim Start an und passen ihn an, falls die Konfiguration im Code (##src/worker/broker.py##) abweicht. Änderungen daher bitte im Code und nicht über die NATS CLI vornehmen.
++
++|=Eigenschaft|=Wert|=Beschreibung
++|Stream|##MKSP_TASKS##|Work-Queue Stream, Nachrichten werden nach der Bestätigung gelöscht
++|Subject|##tasks.mksp.backend##|Muss außerhalb von ##mksp.>## liegen, da dieser Bereich bereits vom Stream **backend_events** belegt ist
++|Consumer|##mksp_backend_worker##|Dauerhafter Pull Consumer, wird nur vom Worker angelegt. Mehrere Worker-Prozesse teilen sich den Consumer
++|Max Age|7 Tage|Tasks, die bis dahin kein Worker abgeholt hat, verfallen
++|Ack|beim Empfang|Der Worker bestätigt einen Task sofort beim Abholen (##~-~-ack-type when_received##). Ein Task läuft so nie doppelt, bei einem Absturz des Workers während der Ausführung geht er aber verloren. Ack Wait (5 Minuten) ist nur eine Absicherung
++|Message TTL|bis zum nächsten Lauf|Vom Scheduler eingeplante Tasks bekommen einen ##Nats-TTL## Header bis zum nächsten Cron-Zeitpunkt. Ist der Worker länger nicht erreichbar, staut sich so pro Cron-Task höchstens ein Lauf auf
++
++Tasks, die erstellt werden während der Worker nicht läuft, bleiben damit im Stream liegen und werden abgearbeitet, sobald der Worker wieder verfügbar ist. Per-Message TTL setzt NATS Server 2.11 oder neuer voraus.
++
  === 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>>url:https://docs.nats.io/nats-concepts/jetstream/consumers||shape="rect"]]
@@ -150,7 +150,7 @@
  Schema
  )))
  |(((
--{{{mksp.backend.briefing.offer.cancelled}}}
++mksp.backend.briefing.offer.cancelled
  (((
@@ -161,7 +161,7 @@
  (% class="nc" %)##BriefingOfferEvent##
  )))
  |(((
--{{{mksp.backend.briefing.offer.created}}}
++mksp.backend.briefing.offer.created
  (((
@@ -172,7 +172,7 @@
  (% class="nc" %)##BriefingOfferEvent##
  )))
  |(((
--{{{mksp.backend.briefing.offer.updated}}}
++mksp.backend.briefing.offer.updated
  )))|(((
  backend_briefing_offer_updated
  )))|(((
@@ -179,7 +179,7 @@
  (% class="nc" %)##BriefingOfferEvent##
  )))
  |(((
--{{{mksp.backend.briefing.created}}}
++mksp.backend.briefing.created
  (((
@@ -190,7 +190,7 @@
  (% class="n" %)##BriefingEvent##
  )))
  |(((
--{{{mksp.backend.key.assigned}}}
++mksp.backend.key.assigned
  )))|(((
  backend_key_assigned
  )))|(((
@@ -197,7 +197,7 @@
  (% class="nc" %)##KeyEvent##
  )))
  |(((
--{{{mksp.backend.key.unassigned}}}
++mksp.backend.key.unassigned
  )))|(((
  backend_key_unassigned
  )))|(((
@@ -204,7 +204,7 @@
  (% class="nc" %)##KeyEvent##
  )))
  |(((
--{{{mksp.backend.storage.reserved}}}
++mksp.backend.storage.reserved
  )))|(((
  backend_storage_reserved
  )))|(((
@@ -211,8 +211,7 @@
  (% class="nc" %)##StorageSpaceEvent##
  )))
  |(((
--{{{
-- }}}
++mksp.backend.storage.released
  )))|(((
  backend_storage_released
  )))|(((
@@ -219,8 +219,7 @@
  (% class="nc" %)##StorageSpaceEvent##
  )))
  |(((
--{{{
-- }}}
++mksp.backend.storage.expired
  )))|(((
  backend_storage_expired
  )))|(((
@@ -227,8 +227,7 @@
  (% class="nc" %){{code language="none"}}StorageSpaceEvent{{/code}}
  )))
  |(((
--{{{
-- }}}
++mksp.backend.user.converted_to_member
  )))|(((
  backend_user_converted_to_member
  )))|(((
@@ -235,13 +235,45 @@
  (% class="nc" %){{code language="none"}}UserEvent{{/code}}
  )))
  |(((
--{{{
-- }}}
++mksp.backend.user.converted_to_guest
  )))|(((
  backend_user_converted_to_guest
  )))|(((
  (% class="nc" %){{code language="none"}}UserEvent{{/code}}
  )))
++|(((
++mksp.backend.user.created
++)))|backend_user_created|UserEvent
++|(((
++mksp.docuseal.signature.expired
++)))|docuseal_signature_expired|(((
++SignatureEvent
++)))
++|(((
++mksp.docuseal.signature.completed
++)))|docuseal_signature_completed|(((
++SignatureEvent
++)))
++|mksp.backend.key.activate|backend_key_activate|KeyEvent
++|mksp.backend.key.deactivate|backend_key_deactivate|KeyEvent
++|mksp.backend.user.membership_changed|backend_user_membership_changed|MembershipChangedEvent
++|mksp.backend.user.deleted|backend_user_deleted|UserDeletedEvent
++|mksp.backend.department.head_membership_changed|backend_department_head_membership_changed|DepartmentHeadMembershipEvent
++|(((
++mksp.backend.device.event.locked
++)))|backend_device_event_locked|
++|(((
++mksp.backend.device.event.unlocked
++)))|backend_device_event_unlocked|
++|(((
++mksp.backend.device.event.access_granted
++)))|backend_device_event_access_granted|
++|(((
++mksp.backend.device.event.offline
++)))|backend_device_event_offline|
++|(((
++mksp.backend.device.event.access_denied
++)))|backend_device_event_access_denied|
  Die Consumer können dann wie folgt angelegt werden:
@@ -253,15 +253,15 @@
  nats consumer add backend_events backend_key_assigned --pull --filter="mksp.backend.key.assigned" --defaults
  {{/code}}
--= {{id name="NATSSetup-Troubleshooting"/}}Troubleshooting =
++= Troubleshooting =
  Man kann über die NATS CLI mit dem Server interagieren.
--== {{id name="NATSSetup-JetStream"/}}JetStream ==
++== JetStream ==
--=== {{id name="NATSSetup-Streams"/}}Streams ===
++=== 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.
++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. Neben **backend_events** gibt es den Stream **MKSP_TASKS** der Task Queue; liegen dort dauerhaft Nachrichten, läuft der Worker nicht oder holt keine Tasks ab (prüfen mit ##nats consumer info MKSP_TASKS mksp_backend_worker##).
  {{code language="shell"}}
  $ nats context select mksp-jsadmin
@@ -285,7 +285,7 @@
  {"timestamp":"2025-09-08T09:06:00.062358","stora
  {{/code}}
--=== {{id name="NATSSetup-Consumer"/}}Consumer ===
++=== Consumer ===
  Die bestehenden Consumer kann man sich ebenfalls im Jetstream Context anzeigen lassen:
@@ -340,7 +340,7 @@
  * **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.
--== {{id name="NATSSetup-Server"/}}Server ==
++== Server ==
  Man kann sich ebenfalls die aktiven Verbindungen anzeigen:
@@ -372,8 +372,10 @@
  ╰──────────────┴─────────┴─────────────╯
  {{/code}}
--Der Name ist hierbei frei vergeben, in unserem Fall im Backend Code. Wir erwarten die folgenden Clients:
++Die Ausgabe oben stammt aus der Zeit vor der Umstellung der Task Queue auf JetStream, die Verbindung **backend_fastapi** gibt es inzwischen nicht mehr.
++Der Name ist hierbei frei vergeben, in unserem Fall im Backend Code (abhängig von der Rolle des Prozesses). Jeder Prozess hält genau eine Verbindung, über die sowohl Tasks als auch Events laufen. Wir erwarten die folgenden Clients:
++
  |=(((
  Client
  )))|=(((
@@ -390,11 +390,11 @@
  )))|(((
  )))|(((
--Taskiq
++FastAPI / Taskiq
  )))|(((
--Core
++JetStream
  )))|(((
--Gibt dem Backend die Möglichkeit, asynchrone Tasks an das Taskiq backend zu delegieren
++Delegiert asynchrone Tasks an den Worker und gibt Events aus, die dann von N8n abgearbeitet werden
  )))
  |(((
  backend_scheduler
@@ -403,31 +403,20 @@
  )))|(((
  Taskiq
  )))|(((
--Core
++JetStream
  )))|(((
  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
++2 (ein Client pro Worker-Prozess, ##NUM_WORKERS##)
  )))|(((
  Taskiq
  )))|(((
--Core
++JetStream
  )))|(((
--Worker für asynchrone Tasks
++Worker für asynchrone Tasks, gibt ebenfalls Events aus
  )))
  Man kann sich ebenfalls die Subscriptions der jeweiligen Connections anschauen. Hierfür muss die Ausgabe auf JSON umgestellt werden:
@@ -490,4 +490,6 @@
   ]
  {{/code}}
++Auch diese Ausgabe stammt aus der Zeit vor der JetStream-Umstellung: Die Subscription auf ##taskiq_tasks## gibt es nicht mehr, der Worker holt Tasks über den Pull Consumer ##mksp_backend_worker## ab.
++