Ä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 Setup
	1	+NATS - Technisches Setup

Übergeordnete Seite

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

Inhalt

...	...	@@ -2,9 +2,9 @@
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		-= {{id name="NATSSetup-Grundlagen"/}}Grundlagen =
	5	+= Grundlagen =
6	6
7		-== {{id name="NATSSetup-Übersicht"/}}Übersicht ==
	7	+== Übersicht ==
8	8
9	9	NATS kann grob in zwei Varianten unterteilt werden, **NATS Core** und **NATS JetStream**.
10	10
...	...	@@ -12,17 +12,17 @@
12	12
13	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.
14	14
15		-== {{id name="NATSSetup-Accounts"/}}Accounts ==
	15	+== Accounts ==
16	16
17		-(% style="text-decoration: none;color:var(--ds-text,#333333);" %)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.
	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	18
19		-(% style="text-decoration: none;color:var(--ds-text,#333333);" %)Wir verwenden zwei verschiedene Accounts:
	19	+(% style="color:var(--ds-text,#333333); text-decoration:none" %)Wir verwenden zwei verschiedene Accounts:
20	20
21		-|=(% scope="col" %)(((
	21	+|=(((
22	22	Account
23		-)))|=(% scope="col" %)(((
	23	+)))|=(((
24	24	Berechtigungen
25		-)))|=(% scope="col" %)(((
	25	+)))|=(((
26	26	Beschreibung
27	27	)))
28	28	|(((
...	...	@@ -42,9 +42,9 @@
42	42
43	43	Benutzer können jeweils nur einem Account zugeordnet werden.
44	44
45		-== {{id name="NATSSetup-Authentifizierung"/}}Authentifizierung ==
	45	+== Authentifizierung ==
46	46
47		-Die Kommunikation ist TLS verschlüsselt, es kommen die TLS Zertifikate aus [[HashiCorp KeyVault>>confluencePage:page:IN.Hashicorp Vault]] 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
...	...	@@ -56,7 +56,7 @@
56	56
57	57	Diese Subject wird dann dem Account zugeordnet:
58	58
59		-{{code language="json"}}
	59	+{{code}}
60	60	system_account: SYS
61	61	accounts: {
62	62	MKSP: {
...	...	@@ -83,11 +83,11 @@
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		-== {{id name="NATSSetup-NATSCoremitAccounts"/}}NATS Core mit Accounts ==
	86	+== NATS Core mit Accounts ==
87	87
88	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		-{{code language="json"}}
	90	+{{code}}
91	91	accounts: {
92	92	MKSP: {
93	93	users: [
...	...	@@ -103,18 +103,18 @@
103	103
104	104	Wichtig sind hier die zusätzlichen Permissions, die den Zugriff auf Core Events regeln.
105	105
106		-== {{id name="NATSSetup-JetStreamKonfiguration"/}}JetStream Konfiguration ==
	106	+== JetStream Konfiguration ==
107	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		-=== {{id name="NATSSetup-NATSCLIkonfigurieren"/}}NATS CLI konfigurieren ===
	110	+=== NATS CLI konfigurieren ===
111	111
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:
...	...	@@ -123,7 +123,7 @@
123	123	nats context select mksp-jsadmin
124	124	{{/code}}
125	125
126		-=== {{id name="NATSSetup-JetStreaminitialisieren"/}}JetStream initialisieren ===
	126	+=== 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,18 +136,140 @@
136	136	nats stream add backend_events --subjects "mksp.>" --retention work --max-age 7d --storage file --defaults
137	137	{{/code}}
138	138
139		-=== {{id name="NATSSetup-JetStreamConsumer"/}}JetStream Consumer ===
	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"]]
142	142
143		-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.
	143	+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.
144	144
145		-= {{id name="NATSSetup-Troubleshooting"/}}Troubleshooting =
	145	+|=(((
	146	+Backend Event
	147	+)))|=(((
	148	+Consumer Name
	149	+)))|=(((
	150	+Schema
	151	+)))
	152	+|(((
	153	+mksp.backend.briefing.offer.cancelled
146	146
	155	+(((
	156	+
	157	+)))
	158	+)))|(((
	159	+backend_briefing_offer_cancelled
	160	+)))|(((
	161	+(% class="nc" %)##BriefingOfferEvent##
	162	+)))
	163	+|(((
	164	+mksp.backend.briefing.offer.created
	165	+
	166	+(((
	167	+
	168	+)))
	169	+)))|(((
	170	+backend_briefing_offer_created
	171	+)))|(((
	172	+(% class="nc" %)##BriefingOfferEvent##
	173	+)))
	174	+|(((
	175	+mksp.backend.briefing.offer.updated
	176	+)))|(((
	177	+backend_briefing_offer_updated
	178	+)))|(((
	179	+(% class="nc" %)##BriefingOfferEvent##
	180	+)))
	181	+|(((
	182	+mksp.backend.briefing.created
	183	+
	184	+(((
	185	+
	186	+)))
	187	+)))|(((
	188	+backend_briefing_created
	189	+)))|(((
	190	+(% class="n" %)##BriefingEvent##
	191	+)))
	192	+|(((
	193	+mksp.backend.key.assigned
	194	+)))|(((
	195	+backend_key_assigned
	196	+)))|(((
	197	+(% class="nc" %)##KeyEvent##
	198	+)))
	199	+|(((
	200	+mksp.backend.key.unassigned
	201	+)))|(((
	202	+backend_key_unassigned
	203	+)))|(((
	204	+(% class="nc" %)##KeyEvent##
	205	+)))
	206	+|(((
	207	+mksp.backend.storage.reserved
	208	+)))|(((
	209	+backend_storage_reserved
	210	+)))|(((
	211	+(% class="nc" %)##StorageSpaceEvent##
	212	+)))
	213	+|(((
	214	+mksp.backend.storage.released
	215	+)))|(((
	216	+backend_storage_released
	217	+)))|(((
	218	+(% class="nc" %)##StorageSpaceEvent##
	219	+)))
	220	+|(((
	221	+mksp.backend.storage.expired
	222	+)))|(((
	223	+backend_storage_expired
	224	+)))|(((
	225	+(% class="nc" %){{code language="none"}}StorageSpaceEvent{{/code}}
	226	+)))
	227	+|(((
	228	+mksp.backend.user.converted_to_member
	229	+)))|(((
	230	+backend_user_converted_to_member
	231	+)))|(((
	232	+(% class="nc" %){{code language="none"}}UserEvent{{/code}}
	233	+)))
	234	+|(((
	235	+mksp.backend.user.converted_to_guest
	236	+)))|(((
	237	+backend_user_converted_to_guest
	238	+)))|(((
	239	+(% class="nc" %){{code language="none"}}UserEvent{{/code}}
	240	+)))
	241	+|(((
	242	+mksp.backend.user.created
	243	+)))|backend_user_created|UserEvent
	244	+|(((
	245	+mksp.docuseal.signature.expired
	246	+)))|docuseal_signature_expired|(((
	247	+SignatureEvent
	248	+)))
	249	+|(((
	250	+mksp.docuseal.signature.completed
	251	+)))|docuseal_signature_completed|(((
	252	+SignatureEvent
	253	+)))
	254	+
	255	+Die Consumer können dann wie folgt angelegt werden:
	256	+
	257	+{{code}}
	258	+$ nats consumer add backend_events <name> --pull --filter="<filter>" --defaults
	259	+
	260	+# Beispiel
	261	+nats consumer add backend_events backend_briefing_offer_cancelled --pull --filter="mksp.backend.briefing.offer.cancelled" --defaults
	262	+nats consumer add backend_events backend_key_assigned --pull --filter="mksp.backend.key.assigned" --defaults
	263	+{{/code}}
	264	+
	265	+= Troubleshooting =
	266	+
147	147	Man kann über die NATS CLI mit dem Server interagieren.
148	148
149		-== {{id name="NATSSetup-JetStream"/}}JetStream ==
	269	+== JetStream ==
150	150
	271	+=== Streams ===
	272	+
151	151	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.
152	152
153	153	{{code language="shell"}}
...	...	@@ -172,8 +172,63 @@
172	172	{"timestamp":"2025-09-08T09:06:00.062358","stora
173	173	{{/code}}
174	174
175		-== {{id name="NATSSetup-Server"/}}Server ==
	297	+=== Consumer ===
176	176
	299	+Die bestehenden Consumer kann man sich ebenfalls im Jetstream Context anzeigen lassen:
	300	+
	301	+{{code}}
	302	+$ nats consumer ls backend_events
	303	+╭──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
	304	+│ Consumers │
	305	+├──────────────────────────────────┬─────────────┬─────────────────────┬─────────────┬─────────────┬───────────────┤
	306	+│ Name │ Description │ Created │ Ack Pending │ Unprocessed │ Last Delivery │
	307	+├──────────────────────────────────┼─────────────┼─────────────────────┼─────────────┼─────────────┼───────────────┤
	308	+│ backend_briefing_created │ │ 2025-09-10 08:30:12 │ 0 │ 12 │ never │
	309	+│ backend_briefing_offer_cancelled │ │ 2025-09-10 08:21:02 │ 0 │ 0 │ never │
	310	+│ backend_briefing_offer_created │ │ 2025-09-10 08:28:25 │ 0 │ 0 │ never │
	311	+│ backend_briefing_offer_updated │ │ 2025-09-10 08:29:19 │ 0 │ 0 │ never │
	312	+│ backend_key_assigned │ │ 2025-09-10 08:21:04 │ 0 │ 0 │ never │
	313	+╰──────────────────────────────────┴─────────────┴─────────────────────┴─────────────┴─────────────┴───────────────╯
	314	+{{/code}}
	315	+
	316	+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:
	317	+
	318	+{{code}}
	319	+$ nats consumer info backend_events backend_briefing_offer_cancelled
	320	+
	321	+Information for Consumer backend_events > backend_briefing_offer_cancelled created 2025-09-09 22:53:26
	322	+
	323	+Configuration:
	324	+
	325	+ Name: backend_briefing_offer_cancelled
	326	+ Pull Mode: true
	327	+ Filter Subject: mksp.backend.briefing.offer.cancelled
	328	+ Deliver Policy: All
	329	+ Ack Policy: Explicit
	330	+ Ack Wait: 30.00s
	331	+ Replay Policy: Instant
	332	+ Max Ack Pending: 1,000
	333	+ Max Waiting Pulls: 512
	334	+
	335	+State:
	336	+
	337	+ Host Version: 2.11.8
	338	+ Required API Level: 0 hosted at level 1
	339	+ Last Delivered Message: Consumer sequence: 0 Stream sequence: 10
	340	+ Acknowledgment Floor: Consumer sequence: 0 Stream sequence: 0
	341	+ Outstanding Acks: 0 out of maximum 1,000
	342	+ Redelivered Messages: 0
	343	+ Unprocessed Messages: 0
	344	+ Waiting Pulls: 1 of maximum 512
	345	+{{/code}}
	346	+
	347	+Insbesondere die letzten beiden Zeilen sind wichtig:
	348	+
	349	+* **Unprocessed Messages** sind Nachrichten, die noch nicht abgerufen wurden. Dies sollte immer 0 sein
	350	+* **Waiting Pulls**: die Anzahl der verbundenen Clients. Üblicherweise sollte das nur n8n sein, also immer 1.
	351	+
	352	+== Server ==
	353	+
177	177	Man kann sich ebenfalls die aktiven Verbindungen anzeigen:
178	178
179	179	{{code language="shell"}}
...	...	@@ -206,15 +206,15 @@
206	206
207	207	Der Name ist hierbei frei vergeben, in unserem Fall im Backend Code. Wir erwarten die folgenden Clients:
208	208
209		-|=(% scope="col" %)(((
	386	+|=(((
210	210	Client
211		-)))|=(% scope="col" %)(((
	388	+)))|=(((
212	212	Anzahl
213		-)))|=(% scope="col" %)(((
	390	+)))|=(((
214	214	Komponente
215		-)))|=(% scope="col" %)(((
	392	+)))|=(((
216	216	Art
217		-)))|=(% scope="col" %)(((
	394	+)))|=(((
218	218	Beschreibung
219	219	)))
220	220	|(((
...	...	@@ -322,4 +322,4 @@
322	322	]
323	323	{{/code}}
324	324
325		-\\
	502	+

Confluence.Code.ConfluencePageClass[0]

URL

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

Id

...	...	@@ -1,1 +1,1 @@
1		-207814673
	1	+207814660