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

FerretDB-Stack — eine Dokumentendatenbank, als Modul zusammengesetzt

Dieses Beispiel kompiliert einen kleinen, realen Stack — eine Dokumentendatenbank, die das MongoDB-Wire-Protokoll bereitstellt — aus einem einzigen vom Entwickler verfassten Aggregate zu synthetisierten Kubernetes-Manifesten.

Die Dokumentendatenbank ist keine einzelne Komponente. Sie ist ein Modul: ein wiederverwendbares Sub-Aggregat, das zwei Komponenten mit je einer einzigen Arbeitslast zusammensetzt —

  • ein Proxy, der das MongoDB-Wire-Protokoll spricht und keinen lokalen Zustand hält, und
  • ein Backend, PostgreSQL 17 mit der Erweiterung DocumentDB, das die Daten auf einem Volume persistiert.

Das Modul verdrahtet seine eigene interne Kante vom Proxy zum Backend und exportiert den Proxy als seinen öffentlichen Endpunkt mongo. Das Aggregate der obersten Ebene importiert das Modul über seinen Namen und rendert den zusammengesetzten Stack; der Betreiber dimensioniert die internen Komponenten des Moduls im Release.

Dateien

DateiRolle
aggregate.yamlEntwicklerabsicht: importiert das Dokumentendatenbank-Modul (core/ferretdb).
manifest-helm-synth.yamlOrdnet die Typen Proxy und Backend ihren synth-helm-Recipes zu.
release-helm-synth.yamlBetreiber-Datensatz für das Kubernetes-Ziel. Dimensioniert die internen Komponenten des Moduls über ihre modulbezogenen IDs; alles, was den Schema-Voreinstellungen überlassen bleibt, wird in sich geschlossen gerendert.

Was es zeigt

  • Komposition als Modul. Eine Fähigkeit aus mehreren Arbeitslasten — eine Dokumentendatenbank, die eigentlich ein Proxy plus ein Speicher-Backend ist — wird als Sub-Aggregat verpackt, das zwei Komponenten mit je einer einzigen Arbeitslast zusammensetzt, nicht als eine monolithische Komponente. Das Modul wird über seinen Namen importiert und überall wiederverwendet, wo eine Dokumentendatenbank gebraucht wird.
  • Eine interne Kante innerhalb des Moduls. Der Proxy deklariert eine Nutzung des Backends; Host, Port, Benutzer und Datenbank aus den provides des Backend-Recipe werden in den Proxy durchgereicht und zu seiner PostgreSQL-Verbindung zusammengesetzt. Der Compiler leitet die Strings weiter, ohne sie zu interpretieren.
  • Ein öffentlicher Endpunkt. Das Modul exportiert seinen Proxy als mongo, den stabilen öffentlichen Namen, mit dem sich ein Konsument der Dokumentendatenbank verbindet — entkoppelt von den internen Komponentennamen des Moduls.
  • Dimensionierung interner Komponenten durch den Betreiber. Das Release adressiert die internen Komponenten des Moduls über ihre modulbezogenen IDs (database.backend, database.proxy), um Rechenressourcen festzulegen, ohne dass das Aggregate des Entwicklers die physische Dimensionierung wiederholt.
  • Gemeinsame Zugangsdaten. Der Proxy delegiert die Authentifizierung an sein PostgreSQL-Backend, daher teilen sich beide ein Passwort. Dieses Beispiel verwendet einen gemeinsamen, inline angegebenen Entwicklungs-Standardwert, sodass der Stack in sich geschlossen ohne externes Secret läuft.
  • Ein Verbindungsstring ohne Passwort. Die PostgreSQL-Verbindungs-URL des Proxys wird ohne eingebettetes Passwort gerendert; das Passwort wird separat über die standardmäßige libpq-Umgebungsvariable PGPASSWORD geliefert, die der Treiber in die Verbindung übernimmt. So bleiben die Zugangsdaten aus dem Verbindungsstring im gerenderten Manifest heraus.
  • Reproduzierbare Images. Sowohl der Proxy als auch das Backend heften explizite Image-Tags an, daher verweisen die gerenderten Manifeste auf stabile Images.

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 ferretdb-stack

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

Terminal window
cd ferretdb-stack

Build

Dieser Workspace enthält kein .aggrega-config.yaml, daher werden die Entitäten der Standardbibliothek aus der Hub-Registry hub.aggrega.ai aufgelöst, und es ist kein Katalog-Flag nötig; --auto-pull schreibt während des Builds das Lockfile, das einem frischen Klon fehlt:

Terminal window
aggrega build --release release-helm-synth.yaml --auto-pull

Gerenderte Artefakte landen unter dist/. Das Kubernetes-Ziel rendert einfache Manifeste offline — es ist kein Chart-Pull erforderlich.

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 Arbeitsbereichsordner noch keinen Ordner `ferretdb-stack` enthält, rufen Sie das Tool `scaffold` einmal mit `example` auf `ferretdb-stack` gesetzt und ohne `dir` auf: Es schreibt das Beispiel in einen neuen Ordner `ferretdb-stack`. Rufen Sie dann das Tool `build` mit `workspace_root` auf `ferretdb-stack`, `release` auf `release-helm-synth.yaml`, `auto_pull` auf true und `write` auf true gesetzt auf. Nennen Sie mir die Dateien, die der Build geschrieben hat; sie liegen unter `ferretdb-stack/dist/`.

Wie der zusammengesetzte Stack aussieht

Der Proxy wird als zustandsloses Deployment plus ein ClusterIP-Service auf dem Wire-Port gerendert. Seine Container-Umgebung trägt die aus der Backend-Kante zusammengesetzte Verbindung — den clusterinternen Service-Namen des Backends, Benutzer und Datenbank, ohne Passwort in der URL — und hält den Debug-Listener von FerretDB auf der Loopback-Adresse des Pods, wo kein anderer Pod ihn erreicht:

env:
- name: FERRETDB_LISTEN_ADDR
value: :27017
- name: FERRETDB_DEBUG_ADDR
value: 127.0.0.1:8088
- name: FERRETDB_POSTGRESQL_URL
value: postgres://postgres@database-zdbackend-default:5432/postgres
- name: PGPASSWORD
value: apppass

Keine der beiden Probes braucht diesen Listener. Die Readiness-Probe führt ferretdb ping im Container aus, das den Wire-Port anpingt und damit auch die Backend-Verbindung nachweist; die Liveness-Probe prüft nur, ob der Wire-Port Verbindungen annimmt, sodass ein Ausfall des Backends den Proxy aus seinem Service nimmt, ohne ihn neu zu starten:

livenessProbe:
tcpSocket:
port: 27017
readinessProbe:
exec:
command:
- /ferretdb
- ping

Das Backend wird als StatefulSet mit einem persistenten Volume gerendert, das unter /var/lib/postgresql/data eingehängt ist, plus ein ClusterIP-Service und ein Headless-Service.