Zum Inhalt springen

Änderungen von Dokument NATS - Technisches Setup

Zuletzt geändert von Daniel Herrmann am 2025/12/14 16:20
Von Version Icon 21.1
bearbeitet von Daniel Herrmann
am 2025/12/14 16:20
Ä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
Titel
... ... @@ -1,1 +1,1 @@
1 -NATS - Technisches Setup
1 +NATS Setup
Übergeordnete Seite
... ... @@ -1,1 +1,0 @@
1 -PROJ.Digitale Mitgliederverwaltung.Technische Dokumentation.WebHome
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.Services.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,18 +103,18 @@
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  
114 114  {{code language="shell"}}
115 -nats context add mksp-sysadmin --server nats.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
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 116  
117 -nats context add mksp-jsadmin --server nats.mksp-da.de:4222 --description "MKSP NATS JetStream" --tlscert /path/to/js-admin.mksp-da.de.crt --tlskey /path/to/js-admin.mksp-da.de.key --tlsca /path/to/mksp_root_x1_ca.crt
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 118  {{/code}}
119 119  
120 120  Anschließend wählen wir den richtigen Kontext aus, in diesem Fall den JetStream Admin Context:
... ... @@ -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,89 +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 +{{code language="none"}}
153 153  mksp.backend.briefing.offer.cancelled
154 -
155 -(((
156 -
157 -)))
155 +{{/code}}
158 158  )))|(((
159 159  backend_briefing_offer_cancelled
160 160  )))|(((
161 -(% class="nc" %)##BriefingOfferEvent##
159 +##(% class="nc" %)BriefingOfferEvent(%%)##
162 162  )))
163 163  |(((
162 +{{code language="none"}}
164 164  mksp.backend.briefing.offer.created
165 -
166 -(((
167 -
168 -)))
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  |(((
178 +{{code language="none"}}
182 182  mksp.backend.briefing.created
183 -
184 -(((
185 -
186 -)))
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 -mksp.backend.storage.released
208 +(% class="s" %){{code language="none"}}mksp.backend.storage.released{{/code}}
215 215  )))|(((
216 216  backend_storage_released
217 217  )))|(((
218 -(% class="nc" %)##StorageSpaceEvent##
212 +##(% class="nc" %)StorageSpaceEvent(%%)##
219 219  )))
220 220  |(((
221 -mksp.backend.storage.expired
215 +(% class="s" %){{code language="none"}}mksp.backend.storage.expired{{/code}}
222 222  )))|(((
223 223  backend_storage_expired
224 224  )))|(((
... ... @@ -225,7 +225,7 @@
225 225  (% class="nc" %){{code language="none"}}StorageSpaceEvent{{/code}}
226 226  )))
227 227  |(((
228 -mksp.backend.user.converted_to_member
222 +(% class="s" %){{code language="none"}}mksp.backend.user.converted_to_member{{/code}}
229 229  )))|(((
230 230  backend_user_converted_to_member
231 231  )))|(((
... ... @@ -232,29 +232,16 @@
232 232  (% class="nc" %){{code language="none"}}UserEvent{{/code}}
233 233  )))
234 234  |(((
235 -mksp.backend.user.converted_to_guest
229 +(% class="s" %){{code language="none"}}mksp.backend.user.converted_to_guest{{/code}}
236 236  )))|(((
237 237  backend_user_converted_to_guest
238 238  )))|(((
239 239  (% class="nc" %){{code language="none"}}UserEvent{{/code}}
240 240  )))
241 -|(((
242 -mksp.backend.user.created
243 -)))|backend_user_created|UserEvent
244 -|(((
245 -mksp.docuseal.signature.expired
246 -)))|docuseal_signature_expired|(((
247 -SignatureEvent
248 -)))
249 -|(((
250 -mksp.docuseal.signature.completed
251 -)))|docuseal_signature_completed|(((
252 -SignatureEvent
253 -)))
254 254  
255 255  Die Consumer können dann wie folgt angelegt werden:
256 256  
257 -{{code}}
238 +{{code language="json"}}
258 258  $ nats consumer add backend_events <name> --pull --filter="<filter>" --defaults
259 259  
260 260  # Beispiel
... ... @@ -262,13 +262,13 @@
262 262  nats consumer add backend_events backend_key_assigned --pull --filter="mksp.backend.key.assigned" --defaults
263 263  {{/code}}
264 264  
265 -= Troubleshooting =
246 += {{id name="NATSSetup-Troubleshooting"/}}Troubleshooting =
266 266  
267 267  Man kann über die NATS CLI mit dem Server interagieren.
268 268  
269 -== JetStream ==
250 +== {{id name="NATSSetup-JetStream"/}}JetStream ==
270 270  
271 -=== Streams ===
252 +=== {{id name="NATSSetup-Streams"/}}Streams ===
272 272  
273 273  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.
274 274  
... ... @@ -294,11 +294,11 @@
294 294  {"timestamp":"2025-09-08T09:06:00.062358","stora
295 295  {{/code}}
296 296  
297 -=== Consumer ===
278 +=== {{id name="NATSSetup-Consumer"/}}Consumer ===
298 298  
299 299  Die bestehenden Consumer kann man sich ebenfalls im Jetstream Context anzeigen lassen:
300 300  
301 -{{code}}
282 +{{code language="json"}}
302 302  $ nats consumer ls backend_events                       
303 303  ╭──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
304 304  │ Consumers │
... ... @@ -315,7 +315,7 @@
315 315  
316 316  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:
317 317  
318 -{{code}}
299 +{{code language="json"}}
319 319  $ nats consumer info backend_events backend_briefing_offer_cancelled
320 320  
321 321  Information for Consumer backend_events > backend_briefing_offer_cancelled created 2025-09-09 22:53:26
... ... @@ -349,7 +349,7 @@
349 349  * **Unprocessed Messages** sind Nachrichten, die noch nicht abgerufen wurden. Dies sollte immer 0 sein
350 350  * **Waiting Pulls**: die Anzahl der verbundenen Clients. Üblicherweise sollte das nur n8n sein, also immer 1.
351 351  
352 -== Server ==
333 +== {{id name="NATSSetup-Server"/}}Server ==
353 353  
354 354  Man kann sich ebenfalls die aktiven Verbindungen anzeigen:
355 355  
... ... @@ -383,15 +383,15 @@
383 383  
384 384  Der Name ist hierbei frei vergeben, in unserem Fall im Backend Code. Wir erwarten die folgenden Clients:
385 385  
386 -|=(((
367 +|=(% scope="col" %)(((
387 387  Client
388 -)))|=(((
369 +)))|=(% scope="col" %)(((
389 389  Anzahl
390 -)))|=(((
371 +)))|=(% scope="col" %)(((
391 391  Komponente
392 -)))|=(((
373 +)))|=(% scope="col" %)(((
393 393  Art
394 -)))|=(((
375 +)))|=(% scope="col" %)(((
395 395  Beschreibung
396 396  )))
397 397  |(((
... ... @@ -499,4 +499,4 @@
499 499   ]
500 500  {{/code}}
501 501  
502 -
483 +\\