Änderungen von Dokument NATS - Technisches Setup

Zusammenfassung

• Seiteneigenschaften (3 geändert, 0 hinzugefügt, 0 gelöscht)
• Objekte (1 geändert, 0 hinzugefügt, 0 gelöscht)
  • Confluence.Code.ConfluencePageClass[0]

Details

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

...	...	@@ -2,128 +2,35 @@
2	2
3	3	Unser Backend (oder auch andere Systeme) publizieren Events in NATS, die dann beispielsweise in N8n über ein Trigger konsumiert werden.
4	4
5		-= Grundlagen =
	5	+= {{id name="NATSSetup-GrundlegenderAufbau"/}}Grundlegender Aufbau =
6	6
7		-== Übersicht ==
8		-
9	9	NATS kann grob in zwei Varianten unterteilt werden, **NATS Core** und **NATS JetStream**.
10	10
	9	+(% style="" data-start="0" data-end="347" %)
11	11	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.
12	12
13		-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.
	12	+(% style="" data-start="349" data-end="822" data-is-last-node="" data-is-only-node="" %)
	13	+NATS JetStream erweitert NATS Core um Funktionen wie (% data-start="402" data-end="483" %)**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.
14	14
15		-== Accounts ==
	15	+== {{id name="NATSSetup-JetStreamkonfiguration"/}}JetStream konfiguration ==
