Zum Inhalt springen

Wiki-Quellcode von NATS Setup

Version 6.1 von Daniel Herrmann am 2025/09/08 22:55
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.
144
145 = {{id name="NATSSetup-Troubleshooting"/}}Troubleshooting =
146
147 Man kann über die NATS CLI mit dem Server interagieren.
148
149 == {{id name="NATSSetup-JetStream"/}}JetStream ==
150
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
153 {{code language="shell"}}
154 $ nats context select mksp-jsadmin
155 $ nats stream ls
156 ╭─────────────────────────────────────────────────────────────────────────────────────╮
157 │ Streams │
158 ├────────────────┬─────────────┬─────────────────────┬──────────┬──────┬──────────────┤
159 │ Name │ Description │ Created │ Messages │ Size │ Last Message │
160 ├────────────────┼─────────────┼─────────────────────┼──────────┼──────┼──────────────┤
161 │ backend_events │ │ 2025-09-08 08:36:19 │ 0 │ 0 B │ never │
162 ╰────────────────┴─────────────┴─────────────────────┴──────────┴──────┴──────────────╯
163 {{/code}}
164
165 Ebenso kann man sich - falls vorhandenen - die Nachrichten im Stream anzeigen lassen:
166
167 {{code language="shell"}}
168 $ nats context select mksp-jsadmin
169 $ nats stream view backend_events
170 [1] Subject: mksp.backend.storage.reserved Received: 2025-09-08 09:06:00
171
172 {"timestamp":"2025-09-08T09:06:00.062358","stora
173 {{/code}}
174
175 == {{id name="NATSSetup-Server"/}}Server ==
176
177 Man kann sich ebenfalls die aktiven Verbindungen anzeigen:
178
179 {{code language="shell"}}
180 $ nats context select mksp-sysadmin
181 $ nats server report connections   
182
183 ╭─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
184 │ Top 6 Connections out of 6 by subs │
185 ├─────┬──────────────────────────┬──────────────┬─────────┬───────────────────┬─────────┬──────────┬─────────┬──────────┬──────────┬───────────┬──────┤
186 │ CID │ Name │ Server │ Cluster │ IP │ Account │ Uptime │ In Msgs │ Out Msgs │ In Bytes │ Out Bytes │ Subs │
187 ├─────┼──────────────────────────┼──────────────┼─────────┼───────────────────┼─────────┼──────────┼─────────┼──────────┼──────────┼───────────┼──────┤
188 │ 83 │ backend_kicker │ mksp-nats-01 │ │ 172.18.0.33:52808 │ MKSP │ 2h24m18s │ 0 │ 0 │ 0 B │ 0 B │ 0 │
189 │ 93 │ backend_scheduler │ mksp-nats-01 │ │ 172.18.0.29:47620 │ MKSP │ 2h23m23s │ 0 │ 0 │ 0 B │ 0 B │ 0 │
190 │ 82 │ backend_fastapi │ mksp-nats-01 │ │ 172.18.0.33:52798 │ MKSP │ 2h24m18s │ 1 │ 1 │ 345 B │ 838 B │ 1 │
191 │ 94 │ backend_worker │ mksp-nats-01 │ │ 172.18.0.37:53550 │ MKSP │ 2h23m23s │ 0 │ 0 │ 0 B │ 0 B │ 1 │
192 │ 95 │ backend_worker │ mksp-nats-01 │ │ 172.18.0.37:53554 │ MKSP │ 2h23m23s │ 0 │ 0 │ 0 B │ 0 B │ 1 │
193 │ 111 │ NATS CLI Version 0.2.4 │ mksp-nats-01 │ │ 10.1.253.1:50712 │ SYS │ 0s │ 2 │ 1 │ 210 B │ 944 B │ 1 │
194 ├─────┼──────────────────────────┼──────────────┼─────────┼───────────────────┼─────────┼──────────┼─────────┼──────────┼──────────┼───────────┼──────┤
195 │ │ Totals for 6 connections │ │ │ │ │ │ 3 │ 2 │ 555 B │ 1.7 KiB │ 4 │
196 ╰─────┴──────────────────────────┴──────────────┴─────────┴───────────────────┴─────────┴──────────┴─────────┴──────────┴──────────┴───────────┴──────╯
197
198 ╭──────────────────────────────────────╮
199 │ Connections per server │
200 ├──────────────┬─────────┬─────────────┤
201 │ Server │ Cluster │ Connections │
202 ├──────────────┼─────────┼─────────────┤
203 │ mksp-nats-01 │ │ 6 │
204 ╰──────────────┴─────────┴─────────────╯
205 {{/code}}
206
207 Der Name ist hierbei frei vergeben, in unserem Fall im Backend Code. Wir erwarten die folgenden Clients:
208
209 |=(% scope="col" %)(((
210 Client
211 )))|=(% scope="col" %)(((
212 Anzahl
213 )))|=(% scope="col" %)(((
214 Komponente
215 )))|=(% scope="col" %)(((
216 Art
217 )))|=(% scope="col" %)(((
218 Beschreibung
219 )))
220 |(((
221 backend_kicker
222 )))|(((
223 1
224 )))|(((
225 Taskiq
226 )))|(((
227 Core
228 )))|(((
229 Gibt dem Backend die Möglichkeit, asynchrone Tasks an das Taskiq backend zu delegieren
230 )))
231 |(((
232 backend_scheduler
233 )))|(((
234 1
235 )))|(((
236 Taskiq
237 )))|(((
238 Core
239 )))|(((
240 Komponente welches die regelmäßigen Jobs überwacht und triggert
241 )))
242 |(((
243 backend_fastapi
244 )))|(((
245 1
246 )))|(((
247 FastAPI
248 )))|(((
249 JetStream
250 )))|(((
251 Das Backend kann hiermit Events ausgeben, die dann von N8n abgearbeitet werden.
252 )))
253 |(((
254 backend_worker
255 )))|(((
256 2
257 )))|(((
258 Taskiq
259 )))|(((
260 Core
261 )))|(((
262 Worker für asynchrone Tasks
263 )))
264
265 Man kann sich ebenfalls die Subscriptions der jeweiligen Connections anschauen. Hierfür muss die Ausgabe auf JSON umgestellt werden:
266
267 {{code language="shell"}}
268 $ nats context select mksp-jsadmin
269 $ nats server report connections -j
270 [
271 {
272 "cid": 95,
273 "kind": "Client",
274 "type": "nats",
275 "ip": "172.18.0.37",
276 "port": 53554,
277 "start": "2025-09-08T13:35:37.398441269Z",
278 "last_activity": "2025-09-08T13:35:37.434868631Z",
279 "rtt": "479µs",
280 "uptime": "2h27m5s",
281 "idle": "2h27m5s",
282 "pending_bytes": 0,
283 "in_msgs": 0,
284 "out_msgs": 0,
285 "in_bytes": 0,
286 "out_bytes": 0,
287 "subscriptions": 1,
288 "name": "backend_worker",
289 "lang": "python3",
290 "version": "2.11.0",
291 "tls_version": "1.3",
292 "tls_cipher_suite": "TLS_AES_128_GCM_SHA256",
293 "tls_peer_certs": [
294 {
295 "subject": "CN=backend.mksp-da.de,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE",
296 "spki_sha256": "1c7826ac936267622a5bfec0359304e795a4fd552b4d76556d7fcbddf51f43fb",
297 "cert_sha256": "e25dd3084b13f5f3cb81ebb9291627bcd0a25ab51325f1cc627a2b758f03d1ca"
298 },
299 {
300 "subject": "CN=MKSP NATS Issuing CA,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE",
301 "spki_sha256": "af16c3490475a4ba65d273b7dae825622b4c1eeca5f3da808df14b3c298627a7",
302 "cert_sha256": "10ccebe5826128f50f7b007537fa8b832326d4bb14b1676588abac9a10bf7585"
303 }
304 ],
305 "authorized_user": "CN=backend.mksp-da.de,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE",
306 "account": "MKSP",
307 "subscriptions_list": [
308 "taskiq_tasks"
309 ],
310 "name_tag": "MKSP",
311 "server": {
312 "name": "mksp-nats-01",
313 "host": "0.0.0.0",
314 "id": "NDH7ZAPFJ5EORJKZDJGOUNN3NDMTLWR6V7BGBOYUIG5UE7VEIK76F6WH",
315 "ver": "2.11.6",
316 "jetstream": true,
317 "flags": 7,
318 "seq": 2937,
319 "time": "2025-09-08T16:02:42.888686229Z"
320 }
321 },
322 ]
323 {{/code}}
324
325 \\