MKSP - NATS - Technisches Setup

1

NATS ist eine zentrale Komponente der Architektur. NATS ist ein verteiltes Messaging-System, welches häufig für Microservices verwendet wird.

2

3

Unser Backend (oder auch andere Systeme) publizieren Events in NATS, die dann beispielsweise in N8n über ein Trigger konsumiert werden.

= Grundlagen =

== Übersicht ==

NATS kann grob in zwei Varianten unterteilt werden, **NATS Core** und **NATS JetStream**.

10

11

NATS Core ist das Grundsystem von NATS und bietet schnelle, leichtgewichtige Kommunikationsmöglichkeiten wie Publish/Subscribe, Request/Reply und Queueing. Dabei werden Nachrichten in der Regel nur flüchtig übertragen: Geht ein Empfänger offline, gehen die Nachrichten verloren. Der Fokus liegt auf extrem niedriger Latenz und hoher Performance.

12

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.

== Accounts ==

(% 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

19

(% style="color:var(--ds-text,#333333); text-decoration:none" %)Wir verwenden zwei verschiedene Accounts:

|=(((

Account

)))|=(((

Berechtigungen

)))|=(((

Beschreibung

)))

|(((

SYS

)))|(((

SYSTEM Account

)))|(((

Wird für administrative Tätigkeiten wie beispielsweise Troubleshooting oder das Auslesen von Informationen verwendet

)))

|(((

MKSP

)))|(((

Regulärer Account

)))|(((

Regulärer Account für Daten

41

)))

42

43

Benutzer können jeweils nur einem Account zugeordnet werden.

44

45

== Authentifizierung ==

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.

48

49

50

$ openssl x509 -noout -text -nameopt RFC2253 -in backend.mksp-da.de.crt

Certificate:

Data:

...

Subject: CN=backend.mksp-da.de,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE

55

56

57

Diese Subject wird dann dem Account zugeordnet:

system_account: SYS

accounts: {

MKSP: {

jetstream: enabled

users: [

{

user: "CN=backend.mksp-da.de,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE"

67

},

68

{

69

user: "CN=n8n.mksp-da.de,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE"

70

},

71

{

72

user: "CN=js-admin.mksp-da.de,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE"

},

]

}

SYS: {

users: [

{user: "CN=admin.mksp-da.de,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE"}

]

}

}

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

86

== NATS Core mit Accounts ==

87

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:

accounts: {

MKSP: {

users: [

{

user: "CN=backend.mksp-da.de,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE"

permissions: {

publish: [">"]

subscribe: [">"]

}

},

...

Wichtig sind hier die zusätzlichen Permissions, die den Zugriff auf Core Events regeln.

105

106

== JetStream Konfiguration ==

107

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

110

=== NATS CLI konfigurieren ===

111

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

114

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

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

119

120

Anschließend wählen wir den richtigen Kontext aus, in diesem Fall den JetStream Admin Context:

121

122

123

nats context select mksp-jsadmin

124

125

126

=== JetStream initialisieren ===

127

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

130

* JetStream im Allgemeinen: [[https:~~/~~/docs.nats.io/nats-concepts/jetstream>>url:https://docs.nats.io/nats-concepts/jetstream||shape="rect"]]

131

* JetStream Streams: [[https:~~/~~/docs.nats.io/nats-concepts/jetstream/streams>>url:https://docs.nats.io/nats-concepts/jetstream/streams||shape="rect"]]

132

133

Wir legen nun also ein Stream namens **backend_events** an:

134

135

136

nats stream add backend_events --subjects "mksp.>" --retention work --max-age 7d --storage file --defaults

137

138

139

=== JetStream Consumer ===

140

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

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.

|=(((

Backend Event

)))|=(((

Consumer Name

)))|=(((

Schema

)))

|(((

mksp.backend.briefing.offer.cancelled

(((

)))

)))|(((

backend_briefing_offer_cancelled

160

)))|(((

161

(% class="nc" %)##BriefingOfferEvent##

162

)))

163

|(((

164

mksp.backend.briefing.offer.created

(((

)))

)))|(((

backend_briefing_offer_created

171

)))|(((

172

(% class="nc" %)##BriefingOfferEvent##

173

)))

174

|(((

175

mksp.backend.briefing.offer.updated

176

)))|(((

177

backend_briefing_offer_updated

178

)))|(((

179

(% class="nc" %)##BriefingOfferEvent##

180

)))

181

|(((

182

mksp.backend.briefing.created

(((

)))

)))|(((

backend_briefing_created

189

)))|(((

190

(% class="n" %)##BriefingEvent##

191

)))

192

|(((

193

mksp.backend.key.assigned

)))|(((

backend_key_assigned

)))|(((

(% class="nc" %)##KeyEvent##

198

)))

199

|(((

200

mksp.backend.key.unassigned

201

)))|(((

202

backend_key_unassigned

203

)))|(((

204

(% class="nc" %)##KeyEvent##

205

)))

206

|(((

207

mksp.backend.storage.reserved

208

)))|(((

209

backend_storage_reserved

210

)))|(((

211

(% class="nc" %)##StorageSpaceEvent##

212

)))

213

|(((

214

mksp.backend.storage.released

215

)))|(((

216

backend_storage_released

217

)))|(((

218

(% class="nc" %)##StorageSpaceEvent##

219

)))

220

|(((

221

mksp.backend.storage.expired

222

)))|(((

223

backend_storage_expired

224

)))|(((

225

(% class="nc" %){{code language="none"}}StorageSpaceEvent{{/code}}

226

)))

227

|(((

228

mksp.backend.user.converted_to_member

229

)))|(((

230

backend_user_converted_to_member

231

)))|(((

232

(% class="nc" %){{code language="none"}}UserEvent{{/code}}

233

)))

234

|(((

235

mksp.backend.user.converted_to_guest

236

)))|(((

237

backend_user_converted_to_guest

238

)))|(((

239

(% class="nc" %){{code language="none"}}UserEvent{{/code}}

240

)))

241

|(((

242

mksp.backend.user.created

243

)))|backend_user_created|UserEvent

244

|(((

245

mksp.docuseal.signature.expired

246

)))|docuseal_signature_expired|(((

SignatureEvent

)))

|(((

mksp.docuseal.signature.completed

251

)))|docuseal_signature_completed|(((

252

SignatureEvent

253

)))

254

|mksp.backend.key.activate|backend_key_activate|KeyEvent

255

|mksp.backend.key.deactivate|backend_key_deactivate|KeyEvent

256

|mksp.backend.user.membership_changed|backend_user_membership_changed|MembershipChangedEvent

257

|mksp.backend.user.deleted|backend_user_deleted|UserDeletedEvent

258

|mksp.backend.department.head_membership_changed|backend_department_head_membership_changed|DepartmentHeadMembershipEvent

259

|(((

260

mksp.backend.device.event.locked

261

)))|backend_device_event_locked|

262

|(((

263

mksp.backend.device.event.unlocked

264

)))|backend_device_event_unlocked|

265

|(((

266

mksp.backend.device.event.access_granted

267

)))|backend_device_event_access-|

268

| | |

269

270

Die Consumer können dann wie folgt angelegt werden:

271

272

273

$ nats consumer add backend_events <name> --pull --filter="<filter>" --defaults

274

275

# Beispiel

276

nats consumer add backend_events backend_briefing_offer_cancelled --pull --filter="mksp.backend.briefing.offer.cancelled" --defaults

277

nats consumer add backend_events backend_key_assigned --pull --filter="mksp.backend.key.assigned" --defaults

= Troubleshooting =

Man kann über die NATS CLI mit dem Server interagieren.

== JetStream ==

=== Streams ===

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.

289

290

291

$ nats context select mksp-jsadmin

292

$ nats stream ls

293

╭─────────────────────────────────────────────────────────────────────────────────────╮

294

│ Streams │

295

├────────────────┬─────────────┬─────────────────────┬──────────┬──────┬──────────────┤

296

│ Name │ Description │ Created │ Messages │ Size │ Last Message │

297

├────────────────┼─────────────┼─────────────────────┼──────────┼──────┼──────────────┤

298

│ backend_events │ │ 2025-09-08 08:36:19 │ 0 │ 0 B │ never │

299

╰────────────────┴─────────────┴─────────────────────┴──────────┴──────┴──────────────╯

300

301

302

Ebenso kann man sich - falls vorhandenen - die Nachrichten im Stream anzeigen lassen:

303

304

305

$ nats context select mksp-jsadmin

306

$ nats stream view backend_events

307

[1] Subject: mksp.backend.storage.reserved Received: 2025-09-08 09:06:00

308

309

{"timestamp":"2025-09-08T09:06:00.062358","stora

=== Consumer ===

Die bestehenden Consumer kann man sich ebenfalls im Jetstream Context anzeigen lassen:

315

316

317

$ nats consumer ls backend_events

318

╭──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮

319

│ Consumers │

320

├──────────────────────────────────┬─────────────┬─────────────────────┬─────────────┬─────────────┬───────────────┤

321

│ Name │ Description │ Created │ Ack Pending │ Unprocessed │ Last Delivery │

322

├──────────────────────────────────┼─────────────┼─────────────────────┼─────────────┼─────────────┼───────────────┤

323

│ backend_briefing_created │ │ 2025-09-10 08:30:12 │ 0 │ 12 │ never │

324

│ backend_briefing_offer_cancelled │ │ 2025-09-10 08:21:02 │ 0 │ 0 │ never │

325

│ backend_briefing_offer_created │ │ 2025-09-10 08:28:25 │ 0 │ 0 │ never │

326

│ backend_briefing_offer_updated │ │ 2025-09-10 08:29:19 │ 0 │ 0 │ never │

327

│ backend_key_assigned │ │ 2025-09-10 08:21:04 │ 0 │ 0 │ never │

328

╰──────────────────────────────────┴─────────────┴─────────────────────┴─────────────┴─────────────┴───────────────╯

329

330

331

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:

332

333

334

$ nats consumer info backend_events backend_briefing_offer_cancelled

335

336

Information for Consumer backend_events > backend_briefing_offer_cancelled created 2025-09-09 22:53:26

Configuration:

Name: backend_briefing_offer_cancelled

341

Pull Mode: true

342

Filter Subject: mksp.backend.briefing.offer.cancelled

Deliver Policy: All

Ack Policy: Explicit

Ack Wait: 30.00s

Replay Policy: Instant

347

Max Ack Pending: 1,000

348

Max Waiting Pulls: 512

State:

Host Version: 2.11.8

Required API Level: 0 hosted at level 1

354

Last Delivered Message: Consumer sequence: 0 Stream sequence: 10

355

Acknowledgment Floor: Consumer sequence: 0 Stream sequence: 0

356

Outstanding Acks: 0 out of maximum 1,000

357

Redelivered Messages: 0

358

Unprocessed Messages: 0

359

Waiting Pulls: 1 of maximum 512

360

361

362

Insbesondere die letzten beiden Zeilen sind wichtig:

363

364

* **Unprocessed Messages** sind Nachrichten, die noch nicht abgerufen wurden. Dies sollte immer 0 sein

365

* **Waiting Pulls**: die Anzahl der verbundenen Clients. Üblicherweise sollte das nur n8n sein, also immer 1.

== Server ==

Man kann sich ebenfalls die aktiven Verbindungen anzeigen:

370

371

372

$ nats context select mksp-sysadmin

373

$ nats server report connections

374

375

╭─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮

376

│ Top 6 Connections out of 6 by subs │

377

├─────┬──────────────────────────┬──────────────┬─────────┬───────────────────┬─────────┬──────────┬─────────┬──────────┬──────────┬───────────┬──────┤

378

│ CID │ Name │ Server │ Cluster │ IP │ Account │ Uptime │ In Msgs │ Out Msgs │ In Bytes │ Out Bytes │ Subs │

379

├─────┼──────────────────────────┼──────────────┼─────────┼───────────────────┼─────────┼──────────┼─────────┼──────────┼──────────┼───────────┼──────┤

380

│ 83 │ backend_kicker │ mksp-nats-01 │ │ 172.18.0.33:52808 │ MKSP │ 2h24m18s │ 0 │ 0 │ 0 B │ 0 B │ 0 │

381

│ 93 │ backend_scheduler │ mksp-nats-01 │ │ 172.18.0.29:47620 │ MKSP │ 2h23m23s │ 0 │ 0 │ 0 B │ 0 B │ 0 │

382

│ 82 │ backend_fastapi │ mksp-nats-01 │ │ 172.18.0.33:52798 │ MKSP │ 2h24m18s │ 1 │ 1 │ 345 B │ 838 B │ 1 │

383

│ 94 │ backend_worker │ mksp-nats-01 │ │ 172.18.0.37:53550 │ MKSP │ 2h23m23s │ 0 │ 0 │ 0 B │ 0 B │ 1 │

384

│ 95 │ backend_worker │ mksp-nats-01 │ │ 172.18.0.37:53554 │ MKSP │ 2h23m23s │ 0 │ 0 │ 0 B │ 0 B │ 1 │

385

│ 111 │ NATS CLI Version 0.2.4 │ mksp-nats-01 │ │ 10.1.253.1:50712 │ SYS │ 0s │ 2 │ 1 │ 210 B │ 944 B │ 1 │

386

├─────┼──────────────────────────┼──────────────┼─────────┼───────────────────┼─────────┼──────────┼─────────┼──────────┼──────────┼───────────┼──────┤

387

│ │ Totals for 6 connections │ │ │ │ │ │ 3 │ 2 │ 555 B │ 1.7 KiB │ 4 │

388

╰─────┴──────────────────────────┴──────────────┴─────────┴───────────────────┴─────────┴──────────┴─────────┴──────────┴──────────┴───────────┴──────╯

389

390

╭──────────────────────────────────────╮

391

│ Connections per server │

392

├──────────────┬─────────┬─────────────┤

393

│ Server │ Cluster │ Connections │

394

├──────────────┼─────────┼─────────────┤

395

│ mksp-nats-01 │ │ 6 │

396

╰──────────────┴─────────┴─────────────╯

397

398

399

Der Name ist hierbei frei vergeben, in unserem Fall im Backend Code. Wir erwarten die folgenden Clients:

|=(((

Client

)))|=(((

Anzahl

)))|=(((

Komponente

)))|=(((

Art

)))|=(((

Beschreibung

)))

|(((

backend_kicker

)))|(((

1

)))|(((

Taskiq

)))|(((

Core

)))|(((

Gibt dem Backend die Möglichkeit, asynchrone Tasks an das Taskiq backend zu delegieren

)))

|(((

backend_scheduler

)))|(((

1

)))|(((

Taskiq

)))|(((

Core

)))|(((

Komponente welches die regelmäßigen Jobs überwacht und triggert

)))

|(((

backend_fastapi

)))|(((

1

)))|(((

FastAPI

)))|(((

JetStream

)))|(((

Das Backend kann hiermit Events ausgeben, die dann von N8n abgearbeitet werden.

)))

|(((

backend_worker

)))|(((

2

)))|(((

Taskiq

)))|(((

Core

)))|(((

Worker für asynchrone Tasks

455

)))

456

457

Man kann sich ebenfalls die Subscriptions der jeweiligen Connections anschauen. Hierfür muss die Ausgabe auf JSON umgestellt werden:

458

459

460

$ nats context select mksp-jsadmin

461

$ nats server report connections -j

[

{

"cid": 95,

"kind": "Client",

"type": "nats",

"ip": "172.18.0.37",

"port": 53554,

"start": "2025-09-08T13:35:37.398441269Z",

470

"last_activity": "2025-09-08T13:35:37.434868631Z",

"rtt": "479µs",

"uptime": "2h27m5s",

"idle": "2h27m5s",

"pending_bytes": 0,

"in_msgs": 0,

"out_msgs": 0,

"in_bytes": 0,

"out_bytes": 0,

"subscriptions": 1,

"name": "backend_worker",

481

"lang": "python3",

482

"version": "2.11.0",

483

"tls_version": "1.3",

484

"tls_cipher_suite": "TLS_AES_128_GCM_SHA256",

485

"tls_peer_certs": [

486

{

487

"subject": "CN=backend.mksp-da.de,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE",

488

"spki_sha256": "1c7826ac936267622a5bfec0359304e795a4fd552b4d76556d7fcbddf51f43fb",

489

"cert_sha256": "e25dd3084b13f5f3cb81ebb9291627bcd0a25ab51325f1cc627a2b758f03d1ca"

490

},

491

{

492

"subject": "CN=MKSP NATS Issuing CA,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE",

493

"spki_sha256": "af16c3490475a4ba65d273b7dae825622b4c1eeca5f3da808df14b3c298627a7",

494

"cert_sha256": "10ccebe5826128f50f7b007537fa8b832326d4bb14b1676588abac9a10bf7585"

495

}

496

],

497

"authorized_user": "CN=backend.mksp-da.de,OU=Makerspace Darmstadt IT,O=Makerspace Darmstadt e.V.,C=DE",

498

"account": "MKSP",

499

"subscriptions_list": [

"taskiq_tasks"

],

"name_tag": "MKSP",

"server": {

"name": "mksp-nats-01",

505

"host": "0.0.0.0",

506

"id": "NDH7ZAPFJ5EORJKZDJGOUNN3NDMTLWR6V7BGBOYUIG5UE7VEIK76F6WH",

"ver": "2.11.6",

"jetstream": true,

"flags": 7,

"seq": 2937,

"time": "2025-09-08T16:02:42.888686229Z"

}

},

]

Wiki-Quellcode von NATS - Technisches Setup