Zum Inhalt springen

Änderungen von Dokument NATS - Technisches Setup

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

Zusammenfassung

Details

Icon Seiteneigenschaften
Titel
... ... @@ -1,1 +1,1 @@
1 -NATS - Technisches Setup
1 +NATS Setup
Übergeordnete Seite
... ... @@ -1,1 +1,0 @@
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.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.
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.
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 -== Berechtigungen des Backend Users ==
86 +== NATS Core mit Accounts ==
87 87  
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:
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:
89 89  
90 90  {{code}}
91 91  accounts: {
... ... @@ -101,7 +101,7 @@
101 101  ...
102 102  {{/code}}
103 103  
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.
104 +Wichtig sind hier die zusätzlichen Permissions, die den Zugriff auf Core Events regeln.
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 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
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
116 116  
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
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
118 118  {{/code}}
119 119  
120 120  Anschließend wählen wir den richtigen Kontext aus, in diesem Fall den JetStream Admin Context:
... ... @@ -136,20 +136,6 @@
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 -
153 153  === JetStream Consumer ===
154 154  
155 155  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"]]
... ... @@ -164,11 +164,9 @@
164 164  Schema
165 165  )))
166 166  |(((
153 +{{code language="none"}}
167 167  mksp.backend.briefing.offer.cancelled
168 -
169 -(((
170 -
171 -)))
155 +{{/code}}
172 172  )))|(((
173 173  backend_briefing_offer_cancelled
174 174  )))|(((
... ... @@ -175,11 +175,9 @@
175 175  (% class="nc" %)##BriefingOfferEvent##
176 176  )))
177 177  |(((
162 +{{code language="none"}}
178 178  mksp.backend.briefing.offer.created
179 -
180 -(((
181 -
182 -)))
164 +{{/code}}
183 183  )))|(((
184 184  backend_briefing_offer_created
185 185  )))|(((
... ... @@ -186,7 +186,7 @@
186 186  (% class="nc" %)##BriefingOfferEvent##
187 187  )))
188 188  |(((
189 -mksp.backend.briefing.offer.updated
171 +(% class="s" %)##mksp.backend.briefing.offer.updated##
190 190  )))|(((
191 191  backend_briefing_offer_updated
192 192  )))|(((
... ... @@ -193,11 +193,9 @@
193 193  (% class="nc" %)##BriefingOfferEvent##
194 194  )))
195 195  |(((
178 +{{code language="none"}}
196 196  mksp.backend.briefing.created
197 -
198 -(((
199 -
200 -)))
180 +{{/code}}
201 201  )))|(((
202 202  backend_briefing_created
203 203  )))|(((
... ... @@ -204,7 +204,7 @@
204 204  (% class="n" %)##BriefingEvent##
205 205  )))
206 206  |(((
207 -mksp.backend.key.assigned
187 +(% class="s" %)##mksp.backend.key.assigned##
208 208  )))|(((
209 209  backend_key_assigned
210 210  )))|(((
... ... @@ -211,7 +211,7 @@
211 211  (% class="nc" %)##KeyEvent##
212 212  )))
213 213  |(((
214 -mksp.backend.key.unassigned
194 +(% class="s" %)##mksp.backend.key.unassigned##
215 215  )))|(((
216 216  backend_key_unassigned
217 217  )))|(((
... ... @@ -218,7 +218,7 @@
218 218  (% class="nc" %)##KeyEvent##
219 219  )))
220 220  |(((
221 -mksp.backend.storage.reserved
201 +(% class="s" %)##mksp.backend.storage.reserved##
222 222  )))|(((
223 223  backend_storage_reserved
224 224  )))|(((
... ... @@ -225,7 +225,7 @@
225 225  (% class="nc" %)##StorageSpaceEvent##
226 226  )))
227 227  |(((
228 -mksp.backend.storage.released
208 +(% class="s" %){{code language="none"}}mksp.backend.storage.released{{/code}}
229 229  )))|(((
230 230  backend_storage_released
231 231  )))|(((
... ... @@ -232,7 +232,7 @@
232 232  (% class="nc" %)##StorageSpaceEvent##
233 233  )))
234 234  |(((
235 -mksp.backend.storage.expired
215 +(% class="s" %){{code language="none"}}mksp.backend.storage.expired{{/code}}
236 236  )))|(((
237 237  backend_storage_expired
238 238  )))|(((
... ... @@ -239,7 +239,7 @@
239 239  (% class="nc" %){{code language="none"}}StorageSpaceEvent{{/code}}
240 240  )))
241 241  |(((
242 -mksp.backend.user.converted_to_member
222 +(% class="s" %){{code language="none"}}mksp.backend.user.converted_to_member{{/code}}
243 243  )))|(((
244 244  backend_user_converted_to_member
245 245  )))|(((
... ... @@ -246,45 +246,12 @@
246 246  (% class="nc" %){{code language="none"}}UserEvent{{/code}}
247 247  )))
248 248  |(((
249 -mksp.backend.user.converted_to_guest
229 +(% class="s" %){{code language="none"}}mksp.backend.user.converted_to_guest{{/code}}
250 250  )))|(((
251 251  backend_user_converted_to_guest
252 252  )))|(((
253 253  (% class="nc" %){{code language="none"}}UserEvent{{/code}}
254 254  )))
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|
288 288  
289 289  Die Consumer können dann wie folgt angelegt werden:
290 290  
... ... @@ -296,15 +296,15 @@
296 296  nats consumer add backend_events backend_key_assigned --pull --filter="mksp.backend.key.assigned" --defaults
297 297  {{/code}}
298 298  
299 -= Troubleshooting =
246 += {{id name="NATSSetup-Troubleshooting"/}}Troubleshooting =
300 300  
301 301  Man kann über die NATS CLI mit dem Server interagieren.
302 302  
303 -== JetStream ==
250 +== {{id name="NATSSetup-JetStream"/}}JetStream ==
304 304  
305 -=== Streams ===
252 +=== {{id name="NATSSetup-Streams"/}}Streams ===
306 306  
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##).
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.
308 308  
309 309  {{code language="shell"}}
310 310  $ nats context select mksp-jsadmin
... ... @@ -328,11 +328,11 @@
328 328  {"timestamp":"2025-09-08T09:06:00.062358","stora
329 329  {{/code}}
330 330  
331 -=== Consumer ===
278 +=== {{id name="NATSSetup-Consumer"/}}Consumer ===
332 332  
333 333  Die bestehenden Consumer kann man sich ebenfalls im Jetstream Context anzeigen lassen:
334 334  
335 -{{code}}
282 +{{code language="json"}}
336 336  $ nats consumer ls backend_events                       
337 337  ╭──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
338 338  │ Consumers │
... ... @@ -349,7 +349,7 @@
349 349  
350 350  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:
351 351  
352 -{{code}}
299 +{{code language="json"}}
353 353  $ nats consumer info backend_events backend_briefing_offer_cancelled
354 354  
355 355  Information for Consumer backend_events > backend_briefing_offer_cancelled created 2025-09-09 22:53:26
... ... @@ -383,7 +383,7 @@
383 383  * **Unprocessed Messages** sind Nachrichten, die noch nicht abgerufen wurden. Dies sollte immer 0 sein
384 384  * **Waiting Pulls**: die Anzahl der verbundenen Clients. Üblicherweise sollte das nur n8n sein, also immer 1.
385 385  
386 -== Server ==
333 +== {{id name="NATSSetup-Server"/}}Server ==
387 387  
388 388  Man kann sich ebenfalls die aktiven Verbindungen anzeigen:
389 389  
... ... @@ -415,19 +415,17 @@
415 415  ╰──────────────┴─────────┴─────────────╯
416 416  {{/code}}
417 417  
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.
365 +Der Name ist hierbei frei vergeben, in unserem Fall im Backend Code. Wir erwarten die folgenden Clients:
419 419  
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 -|=(((
367 +|=(% scope="col" %)(((
423 423  Client
424 -)))|=(((
369 +)))|=(% scope="col" %)(((
425 425  Anzahl
426 -)))|=(((
371 +)))|=(% scope="col" %)(((
427 427  Komponente
428 -)))|=(((
373 +)))|=(% scope="col" %)(((
429 429  Art
430 -)))|=(((
375 +)))|=(% scope="col" %)(((
431 431  Beschreibung
432 432  )))
433 433  |(((
... ... @@ -435,11 +435,11 @@
435 435  )))|(((
436 436  1
437 437  )))|(((
438 -FastAPI / Taskiq
383 +Taskiq
439 439  )))|(((
440 -JetStream
385 +Core
441 441  )))|(((
442 -Delegiert asynchrone Tasks an den Worker und gibt Events aus, die dann von N8n abgearbeitet werden
387 +Gibt dem Backend die Möglichkeit, asynchrone Tasks an das Taskiq backend zu delegieren
443 443  )))
444 444  |(((
445 445  backend_scheduler
... ... @@ -448,20 +448,31 @@
448 448  )))|(((
449 449  Taskiq
450 450  )))|(((
451 -JetStream
396 +Core
452 452  )))|(((
453 453  Komponente welches die regelmäßigen Jobs überwacht und triggert
454 454  )))
455 455  |(((
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 +|(((
456 456  backend_worker
457 457  )))|(((
458 -2 (ein Client pro Worker-Prozess, ##NUM_WORKERS##)
414 +2
459 459  )))|(((
460 460  Taskiq
461 461  )))|(((
462 -JetStream
418 +Core
463 463  )))|(((
464 -Worker für asynchrone Tasks, gibt ebenfalls Events aus
420 +Worker für asynchrone Tasks
465 465  )))
466 466  
467 467  Man kann sich ebenfalls die Subscriptions der jeweiligen Connections anschauen. Hierfür muss die Ausgabe auf JSON umgestellt werden:
... ... @@ -524,6 +524,4 @@
524 524   ]
525 525  {{/code}}
526 526  
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 -
483 +\\