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

Modul-Boundary-Routing — ganze Untermodule in Boundaries platzieren

Dieses Beispiel kompiliert zwei Fähigkeiten — eine Thanos-Leseschicht für Metriken über Objektspeicher und eine Dokumentendatenbank, die das MongoDB-Wire-Protokoll spricht — aus einem einzigen vom Entwickler verfassten Aggregate und platziert jede vom Release aus in eine eigene Boundary.

Beide Fähigkeiten sind Module: wiederverwendbare Sub-Aggregate, die jeweils mehrere Komponenten mit je einer einzigen Arbeitslast zusammensetzen und ihre eigenen internen Kanten verdrahten. Das Aggregate nennt die beiden Module und nichts darüber, wo sie laufen. Das Release platziert jedes ganze Modul mit einem Eintrag aggregates: pro Boundary — der Operator entscheidet, wo eine Fähigkeit läuft, ohne nachzuverfolgen oder zu wiederholen, was in ihr steckt.

Dateien

DateiRolle
aggregate.yamlEntwicklerabsicht: importiert das Metrikmodul (core/thanos) und das Dokumentendatenbank-Modul (core/ferretdb).
manifest.yamlOrdnet jeden Komponententyp, den die beiden Module beisteuern, seinem synth-helm-Recipe zu, das Zugangsdaten-Feature, das das Metrikmodul anbindet, der Realisierung, die aus jedem der beiden Schlüsselparameter des Moduls ein Secret ausgibt, und das Scrape-Feature seinem FeatureRecipe.
release.yamlDokument des Operators: routet jedes Modul in seine eigene Boundary, dimensioniert eine Komponente eines Moduls und bindet das Scrape-Feature an sie an.

Was es zeigt

  • Ein ganzes Modul in eine Boundary routen. Der Eintrag aggregates: einer Boundary hat als Schlüssel den Namen des Moduls im Aggregate. Er platziert jede Komponente, die das Modul enthält, sodass die ausgegebenen Artefakte aller drei Metrikkomponenten unter der Boundary observability landen und beide Komponenten der Dokumentendatenbank unter data.
  • Gar keine Komponenten zu nennen ist die primäre Form. Die Boundary data routet das Dokumentendatenbank-Modul mit einem bloßen documents: {}. Jede Komponente darin wird platziert und übernimmt ihre eigenen Schema-Standardwerte; das Release braucht den Namen des Moduls und sonst nichts darüber.
  • Eine geroutete Komponente über ihren lokalen Namen konfigurieren. Ein Routing-Eintrag kann auch einzelne Komponenten des Moduls konfigurieren, das er routet, adressiert über den lokalen Namen, den jede innerhalb dieses Moduls trägt — query, nicht metrics.query, weil sie innerhalb des Moduls nur diesen Namen hat. Eine Komponente zu nennen sagt nichts über die anderen aus: Hier wird query dimensioniert und erhält ein Scrape-Ziel, während der Objektspeicher und das Store Gateway mit ihren Standardwerten hineingeroutet werden.
  • Eine geroutete Komponente ist eine Komponente dieser Boundary. Sie erbt die Annotationskaskade der Boundary wie jede andere, und genau das gibt jeder Ressource eines gerouteten Moduls den Wert aggrega.ai/namespace der Boundary — einschließlich der Komponenten, die der Routing-Eintrag nie erwähnt.
  • Routing ist Platzierung, keine andere Art der Mitgliedschaft. Eine Komponente, die hineingeroutet wird, ohne dass etwas über sie gesagt wird, rendert genauso wie dieselbe Komponente, die direkt in dieser Boundary mit leerem Rumpf genannt wird. Die beiden Schreibweisen sind zwei Arten zu sagen, wohin eine Komponente gehört, nicht zwei Verhaltensweisen.

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 module-boundary-routing

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

Terminal window
cd module-boundary-routing

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.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 Workspace-Ordner noch keinen Ordner `module-boundary-routing` enthält, rufen Sie das Tool `scaffold` einmal mit `example` auf `module-boundary-routing` gesetzt und ohne `dir` auf: Es schreibt das Beispiel in einen neuen Ordner `module-boundary-routing`. Rufen Sie anschließend das Tool `build` mit `workspace_root` auf `module-boundary-routing`, `release` auf `release.yaml`, `auto_pull` auf true und `write` auf true gesetzt auf. Nennen Sie mir, welche Dateien der Build geschrieben hat; sie liegen unter `module-boundary-routing/dist/`.

Wie die platzierten Stacks aussehen

Das directory jeder Boundary ist die Artefakt-Wurzel für alles, was in ihr platziert wird, sodass sich die Komponenten der beiden Module auf der Festplatte nach der Boundary trennen, die sie geroutet hat:

dist/observability/helm/ metrics-zdobjstore, metrics-zdstore, metrics-zdquery
dist/data/helm/ documents-zdproxy, documents-zdbackend

Die Dateinamen tragen die Identität jeder Komponente mit ausgeschriebenem Modultrennzeichen, weil ein Punkt kein Zeichen ist, das jeder Ressourcenname enthalten kann — metrics.store im Aggregate ist metrics-zdstore im Cluster. Das Zusammensetzen eines Moduls ist das Einzige, was ein Trennzeichen in eine Identität bringt, daher wird eine Komponente, die Sie direkt nennen, an beiden Stellen gleich geschrieben.

Jede Ressource trägt den Namespace der routenden Boundary und hält fest, welche Boundary sie platziert hat. Das Store Gateway wird im Routing-Eintrag nie genannt und erbt dennoch beides:

metadata:
name: metrics-zdstore
namespace: observability
[… omitted: the labels every rendered document carries]
annotations:
aggrega.ai/boundary-path: observability
[… omitted: the annotation naming the Recipe that rendered it]

Dasselbe gilt für die vier Secrets, die das Zugangsdaten-Feature des Metrikmoduls für das Schlüsselpaar des Objektspeichers und für dasjenige ausgibt, das das Store Gateway ihm vorlegt: Jedes landet unter observability mit diesem Namespace, neben der Arbeitslast, die es liest.

Das an die geroutete Komponente query angebundene Scrape-Feature rendert ein eigenes Artefakt unter derselben Boundary, mit den Scrape-Einstellungen des Operators:

apiVersion: monitoring.coreos.com/v1
kind: ServiceMonitor
metadata:
name: metrics-zdquery-scrape
[… omitted: the namespace, labels and annotations every rendered document carries]
spec:
selector:
matchLabels:
app.kubernetes.io/name: metrics-zdquery
endpoints:
- port: http
interval: 30s
path: /metrics