Aggrega-Schema für die Infrastrukturbasis (FeatureRecipe)
Generierte Referenz. Nicht von Hand bearbeiten — aus dem veröffentlichten JSON Schema neu generieren.
Schema-ID: https://aggrega.ai/schemas/featurerecipe-v1beta1.schema.json
Von Ops verfasste Definitionen, die ein abstraktes Feature des Katalogs auf eine konkrete, versionierte Implementierung für eine Provider-Fähigkeit abbilden. Strikt 1:1 mit einem physischen Provider und einem Katalog-Feature.
Siehe die Authoring-Referenz zum FeatureRecipe für Anleitungen in Prosaform zum Verfassen von FeatureRecipe-Entitäten; diese Seite dokumentiert das strukturelle Schema, das diese Referenz beschreibt.
Typ der obersten Ebene: object
Eigenschaften
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
apiVersion | const “aggrega.ai/v1beta1” | ja | Konstante: "aggrega.ai/v1beta1" |
kind | const “FeatureRecipe” | ja | Konstante: "FeatureRecipe" |
metadata | object | ja | |
spec | object | ja | Die Bindung an die Provider-Fähigkeit, das Mapping, die Pipeline und das Inject-Mapping für ein FeatureRecipe. Trägt dieselben drei Eingabearten wie ein Recipe (mit Quelle, synthetisiert, artifacts) sowie das nur bei FeatureRecipe vorhandene injectMapping; ein reines Verdrahtungs-FeatureRecipe, das nur capability und implements deklariert, ist gültig und rendert nichts. |
Zusätzliche Eigenschaften sind nicht zulässig.
featurerecipe.metadata
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
name | string | ja | Mindestens 1 Zeichen lang. |
version | string | ja | Strikte semantische Versionierung des FeatureRecipe (z. B. 1.2.5). 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-]+)*))?$. |
description | string | nein | Was 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. |
maintainers | object[] | nein | Liste der Maintainer, die für diese Entität verantwortlich sind. |
license | string | nein | SPDX-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. |
repository | string | nein | Die URL des Git-Repositorys, in dem die Quelldateien liegen. |
home | string | nein | Die URL der Homepage, des Wikis oder der Dokumentation dieser Entität. |
keywords | string[] | nein | Eine Liste beschreibender Schlüsselwörter für die Auffindbarkeit in der Benutzeroberfläche. |
Zusätzliche Eigenschaften sind nicht zulässig.
featurerecipe.metadata.maintainers[]
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
name | string | ja | |
email | string | nein | |
url | string | nein |
Zusätzliche Eigenschaften sind nicht zulässig.
featurerecipe.spec
Die Bindung an die Provider-Fähigkeit, das Mapping, die Pipeline und das Inject-Mapping für ein FeatureRecipe. Trägt dieselben drei Eingabearten wie ein Recipe (mit Quelle, synthetisiert, artifacts) sowie das nur bei FeatureRecipe vorhandene injectMapping; ein reines Verdrahtungs-FeatureRecipe, das nur capability und implements deklariert, ist gültig und rendert nichts.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
capability | string | ja | Die explizite Provider-Fähigkeit, an die sich dieses Rezept bindet (z. B. ‘helm’, ‘terraform’, ‘compose’) — die Art von Provider, die es rendert. |
implements | string | ja | Deklariert, welchen Feature-Typ des Katalogs dieses Rezept implementieren kann (einschließlich Zugangsdaten-Features mit dem Label feature.aggrega.ai/kind: secret; exakte Version, major-kompatibler Bereich ’^’ oder unversioniert). 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. Das Manifest-Mapping ist die explizite Wahl der Implementierung durch den Benutzer, festgelegt im Lockfile des Release. |
locals | Map von string | nein | Der private Ops-Zustand. Interne Berechnungsergebnisse, die nur innerhalb der Templates dieses FeatureRecipe als ‘.locals.*’ verfügbar sind. Jeder Eintrag ist selbst ein Go-Template, ausgewertet gegen einen in sich geschlossenen Kontext: ‘.context.instance_id’ (die HOST-KOMPONENTE, für die diese Anbindung aufgelöst wird, und das ist es, was diese Referenz auf jeder Template-Oberfläche bezeichnet), ‘.attachment_name’ (die Anbindungsinstanz, die aufgelöst wird, und der einzige Weg von einem Local zu diesem Namen), die eigenen ‘.values’ und ‘.infra’ der Anbindung 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. |
provides | Map von string | nein | Die öffentliche Entwickler-API. Vertragliche Ausgabevariablen, die für die nachgelagerte Auflösung von inject beim Aufrufer verfügbar sind. Wenn executionScope boundary ist, werden die provides einmal für die Boundary-Anbindung ausgewertet, gegen den Template-Kontext des Geltungsbereichs boundary, und jede Komponente, die von der Anbindung erreicht wird, liest diese eine Auswertung unter ‘.features. |
source | string oder object | nein | Optionaler Pfad zu Infrastrukturcode. Akzeptiert einen URI-String oder ein offenes strukturiertes Objekt. Wird er zusammen mit valuesMapping angegeben, rendert der Compiler ihn, und die gerenderten Dokumente werden der Ausgabe des FeatureRecipe hinzugefügt, bevor seine Pipeline-Schritte ausgeführt werden. |
valuesMapping | string oder object | nein | Inhalt des Mappings für values mit drei Authoring-Modi per Dispatch nach Inhaltsform. Modus 1 (inline): ein String-Skalar mit Go-Template, der 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. |
workload | string oder object | nein | Erzeuger 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 FeatureRecipe mit workload:, das an einen Provider gebunden ist, der nicht synthetisieren kann, bricht beim Rendern mit einer deutlichen Fehlermeldung ab. Eine synthetisierte Arbeitslast eines FeatureRecipe gibt ihre providernativen Manifeste im Ausgabeverzeichnis des Feature aus. In der Objektform darf $import nicht auf ^oci:// passen; ein Wert, der darauf passt, wird abgelehnt. |
artifacts | Map von string oder object | nein | Map 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. Die Hilfsressourcen, die ein ressourcengenerierendes FeatureRecipe ausgibt (ConfigMap, ServiceMonitor, NetworkPolicy, ExternalSecret-CRD usw.), haben Artefaktform; artifacts: ist der primäre Mechanismus zur Ressourcengenerierung. 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._-]*$. |
omits | object[] | nein | Was aus dem, was die Quelle dieses FeatureRecipe 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 FeatureRecipes 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 FeatureRecipe, 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. Der Schlüssel wird bei einem Recipe und bei einem FeatureRecipe identisch verfasst. Mindestens 1 Eintrag. |
injectMapping | string | nein | Optionales Inline-Go-Template, das während der Pre-Render-Abfangphase ausgewertet wird, einmal für jede Komponente, die von der Anbindung erreicht wird, gegen den Template-Kontext dieser Komponente: Es liest ‘.context’ und ‘.features’ der Komponente sowie ‘.attachment_name’, ‘.values’, ‘.infra’ und ‘.locals’ der Anbindung, was auch immer executionScope angibt, und eine Referenz auf ‘.boundary’, die der Kontext keiner Komponente enthält, bricht den Build ab. Gibt ein JSON/YAML-Dictionary aus, das der Go-Compiler nativ per Deep-Merge über die Speicher-Pipe ‘.context.inject’ des Aufrufers legt. Wird für die Wasm-freie Mutation von Umgebungsvariablen und Zustellverträgen auf Aufruferseite verwendet. |
pipeline | object[] | nein | Sequenzielle Liste von Wasm-Pipeline-Schritten, die nach dem Rendern über die gerenderte Dokumentmenge laufen und jeweils RFC-6902-Patches und Seiteneffekte zurückgeben. |
executionScope | string (enum) | nein | Ob die Ressourcengenerierung dieses FeatureRecipe pro Komponente (der Standard) oder einmal pro Boundary-Anbindung läuft. FeatureRecipes mit Geltungsbereich boundary werden nach (boundary_path, FeatureRecipe-Instanz) dedupliziert, und jedes Template außer dem injectMapping liest einen Template-Kontext des Geltungsbereichs boundary: die Säulen .boundary.* statt der Säulen .context.* pro Komponente, deren Referenzierung den Build abbricht. Das injectMapping läuft unabhängig von executionScope einmal für jede Komponente, die von der Anbindung erreicht wird, und liest daher den Kontext dieser Komponente und nie .boundary. Zulässige Werte: "component", "boundary" Standardwert: "component" |
readsCallerRenderFacts | boolesch | nein | Deklariert, dass die Templates dieses FeatureRecipe lesen, was die Components gerendert haben, die sich mit derjenigen verbinden, an die es angebunden ist: die Render-Fakten, die der Provider jedes dieser Aufrufer über seine eigene Ausgabe meldet. Wenn es true ist und das FeatureRecipe pro Komponente rendert, wird jede seiner Anbindungen gerendert, nachdem jede Component im Build gerendert wurde, statt direkt nach der Component, an die es angebunden ist, sodass das Rendern jedes Aufrufers abgeschlossen ist, bevor die Anbindung ausgewertet wird. Wenn es false ist oder fehlt, trägt der Eintrag keines Aufrufers in ‘.context.used_by’ Render-Fakten, die Anbindung wird direkt nach ihrer Component gerendert, sofern readsTargetRenderFacts nicht true ist, und der Build bricht bei einem inline in diesem FeatureRecipe geschriebenen Template ab, das die Render-Fakten eines Aufrufers unterhalb von ‘.context.used_by’ liest. Standardwert: false |
readsTargetRenderFacts | boolesch | nein | Deklariert, dass die Templates dieses FeatureRecipe lesen, was die Components gerendert haben, mit denen die Komponente verbunden ist, an die es angebunden ist: die Render-Fakten, die der Provider jedes dieser Ziele über seine eigene Ausgabe meldet, auf jedem Eintrag von ‘.context.uses’. Wenn es true ist und das FeatureRecipe pro Komponente rendert, wird jede seiner Anbindungen gerendert, nachdem jede Component im Build gerendert wurde, statt direkt nach der Component, an die es angebunden ist, sodass das Rendern jedes Ziels abgeschlossen ist, bevor die Anbindung ausgewertet wird. Dies ist dasselbe spätere Rendern, das readsCallerRenderFacts bewirkt, daher führt das Setzen eines der beiden Schlüssel oder beider dazu, dass die Anbindung dann gerendert wird. Wenn es false ist oder fehlt, trägt kein Eintrag in ‘.context.uses’ Render-Fakten, die Anbindung wird direkt nach ihrer Component gerendert, sofern readsCallerRenderFacts nicht true ist, und der Build bricht bei einem inline in diesem FeatureRecipe geschriebenen Template ab, das die Render-Fakten eines Ziels unterhalb von ‘.context.uses’ liest. Standardwert: false |
assertions | Map von string | nein | Feldü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. FeatureRecipe-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 FeatureRecipe 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.
featurerecipe.spec.omits[]
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
kind | string | ja | Die 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. |
name | string | ja | Der 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. |
namespace | string | nein | Der 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. |
subchart | string | nein | Das 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. |
when | string | nein | Inline-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.
featurerecipe.spec.pipeline[]
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
id | string | ja | Ein 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_]+$. |
plugin | string | ja | Die 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. |
function | string | ja | Die exportierte Wasm-Funktion, die aufgerufen wird. |
with | string | nein | Inline-Go-Template, das zu einer JSON/YAML-Map ausgewertet wird, die das explizite Eingabeschema dieses Plugin strikt erfüllt. |
optional | boolesch | nein | Wenn 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. |
when | string | nein | Inline-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.