Zum Inhalt springen

Änderungen von Dokument NATS - Technisches Setup

Zuletzt geändert von Daniel Herrmann am 2026/10/13 10:36
Von Version Icon 9.2 Icon
bearbeitet von Daniel Herrmann
am 2025/09/20 09:59
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version Icon 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

Zusammenfassung

Details

Icon Seiteneigenschaften
Titel
... ... @@ -1,1 +1,1 @@
1 -NATS Setup
1 +NATS - Technisches Setup
Übergeordnete Seite
... ... @@ -1,0 +1,1 @@
1 +PROJ.Digitale Mitgliederverwaltung.Technische Dokumentation.WebHome
Inhalt
... ... @@ -44,7 +44,7 @@
44 44  
45 45  == Authentifizierung ==
46 46  
47 -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.
47 +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.
48 48  
49 49  {{code language="shell"}}
50 50  $ openssl x509 -noout -text -nameopt RFC2253 -in backend.mksp-da.de.crt
... ... @@ -83,9 +83,9 @@
83 83  
84 84  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.
85 85  
86 -== NATS Core mit Accounts ==
86 +== Berechtigungen des Backend Users ==
87 87  
88 -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:
88 +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:
89 89  
90 90  {{code}}
91 91  accounts: {
... ... @@ -101,7 +101,7 @@
101 101  ...
102 102  {{/code}}
103 103  
104 -Wichtig sind hier die zusätzlichen Permissions, die den Zugriff auf Core Events regeln.
104 +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.
105 105  
106 106  == JetStream Konfiguration ==
107 107  
... ... @@ -112,9 +112,9 @@
112 112  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:
113 113  
114 114  {{code language="shell"}}
115 -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
115 +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
116 116  
117 -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
117 +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
118 118  {{/code}}
119 119  
120 120  Anschließend wählen wir den richtigen Kontext aus, in diesem Fall den JetStream Admin Context:
... ... @@ -136,6 +136,20 @@
136 136  nats stream add backend_events --subjects "mksp.>" --retention work --max-age 7d --storage file --defaults
137 137  {{/code}}
138 138  
139 +=== Task Queue (Taskiq) ===
140 +
141 +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.
142 +
143 +|=Eigenschaft|=Wert|=Beschreibung
144 +|Stream|##MKSP_TASKS##|Work-Queue Stream, Nachrichten werden nach der Bestätigung gelöscht
145 +|Subject|##tasks.mksp.backend##|Muss außerhalb von ##mksp.>## liegen, da dieser Bereich bereits vom Stream **backend_events** belegt ist
146 +|Consumer|##mksp_backend_worker##|Dauerhafter Pull Consumer, wird nur vom Worker angelegt. Mehrere Worker-Prozesse teilen sich den Consumer
147 +|Max Age|7 Tage|Tasks, die bis dahin kein Worker abgeholt hat, verfallen
148 +|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
149 +|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
150 +
151 +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.
152 +
139 139  === JetStream Consumer ===
140 140  
141 141  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,9 +150,11 @@
150 150  Schema
151 151  )))
152 152  |(((
153 -{{code language="none"}}
154 154  mksp.backend.briefing.offer.cancelled
155 -{{/code}}
168 +
169 +(((
170 +
171 +)))
156 156  )))|(((
157 157  backend_briefing_offer_cancelled
158 158  )))|(((
... ... @@ -159,9 +159,11 @@
159 159  (% class="nc" %)##BriefingOfferEvent##
160 160  )))
161 161  |(((
162 -{{code language="none"}}
163 163  mksp.backend.briefing.offer.created
164 -{{/code}}
179 +
180 +(((
181 +
182 +)))
165 165  )))|(((
166 166  backend_briefing_offer_created
167 167  )))|(((
... ... @@ -168,7 +168,7 @@
168 168  (% class="nc" %)##BriefingOfferEvent##
169 169  )))
170 170  |(((
171 -(% class="s" %)##mksp.backend.briefing.offer.updated##
189 +mksp.backend.briefing.offer.updated
172 172  )))|(((
173 173  backend_briefing_offer_updated
174 174  )))|(((
... ... @@ -175,9 +175,11 @@
175 175  (% class="nc" %)##BriefingOfferEvent##
176 176  )))
177 177  |(((
178 -{{code language="none"}}
179 179  mksp.backend.briefing.created
180 -{{/code}}
197 +
198 +(((
199 +
200 +)))
181 181  )))|(((
182 182  backend_briefing_created
183 183  )))|(((
... ... @@ -184,7 +184,7 @@
184 184  (% class="n" %)##BriefingEvent##
185 185  )))
186 186  |(((
187 -(% class="s" %)##mksp.backend.key.assigned##
207 +mksp.backend.key.assigned
188 188  )))|(((
189 189  backend_key_assigned
190 190  )))|(((
... ... @@ -191,7 +191,7 @@
191 191  (% class="nc" %)##KeyEvent##
192 192  )))
193 193  |(((
194 -(% class="s" %)##mksp.backend.key.unassigned##
214 +mksp.backend.key.unassigned
195 195  )))|(((
196 196  backend_key_unassigned
197 197  )))|(((
... ... @@ -198,7 +198,7 @@
198 198  (% class="nc" %)##KeyEvent##
199 199  )))
200 200  |(((
201 -(% class="s" %)##mksp.backend.storage.reserved##
221 +mksp.backend.storage.reserved
202 202  )))|(((
203 203  backend_storage_reserved
204 204  )))|(((
... ... @@ -205,7 +205,7 @@
205 205  (% class="nc" %)##StorageSpaceEvent##
206 206  )))
207 207  |(((
208 -(% class="s" %){{code language="none"}}mksp.backend.storage.released{{/code}}
228 +mksp.backend.storage.released
209 209  )))|(((
210 210  backend_storage_released
211 211  )))|(((
... ... @@ -212,7 +212,7 @@
212 212  (% class="nc" %)##StorageSpaceEvent##
213 213  )))
214 214  |(((
215 -(% class="s" %){{code language="none"}}mksp.backend.storage.expired{{/code}}
235 +mksp.backend.storage.expired
216 216  )))|(((
217 217  backend_storage_expired
218 218  )))|(((
... ... @@ -219,7 +219,7 @@
219 219  (% class="nc" %){{code language="none"}}StorageSpaceEvent{{/code}}
220 220  )))
221 221  |(((
222 -(% class="s" %){{code language="none"}}mksp.backend.user.converted_to_member{{/code}}
242 +mksp.backend.user.converted_to_member
223 223  )))|(((
224 224  backend_user_converted_to_member
225 225  )))|(((
... ... @@ -226,12 +226,45 @@
226 226  (% class="nc" %){{code language="none"}}UserEvent{{/code}}
227 227  )))
228 228  |(((
229 -(% class="s" %){{code language="none"}}mksp.backend.user.converted_to_guest{{/code}}
249 +mksp.backend.user.converted_to_guest
230 230  )))|(((
231 231  backend_user_converted_to_guest
232 232  )))|(((
233 233  (% class="nc" %){{code language="none"}}UserEvent{{/code}}
234 234  )))
255 +|(((
256 +mksp.backend.user.created
257 +)))|backend_user_created|UserEvent
258 +|(((
259 +mksp.docuseal.signature.expired
260 +)))|docuseal_signature_expired|(((
261 +SignatureEvent
262 +)))
263 +|(((
264 +mksp.docuseal.signature.completed
265 +)))|docuseal_signature_completed|(((
266 +SignatureEvent
267 +)))
268 +|mksp.backend.key.activate|backend_key_activate|KeyEvent
269 +|mksp.backend.key.deactivate|backend_key_deactivate|KeyEvent
270 +|mksp.backend.user.membership_changed|backend_user_membership_changed|MembershipChangedEvent
271 +|mksp.backend.user.deleted|backend_user_deleted|UserDeletedEvent
272 +|mksp.backend.department.head_membership_changed|backend_department_head_membership_changed|DepartmentHeadMembershipEvent
273 +|(((
274 +mksp.backend.device.event.locked
275 +)))|backend_device_event_locked|
276 +|(((
277 +mksp.backend.device.event.unlocked
278 +)))|backend_device_event_unlocked|
279 +|(((
280 +mksp.backend.device.event.access_granted
281 +)))|backend_device_event_access_granted|
282 +|(((
283 +mksp.backend.device.event.offline
284 +)))|backend_device_event_offline|
285 +|(((
286 +mksp.backend.device.event.access_denied
287 +)))|backend_device_event_access_denied|
235 235  
236 236  Die Consumer können dann wie folgt angelegt werden:
237 237  
... ... @@ -243,15 +243,15 @@
243 243  nats consumer add backend_events backend_key_assigned --pull --filter="mksp.backend.key.assigned" --defaults
244 244  {{/code}}
245 245  
246 -= {{id name="NATSSetup-Troubleshooting"/}}Troubleshooting =
299 += Troubleshooting =
247 247  
248 248  Man kann über die NATS CLI mit dem Server interagieren.
249 249  
250 -== {{id name="NATSSetup-JetStream"/}}JetStream ==
303 +== JetStream ==
251 251  
252 -=== {{id name="NATSSetup-Streams"/}}Streams ===
305 +=== Streams ===
253 253  
254 -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.
307 +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##).
255 255  
256 256  {{code language="shell"}}
257 257  $ nats context select mksp-jsadmin
... ... @@ -275,11 +275,11 @@
275 275  {"timestamp":"2025-09-08T09:06:00.062358","stora
276 276  {{/code}}
277 277  
278 -=== {{id name="NATSSetup-Consumer"/}}Consumer ===
331 +=== Consumer ===
279 279  
280 280  Die bestehenden Consumer kann man sich ebenfalls im Jetstream Context anzeigen lassen:
281 281  
282 -{{code language="json"}}
335 +{{code}}
283 283  $ nats consumer ls backend_events                       
284 284  ╭──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
285 285  │ Consumers │
... ... @@ -296,7 +296,7 @@
296 296  
297 297  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:
298 298  
299 -{{code language="json"}}
352 +{{code}}
300 300  $ nats consumer info backend_events backend_briefing_offer_cancelled
301 301  
302 302  Information for Consumer backend_events > backend_briefing_offer_cancelled created 2025-09-09 22:53:26
... ... @@ -330,7 +330,7 @@
330 330  * **Unprocessed Messages** sind Nachrichten, die noch nicht abgerufen wurden. Dies sollte immer 0 sein
331 331  * **Waiting Pulls**: die Anzahl der verbundenen Clients. Üblicherweise sollte das nur n8n sein, also immer 1.
332 332  
333 -== {{id name="NATSSetup-Server"/}}Server ==
386 +== Server ==
334 334  
335 335  Man kann sich ebenfalls die aktiven Verbindungen anzeigen:
336 336  
... ... @@ -362,17 +362,19 @@
362 362  ╰──────────────┴─────────┴─────────────╯
363 363  {{/code}}
364 364  
365 -Der Name ist hierbei frei vergeben, in unserem Fall im Backend Code. Wir erwarten die folgenden Clients:
418 +Die Ausgabe oben stammt aus der Zeit vor der Umstellung der Task Queue auf JetStream, die Verbindung **backend_fastapi** gibt es inzwischen nicht mehr.
366 366  
367 -|=(% scope="col" %)(((
420 +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:
421 +
422 +|=(((
368 368  Client
369 -)))|=(% scope="col" %)(((
424 +)))|=(((
370 370  Anzahl
371 -)))|=(% scope="col" %)(((
426 +)))|=(((
372 372  Komponente
373 -)))|=(% scope="col" %)(((
428 +)))|=(((
374 374  Art
375 -)))|=(% scope="col" %)(((
430 +)))|=(((
376 376  Beschreibung
377 377  )))
378 378  |(((
... ... @@ -380,11 +380,11 @@
380 380  )))|(((
381 381  1
382 382  )))|(((
383 -Taskiq
438 +FastAPI / Taskiq
384 384  )))|(((
385 -Core
440 +JetStream
386 386  )))|(((
387 -Gibt dem Backend die Möglichkeit, asynchrone Tasks an das Taskiq backend zu delegieren
442 +Delegiert asynchrone Tasks an den Worker und gibt Events aus, die dann von N8n abgearbeitet werden
388 388  )))
389 389  |(((
390 390  backend_scheduler
... ... @@ -393,31 +393,20 @@
393 393  )))|(((
394 394  Taskiq
395 395  )))|(((
396 -Core
451 +JetStream
397 397  )))|(((
398 398  Komponente welches die regelmäßigen Jobs überwacht und triggert
399 399  )))
400 400  |(((
401 -backend_fastapi
402 -)))|(((
403 -1
404 -)))|(((
405 -FastAPI
406 -)))|(((
407 -JetStream
408 -)))|(((
409 -Das Backend kann hiermit Events ausgeben, die dann von N8n abgearbeitet werden.
410 -)))
411 -|(((
412 412  backend_worker
413 413  )))|(((
414 -2
458 +2 (ein Client pro Worker-Prozess, ##NUM_WORKERS##)
415 415  )))|(((
416 416  Taskiq
417 417  )))|(((
418 -Core
462 +JetStream
419 419  )))|(((
420 -Worker für asynchrone Tasks
464 +Worker für asynchrone Tasks, gibt ebenfalls Events aus
421 421  )))
422 422  
423 423  Man kann sich ebenfalls die Subscriptions der jeweiligen Connections anschauen. Hierfür muss die Ausgabe auf JSON umgestellt werden:
... ... @@ -480,4 +480,6 @@
480 480   ]
481 481  {{/code}}
482 482  
483 -\\
527 +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.
528 +
529 +