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

Aggrega-Schema für das Release

Generierte Referenz. Nicht von Hand bearbeiten — aus dem veröffentlichten JSON Schema neu generieren.

Schema-ID: https://aggrega.ai/schemas/release-v1beta1.schema.json

Siehe die Authoring-Referenz zum Release für Anleitungen in Prosaform zum Verfassen von Release-Entitäten; diese Seite dokumentiert das strukturelle Schema, das diese Referenz beschreibt.

Typ der obersten Ebene: object

Eigenschaften

EigenschaftTypErforderlichBeschreibung
apiVersionconst “aggrega.ai/v1beta1”jaKonstante: "aggrega.ai/v1beta1"
kindconst “Release”jaKonstante: "Release"
metadataobjectja
specobjectjaWas das Release bindet und routet: das Aggregate und das Manifest, die es bereitstellt (oder eine extends-Basis), die umgebungsspezifische Erfüllung der Parameter und die Boundaries, in die seine Komponenten geroutet werden.

Zusätzliche Eigenschaften sind nicht zulässig.

release.metadata

EigenschaftTypErforderlichBeschreibung
namestringjaMindestens 1 Zeichen lang.
environmentstringja
versionstringjaStrikte semantische Versionierung des Release (z. B. 1.0.0). Muster: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$.
descriptionstringneinWas diese Entität ist und wofür sie gedacht ist, geschrieben für jemanden, der entscheidet, ob er sie verwendet. Beginnen Sie mit einem Satz, der die Sache benennt, und ergänzen Sie dann, was ein Leser braucht, um sie auszuwählen und richtig zu verwenden — was sie von der Plattform erwartet, auf der sie bereitstellt, und alles Überraschende an ihrem Verhalten. Ein kurzer Absatz ist die übliche Länge.
maintainersobject[]neinListe der Maintainer, die für diese Entität verantwortlich sind.
licensestringneinSPDX-Bezeichner für die Lizenz der Software, die diese Entität beschreibt, etwa MIT oder AGPL-3.0. Er hält die Bedingungen dieser Software fest, nicht die Bedingungen dieser Datei.
repositorystringneinDie URL des Git-Repositorys, in dem die Quelldateien liegen.
homestringneinDie URL der Homepage, des Wikis oder der Dokumentation dieser Entität.
keywordsstring[]neinEine Liste beschreibender Schlüsselwörter für die Auffindbarkeit in der Benutzeroberfläche.

Zusätzliche Eigenschaften sind nicht zulässig.

release.metadata.maintainers[]
EigenschaftTypErforderlichBeschreibung
namestringja
emailstringnein
urlstringnein

Zusätzliche Eigenschaften sind nicht zulässig.

release.spec

Was das Release bindet und routet: das Aggregate und das Manifest, die es bereitstellt (oder eine extends-Basis), die umgebungsspezifische Erfüllung der Parameter und die Boundaries, in die seine Komponenten geroutet werden.

