Zum Inhalt springen

Wiki-Quellcode von NATS Setup

Version 7.1 von Daniel Herrmann am 2025/09/09 21:08
Zeige letzte Bearbeiter
1 NATS ist eine zentrale Komponente der Architektur. NATS ist ein verteiltes Messaging-System, welches häufig für Microservices verwendet wird.
2
3 Unser Backend (oder auch andere Systeme) publizieren Events in NATS, die dann beispielsweise in N8n über ein Trigger konsumiert werden.
4
5 = {{id name="NATSSetup-Grundlagen"/}}Grundlagen =
6
7 == {{id name="NATSSetup-Übersicht"/}}Übersicht ==
8
9 NATS kann grob in zwei Varianten unterteilt werden, **NATS Core** und **NATS JetStream**.
10
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
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
15 == {{id name="NATSSetup-Accounts"/}}Accounts ==
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.
18
19 (% style="text-decoration: none;color:var(--ds-text,#333333);" %)Wir verwenden zwei verschiedene Accounts:
20
21 |=(% scope="col" %)(((
22 Account
23 )))|=(% scope="col" %)(((
24 Berechtigungen
25 )))|=(% scope="col" %)(((
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 == {{id name="NATSSetup-Authentifizierung"/}}Authentifizierung ==
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.
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 language="json"}}
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 == {{id name="NATSSetup-NATSCoremitAccounts"/}}NATS Core mit Accounts ==
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:
89
90 {{code language="json"}}
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 Wichtig sind hier die zusätzlichen Permissions, die den Zugriff auf Core Events regeln.
105
106 == {{id name="NATSSetup-JetStreamKonfiguration"/}}JetStream Konfiguration ==
107
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
110 === {{id name="NATSSetup-NATSCLIkonfigurieren"/}}NATS CLI konfigurieren ===
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:
113
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
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
118 {{/code}}
119
120 Anschließend wählen wir den richtigen Kontext aus, in diesem Fall den JetStream Admin Context:
121
122 {{code language="shell"}}
123 nats context select mksp-jsadmin
124 {{/code}}
125
126 === {{id name="NATSSetup-JetStreaminitialisieren"/}}JetStream initialisieren ===
127
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
130 * JetStream im Allgemeinen: [[https:~~/~~/docs.nats.io/nats-concepts/jetstream>>url:https://docs.nats.io/nats-concepts/jetstream||shape="rect"]]
131 * JetStream Streams: [[https:~~/~~/docs.nats.io/nats-concepts/jetstream/streams>>url:https://docs.nats.io/nats-concepts/jetstream/streams||shape="rect"]]
132
133 Wir legen nun also ein Stream namens **backend_events** an:
134
135 {{code language="shell"}}
136 nats stream add backend_events --subjects "mksp.>" --retention work --max-age 7d --storage file --defaults
137 {{/code}}
138
139 === {{id name="NATSSetup-JetStreamConsumer"/}}JetStream Consumer ===
140
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
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
145 |=(% scope="col" %)(((
146 Backend Event
147 )))|=(% scope="col" %)(((
148 Consumer Name
149 )))|=(% scope="col" %)(((
150 Schema
151 )))
152 |(((
153 {{code language="none"}}
154 mksp.backend.briefing.offer.cancelled
155 {{/code}}
156 )))|(((
157 backend_briefing_offer_cancelled
158 )))|(((
159 ##(% class="nc" %)BriefingOfferEvent(%%)##
160 )))
161 |(((
162 {{code language="none"}}
163 mksp.backend.briefing.offer.created
164 {{/code}}
165 )))|(((
166 backend_briefing_offer_created
167 )))|(((
168 ##(% class="nc" %)BriefingOfferEvent(%%)##
169 )))
170 |(((
171 ##(% class="s" %)mksp.backend.briefing.offer.updated(%%)##
172 )))|(((
173 backend_briefing_offer_updated
174 )))|(((
175 ##(% class="nc" %)BriefingOfferEvent(%%)##
176 )))
177 |(((
178 {{code language="none"}}
179 mksp.backend.briefing.created
180 {{/code}}
181 )))|(((
182 backend_briefing_created
183 )))|(((
184 ##(% class="n" %)BriefingEvent(%%)##
185 )))
186 |(((
187 ##(% class="s" %)mksp.backend.key.assigned(%%)##
188 )))|(((
189 backend_key_assigned
190 )))|(((
191 ##(% class="nc" %)KeyEvent(%%)##
192 )))
193 |(((
194 ##(% class="s" %)mksp.backend.key.unassigned(%%)##
195 )))|(((
196 backend_key_unassigned
197 )))|(((
198 ##(% class="nc" %)KeyEvent(%%)##
199 )))
200 |(((
201 ##(% class="s" %)mksp.backend.storage.reserved(%%)##
202 )))|(((
203 backend_storage_reserved
204 )))|(((
205 ##(% class="nc" %)StorageSpaceEvent(%%)##
206 )))
207 |(((
208 (% class="s" %){{code language="none"}}mksp.backend.storage.released{{/code}}
209 )))|(((
210 backend_storage_released
211 )))|(((
212 ##(% class="nc" %)StorageSpaceEvent(%%)##
213 )))
214 |(((
215 (% class="s" %){{code language="none"}}mksp.backend.storage.expired{{/code}}
216 )))|(((
217 backend_storage_expired
218 )))|(((
219 (% class="nc" %){{code language="none"}}StorageSpaceEvent{{/code}}
220 )))
221 |(((
222 (% class="s" %){{code language="none"}}mksp.backend.user.converted_to_member{{/code}}
223 )))|(((
224 backend_user_converted_to_member
225 )))|(((
226 (% class="nc" %){{code language="none"}}UserEvent{{/code}}
227 )))
228 |(((
229 (% class="s" %){{code language="none"}}mksp.backend.user.converted_to_guest{{/code}}
230 )))|(((
231 backend_user_converted_to_guest
232 )))|(((
233 (% class="nc" %){{code language="none"}}UserEvent{{/code}}
234 )))
235
236 = {{id name="NATSSetup-Troubleshooting"/}}Troubleshooting =
237
238 Man kann über die NATS CLI mit dem Server interagieren.
239
240 == {{id name="NATSSetup-JetStream"/}}JetStream ==
241
242 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.
243
244 {{code language="shell"}}
245 $ nats context select mksp-jsadmin
246 $ nats stream ls
247 ╭─────────────────────────────────────────────────────────────────────────────────────╮
248 │ Streams │
249 ├────────────────┬─────────────┬─────────────────────┬──────────┬──────┬──────────────┤
250 │ Name │ Description │ Created │ Messages │ Size │ Last Message │
251 ├────────────────┼─────────────┼─────────────────────┼──────────┼──────┼──────────────┤
252 │ backend_events │ │ 2025-09-08 08:36:19 │ 0 │ 0 B │ never │
253 ╰────────────────┴─────────────┴─────────────────────┴──────────┴──────┴──────────────╯
254 {{/code}}
255
256 Ebenso kann man sich - falls vorhandenen - die Nachrichten im Stream anzeigen lassen:
257
258 {{code language="shell"}}
259 $ nats context select mksp-jsadmin
260 $ nats stream view backend_events
261 [1] Subject: mksp.backend.storage.reserved Received: 2025-09-08 09:06:00
262
263 {"timestamp":"2025-09-08T09:06:00.062358","stora
264 {{/code}}
265
266 == {{id name="NATSSetup-Server"/}}Server ==
267
268 Man kann sich ebenfalls die aktiven Verbindungen anzeigen:
269
270 {{code language="shell"}}
271 $ nats context select mksp-sysadmin
272 $ nats server report connections   
273
274 ╭─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
275 │ Top 6 Connections out of 6 by subs │
276 ├─────┬──────────────────────────┬──────────────┬─────────┬───────────────────┬─────────┬──────────┬─────────┬──────────┬──────────┬───────────┬──────┤
277 │ CID │ Name │ Server │ Cluster │ IP │ Account │ Uptime │ In Msgs │ Out Msgs │ In Bytes │ Out Bytes │ Subs │
278 ├─────┼──────────────────────────┼──────────────┼─────────┼───────────────────┼─────────┼──────────┼─────────┼──────────┼──────────┼───────────┼──────┤
279 │ 83 │ backend_kicker │ mksp-nats-01 │ │ 172.18.0.33:52808 │ MKSP │ 2h24m18s │ 0 │ 0 │ 0 B │ 0 B │ 0 │
280 │ 93 │ backend_scheduler │ mksp-nats-01 │ │ 172.18.0.29:47620 │ MKSP │ 2h23m23s │ 0 │ 0 │ 0 B │ 0 B │ 0 │
281 │ 82 │ backend_fastapi │ mksp-nats-01 │ │ 172.18.0.33:52798 │ MKSP │ 2h24m18s │ 1 │ 1 │ 345 B │ 838 B │ 1 │
282 │ 94 │ backend_worker │ mksp-nats-01 │ │ 172.18.0.37:53550 │ MKSP │ 2h23m23s │ 0 │ 0 │ 0 B │ 0 B │ 1 │
283 │ 95 │ backend_worker │ mksp-nats-01 │ │ 172.18.0.37:53554 │ MKSP │ 2h23m23s │ 0 │ 0 │ 0 B │ 0 B │ 1 │
284 │ 111 │ NATS CLI Version 0.2.4 │ mksp-nats-01 │ │ 10.1.253.1:50712 │ SYS │ 0s │ 2 │ 1 │ 210 B │ 944 B │ 1 │
285 ├─────┼──────────────────────────┼──────────────┼─────────┼───────────────────┼─────────┼──────────┼─────────┼──────────┼──────────┼───────────┼──────┤
286 │ │ Totals for 6 connections │ │ │ │ │ │ 3 │ 2 │ 555 B │ 1.7 KiB │ 4 │
287 ╰─────┴──────────────────────────┴──────────────┴─────────┴───────────────────┴─────────┴──────────┴─────────┴──────────┴──────────┴───────────┴──────╯
288
289 ╭──────────────────────────────────────╮
290 │ Connections per server │
291 ├──────────────┬─────────┬─────────────┤
292 │ Server │ Cluster │ Connections │
293 ├──────────────┼─────────┼─────────────┤
294 │ mksp-nats-01 │ │ 6 │
295 ╰──────────────┴─────────┴─────────────╯
296 {{/code}}
297
298 Der Name ist hierbei frei vergeben, in unserem Fall im Backend Code. Wir erwarten die folgenden Clients:
299
300 |=(% scope="col" %)(((
301 Client
302 )))|=(% scope="col" %)(((
303 Anzahl
304 )))|=(% scope="col" %)(((
305 Komponente
306 )))|=(% scope="col" %)(((
307 Art
308 )))|=(% scope="col" %)(((
309 Beschreibung
310 )))
311 |(((
312 backend_kicker
313 )))|(((
314 1
315 )))|(((
316 Taskiq
317 )))|(((
318 Core
319 )))|(((
320 Gibt dem Backend die Möglichkeit, asynchrone Tasks an das Taskiq backend zu delegieren
321 )))
322 |(((
323 backend_scheduler
324 )))|(((
325 1
326 )))|(((
327 Taskiq
328 )))|(((
329 Core
330 )))|(((
331 Komponente welches die regelmäßigen Jobs überwacht und triggert
332 )))
333 |(((
334 backend_fastapi
335 )))|(((
336 1
337 )))|(((
338 FastAPI
339 )))|(((
340 JetStream
341 )))|(((
342 Das Backend kann hiermit Events ausgeben, die dann von N8n abgearbeitet werden.
343 )))
344 |(((
345 backend_worker
346 )))|(((
347 2
348 )))|(((
349 Taskiq
350 )))|(((
351 Core
352 )))|(((
353 Worker für asynchrone Tasks
354 )))
355
356 Man kann sich ebenfalls die Subscriptions der jeweiligen Connections anschauen. Hierfür muss die Ausgabe auf JSON umgestellt werden:
357
358 {{code language="shell"}}
359 $ nats context select mksp-jsadmin
360 $ nats server report connections -j
361 [
362 {
363 "cid": 95,
364 "kind": "Client",
365 "type": "nats",
366 "ip": "172.18.0.37",
367 "port": 53554,
368 "start": "2025-09-08T13:35:37.398441269Z",
369 "last_activity": "2025-09-08T13:35:37.434868631Z",
370 "rtt": "479µs",
371 "uptime": "2h27m5s",
372 "idle": "2h27m5s",
373 "pending_bytes": 0,
374 "in_msgs": 0,
375 "out_msgs": 0,
376 "in_bytes": 0,
377 "out_bytes": 0,
378 "subscriptions": 1,
379 "name": "backend_worker",
380 "lang": "python3",
381 "version": "2.11.0",
382 "tls_version": "1.3",
383 "tls_cipher_suite": "TLS_AES_128_GCM_SHA256",
384 "tls_peer_certs": [
385 {
386 "subject": "CN=backend.mksp-da.de,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE",
387 "spki_sha256": "1c7826ac936267622a5bfec0359304e795a4fd552b4d76556d7fcbddf51f43fb",
388 "cert_sha256": "e25dd3084b13f5f3cb81ebb9291627bcd0a25ab51325f1cc627a2b758f03d1ca"
389 },
390 {
391 "subject": "CN=MKSP NATS Issuing CA,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE",
392 "spki_sha256": "af16c3490475a4ba65d273b7dae825622b4c1eeca5f3da808df14b3c298627a7",
393 "cert_sha256": "10ccebe5826128f50f7b007537fa8b832326d4bb14b1676588abac9a10bf7585"
394 }
395 ],
396 "authorized_user": "CN=backend.mksp-da.de,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE",
397 "account": "MKSP",
398 "subscriptions_list": [
399 "taskiq_tasks"
400 ],
401 "name_tag": "MKSP",
402 "server": {
403 "name": "mksp-nats-01",
404 "host": "0.0.0.0",
405 "id": "NDH7ZAPFJ5EORJKZDJGOUNN3NDMTLWR6V7BGBOYUIG5UE7VEIK76F6WH",
406 "ver": "2.11.6",
407 "jetstream": true,
408 "flags": 7,
409 "seq": 2937,
410 "time": "2025-09-08T16:02:42.888686229Z"
411 }
412 },
413 ]
414 {{/code}}
415
416 \\