Änderungen von Dokument NATS - Technisches Setup

Zusammenfassung

• Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)

Details

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,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		-== {{id name="NATSSetup-NATSCoremitAccounts"/}}NATS Core mit Accounts ==
	86	+== 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 language="json"}}
	90	+{{code}}
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		-== {{id name="NATSSetup-JetStreamKonfiguration"/}}JetStream Konfiguration ==
	106	+== 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		-=== {{id name="NATSSetup-NATSCLIkonfigurieren"/}}NATS CLI konfigurieren ===
	110	+=== 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		-=== {{id name="NATSSetup-JetStreaminitialisieren"/}}JetStream initialisieren ===
	126	+=== 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,83 +136,91 @@
136	136	nats stream add backend_events --subjects "mksp.>" --retention work --max-age 7d --storage file --defaults
137	137	{{/code}}
138	138
139		-=== {{id name="NATSSetup-JetStreamConsumer"/}}JetStream Consumer ===
	139	+=== 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		-|=(% scope="col" %)(((
	145	+|=(((
146	146	Backend Event
147		-)))|=(% scope="col" %)(((
	147	+)))|=(((
148	148	Consumer Name
149		-)))|=(% scope="col" %)(((
	149	+)))|=(((
150	150	Schema
151	151	)))
152	152	|(((
153		-{{code language="none"}}
154		-mksp.backend.briefing.offer.cancelled
155		-{{/code}}
	153	+{{{mksp.backend.briefing.offer.cancelled}}}
	154	+
	155	+(((
	156	+
	157	+)))
156	156	)))|(((
157	157	backend_briefing_offer_cancelled
158	158	)))|(((
159		-##(% class="nc" %)BriefingOfferEvent(%%)##
	161	+(% class="nc" %)##BriefingOfferEvent##
160	160	)))
161	161	|(((
162		-{{code language="none"}}
163		-mksp.backend.briefing.offer.created
164		-{{/code}}
	164	+{{{mksp.backend.briefing.offer.created}}}
	165	+
	166	+(((
	167	+
	168	+)))
165	165	)))|(((
166	166	backend_briefing_offer_created
167	167	)))|(((
168		-##(% class="nc" %)BriefingOfferEvent(%%)##
	172	+(% class="nc" %)##BriefingOfferEvent##
169	169	)))
170	170	|(((
171		-##(% class="s" %)mksp.backend.briefing.offer.updated(%%)##
	175	+{{{mksp.backend.briefing.offer.updated}}}
172	172	)))|(((
173	173	backend_briefing_offer_updated
174	174	)))|(((
175		-##(% class="nc" %)BriefingOfferEvent(%%)##
	179	+(% class="nc" %)##BriefingOfferEvent##
176	176	)))
177	177	|(((
178		-{{code language="none"}}
179		-mksp.backend.briefing.created
180		-{{/code}}
	182	+{{{mksp.backend.briefing.created}}}
	183	+
	184	+(((
	185	+
	186	+)))
181	181	)))|(((
182	182	backend_briefing_created
183	183	)))|(((
184		-##(% class="n" %)BriefingEvent(%%)##
	190	+(% class="n" %)##BriefingEvent##
185	185	)))
186	186	|(((
187		-##(% class="s" %)mksp.backend.key.assigned(%%)##
	193	+{{{mksp.backend.key.assigned}}}
188	188	)))|(((
189	189	backend_key_assigned
190	190	)))|(((
191		-##(% class="nc" %)KeyEvent(%%)##
	197	+(% class="nc" %)##KeyEvent##
192	192	)))
193	193	|(((
194		-##(% class="s" %)mksp.backend.key.unassigned(%%)##
	200	+{{{mksp.backend.key.unassigned}}}
195	195	)))|(((
196	196	backend_key_unassigned
197	197	)))|(((
198		-##(% class="nc" %)KeyEvent(%%)##
	204	+(% class="nc" %)##KeyEvent##
199	199	)))
200	200	|(((
201		-##(% class="s" %)mksp.backend.storage.reserved(%%)##
	207	+{{{mksp.backend.storage.reserved}}}
202	202	)))|(((
203	203	backend_storage_reserved
204	204	)))|(((
205		-##(% class="nc" %)StorageSpaceEvent(%%)##
	211	+(% class="nc" %)##StorageSpaceEvent##
206	206	)))
207	207	|(((
208		-(% class="s" %){{code language="none"}}mksp.backend.storage.released{{/code}}
	214	+{{{
	215	+ }}}
209	209	)))|(((
210	210	backend_storage_released
211	211	)))|(((
212		-##(% class="nc" %)StorageSpaceEvent(%%)##
	219	+(% class="nc" %)##StorageSpaceEvent##
213	213	)))
214	214	|(((
215		-(% class="s" %){{code language="none"}}mksp.backend.storage.expired{{/code}}
	222	+{{{
	223	+ }}}
216	216	)))|(((
217	217	backend_storage_expired
218	218	)))|(((
...	...	@@ -219,7 +219,8 @@
219	219	(% class="nc" %){{code language="none"}}StorageSpaceEvent{{/code}}
220	220	)))
221	221	|(((
222		-(% class="s" %){{code language="none"}}mksp.backend.user.converted_to_member{{/code}}
	230	+{{{
	231	+ }}}
223	223	)))|(((
224	224	backend_user_converted_to_member
225	225	)))|(((
...	...	@@ -226,7 +226,8 @@
226	226	(% class="nc" %){{code language="none"}}UserEvent{{/code}}
227	227	)))
228	228	|(((
229		-(% class="s" %){{code language="none"}}mksp.backend.user.converted_to_guest{{/code}}
	238	+{{{
	239	+ }}}
230	230	)))|(((
231	231	backend_user_converted_to_guest
232	232	)))|(((
...	...	@@ -235,7 +235,7 @@
235	235
236	236	Die Consumer können dann wie folgt angelegt werden:
237	237
238		-{{code language="json"}}
	248	+{{code}}
239	239	$ nats consumer add backend_events <name> --pull --filter="<filter>" --defaults
240	240
241	241	# Beispiel
...	...	@@ -279,7 +279,7 @@
279	279
280	280	Die bestehenden Consumer kann man sich ebenfalls im Jetstream Context anzeigen lassen:
281	281
282		-{{code language="json"}}
	292	+{{code}}
283	283	$ nats consumer ls backend_events
284	284	╭──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
285	285	│ Consumers │
...	...	@@ -296,7 +296,7 @@
296	296
297	297	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:
298	298
299		-{{code language="json"}}
	309	+{{code}}
300	300	$ nats consumer info backend_events backend_briefing_offer_cancelled
301	301
302	302	Information for Consumer backend_events > backend_briefing_offer_cancelled created 2025-09-09 22:53:26
...	...	@@ -364,15 +364,15 @@
364	364
365	365	Der Name ist hierbei frei vergeben, in unserem Fall im Backend Code. Wir erwarten die folgenden Clients:
366	366
367		-|=(% scope="col" %)(((
	377	+|=(((
368	368	Client
369		-)))|=(% scope="col" %)(((
	379	+)))|=(((
370	370	Anzahl
371		-)))|=(% scope="col" %)(((
	381	+)))|=(((
372	372	Komponente
373		-)))|=(% scope="col" %)(((
	383	+)))|=(((
374	374	Art
375		-)))|=(% scope="col" %)(((
	385	+)))|=(((
376	376	Beschreibung
377	377	)))
378	378	|(((
...	...	@@ -480,4 +480,4 @@
480	480	]
481	481	{{/code}}
482	482
483		-\\
	493	+