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

Aggrega-Schema für das Abhängigkeits-Lockfile (Manifest)

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

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

Ein einziges, globales Lockfile, das abstrakte Komponenten- und Feature-Typen an konkrete Recipe- und FeatureRecipe-Implementierungen bindet, nach Typ, mit einer Überschreibung pro Instanz über den Namen.

Siehe die Authoring-Referenz zum Manifest für Anleitungen in Prosaform zum Verfassen von Manifest-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 “Manifest”jaKonstante: "Manifest"
metadataobjectja
defsstring[]neinOptionaler Block für Standard-YAML-Anker (& und *), um das Manifest DRY zu halten, während für den Compiler ein flaches O(1)-Wörterbuch erhalten bleibt.
specobjectjaDie Zuordnungsdeklarationen des Manifest plus optionale Vererbung von einer Basis: mappings verbindet abstrakte Komponenten- und Feature-Typen mit konkreten Recipe- und FeatureRecipe-Implementierungen; extends erbt Zuordnungen von einem Basis-Manifest.

Zusätzliche Eigenschaften sind nicht zulässig.

manifest.metadata

EigenschaftTypErforderlichBeschreibung
namestringjaMindestens 1 Zeichen lang.
versionstringjaStrikte semantische Versionierung des Manifest-Lockfiles (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 dem Release erwartet, das sie verwendet, 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.

manifest.metadata.maintainers[]
EigenschaftTypErforderlichBeschreibung
namestringja
emailstringnein
urlstringnein

Zusätzliche Eigenschaften sind nicht zulässig.

manifest.spec

Die Zuordnungsdeklarationen des Manifest plus optionale Vererbung von einer Basis: mappings verbindet abstrakte Komponenten- und Feature-Typen mit konkreten Recipe- und FeatureRecipe-Implementierungen; extends erbt Zuordnungen von einem Basis-Manifest.

EigenschaftTypErforderlichBeschreibung
extendsstringneinURI eines Basis-Manifest, von dem Zuordnungen geerbt werden. Die Zuordnung eines Kindes ersetzt die der Basis für denselben Schlüssel.
mappingsobjectjaBildet abstrakte Schnittstellen auf konkrete Implementierungen ab. Deklarieren Sie Zuordnungen unter den Schlüsseln der obersten Ebene ‘components’ und ‘features’, die jeweils URIs von Komponententypen / Feature-Typen direkt auf URIs von Recipe / FeatureRecipe abbilden. Diese beiden Schlüssel sind die gesamte Oberfläche; kein anderer Schlüssel wird hier akzeptiert. Die Zuordnung ist auf der Ebene des Manifest agnostisch gegenüber der Fähigkeit — die Bestimmung der Fähigkeit ergibt sich aus dem spec.capability jedes aufgelösten Recipe, wenn Aggrega das Release baut. Schlüssel: einer von "components", "features".

Zusätzliche Eigenschaften sind nicht zulässig.

manifest.spec.mappings

Bildet abstrakte Schnittstellen auf konkrete Implementierungen ab. Deklarieren Sie Zuordnungen unter den Schlüsseln der obersten Ebene ‘components’ und ‘features’, die jeweils URIs von Komponententypen / Feature-Typen direkt auf URIs von Recipe / FeatureRecipe abbilden. Diese beiden Schlüssel sind die gesamte Oberfläche; kein anderer Schlüssel wird hier akzeptiert. Die Zuordnung ist auf der Ebene des Manifest agnostisch gegenüber der Fähigkeit — die Bestimmung der Fähigkeit ergibt sich aus dem spec.capability jedes aufgelösten Recipe, wenn Aggrega das Release baut.

EigenschaftTypErforderlichBeschreibung
componentsmapping_tierneinZuordnung von Component-Typ zu Recipe-URI. Eine Recipe-URI trägt höchstens zwei Segmente — eine optionale führende Fähigkeit, dann den Rezeptnamen — plus eine optionale Version; eine Referenz mit einem dritten Segment passt auf kein Rezept. Versionsformen: exakt (‘postgres-bitnami:1.2.0’), Bereich (‘postgres-bitnami:^1.2.0’) oder unversioniert (‘postgres-bitnami’); der Resolver legt die aufgelöste Version bei der ersten Auflösung im Lockfile fest. Eine Referenz kann zusätzlich durch die Fähigkeit qualifiziert sein (‘terraform/mariadb-rds:1.0.0’, wobei das Segment vor dem ersten ’/’ das spec.capability des Rezepts benennt) — erforderlich, wenn mehr als ein Rezept unter demselben Namen ausgeliefert wird; eine mehrdeutige bloße Referenz bricht die Auflösung deutlich sichtbar ab, statt stillschweigend eines auszuwählen.
featuresmapping_tierneinZuordnung von Feature-Typ zu FeatureRecipe-URI. Umfasst sowohl operative Features als auch Zugangsdaten-Features (mit dem Label feature.aggrega.ai/kind: secret).

Schlüssel: einer von "components", "features".

Zusätzliche Eigenschaften sind nicht zulässig.

Definitionen

mapping_tier

Zweistufige Auflösung: ‘type’ ordnet nach Katalogtyp zu (DRY, in großer Menge), ‘name’ ordnet nach Instanzname zu (feingranulare Überschreibung). Beide sind optional, aber mindestens einer muss vorhanden sein. Bei der Auflösung hat name Vorrang vor type. Versionierte type-Schlüssel haben Vorrang vor unversionierten.

EigenschaftTypErforderlichBeschreibung
typeMap von stringneinBildet Katalogtyp-URIs auf Recipe-URIs ab. Unterstützt versionierte Schlüssel (‘core/api-server:1.0.0’) für eine exakte Übereinstimmung, Bereichsschlüssel (‘core/api-server:^1.0.0’) für eine mit der Hauptversion kompatible Übereinstimmung oder unversionierte Schlüssel (‘core/api-server’) für eine Übereinstimmung mit jeder Version.
nameMap von stringneinBildet bestimmte Instanznamen auf Recipe-URIs ab. Hat Vorrang vor der typbasierten Zuordnung.
annotationsMap von objectneinAnnotationsgesteuerte Feature-Kurzformen. Ordnet Annotationsschlüssel einer Feature-URI zu, plus einer nach Säulen gruppierten Routing-Tabelle vom Unterschlüssel mit Punktpfad zur Feature-Säule (values oder infra). Die Validierung ergibt sich aus der Deklaration spec.schema.. des Ziel-Feature; die Bindung deklariert nur das Routing. Die von ‘feature’ referenzierte Feature-URI MUSS auch im Abschnitt ‘type’ erscheinen (dort befindet sich die Bindung an die Version des FeatureRecipe).

Zusätzliche Eigenschaften sind nicht zulässig.