Zum Inhalt springen

Änderungen von Dokument NATS - Technisches Setup

Zuletzt geändert von Daniel Herrmann am 2025/12/14 16:20
Von Version Icon 11.1 Icon
bearbeitet von Daniel Herrmann
am 2025/09/20 10:00
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version Icon 9.1 Icon
bearbeitet von Daniel Herrmann
am 2025/09/10 09:08
Ä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 -= Grundlagen =
5 += {{id name="NATSSetup-Grundlagen"/}}Grundlagen =
6 6  
7 -== Übersicht ==
7 +== {{id name="NATSSetup-Übersicht"/}}Ü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 -== Accounts ==
15 +== {{id name="NATSSetup-Accounts"/}}Accounts ==
16 16  
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.
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 18  
19 -(% style="color:var(--ds-text,#333333); text-decoration:none" %)Wir verwenden zwei verschiedene Accounts:
19 +(% style="text-decoration: none;color:var(--ds-text,#333333);" %)Wir verwenden zwei verschiedene Accounts:
20 20  
21 -|=(((
21 +|=(% scope="col" %)(((
22 22  Account
23 -)))|=(((
23 +)))|=(% scope="col" %)(((
24 24  Berechtigungen
25 -)))|=(((
25 +)))|=(% scope="col" %)(((
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 -== Authentifizierung ==
45 +== {{id name="NATSSetup-Authentifizierung"/}}Authentifizierung ==
46 46  
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.
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 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}}
59 +{{code language="json"}}
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 -== NATS Core mit Accounts ==
86 +== {{id name="NATSSetup-NATSCoremitAccounts"/}}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}}
90 +{{code language="json"}}
91 91  accounts: {
92 92   MKSP: {
93 93   users: [
... ... @@ -103,11 +103,11 @@
103 103  
104 104  Wichtig sind hier die zusätzlichen Permissions, die den Zugriff auf Core Events regeln.
105 105  
106 -== JetStream Konfiguration ==
106 +== {{id name="NATSSetup-JetStreamKonfiguration"/}}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 -=== NATS CLI konfigurieren ===
110 +=== {{id name="NATSSetup-NATSCLIkonfigurieren"/}}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  
... ... @@ -123,7 +123,7 @@
123 123  nats context select mksp-jsadmin
124 124  {{/code}}
125 125  
126 -=== JetStream initialisieren ===
126 +=== {{id name="NATSSetup-JetStreaminitialisieren"/}}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,91 +136,83 @@
136 136  nats stream add backend_events --subjects "mksp.>" --retention work --max-age 7d --storage file --defaults
137 137  {{/code}}
138 138  
139 -=== JetStream Consumer ===
139 +=== {{id name="NATSSetup-JetStreamConsumer"/}}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 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 -|=(((
145 +|=(% scope="col" %)(((
146 146  Backend Event
147 -)))|=(((
147 +)))|=(% scope="col" %)(((
148 148  Consumer Name
149 -)))|=(((
149 +)))|=(% scope="col" %)(((
150 150  Schema
151 151  )))
152 152  |(((
153 -{{{mksp.backend.briefing.offer.cancelled}}}
154 -
155 -(((
156 -
157 -)))
153 +{{code language="none"}}
154 +mksp.backend.briefing.offer.cancelled
155 +{{/code}}
158 158  )))|(((
159 159  backend_briefing_offer_cancelled
160 160  )))|(((
161 -(% class="nc" %)##BriefingOfferEvent##
159 +##(% class="nc" %)BriefingOfferEvent(%%)##
162 162  )))
163 163  |(((
164 -{{{mksp.backend.briefing.offer.created}}}
165 -
166 -(((
167 -
168 -)))
162 +{{code language="none"}}
163 +mksp.backend.briefing.offer.created
164 +{{/code}}
169 169  )))|(((
170 170  backend_briefing_offer_created
171 171  )))|(((
172 -(% class="nc" %)##BriefingOfferEvent##
168 +##(% class="nc" %)BriefingOfferEvent(%%)##
173 173  )))
174 174  |(((
175 -{{{mksp.backend.briefing.offer.updated}}}
171 +##(% class="s" %)mksp.backend.briefing.offer.updated(%%)##
176 176  )))|(((
177 177  backend_briefing_offer_updated
178 178  )))|(((
179 -(% class="nc" %)##BriefingOfferEvent##
175 +##(% class="nc" %)BriefingOfferEvent(%%)##
180 180  )))
181 181  |(((
182 -{{{mksp.backend.briefing.created}}}
183 -
184 -(((
185 -
186 -)))
178 +{{code language="none"}}
179 +mksp.backend.briefing.created
180 +{{/code}}
187 187  )))|(((
188 188  backend_briefing_created
189 189  )))|(((
190 -(% class="n" %)##BriefingEvent##
184 +##(% class="n" %)BriefingEvent(%%)##
191 191  )))
192 192  |(((
193 -{{{mksp.backend.key.assigned}}}
187 +##(% class="s" %)mksp.backend.key.assigned(%%)##
194 194  )))|(((
195 195  backend_key_assigned
196 196  )))|(((
197 -(% class="nc" %)##KeyEvent##
191 +##(% class="nc" %)KeyEvent(%%)##
198 198  )))
199 199  |(((
200 -{{{mksp.backend.key.unassigned}}}
194 +##(% class="s" %)mksp.backend.key.unassigned(%%)##
201 201  )))|(((
202 202  backend_key_unassigned
203 203  )))|(((
204 -(% class="nc" %)##KeyEvent##
198 +##(% class="nc" %)KeyEvent(%%)##
205 205  )))
206 206  |(((
207 -{{{mksp.backend.storage.reserved}}}
201 +##(% class="s" %)mksp.backend.storage.reserved(%%)##
208 208  )))|(((
209 209  backend_storage_reserved
210 210  )))|(((
211 -(% class="nc" %)##StorageSpaceEvent##
205 +##(% class="nc" %)StorageSpaceEvent(%%)##
212 212  )))
213 213  |(((
214 -{{{
215 - }}}
208 +(% class="s" %){{code language="none"}}mksp.backend.storage.released{{/code}}
216 216  )))|(((
217 217  backend_storage_released
218 218  )))|(((
219 -(% class="nc" %)##StorageSpaceEvent##
212 +##(% class="nc" %)StorageSpaceEvent(%%)##
220 220  )))
221 221  |(((
222 -{{{
223 - }}}
215 +(% class="s" %){{code language="none"}}mksp.backend.storage.expired{{/code}}
224 224  )))|(((
225 225  backend_storage_expired
226 226  )))|(((
... ... @@ -227,8 +227,7 @@
227 227  (% class="nc" %){{code language="none"}}StorageSpaceEvent{{/code}}
228 228  )))
229 229  |(((
230 -{{{
231 - }}}
222 +(% class="s" %){{code language="none"}}mksp.backend.user.converted_to_member{{/code}}
232 232  )))|(((
233 233  backend_user_converted_to_member
234 234  )))|(((
... ... @@ -235,8 +235,7 @@
235 235  (% class="nc" %){{code language="none"}}UserEvent{{/code}}
236 236  )))
237 237  |(((
238 -{{{
239 - }}}
229 +(% class="s" %){{code language="none"}}mksp.backend.user.converted_to_guest{{/code}}
240 240  )))|(((
241 241  backend_user_converted_to_guest
242 242  )))|(((
... ... @@ -245,7 +245,7 @@
245 245  
246 246  Die Consumer können dann wie folgt angelegt werden:
247 247  
248 -{{code}}
238 +{{code language="json"}}
249 249  $ nats consumer add backend_events <name> --pull --filter="<filter>" --defaults
250 250  
251 251  # Beispiel
... ... @@ -289,7 +289,7 @@
289 289  
290 290  Die bestehenden Consumer kann man sich ebenfalls im Jetstream Context anzeigen lassen:
291 291  
292 -{{code}}
282 +{{code language="json"}}
293 293  $ nats consumer ls backend_events                       
294 294  ╭──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
295 295  │ Consumers │
... ... @@ -306,7 +306,7 @@
306 306  
307 307  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:
308 308  
309 -{{code}}
299 +{{code language="json"}}
310 310  $ nats consumer info backend_events backend_briefing_offer_cancelled
311 311  
312 312  Information for Consumer backend_events > backend_briefing_offer_cancelled created 2025-09-09 22:53:26
... ... @@ -374,15 +374,15 @@
374 374  
375 375  Der Name ist hierbei frei vergeben, in unserem Fall im Backend Code. Wir erwarten die folgenden Clients:
376 376  
377 -|=(((
367 +|=(% scope="col" %)(((
378 378  Client
379 -)))|=(((
369 +)))|=(% scope="col" %)(((
380 380  Anzahl
381 -)))|=(((
371 +)))|=(% scope="col" %)(((
382 382  Komponente
383 -)))|=(((
373 +)))|=(% scope="col" %)(((
384 384  Art
385 -)))|=(((
375 +)))|=(% scope="col" %)(((
386 386  Beschreibung
387 387  )))
388 388  |(((
... ... @@ -490,4 +490,4 @@
490 490   ]
491 491  {{/code}}
492 492  
493 -
483 +\\