Änderungen von Dokument N8n Workflow Engine

Zusammenfassung

• Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)
• Anhänge (0 geändert, 3 hinzugefügt, 0 gelöscht)
  • 1771784637258-114.png
  • 1771785245954-780.png
  • 1771785309574-242.png

Details

Seiteneigenschaften

Inhalt

...	...	@@ -1,108 +1,98 @@
1	1	n8n ist ein **Open-Source-Tool zur Workflow-Automatisierung**, das man selbst hosten kann. Über eine **visuelle Oberfläche** baut man Workflows per Drag-and-drop aus sogenannten „Nodes“, die verschiedene Dienste und Aktionen miteinander verbinden. Es gibt Hunderte vorgefertigte Integrationen, z. B. für Slack, Mail oder MQTT. Ebenfalls gibt es eine große Auswahl an für uns relevante Community Nodes (Vikunja, Listmonk, und so weiter) sowie die Möglichkeit, eigene Nodes zu schreiben (beispielsweise Paperless oder NATS).
2	2
3		-= {{id name="N8nWorkflowEngine-WorkflowÜbersicht"/}}Workflow Übersicht =
	3	+= Inhaltsverzeichnis =
4	4
5		-asd
	5	+{{toc/}}
6	6
7		-= {{id name="N8nWorkflowEngine-CommunityNodes"/}}Community Nodes =
	7	+= Workflow Übersicht =
8	8
	9	+Workflows bestehen grundsätzlich aus einem oder mehreren **Triggern** und einer oder mehreren **Aktionen**. Im Folgenden werden nur die für die Mitgliederverwaltung relevanten Workflows beschrieben, N8n kann aber natürlich auch für andere Automatisierung verwendet werden.
	10	+
	11	+== Workflows für Dokumente ==
	12	+
	13	+=== Document Consumed Workflow ===
	14	+
	15	+ToDO
	16	+
	17	+=== Paperless Papierkorb ===
	18	+
9	9	asd
10	10
11		-= {{id name="N8nWorkflowEngine-TechnischesSetup"/}}Technisches Setup =
	21	+== Cron Jobs - Sync von Daten ==
12	12
13		-== {{id name="N8nWorkflowEngine-Lizenz"/}}Lizenz ==
	23	+=== Sync Tags für Einweisungen ===
14	14
15		-N8n hat eine so genannte "Sustainable Use License". Für den internen Gerbauch frei verwendbar, solange man keine Produkte damit verkauft. Auszug aus der FAQ:
	25	+ToDo
16	16
17		->Our license restricts use to "internal business purposes". In practice this means all use is allowed unless you are selling a product, service, or module in which the value derives entirely or substantially from n8n functionality.
	27	+=== Sync Document Types ===