EigenschaftTypErforderlichBeschreibung
aggregatestringneinReferenz auf das Aggregate (Entwicklerabsicht), das dieses Release bereitstellt. Ein bloßes Token wird über die Identität aufgelöst — den metadata.name des referenzierten Aggregate, gesucht im eigenen Verzeichnis des Release und dann im Katalog. Ein Wert, der mit ’./’ oder ’../’ beginnt, ist eine explizite lokale Datei, die relativ zum Release aufgelöst wird (z. B. ’../shared/app.yaml’, um ein Aggregate über Release-Varianten in einem Unterverzeichnis hinweg gemeinsam zu nutzen).
manifeststringneinReferenz auf das Manifest, das die abstrakten Schnittstellen auflöst, gegen die dieses Release bereitstellt. Ein bloßes Token wird über die Identität aufgelöst — den metadata.name des referenzierten Manifest, gesucht im eigenen Verzeichnis des Release. Ein Wert, der mit ’./’ oder ’../’ beginnt, ist eine explizite lokale Datei, die relativ zum Release aufgelöst wird. Ein Manifest ist bereitstellungsseitig und wird nicht im Katalog indiziert, daher wird es nur aus dem Release-Verzeichnis oder über einen expliziten Pfad aufgelöst.
extendsstringneinReferenz auf ein Basis-Release, dessen Authoring-Oberfläche dieses Release erbt — seinen Boundary-Baum mit der Infra pro Komponente und den darunter liegenden Feature-Anbindungen, seine Parameter, seine Annotationen und seinen Manifest-Verweis. Der Wert ist ein Pfad zu einer Datei neben diesem Release, beginnend mit ’./’ oder ’../’; ein bloßer Name und eine Registry-Koordinate werden beide abgelehnt, weil ein Release bereitstellungsseitig ist und nicht im Katalog indiziert wird. Was geerbt wird, kann Schlüssel für Schlüssel ersetzt werden, bis hinunter zum ersten unteilbaren Wert — einem Skalar, einer Liste, einem Template —, der als Ganzes ersetzt wird; ein als null geschriebener Schlüssel entfernt, was geerbt wurde. Kein Metadatenfeld wird übernommen, daher trägt ein Kind seinen eigenen Namen, seine eigene Version und seine eigene Umgebung. Die Deklaration von ‘aggregate’ neben ‘extends’ wird von diesem Schema abgelehnt, daher stellt ein Kind dieselbe Entwicklerabsicht bereit wie seine Basis; ‘manifest’ bleibt optional und kann überschrieben werden, um das Abhängigkeits-Lockfile auszutauschen.
parametersobjectneinUmgebungsspezifischer Vertrag zur Erfüllung von Variablen mit zwei Authoring-Modi per Dispatch nach Inhaltsform. Modus 1 (inline): eine YAML-Map, die strukturierte verschachtelte Parameterwerte direkt trägt. Modus 2 (Dateiimport): eine YAML-Map mit genau einem Schlüssel, $import: ./relative/path.yaml, die auf eine einzelne lokale Datei verweist, die die Parameterwerte liefert. An dieser Stelle nur eine einzige Quelle — die Schichtung über mehrere Dateien ist Sache der Release-Ketten über extends: (das übergeordnete Release liefert Basisparameter; das Kind erweitert + überschreibt).
boundariesMap von boundaryneinDie logischen Wurzelboxen, in die die Komponenten des Aggregate geroutet werden. Schlüssel: ein oder mehrere Buchstaben, Ziffern, Unterstriche oder Bindestriche. Ein Punkt ist nicht zulässig. Muster: ^[a-zA-Z0-9_-]+$.
componentsMap von boundary_componentneinKomponenteninstanzen auf oberster Ebene, die Operator-Infra pro Komponente tragen, für ein Release mit einem einzigen Geltungsbereich und ohne benannte Boundaries. Schließt sich mit boundaries gegenseitig aus: Deklarieren Sie components für ein flaches Release oder boundaries für ein Routing zu mehreren Zielen, niemals beides. Wird components verwendet, synthetisiert der Compiler eine Boundary default, die sie enthält, und gibt ihre Artefakte flach nach dist/ aus. Schlüssel: ein oder mehrere Buchstaben, Ziffern, Unterstriche oder Bindestriche. Ein Punkt ist nicht zulässig. Muster: ^[a-zA-Z0-9_-]+$.

Zusätzliche Eigenschaften sind nicht zulässig.

Definitionen

boundary_component

Eine in eine Boundary geroutete Komponenteninstanz, mit optionaler physischer Dimensionierung und optionalen Funktionsanbindungen.

