Zum Inhalt springen

Wiki-Quellcode von NATS Setup

Version 4.1 von Daniel Herrmann am 2025/09/08 18:03
Verstecke letzte Bearbeiter
Daniel Herrmann 1.1 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
Daniel Herrmann 4.1 5 = {{id name="NATSSetup-Grundlagen"/}}Grundlagen =
Daniel Herrmann 1.1 6
Daniel Herrmann 4.1 7 == {{id name="NATSSetup-Übersicht"/}}Übersicht ==
8
Daniel Herrmann 1.1 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
Daniel Herrmann 2.1 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.
Daniel Herrmann 1.1 14
Daniel Herrmann 4.1 15 == {{id name="NATSSetup-Accounts"/}}Accounts ==
Daniel Herrmann 1.1 16
Daniel Herrmann 4.1 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-JetStreamKonfiguration"/}}JetStream Konfiguration ==
87
Daniel Herrmann 1.1 88 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.
89
90 === {{id name="NATSSetup-NATSCLIkonfigurieren"/}}NATS CLI konfigurieren ===
91
Daniel Herrmann 4.1 92 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:
Daniel Herrmann 1.1 93
94 {{code language="shell"}}
95 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
96
97 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
Daniel Herrmann 4.1 98 {{/code}}
Daniel Herrmann 1.1 99
Daniel Herrmann 4.1 100 Anschließend wählen wir den richtigen Kontext aus, in diesem Fall den JetStream Admin Context:
101
102 {{code language="shell"}}
Daniel Herrmann 1.1 103 nats context select mksp-jsadmin
104 {{/code}}
105
106 === {{id name="NATSSetup-JetStreaminitialisieren"/}}JetStream initialisieren ===
107
108 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:
109
110 * JetStream im Allgemeinen: [[https:~~/~~/docs.nats.io/nats-concepts/jetstream>>url:https://docs.nats.io/nats-concepts/jetstream||shape="rect"]]
111 * JetStream Streams: [[https:~~/~~/docs.nats.io/nats-concepts/jetstream/streams>>url:https://docs.nats.io/nats-concepts/jetstream/streams||shape="rect"]]
112
113 Wir legen nun also ein Stream namens **backend_events** an:
114
115 {{code language="shell"}}
116 nats stream add backend_events --subjects "mksp.>" --retention work --max-age 7d --storage file --defaults
117 {{/code}}
118
119 === {{id name="NATSSetup-JetStreamConsumer"/}}JetStream Consumer ===
120
121 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"]]
122
123 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.
Daniel Herrmann 2.1 124
125 = {{id name="NATSSetup-Troubleshooting"/}}Troubleshooting =
126
Daniel Herrmann 4.1 127 Man kann über die NATS CLI mit dem Server interagieren.
Daniel Herrmann 2.1 128
Daniel Herrmann 4.1 129 == {{id name="NATSSetup-JetStream"/}}JetStream ==
130
131 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.
132
Daniel Herrmann 2.1 133 {{code language="shell"}}
134 $ nats context select mksp-jsadmin
135 $ nats stream ls
136 ╭─────────────────────────────────────────────────────────────────────────────────────╮
137 │ Streams │
138 ├────────────────┬─────────────┬─────────────────────┬──────────┬──────┬──────────────┤
139 │ Name │ Description │ Created │ Messages │ Size │ Last Message │
140 ├────────────────┼─────────────┼─────────────────────┼──────────┼──────┼──────────────┤
141 │ backend_events │ │ 2025-09-08 08:36:19 │ 0 │ 0 B │ never │
Daniel Herrmann 3.1 142 ╰────────────────┴─────────────┴─────────────────────┴──────────┴──────┴──────────────╯
Daniel Herrmann 2.1 143 {{/code}}
144
Daniel Herrmann 4.1 145 Ebenso kann man sich - falls vorhandenen - die Nachrichten im Stream anzeigen lassen:
Daniel Herrmann 2.1 146
147 {{code language="shell"}}
Daniel Herrmann 4.1 148 $ nats context select mksp-jsadmin
149 $ nats stream view backend_events
150 [1] Subject: mksp.backend.storage.reserved Received: 2025-09-08 09:06:00
151
152 {"timestamp":"2025-09-08T09:06:00.062358","stora
153 {{/code}}
154
155 == {{id name="NATSSetup-Server"/}}Server ==
156
157 Man kann sich ebenfalls die aktiven Verbindungen anzeigen:
158
159 {{code language="shell"}}
Daniel Herrmann 2.1 160 $ nats context select mksp-sysadmin
Daniel Herrmann 4.1 161 $ nats server report connections   
Daniel Herrmann 2.1 162
Daniel Herrmann 4.1 163 ╭─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
164 │ Top 6 Connections out of 6 by subs │
165 ├─────┬──────────────────────────┬──────────────┬─────────┬───────────────────┬─────────┬──────────┬─────────┬──────────┬──────────┬───────────┬──────┤
166 │ CID │ Name │ Server │ Cluster │ IP │ Account │ Uptime │ In Msgs │ Out Msgs │ In Bytes │ Out Bytes │ Subs │
167 ├─────┼──────────────────────────┼──────────────┼─────────┼───────────────────┼─────────┼──────────┼─────────┼──────────┼──────────┼───────────┼──────┤
168 │ 83 │ backend_kiqer │ mksp-nats-01 │ │ 172.18.0.33:52808 │ MKSP │ 2h24m18s │ 0 │ 0 │ 0 B │ 0 B │ 0 │
169 │ 93 │ backend_scheduler │ mksp-nats-01 │ │ 172.18.0.29:47620 │ MKSP │ 2h23m23s │ 0 │ 0 │ 0 B │ 0 B │ 0 │
170 │ 82 │ backend_fastapi │ mksp-nats-01 │ │ 172.18.0.33:52798 │ MKSP │ 2h24m18s │ 1 │ 1 │ 345 B │ 838 B │ 1 │
171 │ 94 │ backend_worker │ mksp-nats-01 │ │ 172.18.0.37:53550 │ MKSP │ 2h23m23s │ 0 │ 0 │ 0 B │ 0 B │ 1 │
172 │ 95 │ backend_worker │ mksp-nats-01 │ │ 172.18.0.37:53554 │ MKSP │ 2h23m23s │ 0 │ 0 │ 0 B │ 0 B │ 1 │
173 │ 111 │ NATS CLI Version 0.2.4 │ mksp-nats-01 │ │ 10.1.253.1:50712 │ SYS │ 0s │ 2 │ 1 │ 210 B │ 944 B │ 1 │
174 ├─────┼──────────────────────────┼──────────────┼─────────┼───────────────────┼─────────┼──────────┼─────────┼──────────┼──────────┼───────────┼──────┤
175 │ │ Totals for 6 connections │ │ │ │ │ │ 3 │ 2 │ 555 B │ 1.7 KiB │ 4 │
176 ╰─────┴──────────────────────────┴──────────────┴─────────┴───────────────────┴─────────┴──────────┴─────────┴──────────┴──────────┴───────────┴──────╯
Daniel Herrmann 2.1 177
178 ╭──────────────────────────────────────╮
179 │ Connections per server │
180 ├──────────────┬─────────┬─────────────┤
181 │ Server │ Cluster │ Connections │
182 ├──────────────┼─────────┼─────────────┤
Daniel Herrmann 4.1 183 │ mksp-nats-01 │ │ 6 │
Daniel Herrmann 2.1 184 ╰──────────────┴─────────┴─────────────╯
185 {{/code}}
186
Daniel Herrmann 4.1 187 Der Name ist hierbei frei vergeben, in unserem Fall im Backend Code. Wir erwarten die folgenden Clients:
188
189 |=(% scope="col" %)(((
190 Client
191 )))|=(% scope="col" %)(((
192 Anzahl
193 )))|=(% scope="col" %)(((
194 Komponente
195 )))|=(% scope="col" %)(((
196 Art
197 )))|=(% scope="col" %)(((
198 Beschreibung
199 )))
200 |(((
201 backend_kiqer
202 )))|(((
203 1
204 )))|(((
205 Taskiq
206 )))|(((
207 Core
208 )))|(((
209 Gibt dem Backend die Möglichkeit, asynchrone Tasks an das Taskiq backend zu delegieren
210 )))
211 |(((
212 backend_scheduler
213 )))|(((
214 1
215 )))|(((
216 Taskiq
217 )))|(((
218 Core
219 )))|(((
220 Komponente welches die regelmäßigen Jobs überwacht und triggert
221 )))
222 |(((
223 backend_fastapi
224 )))|(((
225 1
226 )))|(((
227 FastAPI
228 )))|(((
229 JetStream
230 )))|(((
231 Das Backend kann hiermit Events ausgeben, die dann von N8n abgearbeitet werden.
232 )))
233 |(((
234 backend_worker
235 )))|(((
236 2
237 )))|(((
238 Taskiq
239 )))|(((
240 Core
241 )))|(((
242 Worker für asynchrone Tasks
243 )))
244
245 Man kann sich ebenfalls die Subscriptions der jeweiligen Connections anschauen. Hierfür muss die Ausgabe auf JSON umgestellt werden:
246
247 {{code language="shell"}}
248 $ nats context select mksp-jsadmin
249 $ nats server report connections -j
250 [
251 {
252 "cid": 95,
253 "kind": "Client",
254 "type": "nats",
255 "ip": "172.18.0.37",
256 "port": 53554,
257 "start": "2025-09-08T13:35:37.398441269Z",
258 "last_activity": "2025-09-08T13:35:37.434868631Z",
259 "rtt": "479µs",
260 "uptime": "2h27m5s",
261 "idle": "2h27m5s",
262 "pending_bytes": 0,
263 "in_msgs": 0,
264 "out_msgs": 0,
265 "in_bytes": 0,
266 "out_bytes": 0,
267 "subscriptions": 1,
268 "name": "backend_worker",
269 "lang": "python3",
270 "version": "2.11.0",
271 "tls_version": "1.3",
272 "tls_cipher_suite": "TLS_AES_128_GCM_SHA256",
273 "tls_peer_certs": [
274 {
275 "subject": "CN=backend.mksp-da.de,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE",
276 "spki_sha256": "1c7826ac936267622a5bfec0359304e795a4fd552b4d76556d7fcbddf51f43fb",
277 "cert_sha256": "e25dd3084b13f5f3cb81ebb9291627bcd0a25ab51325f1cc627a2b758f03d1ca"
278 },
279 {
280 "subject": "CN=MKSP NATS Issuing CA,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE",
281 "spki_sha256": "af16c3490475a4ba65d273b7dae825622b4c1eeca5f3da808df14b3c298627a7",
282 "cert_sha256": "10ccebe5826128f50f7b007537fa8b832326d4bb14b1676588abac9a10bf7585"
283 }
284 ],
285 "authorized_user": "CN=backend.mksp-da.de,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE",
286 "account": "MKSP",
287 "subscriptions_list": [
288 "taskiq_tasks"
289 ],
290 "name_tag": "MKSP",
291 "server": {
292 "name": "mksp-nats-01",
293 "host": "0.0.0.0",
294 "id": "NDH7ZAPFJ5EORJKZDJGOUNN3NDMTLWR6V7BGBOYUIG5UE7VEIK76F6WH",
295 "ver": "2.11.6",
296 "jetstream": true,
297 "flags": 7,
298 "seq": 2937,
299 "time": "2025-09-08T16:02:42.888686229Z"
300 }
301 },
302 ]
303 {{/code}}
304
Daniel Herrmann 2.1 305 \\