16	16
17		-(% style="color:var(--ds-text,#333333); text-decoration:none" %)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.
18		-
19		-(% style="color:var(--ds-text,#333333); text-decoration:none" %)Wir verwenden zwei verschiedene Accounts:
20		-
21		-|=(((
22		-Account
23		-)))|=(((
24		-Berechtigungen
25		-)))|=(((
26		-Beschreibung
27		-)))
28		-|(((
29		-SYS
30		-)))|(((
31		-SYSTEM Account
32		-)))|(((
33		-Wird für administrative Tätigkeiten wie beispielsweise Troubleshooting oder das Auslesen von Informationen verwendet
34		-)))
35		-|(((
36		-MKSP
37		-)))|(((
38		-Regulärer Account
39		-)))|(((
40		-Regulärer Account für Daten
41		-)))
42		-
43		-Benutzer können jeweils nur einem Account zugeordnet werden.
44		-
45		-== Authentifizierung ==
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.
48		-
49		-{{code language="shell"}}
50		-$ openssl x509 -noout -text -nameopt RFC2253 -in backend.mksp-da.de.crt
51		-Certificate:
52		- Data:
53		- ...
54		- Subject: CN=backend.mksp-da.de,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE
55		-{{/code}}
56		-
57		-Diese Subject wird dann dem Account zugeordnet:
58		-
59		-{{code}}
60		-system_account: SYS
61		-accounts: {
62		- MKSP: {
63		- jetstream: enabled
64		- users: [
65		- {
66		- user: "CN=backend.mksp-da.de,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE"
67		- },
68		- {
69		- user: "CN=n8n.mksp-da.de,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE"
70		- },
71		- {
72		- user: "CN=js-admin.mksp-da.de,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE"
73		- },
74		- ]
75		- }
76		- SYS: {
77		- users: [
78		- {user: "CN=admin.mksp-da.de,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE"}
79		- ]
80		- }
81		-}
82		-{{/code}}
83		-
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		-
86		-== Berechtigungen des Backend Users ==
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:
89		-
90		-{{code}}
91		-accounts: {
92		- MKSP: {
93		- users: [
94		- {
95		- user: "CN=backend.mksp-da.de,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE"
96		- permissions: {
97		- publish: [">"]
98		- subscribe: [">"]
99		- }
100		- },
101		-...
102		-{{/code}}
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.
105		-
106		-== JetStream Konfiguration ==
107		-
108	108	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.
109	109
110		-=== NATS CLI konfigurieren ===
	19	+=== {{id name="NATSSetup-NATSCLIkonfigurieren"/}}NATS CLI konfigurieren ===
111	111
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:
	21	+* Unterschied zwischen admin und jsadmin
	22	+* beschreiben wie man context switch macht
	23	+* wie man einen neuen context anlegt
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
	26	+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
118		-{{/code}}
	28	+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
119	119
120		-Anschließend wählen wir den richtigen Kontext aus, in diesem Fall den JetStream Admin Context:
121		-
122		-{{code language="shell"}}
123	123	nats context select mksp-jsadmin
124	124	{{/code}}
125	125
126		-=== JetStream initialisieren ===
	33	+=== {{id name="NATSSetup-JetStreaminitialisieren"/}}JetStream initialisieren ===
127	127
128	128	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:
129	129
...	...	@@ -136,394 +136,8 @@
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) ===
	46	+=== {{id name="NATSSetup-JetStreamConsumer"/}}JetStream Consumer ===
140	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		-=== JetStream Consumer ===
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"]]
156	156
157		-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.
158		-
159		-|=(((
160		-Backend Event
161		-)))|=(((
162		-Consumer Name
163		-)))|=(((
164		-Schema
165		-)))
166		-|(((
167		-mksp.backend.briefing.offer.cancelled
168		-
169		-(((
170		-
171		-)))
172		-)))|(((
173		-backend_briefing_offer_cancelled
174		-)))|(((
175		-(% class="nc" %)##BriefingOfferEvent##
176		-)))
177		-|(((
178		-mksp.backend.briefing.offer.created
179		-
180		-(((
181		-
182		-)))
183		-)))|(((
184		-backend_briefing_offer_created
185		-)))|(((
186		-(% class="nc" %)##BriefingOfferEvent##
187		-)))
188		-|(((
189		-mksp.backend.briefing.offer.updated
190		-)))|(((
191		-backend_briefing_offer_updated
192		-)))|(((
193		-(% class="nc" %)##BriefingOfferEvent##
194		-)))
195		-|(((
196		-mksp.backend.briefing.created
197		-
198		-(((
199		-
200		-)))
201		-)))|(((
202		-backend_briefing_created
203		-)))|(((
204		-(% class="n" %)##BriefingEvent##
205		-)))
206		-|(((
207		-mksp.backend.key.assigned
208		-)))|(((
209		-backend_key_assigned
210		-)))|(((
211		-(% class="nc" %)##KeyEvent##
212		-)))
213		-|(((
214		-mksp.backend.key.unassigned
215		-)))|(((
216		-backend_key_unassigned
217		-)))|(((
218		-(% class="nc" %)##KeyEvent##
219		-)))
220		-|(((
221		-mksp.backend.storage.reserved
222		-)))|(((
223		-backend_storage_reserved
224		-)))|(((
225		-(% class="nc" %)##StorageSpaceEvent##
226		-)))
227		-|(((
228		-mksp.backend.storage.released
229		-)))|(((
230		-backend_storage_released
231		-)))|(((
232		-(% class="nc" %)##StorageSpaceEvent##
233		-)))
234		-|(((
235		-mksp.backend.storage.expired
236		-)))|(((
237		-backend_storage_expired
238		-)))|(((
239		-(% class="nc" %){{code language="none"}}StorageSpaceEvent{{/code}}
240		-)))
241		-|(((
242		-mksp.backend.user.converted_to_member
243		-)))|(((
244		-backend_user_converted_to_member
245		-)))|(((
246		-(% class="nc" %){{code language="none"}}UserEvent{{/code}}
247		-)))
248		-|(((
249		-mksp.backend.user.converted_to_guest
250		-)))|(((
251		-backend_user_converted_to_guest
252		-)))|(((
253		-(% class="nc" %){{code language="none"}}UserEvent{{/code}}
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		-
289		-Die Consumer können dann wie folgt angelegt werden:
290		-
291		-{{code}}
292		-$ nats consumer add backend_events <name> --pull --filter="<filter>" --defaults
293		-
294		-# Beispiel
295		-nats consumer add backend_events backend_briefing_offer_cancelled --pull --filter="mksp.backend.briefing.offer.cancelled" --defaults
296		-nats consumer add backend_events backend_key_assigned --pull --filter="mksp.backend.key.assigned" --defaults
297		-{{/code}}
298		-
299		-= Troubleshooting =
300		-
301		-Man kann über die NATS CLI mit dem Server interagieren.
302		-
303		-== JetStream ==
304		-
305		-=== Streams ===
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##).
308		-
309		-{{code language="shell"}}
310		-$ nats context select mksp-jsadmin
311		-$ nats stream ls
312		-╭─────────────────────────────────────────────────────────────────────────────────────╮
313		-│ Streams │
314		-├────────────────┬─────────────┬─────────────────────┬──────────┬──────┬──────────────┤
315		-│ Name │ Description │ Created │ Messages │ Size │ Last Message │
316		-├────────────────┼─────────────┼─────────────────────┼──────────┼──────┼──────────────┤
317		-│ backend_events │ │ 2025-09-08 08:36:19 │ 0 │ 0 B │ never │
318		-╰────────────────┴─────────────┴─────────────────────┴──────────┴──────┴──────────────╯
319		-{{/code}}
320		-
321		-Ebenso kann man sich - falls vorhandenen - die Nachrichten im Stream anzeigen lassen:
322		-
323		-{{code language="shell"}}
324		-$ nats context select mksp-jsadmin
325		-$ nats stream view backend_events
326		-[1] Subject: mksp.backend.storage.reserved Received: 2025-09-08 09:06:00
327		-
328		-{"timestamp":"2025-09-08T09:06:00.062358","stora
329		-{{/code}}
330		-
331		-=== Consumer ===
332		-
333		-Die bestehenden Consumer kann man sich ebenfalls im Jetstream Context anzeigen lassen:
334		-
335		-{{code}}
336		-$ nats consumer ls backend_events
337		-╭──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
338		-│ Consumers │
339		-├──────────────────────────────────┬─────────────┬─────────────────────┬─────────────┬─────────────┬───────────────┤
340		-│ Name │ Description │ Created │ Ack Pending │ Unprocessed │ Last Delivery │
341		-├──────────────────────────────────┼─────────────┼─────────────────────┼─────────────┼─────────────┼───────────────┤
342		-│ backend_briefing_created │ │ 2025-09-10 08:30:12 │ 0 │ 12 │ never │
343		-│ backend_briefing_offer_cancelled │ │ 2025-09-10 08:21:02 │ 0 │ 0 │ never │
344		-│ backend_briefing_offer_created │ │ 2025-09-10 08:28:25 │ 0 │ 0 │ never │
345		-│ backend_briefing_offer_updated │ │ 2025-09-10 08:29:19 │ 0 │ 0 │ never │
346		-│ backend_key_assigned │ │ 2025-09-10 08:21:04 │ 0 │ 0 │ never │
347		-╰──────────────────────────────────┴─────────────┴─────────────────────┴─────────────┴─────────────┴───────────────╯
348		-{{/code}}
349		-
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		-
352		-{{code}}
353		-$ nats consumer info backend_events backend_briefing_offer_cancelled
354		-
355		-Information for Consumer backend_events > backend_briefing_offer_cancelled created 2025-09-09 22:53:26
356		-
357		-Configuration:
358		-
359		- Name: backend_briefing_offer_cancelled
360		- Pull Mode: true
361		- Filter Subject: mksp.backend.briefing.offer.cancelled
362		- Deliver Policy: All
363		- Ack Policy: Explicit
364		- Ack Wait: 30.00s
365		- Replay Policy: Instant
366		- Max Ack Pending: 1,000
367		- Max Waiting Pulls: 512
368		-
369		-State:
370		-
371		- Host Version: 2.11.8
372		- Required API Level: 0 hosted at level 1
373		- Last Delivered Message: Consumer sequence: 0 Stream sequence: 10
374		- Acknowledgment Floor: Consumer sequence: 0 Stream sequence: 0
375		- Outstanding Acks: 0 out of maximum 1,000
376		- Redelivered Messages: 0
377		- Unprocessed Messages: 0
378		- Waiting Pulls: 1 of maximum 512
379		-{{/code}}
380		-
381		-Insbesondere die letzten beiden Zeilen sind wichtig:
382		-
383		-* **Unprocessed Messages** sind Nachrichten, die noch nicht abgerufen wurden. Dies sollte immer 0 sein
384		-* **Waiting Pulls**: die Anzahl der verbundenen Clients. Üblicherweise sollte das nur n8n sein, also immer 1.
385		-
386		-== Server ==
387		-
388		-Man kann sich ebenfalls die aktiven Verbindungen anzeigen:
389		-
390		-{{code language="shell"}}
391		-$ nats context select mksp-sysadmin
392		-$ nats server report connections
393		-
394		-╭─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
395		-│ Top 6 Connections out of 6 by subs │
396		-├─────┬──────────────────────────┬──────────────┬─────────┬───────────────────┬─────────┬──────────┬─────────┬──────────┬──────────┬───────────┬──────┤
397		-│ CID │ Name │ Server │ Cluster │ IP │ Account │ Uptime │ In Msgs │ Out Msgs │ In Bytes │ Out Bytes │ Subs │
398		-├─────┼──────────────────────────┼──────────────┼─────────┼───────────────────┼─────────┼──────────┼─────────┼──────────┼──────────┼───────────┼──────┤
399		-│ 83 │ backend_kicker │ mksp-nats-01 │ │ 172.18.0.33:52808 │ MKSP │ 2h24m18s │ 0 │ 0 │ 0 B │ 0 B │ 0 │
400		-│ 93 │ backend_scheduler │ mksp-nats-01 │ │ 172.18.0.29:47620 │ MKSP │ 2h23m23s │ 0 │ 0 │ 0 B │ 0 B │ 0 │
401		-│ 82 │ backend_fastapi │ mksp-nats-01 │ │ 172.18.0.33:52798 │ MKSP │ 2h24m18s │ 1 │ 1 │ 345 B │ 838 B │ 1 │
402		-│ 94 │ backend_worker │ mksp-nats-01 │ │ 172.18.0.37:53550 │ MKSP │ 2h23m23s │ 0 │ 0 │ 0 B │ 0 B │ 1 │
403		-│ 95 │ backend_worker │ mksp-nats-01 │ │ 172.18.0.37:53554 │ MKSP │ 2h23m23s │ 0 │ 0 │ 0 B │ 0 B │ 1 │
404		-│ 111 │ NATS CLI Version 0.2.4 │ mksp-nats-01 │ │ 10.1.253.1:50712 │ SYS │ 0s │ 2 │ 1 │ 210 B │ 944 B │ 1 │
405		-├─────┼──────────────────────────┼──────────────┼─────────┼───────────────────┼─────────┼──────────┼─────────┼──────────┼──────────┼───────────┼──────┤
406		-│ │ Totals for 6 connections │ │ │ │ │ │ 3 │ 2 │ 555 B │ 1.7 KiB │ 4 │
407		-╰─────┴──────────────────────────┴──────────────┴─────────┴───────────────────┴─────────┴──────────┴─────────┴──────────┴──────────┴───────────┴──────╯
408		-
409		-╭──────────────────────────────────────╮
410		-│ Connections per server │
411		-├──────────────┬─────────┬─────────────┤
412		-│ Server │ Cluster │ Connections │
413		-├──────────────┼─────────┼─────────────┤
414		-│ mksp-nats-01 │ │ 6 │
415		-╰──────────────┴─────────┴─────────────╯
416		-{{/code}}
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.
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		-|=(((
423		-Client
424		-)))|=(((
425		-Anzahl
426		-)))|=(((
427		-Komponente
428		-)))|=(((
429		-Art
430		-)))|=(((
431		-Beschreibung
432		-)))
433		-|(((
434		-backend_kicker
435		-)))|(((
436		-1
437		-)))|(((
438		-FastAPI / Taskiq
439		-)))|(((
440		-JetStream
441		-)))|(((
442		-Delegiert asynchrone Tasks an den Worker und gibt Events aus, die dann von N8n abgearbeitet werden
443		-)))
444		-|(((
445		-backend_scheduler
446		-)))|(((
447		-1
448		-)))|(((
449		-Taskiq
450		-)))|(((
451		-JetStream
452		-)))|(((
453		-Komponente welches die regelmäßigen Jobs überwacht und triggert
454		-)))
455		-|(((
456		-backend_worker
457		-)))|(((
458		-2 (ein Client pro Worker-Prozess, ##NUM_WORKERS##)
459		-)))|(((
460		-Taskiq
461		-)))|(((
462		-JetStream
463		-)))|(((
464		-Worker für asynchrone Tasks, gibt ebenfalls Events aus
465		-)))
466		-
467		-Man kann sich ebenfalls die Subscriptions der jeweiligen Connections anschauen. Hierfür muss die Ausgabe auf JSON umgestellt werden:
468		-
469		-{{code language="shell"}}
470		-$ nats context select mksp-jsadmin
471		-$ nats server report connections -j
472		-[
473		- {
474		- "cid": 95,
475		- "kind": "Client",
476		- "type": "nats",
477		- "ip": "172.18.0.37",
478		- "port": 53554,
479		- "start": "2025-09-08T13:35:37.398441269Z",
480		- "last_activity": "2025-09-08T13:35:37.434868631Z",
481		- "rtt": "479µs",
482		- "uptime": "2h27m5s",
483		- "idle": "2h27m5s",
484		- "pending_bytes": 0,
485		- "in_msgs": 0,
486		- "out_msgs": 0,
487		- "in_bytes": 0,
488		- "out_bytes": 0,
489		- "subscriptions": 1,
490		- "name": "backend_worker",
491		- "lang": "python3",
492		- "version": "2.11.0",
493		- "tls_version": "1.3",
494		- "tls_cipher_suite": "TLS_AES_128_GCM_SHA256",
495		- "tls_peer_certs": [
496		- {
497		- "subject": "CN=backend.mksp-da.de,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE",
498		- "spki_sha256": "1c7826ac936267622a5bfec0359304e795a4fd552b4d76556d7fcbddf51f43fb",
499		- "cert_sha256": "e25dd3084b13f5f3cb81ebb9291627bcd0a25ab51325f1cc627a2b758f03d1ca"
500		- },
501		- {
502		- "subject": "CN=MKSP NATS Issuing CA,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE",
503		- "spki_sha256": "af16c3490475a4ba65d273b7dae825622b4c1eeca5f3da808df14b3c298627a7",
504		- "cert_sha256": "10ccebe5826128f50f7b007537fa8b832326d4bb14b1676588abac9a10bf7585"
505		- }
506		- ],
507		- "authorized_user": "CN=backend.mksp-da.de,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE",
508		- "account": "MKSP",
509		- "subscriptions_list": [
510		- "taskiq_tasks"
511		- ],
512		- "name_tag": "MKSP",
513		- "server": {
514		- "name": "mksp-nats-01",
515		- "host": "0.0.0.0",
516		- "id": "NDH7ZAPFJ5EORJKZDJGOUNN3NDMTLWR6V7BGBOYUIG5UE7VEIK76F6WH",
517		- "ver": "2.11.6",
518		- "jetstream": true,
519		- "flags": 7,
520		- "seq": 2937,
521		- "time": "2025-09-08T16:02:42.888686229Z"
522		- }
523		- },
524		- ]
525		-{{/code}}
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		-
	50	+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.

Confluence.Code.ConfluencePageClass[0]

Id

...	...	@@ -1,1 +1,1 @@
1		-207814660
	1	+207814662

URL

...	...	@@ -1,1 +1,1 @@
1		-https://wiki.makerspace-darmstadt.de/spaces/PROJ/pages/207814660/NATS Setup
	1	+https://wiki.makerspace-darmstadt.de/spaces/PROJ/pages/207814662/NATS Setup