EigenschaftTypErforderlichBeschreibung
descriptionstringneinOptionale Dokumentation, die die Rolle dieser Komponente in dieser Boundary des Release beschreibt.
subDirectorystringneinÜberschreibung des Unterpfads auf Component-Ebene, an das Verzeichnis der übergeordneten Boundary angehängt. Wenn er sowohl an der Boundary als auch an der Komponente weggelassen oder leer ist, ist der Standardwert ’{{ .capability }}’; ein hier geschriebener leerer String gilt als weggelassen. Setzen Sie ihn auf ’.’ oder auf ein Template, das zu einem leeren String ausgewertet wird, um die Erzeugung von Unterverzeichnissen zu deaktivieren.
annotationsMap von string oder object oder nullneinComponent-spezifische Operator-Annotationen, die für diese Komponente die Annotationen auf Boundary-Ebene überschreiben. Per Deep-Merge über die Boundary-Annotationen gelegt (die Komponente gewinnt bei einer Schlüsselkollision; strukturierte Werte werden pro Unterschlüssel mit strukturierten übergeordneten Werten zusammengeführt). Werte sind Strings, strukturierte Objekte oder null. Wird für Überschreibungen bekannter Provider-Annotationen pro Komponente verwendet (z. B. aggrega.ai/namespace beim Provider helm). Ein explizites null auf einem von der übergeordneten Boundary geerbten Schlüssel entfernt die geerbte Bindung aus dieser Komponente (annotationsgesteuerter Verzicht auf ein Feature); Geschwisterkomponenten behalten die geerbte Bindung.
infraobjectneinPhysische Dimensionierung, die streng auf diese Komponente beschränkt ist (z. B. Replikate, Disk-IOPS).
featuresMap von objectneinFeatures, die über das Release an diese Komponente angebunden werden. Für Funktionen, die auch im Aggregate deklariert sind, wird nur infra geliefert (die values stammen aus dem Aggregate). Für Funktionen nur im Release (vom Operator injiziert) ist type erforderlich. Die Schlüssel sind Instanznamen von Funktionen und können die vollständige URI des Funktionstyps tragen (Punkte und Schrägstriche zulässig). Das Release DARF KEINE values für Funktionen liefern — dies ist die Domäne des Entwicklers. Schlüssel: ein oder mehrere Buchstaben, Ziffern, Unterstriche, Punkte, Schrägstriche oder Bindestriche. Muster: ^[a-zA-Z0-9_./-]+$.
usesrelease_uses_blockneinKantenoberfläche des Operators. Innerhalb der vom Architekten deklarierten Sockets darf das Release einen deklarierten, aber ungebundenen Socket mit einer bestehenden Komponente verdrahten (target) und/oder Infra pro Kante liefern. Keine values (das values:-Verbot des Release gilt) und keine Erzeugung von Rechenressourcen; das Umleiten einer vom Entwickler deklarierten Kante bricht den Build ab.

Zusätzliche Eigenschaften sind nicht zulässig.

release_uses_block

Vom Release verfasste uses-Oberfläche pro Kante, nach Socket und dann nach Alias geschlüsselt (spiegelt die Form der uses-Topologie des Aggregate). Jede Verbindung kann target setzen (um eine Kante in einen deklarierten, aber ungebundenen Socket zu erzeugen, die auf eine bestehende Komponente zeigt), infra (Operator-Konfiguration pro Kante, validiert gegen das infraSchema des Sockets, wenn das Release aufgelöst wird) und features (Anbindungen, die die vom Socket deklarierten Slots füllen), in beliebiger Kombination. values ist verboten (das values:-Verbot des Release); das Umleiten einer vom Entwickler deklarierten Kante ist eine deutlich sichtbare Schutzschranke beim Build.

Schlüssel: ein oder mehrere Buchstaben, Ziffern, Unterstriche oder Bindestriche. Ein Punkt ist nicht zulässig. Muster: ^[a-zA-Z0-9_-]+$.

Werte sind map of object.

Kein anderer Schlüssel ist zulässig.

release_connection_attachment

Eine Anbindung, die ein Verbindungseintrag eines Release trägt: das Feature, das einen vom Socket der Verbindung deklarierten Slot füllt, mit der Dimensionierung des Operators dafür.

EigenschaftTypErforderlichBeschreibung
typestringneinDie URI des Feature. Erforderlich für eine Anbindung, die nur das Release vornimmt. Muss mit dem type des Aggregate übereinstimmen, wenn beide ihn deklarieren.
descriptionstringneinOptionale Dokumentation, die erklärt, warum der Operator diese Funktion an die Verbindung angebunden hat.
infraobjectneinOperative Dimensionierung für diese Anbindung, validiert durch die Schemadeklaration des Feature.

