Ein Compose-Projekt importieren — eine Notizen-API mit PostgreSQL und Redis
Eine Compose-Datei, die eine API, die PostgreSQL-Datenbank, in der sie ihre Notizen hält, und einen Redis-Cache ausführt, von aggrega import als Entwurf in Aggrega-Dateien überführt — wobei die Verbindungen, die Einstellungen der Datenbank, das Passwort als Variablenreferenz und der Tag jedes Images übernommen werden — und für Docker Compose gebaut.
Ein Compose-Projekt importieren führt Schritt für Schritt hindurch: der Befehl, die Dateien, die er schreibt, und warum jede Zeile dort steht, der Build und der laufende Stack. Dieser Ordner enthält jede Stufe dieser Anleitung:
| Ordner oder Datei | was er enthält |
|---|---|
source/ | das Compose-Projekt, compose.yaml, die .aggrega-config.yaml, die den Ordner zu einem Workspace macht, und import-answers.yaml, der eine Wert, den ein Build für Kubernetes benötigt und den keine Compose-Datei enthält |
draft/ | die Dateien, die aggrega import compose.yaml --target compose geschrieben hat, unverändert, einschließlich release.lock, und was der Befehl ausgegeben hat: stdout.txt auf der Standardausgabe, import.txt auf der Standardfehlerausgabe |
In einem Checkout des Dokumentations-Repositorys führt check.sh den Import erneut aus, vergleicht, was er schreibt und ausgibt, mit draft/, vergleicht die Blöcke, die die Anleitung zitiert, mit diesen Dateien und validiert und baut, was der Import geschrieben hat. Es benötigt den Katalog der Standardbibliothek (woher Sie einen bekommen), neben diesem Repository ausgecheckt, oder dessen Verzeichnis in AGGREGA_CATALOG_DIRS angegeben.
Das Beispiel generieren
Sie können den Import dieses Beispiels mit den folgenden Befehlen ausführen oder ihn von Ihrem KI-Assistenten für Sie ausführen lassen.
Schreiben Sie das Beispiel in einen neuen Ordner, der nach ihm benannt ist:
aggrega scaffold --example import-composeDanach gibt er die als Nächstes auszuführenden Befehle aus. Der erste wechselt in den neuen Ordner:
cd import-composeBuild
Der Import entwirft die Aggrega-Dateien neben dem Projekt, in source/. Er gleicht das Projekt mit dem Katalog der Standardbibliothek ab, den die Standard-Registry des Workspace als signierten Snapshot veröffentlicht: Der erste Import ruft ihn ab, verifiziert ihn, legt ihn im Inhaltscache des Workspace ab und benennt ihn über seinen Digest in dem Datensatz, den er neben die Entwürfe schreibt. Ein Workspace, der eigene Katalogordner angibt — in AGGREGA_CATALOG_DIRS oder unter workspace.catalog_dirs —, importiert stattdessen gegen diese. Der Import lädt dann herunter, wovon das entworfene Release abhängt, sodass der Build unmittelbar folgt:
cd sourceaggrega import compose.yaml --target composeaggrega build --release release.yamlDer Build schreibt dist/compose/docker-compose.yaml; wie Sie es ausführen, steht in der oben verlinkten Anleitung.
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 `import-compose` enthält, rufen Sie das Tool `scaffold` einmal mit `example` auf `import-compose` gesetzt und ohne `dir` auf: Es schreibt das Beispiel in einen neuen Ordner `import-compose`, dessen Ordner `source` enthält, was dieses Beispiel importiert. Rufen Sie dann das Tool `import` mit `workspace_root` auf `import-compose/source`, `source` auf `compose.yaml` und `target` auf `compose` gesetzt auf: Es liest die benötigten Antworten aus `import-answers.yaml` neben `compose.yaml`, schreibt seine Entwürfe nach `import-compose/source` und lädt per Pull, was diese benötigen. Rufen Sie dann das Tool `validate` mit `workspace_root` auf `import-compose/source` und `release` auf `release.yaml` gesetzt auf, und das Tool `build` mit `workspace_root` auf `import-compose/source`, `release` auf `release.yaml` und `write` auf true gesetzt. Nennen Sie mir die Dateien, die der Build geschrieben hat; sie liegen unter `import-compose/source/dist/`.Testen
Wenn der Stack so läuft, wie ihn die Schritt-für-Schritt-Anleitung ausführt, und ein Image, das auf Port 8080 HTTP beantwortet, für die API angegeben ist, fragen Sie die API an dem Port an, den das Release veröffentlicht:
curl -sS http://127.0.0.1:8080/notesDer Platzhalterdienst der Anleitung antwortet mit einer Beschreibung der Anfrage, die er empfangen hat:
{ "path": "/notes", "headers": { "host": "127.0.0.1:8080", [… omitted: the user agent and the media types the client sent] }, "method": "GET", [… omitted: the rest of the request as the stand-in received it, the client's address and the container's host name]}Mit --target helm importiert und auf Kubernetes angewendet, wie die Schritt-für-Schritt-Anleitung zeigt, beantwortet die API dieselbe Anfrage unter derselben Adresse, sobald ein lokaler Port an ihren Service weitergeleitet ist; dort erhält sie ihr Datenbankpasswort noch nicht, da das Secret nur die Datenbank erreicht:
kubectl port-forward -n <namespace> svc/api-default 8080:8080