Zum Inhalt springen
AggregaAggrega
Sprache wählen: Deutsch
Diese Seite wurde maschinell übersetzt. Das englische Original lesen.

PostgreSQL-Bootstrap-Skripte und benutzerdefinierte Konfiguration — synthetisiertes helm

core/datastore/postgres stellt zwei optionale Entwicklerwerte bereit, die den ersten Start der Datenbank bestimmen: init_scripts (SQL oder Shell, einmalig bei der Initialisierung ausgeführt) und custom_config (ein Fragment von postgresql.conf). Auf dem synthetisierten helm-Ziel trägt das Recipe sie als eingehängte ConfigMaps in den Container. Dieses Beispiel zeigt, dass die Funktion additiv ist: Ein Aggregate, das keinen der beiden Werte setzt, wird genau wie eine minimale Datenbank gerendert, und ein Aggregate, das sie setzt, erhält die ConfigMaps, Volumes und Mounts, ohne dass etwas anderes gestört wird.

Zwei Releases derselben Component mit demselben Manifest, die sich nur in den Entwicklerwerten unterscheiden:

  • release-bare.yaml (aggregate-bare.yaml) — init_scripts und custom_config nicht gesetzt.
  • release-config.yaml (aggregate-config.yaml) — beide gesetzt.

Das Beispiel generieren

Sie können dieses Beispiel mit den folgenden Befehlen bauen oder es von Ihrem KI-Assistenten für Sie bauen lassen.

Schreiben Sie das Beispiel in einen neuen Ordner, der nach ihm benannt ist:

Terminal window
aggrega scaffold --example postgres-init-config

Danach gibt er die als Nächstes auszuführenden Befehle aus. Der erste wechselt in den neuen Ordner:

Terminal window
cd postgres-init-config

Build

Terminal window
aggrega build --release release-bare.yaml --auto-pull
aggrega build --release release-config.yaml --auto-pull

Der Katalog wird aus der in .aggrega-config.yaml benannten Hub-Registry aufgelöst, daher ist kein Flag --catalog nötig, und --auto-pull schreibt während des Builds die Lockfile, die einem frischen Klon fehlt. Das schlichte Release schreibt drei Dateien unter dist/helm/helm/; das konfigurierte Release schreibt diese drei und zwei weitere unter dist/helm/helm/db/.

Mit einem KI-Assistenten

Ein KI-Assistent, der mit den Tools von Aggrega eingerichtet ist, kann dasselbe tun: Fügen Sie ihm diesen Prompt ein.

Verwenden Sie ausschließlich die Aggrega-Tools und legen Sie selbst keinen Ordner an. Wenn der Workspace-Ordner noch keinen Ordner `postgres-init-config` enthält, rufen Sie das Tool `scaffold` einmal auf, mit `example` auf `postgres-init-config` gesetzt und ohne `dir`: Es schreibt das Beispiel in einen neuen Ordner `postgres-init-config`. Rufen Sie dann das Tool `build` einmal für jedes Release auf, in dieser Reihenfolge — `release-bare.yaml` und `release-config.yaml` — jedes Mal mit `workspace_root` auf `postgres-init-config`, `release` auf die jeweilige Datei, `auto_pull` auf true und `write` auf true gesetzt. Nennen Sie mir die Dateien, die jeder Build geschrieben hat; sie liegen unter `postgres-init-config/dist/`.

Schlicht — die additive Grundlinie

aggregate-bare.yaml lässt beide Werte ungesetzt. Die gerenderte Ausgabe ist ein StatefulSet, ein ClusterIP-Service und ein Headless-Service — keine ConfigMap, kein Volume vom Typ configmap, kein Volume-Mount in das Init-Verzeichnis und kein Konfigurationsdatei-Argument am Container. Das ist die gewöhnliche Form einer minimalen PostgreSQL-Datenbank:

dist/helm/helm/db-statefulset.yaml
dist/helm/helm/db-default-service.yaml
dist/helm/helm/db-headless-service.yaml

Weil beide Werte im Recipe durch eine Präsenzprüfung geschützt sind, gibt ein nicht gesetzter Wert nichts aus — der ConfigMap-Rumpf wird leer gerendert und übersprungen, und die Zeilen für Volume, Mount und Server-Argument werden durch die Prüfung ausgeschlossen. Ein Aggregate, das diese Werte nie berührt, bleibt durch ihre Existenz unverändert.

Konfiguriert — Skripte und Konfiguration eingehängt

aggregate-config.yaml setzt beide Werte:

values:
init_scripts:
01-schema.sql: |
CREATE TABLE app_users ( ... );
02-seed.sql: |
INSERT INTO app_users (email) VALUES ('founder@example.com');
custom_config: |
max_connections = 200
shared_buffers = 256MB

Der Build schreibt nun zwei zusätzliche ConfigMaps und verdrahtet sie mit dem StatefulSet:

dist/helm/helm/db/initdb-configmap.yaml
dist/helm/helm/db/config-configmap.yaml

Beide liegen unter db/, dem eigenen Namen der Komponente. Das Recipe benennt sie in seinem Block artifacts:, und eine dort benannte Datei trägt den Schlüssel, den ihr Autor geschrieben hat, statt etwas, das die Komponente identifiziert — daher schreibt der Build sie unter der Komponente, die sie deklariert hat, und zwei Komponenten, die sich ein Recipe teilen, können nicht auf einem Pfad landen. Das StatefulSet und die beiden Services werden vom Ziel nach der Komponente benannt, zu der sie gehören, daher bleiben sie im eigenen Verzeichnis der Boundary.

Die beiden Werte reisen in getrennten ConfigMaps, weil jede vollständig in einen anderen Container-Pfad eingehängt wird:

  • init_scripts → ConfigMap db-initdb, ein Datenschlüssel pro Skript (01-schema.sql, 02-seed.sql). Ein Volume vom Typ configmap hängt sie unter /docker-entrypoint-initdb.d ein, wo PostgreSQL die Dateien bei der ersten Initialisierung einmalig ausführt, in alphabetischer Reihenfolge der Schlüssel.
  • custom_config → ConfigMap db-config, ein Datenschlüssel postgresql.conf. Ein zweites Volume vom Typ configmap hängt sie unter /etc/postgresql ein, und die args: des Containers verweisen den Server darauf: postgres -c config_file=/etc/postgresql/postgresql.conf. Einstellungen, die das Fragment auslässt, behalten ihre eingebauten Standardwerte.
# db-statefulset.yaml (container)
containers:
- name: main
image: postgres:16
args:
- postgres
- -c
- config_file=/etc/postgresql/postgresql.conf
[… omitted: the container's port, environment and resources]
volumeMounts:
- name: data
mountPath: /var/lib/postgresql/data
- name: initdb
mountPath: /docker-entrypoint-initdb.d
- name: pgconf
mountPath: /etc/postgresql
[… omitted: the liveness and readiness probes]
volumes:
- name: initdb
configMap:
name: db-initdb
- name: pgconf
configMap:
name: db-config

Diese Server-Argumente kommen als args: statt als command: an, und der Unterschied entscheidet, ob die Datenbank befüllt hochfährt: args: liefert Argumente an den Entrypoint des Images, während command: ihn ersetzt. Dieser Entrypoint ist das Startskript, das die Datenbank in einem leeren Datenverzeichnis anlegt, die Umgebung POSTGRES_* liest und die Dateien unter /docker-entrypoint-initdb.d ausführt. Ihn zu ersetzen würde den Server mit der eingehängten postgresql.conf starten und sowohl die Initialisierung als auch die Bootstrap-Skripte überspringen — die Werte, die das Aggregate gesetzt hat, würden in das Manifest gerendert und nie ausgeführt.

Nur einen der beiden Werte zu setzen ist ebenso gültig — ConfigMap, Volume und Mount des anderen fehlen dann einfach, und das Konfigurationsdatei-Argument erscheint nur, wenn custom_config gesetzt ist.

Compose

Das Compose-Recipe für core/datastore/postgres liest dieselbe Component und realisiert beide Werte über die eigene Primitive von compose: Es rendert Einträge configs: auf oberster Ebene, und der Service hängt jeden davon als Datei ein.

  • init_scripts → eine Config pro Schlüssel, jede unter ihrem eigenen Dateinamen unter /docker-entrypoint-initdb.d eingehängt. Das Image führt die Dateien, die es dort findet, einmalig aus, in der Reihenfolge der Dateinamen, und nur, wenn das Datenverzeichnis leer ist — eine Datenbank, die bereits Daten enthält, bleibt unberührt.
  • custom_config → eine Config, eingehängt als die einzelne Datei /etc/postgresql/postgresql.conf, mit denselben Argumenten postgres -c config_file=…, die den Server darauf verweisen. Einstellungen, die das Fragment auslässt, behalten ihre eingebauten Standardwerte.

Auch hier ist jede Hälfte durch eine Präsenzprüfung geschützt, sodass ein Aggregate, das einen Wert ungesetzt lässt, so gerendert wird, als gäbe es diesen Schlüssel nicht.

Eine Einstellung ist erwähnenswert, wenn man einen Block custom_config für ein Release auf compose schreibt: listen_addresses akzeptiert standardmäßig nur lokale Verbindungen, daher lässt ein Block, der sie auslässt, die Datenbank für die anderen Services im compose-Netzwerk unerreichbar.

Das Manifest in diesem Beispiel leitet core/datastore/postgres an das helm-Recipe. Dasselbe Aggregate auf compose zu bauen bedeutet stattdessen ein Manifest, das es an compose/postgres leitet; die Entwicklerwerte bleiben unberührt.