Zusätzliche Eigenschaften sind nicht zulässig.

aggregate_routing

Routet die internen Komponenten eines verschachtelten Aggregate-Untermoduls in diese Boundary. Spiegelt die component/aggregate-Struktur der Boundary für die rekursive Komposition.

EigenschaftTypErforderlichBeschreibung
componentsMap von boundary_componentneinComponent-Instanzen innerhalb des verschachtelten Aggregats, die in diese Boundary geroutet werden. Die Schlüssel sind der lokale Name, den jede Komponente innerhalb dieses Untermoduls trägt — ‘main-db’ für die Komponente, die die eigene Map components einer Boundary als ‘data.main-db’ adressiert —, weil das der einzige Name ist, den sie dort hat. Schlüssel: ein oder mehrere Buchstaben, Ziffern, Unterstriche oder Bindestriche. Ein Punkt ist nicht zulässig. Muster: ^[a-zA-Z0-9_-]+$.
aggregatesMap von aggregate_routingneinWeitere verschachtelte Aggregate innerhalb dieses Unteraggregats (für tief verschachtelte Modulkomposition). Schlüssel: ein oder mehrere Buchstaben, Ziffern, Unterstriche oder Bindestriche. Ein Punkt ist nicht zulässig. Muster: ^[a-zA-Z0-9_-]+$.

Zusätzliche Eigenschaften sind nicht zulässig.

boundary

