Zum Inhalt springen

Änderungen von Dokument NATS - Technisches Setup

Zuletzt geändert von Daniel Herrmann am 2025/12/14 16:20
Von Version Icon 18.1 Icon
bearbeitet von Daniel Herrmann
am 2025/12/14 15:59
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version Icon 9.2 Icon
bearbeitet von Daniel Herrmann
am 2025/09/20 09:59
Ä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
... ... @@ -44,7 +44,7 @@
44 44  
45 45  == 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>>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
... ... @@ -114,7 +114,7 @@
114 114  {{code language="shell"}}
115 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 ds-hetzner.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:
... ... @@ -150,11 +150,9 @@
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,11 +161,9 @@
161 161  (% 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,7 +172,7 @@
172 172  (% 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,11 +179,9 @@
179 179  (% 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,7 +190,7 @@
190 190  (% 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,7 +197,7 @@
197 197  (% 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,7 +204,7 @@
204 204  (% 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,7 +211,7 @@
211 211  (% 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,7 +218,7 @@
218 218  (% 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,30 +232,12 @@
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.document.signed
246 -)))|docuseal_document_signed|(((
247 -SignatureEvent
248 -)))
249 -|(((
250 -mksp.docuseal.signature.expired
251 -)))| |(((
252 -SignatureEvent
253 -)))
254 -|(((
255 -mksp.docuseal.signature.completed
256 -)))| |(((
257 -SignatureEvent
258 -)))
259 259  
260 260  Die Consumer können dann wie folgt angelegt werden:
261 261  
... ... @@ -267,13 +267,13 @@
267 267  nats consumer add backend_events backend_key_assigned --pull --filter="mksp.backend.key.assigned" --defaults
268 268  {{/code}}
269 269  
270 -= Troubleshooting =
246 += {{id name="NATSSetup-Troubleshooting"/}}Troubleshooting =
271 271  
272 272  Man kann über die NATS CLI mit dem Server interagieren.
273 273  
274 -== JetStream ==
250 +== {{id name="NATSSetup-JetStream"/}}JetStream ==
275 275  
276 -=== Streams ===
252 +=== {{id name="NATSSetup-Streams"/}}Streams ===
277 277  
278 278  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.
279 279  
... ... @@ -299,11 +299,11 @@
299 299  {"timestamp":"2025-09-08T09:06:00.062358","stora
300 300  {{/code}}
301 301  
302 -=== Consumer ===
278 +=== {{id name="NATSSetup-Consumer"/}}Consumer ===
303 303  
304 304  Die bestehenden Consumer kann man sich ebenfalls im Jetstream Context anzeigen lassen:
305 305  
306 -{{code}}
282 +{{code language="json"}}
307 307  $ nats consumer ls backend_events                       
308 308  ╭──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
309 309  │ Consumers │
... ... @@ -320,7 +320,7 @@
320 320  
321 321  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:
322 322  
323 -{{code}}
299 +{{code language="json"}}
324 324  $ nats consumer info backend_events backend_briefing_offer_cancelled
325 325  
326 326  Information for Consumer backend_events > backend_briefing_offer_cancelled created 2025-09-09 22:53:26
... ... @@ -354,7 +354,7 @@
354 354  * **Unprocessed Messages** sind Nachrichten, die noch nicht abgerufen wurden. Dies sollte immer 0 sein
355 355  * **Waiting Pulls**: die Anzahl der verbundenen Clients. Üblicherweise sollte das nur n8n sein, also immer 1.
356 356  
357 -== Server ==
333 +== {{id name="NATSSetup-Server"/}}Server ==
358 358  
359 359  Man kann sich ebenfalls die aktiven Verbindungen anzeigen:
360 360  
... ... @@ -388,15 +388,15 @@
388 388  
389 389  Der Name ist hierbei frei vergeben, in unserem Fall im Backend Code. Wir erwarten die folgenden Clients:
390 390  
391 -|=(((
367 +|=(% scope="col" %)(((
392 392  Client
393 -)))|=(((
369 +)))|=(% scope="col" %)(((
394 394  Anzahl
395 -)))|=(((
371 +)))|=(% scope="col" %)(((
396 396  Komponente
397 -)))|=(((
373 +)))|=(% scope="col" %)(((
398 398  Art
399 -)))|=(((
375 +)))|=(% scope="col" %)(((
400 400  Beschreibung
401 401  )))
402 402  |(((
... ... @@ -504,4 +504,4 @@
504 504   ]
505 505  {{/code}}
506 506  
507 -
483 +\\