Änderungen von Dokument NATS - Technisches Setup

Zusammenfassung

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

Details

Seiteneigenschaften

Ü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,7 +150,7 @@
150	150	Schema
151	151	)))
152	152	|(((
153		-{{{mksp.backend.briefing.offer.cancelled}}}
	167	+mksp.backend.briefing.offer.cancelled
154	154
155	155	(((
156	156
...	...	@@ -161,7 +161,7 @@
161	161	(% class="nc" %)##BriefingOfferEvent##
162	162	)))
163	163	|(((
164		-{{{mksp.backend.briefing.offer.created}}}
	178	+mksp.backend.briefing.offer.created
165	165
166	166	(((
167	167
...	...	@@ -172,7 +172,7 @@
172	172	(% class="nc" %)##BriefingOfferEvent##
173	173	)))
174	174	|(((
175		-{{{mksp.backend.briefing.offer.updated}}}
	189	+mksp.backend.briefing.offer.updated
176	176	)))|(((
177	177	backend_briefing_offer_updated
178	178	)))|(((
...	...	@@ -179,7 +179,7 @@
179	179	(% class="nc" %)##BriefingOfferEvent##
180	180	)))
181	181	|(((
182		-{{{mksp.backend.briefing.created}}}
	196	+mksp.backend.briefing.created
183	183
184	184	(((
185	185
...	...	@@ -190,7 +190,7 @@
190	190	(% class="n" %)##BriefingEvent##
191	191	)))
192	192	|(((
193		-{{{mksp.backend.key.assigned}}}
	207	+mksp.backend.key.assigned
194	194	)))|(((
195	195	backend_key_assigned
196	196	)))|(((
...	...	@@ -197,7 +197,7 @@
197	197	(% class="nc" %)##KeyEvent##
198	198	)))
199	199	|(((
200		-{{{mksp.backend.key.unassigned}}}
	214	+mksp.backend.key.unassigned
201	201	)))|(((
202	202	backend_key_unassigned
203	203	)))|(((
...	...	@@ -204,7 +204,7 @@
204	204	(% class="nc" %)##KeyEvent##
205	205	)))
206	206	|(((
207		-{{{mksp.backend.storage.reserved}}}
	221	+mksp.backend.storage.reserved
208	208	)))|(((
209	209	backend_storage_reserved
210	210	)))|(((
...	...	@@ -239,16 +239,38 @@
239	239	(% class="nc" %){{code language="none"}}UserEvent{{/code}}
240	240	)))
241	241	|(((
242		-mksp.docuseal.document.signed
243		-)))|docuseal_document_signed|(((
	256	+mksp.backend.user.created
	257	+)))|backend_user_created|UserEvent
	258	+|(((
	259	+mksp.docuseal.signature.expired
	260	+)))|docuseal_signature_expired|(((
244	244	SignatureEvent
245	245	)))
246	246	|(((
247		-mksp.docuseal.signature.expired
248		-)))| |
249		-|(((
250	250	mksp.docuseal.signature.completed
251		-)))| |
	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|
252	252
253	253	Die Consumer können dann wie folgt angelegt werden:
254	254
...	...	@@ -260,15 +260,15 @@
260	260	nats consumer add backend_events backend_key_assigned --pull --filter="mksp.backend.key.assigned" --defaults
261	261	{{/code}}
262	262
263		-= {{id name="NATSSetup-Troubleshooting"/}}Troubleshooting =
	299	+= Troubleshooting =
264	264
265	265	Man kann über die NATS CLI mit dem Server interagieren.
266	266
267		-== {{id name="NATSSetup-JetStream"/}}JetStream ==
	303	+== JetStream ==
268	268
269		-=== {{id name="NATSSetup-Streams"/}}Streams ===
	305	+=== Streams ===
270	270
271		-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##).
272	272
273	273	{{code language="shell"}}
274	274	$ nats context select mksp-jsadmin
...	...	@@ -292,7 +292,7 @@
292	292	{"timestamp":"2025-09-08T09:06:00.062358","stora
293	293	{{/code}}
294	294
295		-=== {{id name="NATSSetup-Consumer"/}}Consumer ===
	331	+=== Consumer ===
296	296
297	297	Die bestehenden Consumer kann man sich ebenfalls im Jetstream Context anzeigen lassen:
298	298
...	...	@@ -347,7 +347,7 @@
347	347	* **Unprocessed Messages** sind Nachrichten, die noch nicht abgerufen wurden. Dies sollte immer 0 sein
348	348	* **Waiting Pulls**: die Anzahl der verbundenen Clients. Üblicherweise sollte das nur n8n sein, also immer 1.
349	349
350		-== {{id name="NATSSetup-Server"/}}Server ==
	386	+== Server ==
351	351
352	352	Man kann sich ebenfalls die aktiven Verbindungen anzeigen:
353	353
...	...	@@ -379,8 +379,10 @@
379	379	╰──────────────┴─────────┴─────────────╯
380	380	{{/code}}
381	381
382		-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.
383	383
	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	+
384	384	|=(((
385	385	Client
386	386	)))|=(((
...	...	@@ -397,11 +397,11 @@
397	397	)))|(((
398	398	1
399	399	)))|(((
400		-Taskiq
	438	+FastAPI / Taskiq
401	401	)))|(((
402		-Core
	440	+JetStream
403	403	)))|(((
404		-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
405	405	)))
406	406	|(((
407	407	backend_scheduler
...	...	@@ -410,31 +410,20 @@
410	410	)))|(((
411	411	Taskiq
412	412	)))|(((
413		-Core
	451	+JetStream
414	414	)))|(((
415	415	Komponente welches die regelmäßigen Jobs überwacht und triggert
416	416	)))
417	417	|(((
418		-backend_fastapi
419		-)))|(((
420		-1
421		-)))|(((
422		-FastAPI
423		-)))|(((
424		-JetStream
425		-)))|(((
426		-Das Backend kann hiermit Events ausgeben, die dann von N8n abgearbeitet werden.
427		-)))
428		-|(((
429	429	backend_worker
430	430	)))|(((
431		-2
	458	+2 (ein Client pro Worker-Prozess, ##NUM_WORKERS##)
432	432	)))|(((
433	433	Taskiq
434	434	)))|(((
435		-Core
	462	+JetStream
436	436	)))|(((
437		-Worker für asynchrone Tasks
	464	+Worker für asynchrone Tasks, gibt ebenfalls Events aus
438	438	)))
439	439
440	440	Man kann sich ebenfalls die Subscriptions der jeweiligen Connections anschauen. Hierfür muss die Ausgabe auf JSON umgestellt werden:
...	...	@@ -497,4 +497,6 @@
497	497	]
498	498	{{/code}}
499	499
	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	+
500	500