EigenschaftTypErforderlichBeschreibung
descriptionstringneinOptionale Dokumentation, die den Zweck und das physische Ziel dieser Boundary beschreibt (z. B. ‘Primary production EKS cluster in us-east-1, PCI-DSS compliant’).
directorystringneinPhysischer Ausgabepfad für die Erzeugung von GitOps-Artefakten. Unterstützt Go-Template-Variablen ({{ .capability }}, {{ .boundary_name }}, {{ .parameters.X }}). Wird mit subDirectory per Pfadverknüpfung kombiniert, um den endgültigen Artefaktpfad zu erzeugen.
subDirectorystringneinUnterpfad auf Boundary-Ebene, an directory angehängt. Wenn er sowohl an der Boundary als auch an der Komponente weggelassen oder leer ist, ist der Standardwert ’{{ .capability }}’ für die automatische CI/CD-Partitionierung; ein hier geschriebener leerer String gilt als weggelassen. Setzen Sie ihn auf ’.’ oder auf ein Template, das zu einem leeren String ausgewertet wird, um ihn zu deaktivieren.
syncWaveintegerneinOptionale Bereitstellungswelle pro Boundary (Ganzzahl mit Vorzeichen, Standardwert 0). Jede Komponente in dieser Boundary erbt die Welle der Boundary in ihren Knoten. Negative Werte sind zulässig (werden vor allem anderen ausgeführt); größere Werte werden nach kleineren ausgeführt. Auf K8s und Helm ist die Welle das, was die Bereitstellung ordnet: Sie wird zu einer Annotation argocd.argoproj.io/sync-wave, und auf einer Ressource, die der Chart bereits als Helm-Hook kennzeichnet, wird sie außerdem zum helm.sh/hook-weight dieses Hooks. Auf compose wird die Welle sowohl als Service-Label festgehalten als auch zum Ordnen der Services der Datei verwendet, in die sie gerendert wird, über depends_on zwischen ihnen — sie erreicht also jeden Service in dieser einen Datei und nichts außerhalb davon. Auf cloudformation ordnet die Welle die Provisionierung des Stacks, zu dem die Boundary zusammengesetzt wird: Jede Ressource in einer Welle wird als abhängig von den Ressourcen der vorherigen Welle deklariert, was die Reihenfolge festlegt, in der sie erstellt werden, und umgekehrt die Reihenfolge, in der sie gelöscht werden. Das ist nur die Erstellungs- und Löschreihenfolge — ein Stack-Template kennt keinen Begriff davon, dass eine Ressource bereit ist, daher wartet nichts darauf, dass eine Ressource einsatzfähig wird. Auf terraform ordnet die Welle die module-Blöcke der Root-Konfiguration, zu der die Boundary zusammengesetzt wird: Jedes Modul in einer Welle wird als abhängig von den Modulen der vorherigen Welle deklariert, was die Reihenfolge festlegt, in der die Engine ihre Aktionen ausführt. Das ist nur die Reihenfolge der Aktionen — eine Konfiguration kennt keinen Begriff davon, dass eine Ressource bereit ist, daher wartet nichts darauf, dass eine Ressource einsatzfähig wird —, und der Wert wird außerdem mit der Build-Herkunft des Knotens festgehalten. Der Compiler überträgt denselben Wert auf jeden Knoten in der Boundary als dessen sync_wave, wo das Verhalten pro Ziel noch einmal aus Sicht des Knotens beschrieben wird. Verschachtelte Boundaries erben nicht implizit — jede deklariert ihre eigene Welle.
annotationsMap von string oder object oder nullneinBoundary-weite Operator-Annotationen, die hinunter in den Bucket .context.annotations.release kaskadieren. Werte sind Strings, strukturierte Objekte oder null. Ein strukturierter Wert trägt eine Konfiguration pro Unterschlüssel, die per Deep-Merge mit strukturierten übergeordneten Werten zusammengeführt wird (pro Unterschlüssel, das Kind gewinnt), und fließt durch die annotationsgesteuerte Feature-Expansion; nur skalare Werte erscheinen im Render-Kontext. Ein explizites null auf einem von einer übergeordneten Boundary geerbten Schlüssel entfernt die geerbte Bindung aus der effektiven Annotationsmenge dieser Boundary (annotationsgesteuerter Verzicht auf ein Feature) und wirkt auf jede in diese Boundary geroutete Komponente, sofern nicht eine tiefere Überschreibung die Bindung wieder einführt.
featuresMap von objectneinBoundary-weite Funktionen, die auf alle verschachtelten Komponenten angewendet werden (z. B. ein standardmäßiges Sicherheits-Mesh). Der uses-Block einer Funktion wird auf jede Komponente in der Boundary projiziert und deklariert eine gemeinsame Abhängigkeit einmal an der Boundary, statt sie an jeder Komponente zu wiederholen. Die Schlüssel sind Instanznamen von Funktionen und können die vollständige URI des Funktionstyps tragen (Punkte und Schrägstriche zulässig). Schlüssel: ein oder mehrere Buchstaben, Ziffern, Unterstriche, Punkte, Schrägstriche oder Bindestriche. Muster: ^[a-zA-Z0-9_./-]+$.
boundariesMap von boundaryneinVerschachtelte logische Boundaries (z. B. Namespaces innerhalb eines Clusters). Schlüssel: ein oder mehrere Buchstaben, Ziffern, Unterstriche oder Bindestriche. Ein Punkt ist nicht zulässig. Muster: ^[a-zA-Z0-9_-]+$.
componentsMap von boundary_componentneinWelche Komponenten aus dem Aggregate in diese Boundary platziert werden. Die Schlüssel sind Komponenteninstanznamen; die Komponente eines Unteraggregats wird über ihren qualifizierten Punktpfad adressiert (z. B. ‘data.main-db’ — der Name der Aggregatinstanz, ein Punkt, der Komponentenname). Schlüssel: ein oder mehrere Buchstaben, Ziffern, Unterstriche, Punkte oder Bindestriche. Muster: ^[a-zA-Z0-9_.-]+$.
aggregatesMap von aggregate_routingneinRoutet die Komponenten verschachtelter Aggregate-Untermodule in diese Boundary. Die Schlüssel sind Namen von Aggregatinstanzen, die der Map spec.aggregates des Aggregate entsprechen. Alle Aggregatinstanzen müssen in genau einer Boundary platziert werden, wenn Boundaries definiert sind. Schlüssel: ein oder mehrere Buchstaben, Ziffern, Unterstriche oder Bindestriche. Ein Punkt ist nicht zulässig. Muster: ^[a-zA-Z0-9_-]+$.

