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 21.1
bearbeitet von Daniel Herrmann
am 2025/12/14 16:20
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Icon Seiteneigenschaften
Titel
... ... @@ -1,1 +1,1 @@
1 -NATS Setup
1 +NATS - Technisches Setup
Übergeordnete Seite
... ... @@ -1,0 +1,1 @@
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.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>>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.
48 48  
49 49  {{code language="shell"}}
50 50  $ openssl x509 -noout -text -nameopt RFC2253 -in backend.mksp-da.de.crt
... ... @@ -112,9 +112,9 @@
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 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
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
116 116  
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
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
118 118  {{/code}}
119 119  
120 120  Anschließend wählen wir den richtigen Kontext aus, in diesem Fall den JetStream Admin Context:
... ... @@ -150,7 +150,7 @@
150 150  Schema
151 151  )))
152 152  |(((
153 -{{{mksp.backend.briefing.offer.cancelled}}}
153 +mksp.backend.briefing.offer.cancelled
154 154  
155 155  (((
156 156  
... ... @@ -161,7 +161,7 @@
161 161  (% class="nc" %)##BriefingOfferEvent##
162 162  )))
163 163  |(((
164 -{{{mksp.backend.briefing.offer.created}}}
164 +mksp.backend.briefing.offer.created
165 165  
166 166  (((
167 167  
... ... @@ -172,7 +172,7 @@
172 172  (% class="nc" %)##BriefingOfferEvent##
173 173  )))
174 174  |(((
175 -{{{mksp.backend.briefing.offer.updated}}}
175 +mksp.backend.briefing.offer.updated
176 176  )))|(((
177 177  backend_briefing_offer_updated
178 178  )))|(((
... ... @@ -179,7 +179,7 @@
179 179  (% class="nc" %)##BriefingOfferEvent##
180 180  )))
181 181  |(((
182 -{{{mksp.backend.briefing.created}}}
182 +mksp.backend.briefing.created
183 183  
184 184  (((
185 185  
... ... @@ -190,7 +190,7 @@
190 190  (% class="n" %)##BriefingEvent##
191 191  )))
192 192  |(((
193 -{{{mksp.backend.key.assigned}}}
193 +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}}}
200 +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}}}
207 +mksp.backend.storage.reserved
208 208  )))|(((
209 209  backend_storage_reserved
210 210  )))|(((
... ... @@ -211,8 +211,7 @@
211 211  (% class="nc" %)##StorageSpaceEvent##
212 212  )))
213 213  |(((
214 -{{{
215 - }}}
214 +mksp.backend.storage.released
216 216  )))|(((
217 217  backend_storage_released
218 218  )))|(((
... ... @@ -219,8 +219,7 @@
219 219  (% class="nc" %)##StorageSpaceEvent##
220 220  )))
221 221  |(((
222 -{{{
223 - }}}
221 +mksp.backend.storage.expired
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 - }}}
228 +mksp.backend.user.converted_to_member
232 232  )))|(((
233 233  backend_user_converted_to_member
234 234  )))|(((
... ... @@ -235,13 +235,25 @@
235 235  (% class="nc" %){{code language="none"}}UserEvent{{/code}}
236 236  )))
237 237  |(((
238 -{{{
239 - }}}
235 +mksp.backend.user.converted_to_guest
240 240  )))|(((
241 241  backend_user_converted_to_guest
242 242  )))|(((
243 243  (% class="nc" %){{code language="none"}}UserEvent{{/code}}
244 244  )))
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 +)))
245 245  
246 246  Die Consumer können dann wie folgt angelegt werden:
247 247  
... ... @@ -253,13 +253,13 @@
253 253  nats consumer add backend_events backend_key_assigned --pull --filter="mksp.backend.key.assigned" --defaults
254 254  {{/code}}
255 255  
256 -= {{id name="NATSSetup-Troubleshooting"/}}Troubleshooting =
265 += Troubleshooting =
257 257  
258 258  Man kann über die NATS CLI mit dem Server interagieren.
259 259  
260 -== {{id name="NATSSetup-JetStream"/}}JetStream ==
269 +== JetStream ==
261 261  
262 -=== {{id name="NATSSetup-Streams"/}}Streams ===
271 +=== Streams ===
263 263  
264 264  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.
265 265  
... ... @@ -285,7 +285,7 @@
285 285  {"timestamp":"2025-09-08T09:06:00.062358","stora
286 286  {{/code}}
287 287  
288 -=== {{id name="NATSSetup-Consumer"/}}Consumer ===
297 +=== Consumer ===
289 289  
290 290  Die bestehenden Consumer kann man sich ebenfalls im Jetstream Context anzeigen lassen:
291 291  
... ... @@ -340,7 +340,7 @@
340 340  * **Unprocessed Messages** sind Nachrichten, die noch nicht abgerufen wurden. Dies sollte immer 0 sein
341 341  * **Waiting Pulls**: die Anzahl der verbundenen Clients. Üblicherweise sollte das nur n8n sein, also immer 1.
342 342  
343 -== {{id name="NATSSetup-Server"/}}Server ==
352 +== Server ==
344 344  
345 345  Man kann sich ebenfalls die aktiven Verbindungen anzeigen:
346 346