18	18
19		-Wir verwenden im Makerspace die kostenlose [[Community License>>url:https://docs.n8n.io/hosting/community-edition-features/||shape="rect"]], den Lizenzkey erhält man online durch Ausfüllen eines Formulars.
	29	+ToDo
20	20
21		-== {{id name="N8nWorkflowEngine-HostingundKubernetes"/}}Hosting und Kubernetes ==
	31	+== Backend Event Workflows ==
22	22
23		-N8n soll hauptsächlich mit unserer Paperless Instanz interagieren und läuft aus diesem Grund ebenfalls im Makerspace auf unserem Kubernetes Cluster. Für die Installation kommt das [[Helm Chart von 8gears>>url:https://artifacthub.io/packages/helm/open-8gears/n8n||shape="rect"]] zum Einsatz.
	33	+Bestimmte Events aus dem Backend werden über NATS als Event gepublished. Details dazu sind auf der [[Seite zu NATS>>doc:PROJ.Digitale Mitgliederverwaltung.Technische Dokumentation.NATS Setup.WebHome]] beschrieben. Hier werden die Events beschrieben, die Paperless betreffen:
24	24
25		-Der Code für die ArgoCD App ist in Gitlab gespeichert und wird automatisch über ArgoCD synchronisiert: [[https:~~/~~/git.makerspace-darmstadt.de/makerspace-it-infrastructure/gitops/main-apps/n8n/-/tree/main?ref_type=heads>>url:https://git.makerspace-darmstadt.de/makerspace-it-infrastructure/gitops/main-apps/n8n/-/tree/main?ref_type=heads||shape="rect"]]
	35	+=== mksp.docuseal.signature.completed ===
26	26
27		-[[image:attach:image-2025-8-31_19-10-32.png||height="250"]]
	37	+Dieses Event wird ausgelöst, wenn im Backend ein Signatur-Prozess abgeschlossen ist (d.h. alle Parteien haben unterschrieben und die Unterschrift wurde im Backend erfasst). Dies kann auf zwei Arten passieren:
28	28
29		-Die Komponenten beschränken sich hierbei auf:
	39	+* Bei rein digitalen Signaturen durch einen über Docuseal ausgelösten Webhook
	40	+* Bei handschriftlich unterschrieben Signaturen durch Einscan
30	30
31		-* Die N8n Applikation selbst, das sind die Ressourcen aus dem Helm Chart
32		-* Eine Datenbank-Instanz (PostgeSQL, auf dem zentralen DB Server)
33		-* Secrets, die aus Hashicorp Vault synchronisiert werden
	42	+=== mksp.backend.user.created ===
34	34
35		-== {{id name="N8nWorkflowEngine-HelmChartParameter"/}}Helm Chart Parameter ==
	44	+Dieser Workflow wird immer dann getriggert, wenn im Backend ein **neuer User** angelegt wird. Die Informationen aus der NATS Nachricht werden dann verwendet, um den **Korrespondenten in Paperless anzulegen**.
36	36
37		-Das Helm Chart akzepziert einige Parameter, mit denen das Deployment genauer konfiguriert werden kann. In unserem Fall kurz erklärt:
	46	+[[image:1771784637258-114.png||height="200"]]
38	38
39		-\\
	48	+Die folgenden Aktionen werden ausgeführt:
40	40
41		-{{code}}
42		-{
43		- values(ns, version, url, db_name, sc, size, db_hostname='pgsql-postgresql.mksp-services.svc.cluster.local')::
44		- {
45		- image: {
46		- tag: version,
47		- },
48		- main: {
49		- config: {
50		- db: {
51		- type: 'postgresdb',
52		- postgresdb: {
53		- database: ns + '-' + db_name,
54		- host: db_hostname,
55		- user: ns + '-' + db_name,
56		- },
57		- },
58		- },
59		- extraEnv: {
60		- DB_POSTGRESDB_PASSWORD: {
61		- valueFrom: {
62		- secretKeyRef: {
63		- name: 'db-' + db_name + '-creds',
64		- key: 'POSTGRES_PASSWORD',
65		- },
66		- },
67		- },
68		- },
69		- persistence:
70		- {
71		- enabled: true,
72		- type: 'dynamic',
73		- storageClass: sc,
74		- accessModes: ['ReadWriteOnce'],
75		- size: size,
76		- },
77		- },
78		- ingress:
79		- {
80		- enabled: true,
81		- annotations: {
82		- 'cert-manager.io/cluster-issuer': 'letsencrypt',
83		- },
84		- className: 'nginx',
85		- hosts: [
86		- {
87		- host: url,
88		- paths: ['/'],
89		- },
90		- ],
91		- tls: [
92		- { secretName: 'n8n-tls', hosts: [url] },
93		- ],
94		- },
95		- },
96		-}
	50	+1. Parallel werden **alle Gruppen und Benutzer **aus Paperless ausgelesen
	51	+1. Es wird auf die relevanten Gruppen und Benutzer gefiltert. Ziel ist es, **die ID der entsprechenden Gruppen und Benutzer auszulesen**. Wir sind **interessiert an den Gruppen für die Mitgliederverwaltung und die IT Admins** sowie dem statischen **MV Owner**.
	52	+1. Zuletzt wird der Subflow "Create Paperless Correspondent" angelegt. Dieser bekommt als Info:
	53	+11. **firstname** - aus NATS Trigger
	54	+11. **lastname** - aus NATS Trigger
	55	+11. **isGuest** - true wenn membership_number in NATS Trigger = null, false otherwise
	56	+11. **membership_number** - aus NATS Trigger
	57	+11. **user_id** - aus NATS Trigger
	58	+11. **owner_id** - ID des MV Data Owner Benutzers
	59	+11. **permissions** - siehe unten
	60	+11. **backend_url** - URL des Makerspace Backends
97	97
	62	+Der Subflow erzeugt dann den Display-Namen des Korrespondenten und **speichert die Paperless-ID über die Backend-API zurück ins Backend.** Der **Display-Name **setzt sich wie folgt zusammen:
98	98
	64	+|=Nutzer-Typ|=Format|=Beispiel
	65	+|Mitglied|Vorname Nachname (#Mitgliedsnummer)|Daniel Herrmann (#250)
	66	+|Gast|Vorname Nachname (Gast #Nutzer-ID)|Daniel Herrmann (Gast #1)
	67	+
	68	+Die **Berechtigungen** werden dabei wie folgt gesetzt:
	69	+
	70	+{{code language="none"}}
	71	+{"view":{"users":[],"groups":[{{ $('Static Data').item.json.mv_group_id }}]},"change":{"users":[],"groups":[{{ $('Static Data').item.json.it_admin_group_id }}]}}
99	99	{{/code}}
100	100
101		-Hervorzuheben sind hier insbesondere:
	74	+D.h. Owner (und damit alle Rechte) hat der statische MV Owner Nutzer. Alle Mitglieder der Gruppe "Mitgliederverwaltung" können den Korrespondenten sehen (notwendig für Zuweisung und Filterung), IT-Admins können diese verändern.
102	102
103		-* Das **Image **- Hier wird die Version von N8n konfiguriert. Eine Versions-Änderung des Helm Charts hat nicht zwangsweise auch eine Versions-Änderung der Applikation selbst (N8n) zur Folge, sodass dieses separat übergeben wird
104		-* **DB Config + Extra Env** - Hier werden die Zugangsdaten für die Datenbank übergeben. Host, Benutzername und Datenbankname werden an Hand des App-Namens erzeugt, das Passwort wird beim Anlegen der Datenbank dynamisch erzeugt und von einem Kubernetes Secret gemounted
105		-* **Persistence **- Hier wird angegeben, wie die Daten persistent gespeichert werden - im Prinzip eine Art Festplatte für ein Kubernetes Pod. Im Makerspace gibt es dafür zwei Storage Classes, die werden im Artikel über unseren [[confluencePage:page:IN.Kubernetes Cluster]] genauer beschrieben
106		-* **Ingress **- Hier wird angegeben, unter welcher Domain N8n erreichbar sein soll und wie das Zertifkat erzeugt wird.
	76	+=== mksp.backend.user.converted_to_guest ===
107	107
108		-\\
	78	+Dieser Workflow wird dann ausgelöst, wenn ein Mitglied den Verein verlässt und daher zum Gast wird.
	79	+
	80	+[[image:1771785245954-780.png||height="150"]]
	81	+
	82	+Alle notwendigen Daten (inklusive der Paperless Korrespondent-ID) sind im NATS Event vorhanden. Es wird also lediglich ein neuer Display-Name erzeugt (Format: siehe Tabelle oben) und der Korrespondent wird aktualisiert.
	83	+
	84	+=== mksp.backend.user.converted_to_member ===
	85	+
	86	+Dieser Workflow wird dann ausgelöst, wenn ein neues Mitglied dem Verein beitritt.
	87	+
	88	+[[image:1771785309574-242.png||height="150"]]
	89	+
	90	+Alle notwendigen Daten (inklusive der Paperless Korrespondent-ID) sind im NATS Event vorhanden. Es wird also lediglich ein neuer Display-Name erzeugt (Format: siehe Tabelle oben) und der Korrespondent wird aktualisiert.
	91	+
	92	+== Subflows ==
	93	+
	94	+ToDo
	95	+
	96	+= Community Nodes =
	97	+
	98	+asd

1771784637258-114.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.dherrman

Größe

...	...	@@ -1,0 +1,1 @@
	1	+201.1 KB

Inhalt

1771785245954-780.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.dherrman

Größe

...	...	@@ -1,0 +1,1 @@
	1	+63.2 KB

Inhalt

1771785309574-242.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.dherrman

Größe

...	...	@@ -1,0 +1,1 @@
	1	+63.0 KB

Inhalt