Zusätzliche Eigenschaften sind nicht zulässig.

uses_block

Die strukturelle Topologie - im Besitz des Entwicklers. Deklariert logische Netzwerkkanten und Abhängigkeiten.

Schlüssel: ein oder mehrere Buchstaben, Ziffern, Unterstriche oder Bindestriche. Ein Punkt ist nicht zulässig. Muster: ^[a-zA-Z0-9_-]+$.

Werte sind string[] or map of object.

Kein anderer Schlüssel ist zulässig.

inject_block

Agnostisches Injektions-Routing auf einer Verbindung. Ordnet lokale Variablen den provides-Schlüsseln des Ziels zu. Jeder Zustellmechanismus (env, file, arg oder benutzerdefiniert) wird als Array von Einträgen {in, from} verfasst — explizites ‘from’ für provides-Referenzen. Ein benutzerdefinierter Mechanismus darf jeden Namen außer all tragen: Ein Template liest alle Mechanismen zu einer Ansicht zusammengeführt unter .context.inject.all, sodass ein Mechanismus dieses Namens davon verdeckt würde, und einen solchen zu benennen bricht den Build ab.

EigenschaftTypErforderlichBeschreibung
envinject_deliveryneinEin einzelner Zustellmechanismus, verfasst als Array von Einträgen. Jeder Eintrag trägt ein ‘in’ (lokaler Bezeichner — Name einer Umgebungsvariablen, Dateipfad, Argument-Flag oder benutzerdefinierter mechanismusspezifischer Schlüssel) sowie genau eines von ‘from’ (ein aufzulösender provides-Schlüssel) oder ‘value’. In einem Release sitzt jeder Eintrag auf einer Verbindung, daher wird ‘from’ gegen die provides des Ziels aufgelöst, und ein Eintrag, der ‘value’ trägt, wird abgelehnt.
fileinject_deliveryneinEin einzelner Zustellmechanismus, verfasst als Array von Einträgen. Jeder Eintrag trägt ein ‘in’ (lokaler Bezeichner — Name einer Umgebungsvariablen, Dateipfad, Argument-Flag oder benutzerdefinierter mechanismusspezifischer Schlüssel) sowie genau eines von ‘from’ (ein aufzulösender provides-Schlüssel) oder ‘value’. In einem Release sitzt jeder Eintrag auf einer Verbindung, daher wird ‘from’ gegen die provides des Ziels aufgelöst, und ein Eintrag, der ‘value’ trägt, wird abgelehnt.
arginject_deliveryneinEin einzelner Zustellmechanismus, verfasst als Array von Einträgen. Jeder Eintrag trägt ein ‘in’ (lokaler Bezeichner — Name einer Umgebungsvariablen, Dateipfad, Argument-Flag oder benutzerdefinierter mechanismusspezifischer Schlüssel) sowie genau eines von ‘from’ (ein aufzulösender provides-Schlüssel) oder ‘value’. In einem Release sitzt jeder Eintrag auf einer Verbindung, daher wird ‘from’ gegen die provides des Ziels aufgelöst, und ein Eintrag, der ‘value’ trägt, wird abgelehnt.

inject_delivery

Ein einzelner Zustellmechanismus, verfasst als Array von Einträgen. Jeder Eintrag trägt ein ‘in’ (lokaler Bezeichner — Name einer Umgebungsvariablen, Dateipfad, Argument-Flag oder benutzerdefinierter mechanismusspezifischer Schlüssel) sowie genau eines von ‘from’ (ein aufzulösender provides-Schlüssel) oder ‘value’. In einem Release sitzt jeder Eintrag auf einer Verbindung, daher wird ‘from’ gegen die provides des Ziels aufgelöst, und ein Eintrag, der ‘value’ trägt, wird abgelehnt.

Typ: object[]