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

Aggrega-Schema für die Infrastrukturbasis (Recipe)

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

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

Von Ops verfasste Zeiger- und Zuordnungsschicht, die die Dev-Absicht mit einem bestimmten Infrastruktur-Provider verbindet. Strikt 1:1 mit einem physischen Provider und einer Katalogkomponente.

Siehe die Authoring-Referenz zum Recipe für Anleitungen in Prosaform zum Verfassen von Recipe-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 “Recipe”jaKonstante: "Recipe"
metadataobjectja
specobjectjaDie Provider-Bindung, die Quelle, das Mapping für values und die Pipeline für ein Recipe. Unterstützt drei Eingabearten, die durch Addition kombiniert werden: mit Quelle (source plus Überlagerung durch valuesMapping), synthetisiert (workload) und artifacts (benannte Ausgabedateien). Getrennt davon kann ein Recipe unter ‘boundary’ Dateien zur gemeinsamen Ausgabe der Boundary beitragen, in der es gerendert wird.

Zusätzliche Eigenschaften sind nicht zulässig.

recipe.metadata

EigenschaftTypErforderlichBeschreibung
namestringjaMindestens 1 Zeichen lang.
versionstringjaStrikte semantische Versionierung des Implementierungsrezepts (z. B. 2.1.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 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.

recipe.metadata.maintainers[]
EigenschaftTypErforderlichBeschreibung
namestringja
emailstringnein
urlstringnein

Zusätzliche Eigenschaften sind nicht zulässig.

recipe.spec

Die Provider-Bindung, die Quelle, das Mapping für values und die Pipeline für ein Recipe. Unterstützt drei Eingabearten, die durch Addition kombiniert werden: mit Quelle (source plus Überlagerung durch valuesMapping), synthetisiert (workload) und artifacts (benannte Ausgabedateien). Getrennt davon kann ein Recipe unter ‘boundary’ Dateien zur gemeinsamen Ausgabe der Boundary beitragen, in der es gerendert wird.

EigenschaftTypErforderlichBeschreibung
capabilitystringjaDie explizite Provider-Fähigkeit, an die sich dieses Rezept bindet (z. B. ‘helm’, ‘terraform’, ‘compose’) — die Art von Provider, die es rendert. Akzeptiert eine optionale Versionsfestlegung, in denselben drei Formen wie ‘implements’: unversioniert (‘helm’), exakt (‘helm:1.0.0’) oder major-kompatibler Bereich (‘helm:^1.0.0’). Der bloße Name wählt die Art von Provider; die Festlegung wählt, falls vorhanden, welche Version des Provider-Rendering-Plugins, das diese Fähigkeit bedient, dieses Rezept rendert — die höchste verfügbare ohne Festlegung, die exakte bei einer exakten Festlegung, die höchste im Bereich bei einem Zirkumflex. Eine Festlegung, die keine Version eines bedienenden Plugins erfüllt, bricht den Build mit einer deutlichen Fehlermeldung ab. Alles, was der Provider-Auswahl nachgelagert ist — Gruppierung der Ausgabe, Pfadsegmente, Pipeline-Kompatibilität und Codec-Wahl —, richtet sich nach der bloßen Fähigkeit, sodass zwei Rezepte, die unterschiedliche Plugin-Versionen derselben Fähigkeit festlegen, in einem Build nebeneinander bestehen.
implementsstringjaDeklariert, welchen Komponententyp des Katalogs dieses Rezept implementieren kann (exakte Version ‘core/api-server:1.0.0’, major-kompatibler Bereich ‘core/api-server:^1.0.0’ oder unversioniert ‘core/api-server’). Der Compiler verwendet es, um Manifest-Mappings zu prüfen und um in Diagnosen und in der Editor-Vervollständigung Kandidaten vorzuschlagen; zur Auflösung eines Builds wird es nie verwendet. Auch aggrega lint liest es, um die Component zu finden, deren deklarierter Vertrag provides der Maßstab ist, mit dem die veröffentlichten Schlüssel eines Recipe verglichen werden. Das Manifest-Mapping ist die explizite Wahl der Implementierung durch den Benutzer, festgelegt im Lockfile des Release.
sourcestring oder objectneinDer Ort des Infrastrukturcodes. Akzeptiert einen URI-String oder ein offenes strukturiertes Objekt, dessen vom Provider definierte Schlüssel den Templates des Recipe als ‘.source.*’ zur Verfügung gestellt werden.
localsMap von stringneinDer private Ops-Zustand. Interne Berechnungsergebnisse, die innerhalb der Templates dieses Recipe als ‘.locals.*’ verfügbar sind. Jeder Eintrag ist selbst ein Go-Template, ausgewertet gegen einen in sich geschlossenen, knotenlokalen Kontext: ‘.context.instance_id’, ‘.values’, ‘.infra’ sowie die bis dahin aufgelösten Einträge dieses selben Blocks. Einträge werden in der Reihenfolge aufgelöst, in der sie geschrieben sind, und ein Eintrag DARF einen Geschwistereintrag lesen, der OBERHALB von ihm definiert ist, und erhält dann dessen aufgelösten Wert statt seines Template-Texts. Die Reihenfolge des Autors ist Teil des Vertrags, wo immer ein Eintrag einen anderen liest: Wird eine Definition unter den Eintrag verschoben, der sie liest, bricht der Build, und der Block wird nie umsortiert, damit eine Referenz aufgelöst werden kann. Eine Referenz ‘.locals.’ auf einen Eintrag, den dieser Block SPÄTER definiert, bricht ab und nennt den Reihenfolgefehler; eine, die einen Schlüssel nennt, den der Block überhaupt nicht deklariert, bricht ab und nennt den Schlüssel. Beide Prüfungen lesen den Pfad, zu dem eine Referenz AUFGELÖST wird, statt der Tastenanschläge, und decken daher gleichermaßen die direkte Form ab, einen Lesezugriff innerhalb eines Blocks ’{{ with .locals }}’, einen Lesezugriff über eine Variable, die direkt an ‘.locals’ gebunden ist, und einen Schlüssel, der in Klammern aus dem Block gelesen wird, ‘(.locals).’ oder ’($.locals).’. Eine Schreibweise decken sie nicht ab: eine Referenz, deren Pfad der Template-Text nicht festlegt — eine, die über eine Funktion erreicht wird, etwa ‘index .locals’ oder ‘(default dict .locals).’, oder über einen Block ‘with’ oder eine Variablenbindung, deren Pipeline eine solche anwendet, denn was eine solche Pipeline liefert, wird bei der Auswertung entschieden und nicht durch ihren Text. Sie wird nicht analysiert, und ein fehlender Schlüssel, der auf diesem Weg erreicht wird, führt nicht zum Abbruch: Er rendert den wörtlichen Text '' statt gar nichts. Die einzige Ausnahme ist ‘index’ selbst: Auf jeder Template-Oberfläche bricht es ab und nennt den Schlüssel, wenn die Map, die es liest, den angefragten Schlüssel nicht enthält, sodass ein fehlender Schlüssel, der über ‘index .locals’ erreicht wird, zum Abbruch führt. Ein Local kann ‘.provides’ nicht lesen: Diese Säule ist nicht Teil dieses Kontexts, und ein Eintrag, der danach greift, bricht ab. Die aufgelösten Werte erreichen provides, source, valuesMapping, workload, artifacts, assertions und pipeline[].with (sowie pipeline[].when) — die Locals dieses Recipe werden VOR seinen provides aufgelöst, sodass ein Template für provides ‘.locals’ lesen kann und aufgelöste Werte erhält, während ein Template für provides, das einen Schlüssel nennt, den dieser Block nicht deklariert, abbricht. Wird verwendet, um physische Gegebenheiten (z. B. Ziel-Container, JSON-Pfade) für nachgelagerte Wasm-Plugins zu exportieren. Wird Aufrufern nie offengelegt — verwenden Sie provides für die öffentliche API.
providesMap von string oder number oder booleanneinDie öffentliche Entwickler-API. Vertragliche Ausgabevariablen, die für die nachgelagerte Auflösung von inject beim Aufrufer verfügbar sind. Der Compiler wertet Templates für provides gegen einen in sich geschlossenen Kontext aus, untereinander in beliebiger Reihenfolge — kein Eintrag in provides liest einen anderen. Die Locals des Knotens werden in der Locals-Präambel aufgelöst, vor seinen provides, sodass ein Template für provides ‘.locals’ lesen kann und aufgelöste Werte erhält; das Nennen eines Schlüssels, den der locals-Block nicht deklariert, bricht ab. Aufrufer lösen inject-Schlüssel bei der inject-Hydration gegen diese Werte auf. Werte sind Skalare — die Pipe überträgt sie unverändert und wandelt sie an der Injektionsgrenze deterministisch in Strings um.
valuesMappingstring oder objectneinInhalt des Mappings für values mit drei Authoring-Modi per Dispatch nach Inhaltsform. Modus 1 (inline): ein String-Skalar mit Go-Template (typischerweise Block-Skalar-YAML |), der aus dem Aggrega-Kontext (.values, .features, .infra) das vom Provider erwartete Format für values erzeugt. Modus 2 (Dateiimport): eine YAML-Map mit genau einem Schlüssel, $import: ./relative/path.tmpl, die auf eine lokale Go-Template-Datei verweist. Modus 3 (Bibliotheksimport): eine YAML-Map mit genau einem Schlüssel, $import: <Library>#/mappings/<entry>, die einen MappingLibrary-Eintrag über die Identität per bloßem Namen referenziert (die Version liefert das Lockfile pro Release; kein Registry-Host erscheint in der Referenz). In der Objektform darf $import nicht auf ^oci:// passen; ein Wert, der darauf passt, wird abgelehnt.
workloadstring oder objectneinErzeuger von Workload-YAML mit drei Authoring-Modi per Dispatch nach Inhaltsform. Modus 1 (inline): ein String-Skalar mit Go-Template, dessen Ausgabe als ‘aggrega.ai/v1beta1 Workload’ geparst wird. Modus 2 (Dateiimport): eine YAML-Map mit genau einem Schlüssel, $import: ./relative/path.yaml, die auf eine lokale Go-Template-Datei verweist. Modus 3 (Bibliotheksimport): eine YAML-Map mit genau einem Schlüssel, $import: <Library>#/workloads/<entry>, die einen WorkloadLibrary-Eintrag über die Identität per bloßem Namen referenziert (die Version liefert das Lockfile pro Release; kein Registry-Host erscheint in der Referenz). Der Ziel-Provider muss die Synthese von Arbeitslasten unterstützen; der Katalog der Standardbibliothek deklariert workloadSchema bei solchen Providern als dokumentierten Vertrag. Ein Recipe mit workload:, das an einen Provider gebunden ist, der nicht synthetisieren kann, bricht beim Rendern mit einer deutlichen Fehlermeldung ab. In der Objektform darf $import nicht auf ^oci:// passen; ein Wert, der darauf passt, wird abgelehnt.
artifactsMap von string oder objectneinMap vom Eintragsnamen auf das Authoring des Artefaktinhalts. Der Wert jedes Eintrags trägt einen von drei Modi per Dispatch nach Inhaltsform. Modus 1 (inline): ein String-Skalar mit Go-Template, dessen Ausgabe der Artefaktinhalt ist. Modus 2 (Dateiimport): eine YAML-Map mit genau einem Schlüssel, $import: ./relative/path.yaml, die auf eine lokale Go-Template-Datei verweist. Modus 3 (Bibliotheksimport): eine YAML-Map mit genau einem Schlüssel, $import: <Library>#/artifacts/<entry>, die ein ArtifactLibrary-Bundle über die Identität per bloßem Namen referenziert (die Version liefert das Lockfile pro Release; kein Registry-Host erscheint in der Referenz). Ein Bundle wird zu einer Ausgabe pro Datei erweitert, jede unter dem Schlüssel des Eintrags als <key>/<filename> verschachtelt. Der Schlüssel benennt die Ausgabe des Eintrags: Der Schlüssel eines Eintrags im Modus 1 oder 2 ist sein Ausgabedateiname, so verwendet, wie er geschrieben ist, und die importierte Datei eines Eintrags im Modus 2 liefert den Inhalt, ohne die Ausgabe zu benennen, sodass zwei Einträge, die verschiedene Dateien mit demselben Namen importieren, zwei getrennte Ausgaben sind. Kollisionen zwischen Artefakteinträgen, Bundle-Dateien, Quellausgabe und Arbeitslastsynthese brechen den Build ab, wenn der Knoten gerendert wird. Der Block artifacts wird bei einem Recipe und bei einem FeatureRecipe identisch verfasst — dieselben drei Modi, dieselbe Regel vom Schlüssel zur Ausgabe und dasselbe Kollisionsverhalten —, weshalb dieser Teil dieser Beschreibung bei beiden Arten gleich lautet; ein für die eine Art geschriebenes Beispiel lässt sich unverändert auf die andere übertragen. In der Objektform darf $import nicht auf ^oci:// passen; ein Wert, der darauf passt, wird abgelehnt. Schlüssel: Der Schlüssel benennt die Ausgabe des Eintrags und ist daher auf einen einzelnen Dateinamen beschränkt: Er beginnt mit einem Buchstaben oder einer Ziffer und setzt sich mit Buchstaben, Ziffern, Punkten, Bindestrichen oder Unterstrichen fort. Punkte nach dem ersten Zeichen erhalten die Dateiendungen, die Artefaktschlüssel tragen (main.tf, template.yaml, serviceaccount.yaml). Ein / ließe einen Schlüssel einen Pfad statt einer Datei benennen, und ein führender . würde .. zulassen, das einen Ort außerhalb des Ausgabeverzeichnisses benennt — die Zeichenklasse des ersten Zeichens lehnt beides ab. Bei einem Bibliotheksimport benennt der Schlüssel das Verzeichnis, unter dem die Dateien des Bundles verschachtelt sind, daher gilt dieselbe Beschränkung. Muster: ^[A-Za-z0-9][A-Za-z0-9._-]*$.
omitsobject[]neinWas aus dem, was die Quelle dieses Recipe rendert, ausgelassen werden soll — für eine unverändert übernommene Quelle, die etwas rendert, das das Release nicht ausliefern darf: ein Dokument, das ein abgerufenes Chart rendert, etwa ein Secret mit einem Schlüssel, den das Chart bei jedem Rendern neu erzeugt, einen Service, ein Volume oder eine Config, die eine abgerufene Compose-Datei mitbringt, oder eine Ressource, die ein abgerufenes CloudFormation-Template deklariert. Die meisten Recipes brauchen es nie. Jeder Eintrag benennt eine Einheit, die die Quelle rendert, über ihre Art, ihren Namen und, wo der Eintrag sie angibt, ihren Namespace und das Sub-Chart, aus dem sie stammt, jeweils im Vokabular, das der die Quelle rendernde Provider verwendet — bei einem Chart ein Dokument über sein eigenes kind und metadata.name; bei einer Compose-Datei einen service, ein volume oder eine config jeweils über den Schlüssel unter services:, volumes: oder configs:; bei einem CloudFormation-Template eine Ressource über ihren Type und ihre logische ID. Dieser Provider lässt jede Einheit aus, auf die ein Eintrag passt, und worauf ein Eintrag passt und was der Provider wegen eines Eintrags ablehnt, ist der Vertrag, den dieser Provider selbst dokumentiert. Ein Provider, der nichts auslassen kann, lehnt ein Recipe, das diesen Schlüssel deklariert, ab, bevor irgendetwas gerendert wird. Nur was source: rendert, wird gefiltert — ein Eintrag in workload: oder artifacts: nie —, daher setzt der Schlüssel source voraus. Jeder Wert ist ein Template, ausgewertet gegen den Kontext, gegen den valuesMapping ausgewertet wird. Das when eines Eintrags wird zuerst ausgewertet, und ein Eintrag, dessen when einen falsy-Wert rendert, wird verworfen. Jeder aktiv gebliebene Eintrag muss etwas auslassen: Ein aktiver Eintrag, der auf nichts passt, was die Quelle gerendert hat, bricht den Build ab und nennt den Eintrag. Die Quelle wird trotzdem vollständig gerendert — jedes Template eines Charts läuft trotzdem, sodass ein fehlschlagendes Template den Build trotzdem scheitern lässt —, und nur ihre Ausgabe wird ausgelassen. Mindestens 1 Eintrag.
boundaryobjectneinWas dieses Recipe zur gemeinsamen Ausgabe der Boundary beiträgt, in der es gerendert wird, statt zur Ausgabe seiner eigenen Komponente. Die meisten Recipes brauchen es nie: Es ist für eine Datei gedacht, die das Ziel einmal für die gesamte Boundary liest — etwa eine Terraform-Provider-Konfiguration, die Terraform nur in der Root-Konfiguration einer Boundary und nie innerhalb des Moduls einer einzelnen Komponente akzeptiert. Ein Provider akzeptiert solche Dateien nur dort, wo sein Vertrag boundaryArtifacts deklariert, und ein Recipe, das diesen Block für einen Provider deklariert, der dies nicht tut, wird abgelehnt, bevor irgendetwas gerendert wird. Ein FeatureRecipe trägt keinen solchen Block.
outputLabelsMap von stringneinVom Recipe-Autor deklarierte Labels, die auf jedes Objekt gestempelt werden, das die gerenderte Ausgabe dieses Rezepts erzeugt, vom Provider auf die Label-Oberfläche des jeweiligen Provider übersetzt (metadata.labels von Kubernetes für helm-Synthese, Quell-Rendering und Artefakte; Service-Labels von Compose; Tags pro Ressource in den Artefaktinhalten .tf.json von Terraform). Sie laufen auf derselben Schiene wie die festen Herkunfts-Labels, gehören aber dem Autor statt dem Compiler. Die Namespaces aggrega.ai/ und app.kubernetes.io/ sind plattformnativer Herkunft vorbehalten und werden beim Laden abgelehnt. Ein Schlüssel oder Wert, der für den Ziel-Provider kein gültiges Label ist, liegt in der Verantwortung des Rezeptautors; der Kern kontrolliert den Zeichensatz von Labels über die Regel der reservierten Namespaces hinaus nicht.
outputComponentLabelsstring[]neinIdentitäts-Label-Schlüssel der Component, die dieses Rezept auf seine gerenderte Ausgabe überträgt. Jeder Eintrag nennt einen Label-Schlüssel; der Wert wird aus den Labels der Komponenteninstanz übernommen, die dieses Rezept rendert, sodass das gestempelte Label den deklarierten Wert dieser Komponente trägt statt eines hier wiederholten. Übertragene Labels erreichen dieselbe Label-Oberfläche wie outputLabels, das stattdessen an Ort und Stelle verfasste wörtliche Schlüssel-Wert-Paare trägt. Ein in beiden Blöcken deklarierter Schlüssel wird beim Laden abgelehnt, sodass jeder gestempelte Schlüssel eine einzige Quelle hat. Die Namespaces aggrega.ai/ und app.kubernetes.io/ sind plattformnativer Herkunft vorbehalten und werden beim Laden abgelehnt; ein bereichsbezogener Schlüssel wie component.aggrega.ai/hosting liegt außerhalb dieser reservierten Wurzeln und kann übertragen werden.
pipelineobject[]neinSequenzielle Liste von Wasm-Pipeline-Schritten, die nach dem Rendern über die gerenderte Dokumentmenge laufen und jeweils RFC-6902-Patches und Seiteneffekte zurückgeben.
assertionsMap von stringneinFeldübergreifende Validierung zur Build-Zeit. Jeder Eintrag ist eine benannte Assertion: Der Schlüssel ist ein stabiler Regelbezeichner, der in Fehlermeldungen erscheint; der Wert ist ein Go-Template-String mit der Abbruchsemantik {{ fail "message" }}. Mehrere benannte Assertions pro Entität werden pro Instanz in der vom Autor deklarierten Reihenfolge ausgewertet; die erste fehlschlagende Assertion bricht den Build ab. Recipe-Assertions werden nach der Bindung des Rezepts und nach der Auswertung der provides, vor dem Rendern ausgewertet und drücken Implementierungsinvarianten des konkreten Charts oder Moduls aus, das das Recipe als Quelle verwendet. Template-Kontext: .values / .infra / .uses / .features / .metadata plus .provides / .locals / .recipe. Der Auswerter verwendet missingkey=error: Referenzen auf nicht definierte Schlüssel brechen mit einer no-such-key-Diagnose ab. Da die bloße Referenz abbricht, bevor ein Fallback ausgeführt werden kann, liefert ein einfaches default auf dieser Oberfläche keinen Fallback für ein optionales Feld — sichern Sie die Referenz mit hasKey ab, oder verwenden Sie den Helfer optional, der die Anwesenheitsprüfung direkt durchführt. Auch das Lesen des Schlüssels über index liefert keinen: index bricht bei einem Map-Schlüssel ab, den die Map nicht enthält, und nennt den Schlüssel.

Zusätzliche Eigenschaften sind nicht zulässig.

recipe.spec.omits[]
EigenschaftTypErforderlichBeschreibung
kindstringjaDie Art der auszulassenden Einheit, im Vokabular des Providers, der die Quelle rendert: für ein Chart das eigene kind eines gerenderten Dokuments, etwa Secret; für eine Compose-Datei service, volume oder config; für ein CloudFormation-Template der Type einer Ressource, etwa AWS::S3::Bucket. Sie benennt eine Art, die die Quelle rendert, und hat nichts mit dem kind: zu tun, das ein strukturiertes source: trägt. Ein Template.
namestringjaDer Name der auszulassenden Einheit, im Vokabular des Providers, der die Quelle rendert: für ein Chart der eigene metadata.name eines gerenderten Dokuments; für eine Compose-Datei der Schlüssel der Einheit unter services:, volumes: oder configs:; für ein CloudFormation-Template die logische ID der Ressource, ihr Schlüssel unter Resources. Ein Template.
namespacestringneinDer Namespace, in dem sich die auszulassende Einheit befindet, wenn der Eintrag nur eine Einheit in diesem Namespace erfassen soll — für einen Provider, dessen Ausgabe Namespaces hat, wie es bei den gerenderten Dokumenten eines Charts der Fall ist. Fehlt er oder rendert er zum leeren String, erfasst der Eintrag eine Einheit seiner Art und seines Namens, unabhängig von ihrem Namespace. Eine Compose-Datei und ein CloudFormation-Template haben keine Namespaces, und ihre Provider lehnen einen Eintrag ab, der einen nennt. Ein Template.
subchartstringneinDas Sub-Chart, aus dem die auszulassende Einheit stammt, wenn der Eintrag nur die Kopie erfassen soll, die ein Sub-Chart rendert — für eine Quelle, die aus verschachtelten Quellen zusammengesetzt ist, wie ein Chart aus seinen Sub-Charts. Für ein Chart der eigene Name des Sub-Charts oder der Alias, den ihm die Abhängigkeit seines übergeordneten Charts gibt, wobei die Namen eines verschachtelten Sub-Charts vom äußersten an mit / verbunden werden: operator oder operator/webhooks. Der Eintrag erfasst dann ein Dokument, das aus templates/ oder crds/ dieses Sub-Charts selbst gerendert wird, und weder eines, das das Chart selbst rendert, noch eines, das ein darin verschachteltes Sub-Chart rendert. Fehlt er oder rendert er zum leeren String, erfasst der Eintrag eine Einheit seiner Art und seines Namens, gleich woher sie stammt. Ein Chart, das kein Sub-Chart dieses Namens rendert, bricht den Build ab und nennt den Eintrag. Eine Compose-Datei und ein CloudFormation-Template haben keine Sub-Charts, und ihre Provider lehnen einen Eintrag ab, der eines nennt. Ein Template.
whenstringneinInline-Go-Template, das vor den anderen Feldern des Eintrags ausgewertet wird. Rendert es einen falsy-Wert, wird der Eintrag verworfen: Seine anderen Felder werden nicht ausgewertet, seinetwegen wird nichts ausgelassen, und er muss nichts erfassen. Ein leeres oder fehlendes when behält den Eintrag bei. Der Wahrheitswert folgt der Standardkonvention für boolesch artige Template-Ausgaben: Die Strings true/True/TRUE, jede Zahl ungleich null und jeder andere nicht leere String sind wahr, während false/False/FALSE, der leere String und null falsch sind. Ein when, dessen Rendern fehlschlägt, bricht den Build ab.

Zusätzliche Eigenschaften sind nicht zulässig.

recipe.spec.boundary

Was dieses Recipe zur gemeinsamen Ausgabe der Boundary beiträgt, in der es gerendert wird, statt zur Ausgabe seiner eigenen Komponente. Die meisten Recipes brauchen es nie: Es ist für eine Datei gedacht, die das Ziel einmal für die gesamte Boundary liest — etwa eine Terraform-Provider-Konfiguration, die Terraform nur in der Root-Konfiguration einer Boundary und nie innerhalb des Moduls einer einzelnen Komponente akzeptiert. Ein Provider akzeptiert solche Dateien nur dort, wo sein Vertrag boundaryArtifacts deklariert, und ein Recipe, das diesen Block für einen Provider deklariert, der dies nicht tut, wird abgelehnt, bevor irgendetwas gerendert wird. Ein FeatureRecipe trägt keinen solchen Block.

EigenschaftTypErforderlichBeschreibung
artifactsMap von string oder objectjaMap vom Dateinamen auf das Authoring des Dateiinhalts, genau so geformt wie die eigenen artifacts dieses Recipe: dieselben drei Modi — ein Inline-String mit Go-Template, ein $import: einer lokalen Go-Template-Datei oder ein $import: eines ArtifactLibrary-Bundles, dessen Dateien unter dem Schlüssel des Eintrags als <key>/<filename> verschachtelt werden —, dieselbe Regel vom Schlüssel zum Dateinamen und derselbe Template-Kontext, sodass ein Eintrag .values, .infra, .locals und den Rest genau so lesen kann, wie es ein Eintrag in artifacts tut. Anders ist, wohin jede Datei geschrieben wird: einmal, in das Verzeichnis, das die zusammengesetzte Ausgabe der Boundary enthält, neben die Dateien, die die eigene Zusammensetzung des Provider dort schreibt, statt in das eigene Verzeichnis dieser Komponente. Jeder Eintrag wird für jede Komponente ausgewertet, die dieses Recipe in der Boundary rendert, und die Dateien, die diese Auswertungen erzeugen, werden nach Namen zusammengeführt: Ein Name, der von mehreren Komponenten oder von mehreren Recipes zu identischen Bytes ausgewertet wird, ist eine einzige Datei, während ein Name, der zu unterschiedlichen Bytes ausgewertet wird, den Build abbricht und dabei die Datei und jeden Beitragenden nennt, ebenso wie ein Name, den die eigene Zusammensetzung des Provider bereits schreibt. In eine solche Datei wird nichts gestempelt, das angibt, welche Komponente sie geschrieben hat, denn sie gehört jeder Komponente, die sie deklariert hat. Ein Eintrag, dessen Template zu nichts rendert, schreibt keine Datei. Die Einträge werden nicht an den Provider übergeben, der den Rest der Ausgabe der Boundary schreibt, ohne sie zu lesen. In der Objektform darf $import nicht auf ^oci:// passen; ein Wert, der darauf passt, wird abgelehnt. Schlüssel: Der Schlüssel benennt die Datei und ist daher auf einen einzelnen Dateinamen beschränkt, nach der Regel, der ein Schlüssel in artifacts folgt: Er beginnt mit einem Buchstaben oder einer Ziffer und setzt sich mit Buchstaben, Ziffern, Punkten, Bindestrichen oder Unterstrichen fort. Ein / ließe einen Schlüssel einen Pfad statt einer Datei benennen, und ein führender . würde .. zulassen, das einen Ort außerhalb des Ausgabeverzeichnisses der Boundary benennt — die Zeichenklasse des ersten Zeichens lehnt beides ab. Bei einem Bibliotheksimport benennt der Schlüssel das Verzeichnis, unter dem die Dateien des Bundles verschachtelt sind, daher gilt dieselbe Beschränkung. Muster: ^[A-Za-z0-9][A-Za-z0-9._-]*$. Mindestens 1 Eintrag.

Zusätzliche Eigenschaften sind nicht zulässig.

recipe.spec.pipeline[]
EigenschaftTypErforderlichBeschreibung
idstringjaEin programmatischer Bezeichner für diesen Schritt, eindeutig unter den Schritten dieser Pipeline: Ein Dokument, das eine id an zwei seiner Schritte deklariert, wird beim Lesen abgelehnt. Ein späterer Schritt derselben Pipeline liest die Ausgaben dieses Schritts als .steps.<id>.outputs. Muster: ^[a-zA-Z0-9_]+$.
pluginstringjaDie Referenz auf die Plugin-Entität, die dieser Schritt ausführt, stets qualifiziert durch den eigenen Socket-Typ des Plugin: <pluginType>/<name> mit optionaler Version, wie in parser/yaml oder parser/yaml:1.0.0. Die Qualifizierung ist verpflichtend und nicht eine Form unter mehreren — ein unqualifiziertes name:version wird abgelehnt, weil zwei Sockets ein Plugin desselben Namens enthalten können und erst die Qualifizierung die Entität auflösbar macht. Der Build löst die Entität zu ihrem inhaltsadressierten .wasm-Artefakt auf — ermittelt aus der Identität des Plugin und der konfigurierten Registry, sein Digest im Lockfile festgelegt — und lädt die Bytes. Eine bloße .wasm- oder Artefaktreferenz wird hier nicht akzeptiert.
functionstringjaDie exportierte Wasm-Funktion, die aufgerufen wird.
withstringneinInline-Go-Template, das zu einer JSON/YAML-Map ausgewertet wird, die das explizite Eingabeschema dieses Plugin strikt erfüllt.
optionalbooleschneinWenn true, wird ein Fehlschlag dieses Schritts (ein Guest-Trap, ein Patch, der auf ein im Satz nicht vorhandenes Dokument zielt, ein fehlerhafter Patch oder eine Diagnose mit Abbruch-Schweregrad) zu einer deutlich sichtbaren Warnung herabgestuft: Der Dokumentsatz vor dem Schritt wird wiederhergestellt, die Ausgabe dieses Schritts wird verworfen, und die Pipeline läuft weiter. Wenn false oder fehlend, bricht jeder Fehlschlag eines Schritts den Build ab, nachdem der Dokumentsatz vor dem Schritt wiederhergestellt wurde.
whenstringneinInline-Go-Template, das beim Durchlaufen der Pipeline ausgewertet wird. Rendert es einen falsy-Wert, wird der Schritt übersprungen — ein Durchreichen: Der Dokumentsatz gelangt unverändert zum nächsten Schritt und trägt keine Patches, Nebeneffekte oder Schritteinträge bei. Ein leeres oder fehlendes when führt den Schritt immer aus. Der Wahrheitswert folgt der Standardkonvention für boolesch artige Template-Ausgaben: Die Strings true/True/TRUE, jede Zahl ungleich null und jeder andere nicht leere String sind wahr, während false/False/FALSE, der leere String und null falsch sind. when und optional sind voneinander unabhängig: Ein Schritt kann beide deklarieren.

Zusätzliche Eigenschaften sind nicht zulässig.