Zum Inhalt springen

Änderungen von Dokument NATS - Technisches Setup

Zuletzt geändert von Daniel Herrmann am 2025/12/14 16:20
Von Version Icon 5.1 Icon
bearbeitet von Daniel Herrmann
am 2025/09/08 22:10
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version Icon 12.1 Icon
bearbeitet von Daniel Herrmann
am 2025/09/20 10:34
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Icon Seiteneigenschaften
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.Kubernetes Cluster.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,31 @@
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-JetStreamKonfiguration"/}}JetStream Konfiguration ==
86 +== NATS Core mit Accounts ==
87 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}}
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 +== JetStream Konfiguration ==
107 +
88 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 89  
90 -=== {{id name="NATSSetup-NATSCLIkonfigurieren"/}}NATS CLI konfigurieren ===
110 +=== NATS CLI konfigurieren ===
91 91  
92 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:
93 93  
... ... @@ -103,7 +103,7 @@
103 103  nats context select mksp-jsadmin
104 104  {{/code}}
105 105  
106 -=== {{id name="NATSSetup-JetStreaminitialisieren"/}}JetStream initialisieren ===
126 +=== JetStream initialisieren ===
107 107  
108 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 109  
... ... @@ -116,12 +116,124 @@
116 116  nats stream add backend_events --subjects "mksp.>" --retention work --max-age 7d --storage file --defaults
117 117  {{/code}}
118 118  
119 -=== {{id name="NATSSetup-JetStreamConsumer"/}}JetStream Consumer ===
139 +=== JetStream Consumer ===
120 120  
121 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 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.
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.
124 124  
145 +|=(((
146 +Backend Event
147 +)))|=(((
148 +Consumer Name
149 +)))|=(((
150 +Schema
151 +)))
152 +|(((
153 +{{{mksp.backend.briefing.offer.cancelled}}}
154 +
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.docuseal.document.signed
243 +)))|docuseal_document_signed|(((
244 +SignatureEvent
245 +)))
246 +
247 +Die Consumer können dann wie folgt angelegt werden:
248 +
249 +{{code}}
250 +$ nats consumer add backend_events <name> --pull --filter="<filter>" --defaults
251 +
252 +# Beispiel
253 +nats consumer add backend_events backend_briefing_offer_cancelled --pull --filter="mksp.backend.briefing.offer.cancelled" --defaults
254 +nats consumer add backend_events backend_key_assigned --pull --filter="mksp.backend.key.assigned" --defaults
255 +{{/code}}
256 +
125 125  = {{id name="NATSSetup-Troubleshooting"/}}Troubleshooting =
126 126  
127 127  Man kann über die NATS CLI mit dem Server interagieren.
... ... @@ -128,6 +128,8 @@
128 128  
129 129  == {{id name="NATSSetup-JetStream"/}}JetStream ==
130 130  
263 +=== {{id name="NATSSetup-Streams"/}}Streams ===
264 +
131 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 132  
133 133  {{code language="shell"}}
... ... @@ -152,6 +152,61 @@
152 152  {"timestamp":"2025-09-08T09:06:00.062358","stora
153 153  {{/code}}
154 154  
289 +=== {{id name="NATSSetup-Consumer"/}}Consumer ===
290 +
291 +Die bestehenden Consumer kann man sich ebenfalls im Jetstream Context anzeigen lassen:
292 +
293 +{{code}}
294 +$ nats consumer ls backend_events                       
295 +╭──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
296 +│ Consumers │
297 +├──────────────────────────────────┬─────────────┬─────────────────────┬─────────────┬─────────────┬───────────────┤
298 +│ Name │ Description │ Created │ Ack Pending │ Unprocessed │ Last Delivery │
299 +├──────────────────────────────────┼─────────────┼─────────────────────┼─────────────┼─────────────┼───────────────┤
300 +│ backend_briefing_created │ │ 2025-09-10 08:30:12 │ 0 │ 12 │ never │
301 +│ backend_briefing_offer_cancelled │ │ 2025-09-10 08:21:02 │ 0 │ 0 │ never │
302 +│ backend_briefing_offer_created │ │ 2025-09-10 08:28:25 │ 0 │ 0 │ never │
303 +│ backend_briefing_offer_updated │ │ 2025-09-10 08:29:19 │ 0 │ 0 │ never │
304 +│ backend_key_assigned │ │ 2025-09-10 08:21:04 │ 0 │ 0 │ never │
305 +╰──────────────────────────────────┴─────────────┴─────────────────────┴─────────────┴─────────────┴───────────────╯
306 +{{/code}}
307 +
308 +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:
309 +
310 +{{code}}
311 +$ nats consumer info backend_events backend_briefing_offer_cancelled
312 +
313 +Information for Consumer backend_events > backend_briefing_offer_cancelled created 2025-09-09 22:53:26
314 +
315 +Configuration:
316 +
317 + Name: backend_briefing_offer_cancelled
318 + Pull Mode: true
319 + Filter Subject: mksp.backend.briefing.offer.cancelled
320 + Deliver Policy: All
321 + Ack Policy: Explicit
322 + Ack Wait: 30.00s
323 + Replay Policy: Instant
324 + Max Ack Pending: 1,000
325 + Max Waiting Pulls: 512
326 +
327 +State:
328 +
329 + Host Version: 2.11.8
330 + Required API Level: 0 hosted at level 1
331 + Last Delivered Message: Consumer sequence: 0 Stream sequence: 10
332 + Acknowledgment Floor: Consumer sequence: 0 Stream sequence: 0
333 + Outstanding Acks: 0 out of maximum 1,000
334 + Redelivered Messages: 0
335 + Unprocessed Messages: 0
336 + Waiting Pulls: 1 of maximum 512
337 +{{/code}}
338 +
339 +Insbesondere die letzten beiden Zeilen sind wichtig:
340 +
341 +* **Unprocessed Messages** sind Nachrichten, die noch nicht abgerufen wurden. Dies sollte immer 0 sein
342 +* **Waiting Pulls**: die Anzahl der verbundenen Clients. Üblicherweise sollte das nur n8n sein, also immer 1.
343 +
155 155  == {{id name="NATSSetup-Server"/}}Server ==
156 156  
157 157  Man kann sich ebenfalls die aktiven Verbindungen anzeigen:
... ... @@ -165,7 +165,7 @@
165 165  ├─────┬──────────────────────────┬──────────────┬─────────┬───────────────────┬─────────┬──────────┬─────────┬──────────┬──────────┬───────────┬──────┤
166 166  │ CID │ Name │ Server │ Cluster │ IP │ Account │ Uptime │ In Msgs │ Out Msgs │ In Bytes │ Out Bytes │ Subs │
167 167  ├─────┼──────────────────────────┼──────────────┼─────────┼───────────────────┼─────────┼──────────┼─────────┼──────────┼──────────┼───────────┼──────┤
168 -│ 83 │ backend_kiqer │ mksp-nats-01 │ │ 172.18.0.33:52808 │ MKSP │ 2h24m18s │ 0 │ 0 │ 0 B │ 0 B │ 0 │
357 +│ 83 │ backend_kicker │ mksp-nats-01 │ │ 172.18.0.33:52808 │ MKSP │ 2h24m18s │ 0 │ 0 │ 0 B │ 0 B │ 0 │
169 169  │ 93 │ backend_scheduler │ mksp-nats-01 │ │ 172.18.0.29:47620 │ MKSP │ 2h23m23s │ 0 │ 0 │ 0 B │ 0 B │ 0 │
170 170  │ 82 │ backend_fastapi │ mksp-nats-01 │ │ 172.18.0.33:52798 │ MKSP │ 2h24m18s │ 1 │ 1 │ 345 B │ 838 B │ 1 │
171 171  │ 94 │ backend_worker │ mksp-nats-01 │ │ 172.18.0.37:53550 │ MKSP │ 2h23m23s │ 0 │ 0 │ 0 B │ 0 B │ 1 │
... ... @@ -186,15 +186,15 @@
186 186  
187 187  Der Name ist hierbei frei vergeben, in unserem Fall im Backend Code. Wir erwarten die folgenden Clients:
188 188  
189 -|=(% scope="col" %)(((
378 +|=(((
190 190  Client
191 -)))|=(% scope="col" %)(((
380 +)))|=(((
192 192  Anzahl
193 -)))|=(% scope="col" %)(((
382 +)))|=(((
194 194  Komponente
195 -)))|=(% scope="col" %)(((
384 +)))|=(((
196 196  Art
197 -)))|=(% scope="col" %)(((
386 +)))|=(((
198 198  Beschreibung
199 199  )))
200 200  |(((
... ... @@ -302,4 +302,4 @@
302 302   ]
303 303  {{/code}}
304 304  
305 -\\
494 +
Icon Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -207814669
1 +207814660
URL
... ... @@ -1,1 +1,1 @@
1 -https://wiki.makerspace-darmstadt.de/spaces/PROJ/pages/207814669/NATS Setup
1 +https://wiki.makerspace-darmstadt.de/spaces/PROJ/pages/207814660/NATS Setup