Aggrega-Schema für den Wasm-Render-Socket des Providers
Generierte Referenz. Nicht von Hand bearbeiten — aus dem veröffentlichten JSON Schema neu generieren.
Schema-ID: https://aggrega.ai/schemas/wasm-provider-v1beta1.schema.json
Die Übertragungsformen, die ein Provider-Render-Plugin-Socket verarbeitet und ausgibt. Ein Provider-Guest rendert über seinen Export render_node einen IR-Knoten in Ausgabedateien (RenderNodeInput zu RenderNodeOutput) und führt optional über seinen Export assemble_boundary die Ausgaben pro Knoten an einer Boundary zu einem einzigen zusammengesetzten Artefakt zusammen (AssembleBoundaryInput zu AssembleBoundaryOutput). AssembleBoundaryOutput trägt die zusammengesetzten Dateien und etwaige Diagnosen; wo die Dateien jedes Beitragenden liegen, wird einmal im describe()-Vertrag des Guests deklariert statt in dieser Antwort. Ein Guest kann außerdem einen optionalen Export validate_node_input deklarieren, der die aufgelöste Eingabe eines Knotens vor dem Render-Dispatch strukturell prüft: Er verarbeitet dieselbe RenderNodeInput-Projektion, die render_node erhält, und gibt ein ValidateNodeOutput zurück, das nur Diagnosen trägt — eine Diagnose mit Schweregrad halt hält den Build unübersehbar an, eine Diagnose mit Schweregrad warn wird im Build-Ergebnis ausgegeben. Ein Guest, dessen Ziel die Namen, die es akzeptiert, begrenzt oder einschränkt, kann außerdem einen optionalen Export name_bound deklarieren, den der Host befragt, bevor er die Komponentenidentität eines Knotens festlegt: Er verarbeitet ein NameBoundInput, das einen vorgeschlagenen Namen trägt, und gibt ein NameBoundOutput zurück, das ein Urteil pro Namensart trägt, die der Guest daraus ableiten würde. Ein Urteil trägt eine Einschränkung — verwendbar oder auf eine kürzere Länge begrenzt — und nie einen vom Guest gebildeten Namen, sodass das Wissen darüber, was das Ziel akzeptiert, im Guest bleibt. Davon getrennt kann ein Guest, dessen Ziel für die Ressourcen, die er rendert, einen eigenen Namen ableitet — aus vom Autor gelieferter Quelle oder aus einer Workload, die er synthetisiert —, einen optionalen Export rendered_name deklarieren, den der Host befragt, damit ein Recipe-Autor diesen Namen lesen und eine daraus gebildete Adresse veröffentlichen kann: Er verarbeitet ein RenderedNameInput, das die Identitäten trägt, aus denen das Ziel ableitet, und die Eingabearten, die das Recipe des Knotens deklariert, und gibt ein RenderedNameOutput zurück, das den Namen trägt, unter dem der Guest selbst rendern wird, oder keinen Namen, wo er keinen ableitet. Die beiden Exports sind entgegengesetzte Richtungen eines Themas, und keiner vertritt den anderen — name_bound bittet den Guest, einen vom Host vorgeschlagenen Namen zu beurteilen, während rendered_name einen vom Guest gebildeten Namen meldet, den der Host trägt, ohne ihn zu lesen. Ein Guest kann außerdem carve und reassemble deklarieren, die seine eigene Ausgabe für einen Pipeline-Schritt in adressierbare Einheiten zerlegen und die gepatchten Einheiten wieder einfügen, sowie link_publish und link_resolve, die eine uses-Kante verdrahten, deren Enden in unterschiedliche Dispatch-Gruppen zusammengesetzt werden. Die Form jeder Payload ist die Definition, die ihr Export nennt: Die Tabelle x-aggrega-exports ordnet jeden Export, mit dem der Host einen Guest aufruft — carve und reassemble eingeschlossen —, der Definition seiner Eingabe und der Definition seiner Ausgabe zu, jeweils als JSON Pointer in die $defs dieses Dokuments, sodass ein Werkzeug, das eine Payload validiert, ihre Definition dort nachschlägt. Die Dokumentwurzel deklariert keine eigene Form, weil ein Dokument eine gültige Payload mehrerer Exports sein kann (ein leeres Objekt ist eine gültige Antwort von validate_node_input, name_bound und rendered_name gleichermaßen). Der Guest gibt die serialisierten Bytes jeder Ausgabedatei zurück; der Host schreibt sie unverändert und führt keinen Serialisierer aus, daher liegt der Determinismus in der Verantwortung des Guests: Identische Eingabe muss identische Bytes erzeugen. Die Payload-Typen für Go, Rust und TypeScript werden aus diesem Schema in die Plugin-ABI-Pakete generiert, sodass die drei Sprachen dasselbe Übertragungsformat lesen und schreiben; ein Guest importiert sie aus diesen Paketen oder über sein Plugin-Kit, wo das Kit sie re-exportiert.
Exports
Die Tabelle x-aggrega-exports des Schemas ordnet jeden Export, mit dem der Host einen Guest aufruft, der Definition seiner Eingabe und der Definition seiner Ausgabe zu. Die Form einer Payload ist die Definition, die ihr Export nennt.
| Export | Eingabe | Ausgabe |
|---|---|---|
render_node | RenderNodeInput | RenderNodeOutput |
validate_node_input | RenderNodeInput | ValidateNodeOutput |
assemble_boundary | AssembleBoundaryInput | AssembleBoundaryOutput |
carve | CarveInput | CarveOutput |
reassemble | ReassembleInput | ReassembleOutput |
name_bound | NameBoundInput | NameBoundOutput |
rendered_name | RenderedNameInput | RenderedNameOutput |
link_publish | LinkPublishInput | LinkPublishOutput |
link_resolve | LinkResolveInput | LinkResolveOutput |
Definitionen
RenderNodeInput
Die Payload, die ein Provider-Guest über seinen Export render_node erhält: die IR-Projektion pro Knoten, die der Guest rendert, den Kontext zur Render-Zeit, die vorab ausgewerteten Eingaben, die das gebundene Recipe des Knotens deklariert — eine Auflistung der bezogenen Quelle, eine Workload, eine Artefaktmenge —, jeweils nur vorhanden, wenn dieses Recipe sie deklariert, und die Einträge, die gerenderte Einheiten nennen, die der Guest aus einem Quell-Rendering weglässt.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
node | IRNodeProjection | ja | Die IR-Daten pro Knoten, die ein Provider-Guest rendert — eine begrenzte Projektion des vollständigen IR-Knotens, die die Identität pro Knoten und die Herkunft trägt, die der Guest auf jedes ausgegebene Manifest stempelt: seine id, den Typ, das aufgelöste Rezept, die Werte, ob ein Werte-Mapping diese Werte erzeugt hat, die Feature-Anbindungen, die Sensitivitätsmarkierung über seine gerenderten Schlüssel und über die Werte als Ganzes, ausgehende uses-Kanten, den Boundary-Pfad, die sync wave, die Recipe-Identität, die Überschreibung der Komponenten-ID, die Basis des abgeleiteten Namens und die Build-Herkunft. Die Identität und die Basis des abgeleiteten Namens werden getrennt getragen, weil sie zwei Fragen beantworten — wozu eine Ressource gehört und wogegen die eigene Quelle eines Autors rendert —, und eine Feature-Anbindung, die von ihrem Autor geschriebene Quelle liefert, ist der Fall, in dem sich die beiden Antworten unterscheiden. Inhalte von Quelldateien werden hier nicht getragen; sie werden getrennt in der Quellprojektion übertragen. Jede Schlüsselmenge hier hat eine feste Reihenfolge — features und uses in Autorenreihenfolge, values und die Sensitivitätsmarkierung in sortierter Schlüsselreihenfolge —, sodass die übertragene Payload über Läufe mit identischer Eingabe hinweg byte-identisch ist. |
context | object | ja | Der Kontext zur Render-Zeit, den der Host dem Guest übergibt, getragen als die Bytes seines JSON-Dokuments; dieses Schema lässt das Objekt undeklariert. Er ist der Kontext, den ein Pipeline-Schritt desselben Knotens erhält, plus die Einrückungsbreite: parameters, die Parameterwerte des Release, nach Namen sortiert und fehlend, wenn es keine gibt; annotations, die Annotationen des Knotens, aufgeteilt danach, wo jede geschrieben wurde, in aggregate, release und catalog, jeweils fehlend, wenn leer; boundary, die Boundary, in der der Knoten liegt: name, path (ihre Segmente), sync_wave (fehlend, wenn 0), directory, sub_directory (fehlend, wenn es keines gibt) und annotations (die Menge, die die Boundaries des Release bis zum Knoten kaskadieren, wobei sein eigener Release-Eintrag zuletzt darübergelegt wird; fehlend, wenn leer); und yaml_indent, die für das gesamte Rendering geltende Einrückungsbreite, mit der der Guest seine Ausgabe serialisiert. Das Rendering eines FeatureRecipe mit Boundary-Geltungsbereich, das keine Host-Komponente hat, erhält den Kontext, den sein Pipeline-Schritt erhält, plus yaml_indent: parameters; annotations, das allein den release-Bucket trägt, der die eigene Annotationsmenge der Boundary ist; und ein boundary, das seinen name, seinen path und dieselbe Menge als seine annotations trägt. Die bekannten aggrega.ai/*-Annotationen werden aus dem aggregate-Bucket gelesen, über den der release-Bucket geschrieben wird, sodass ein Schlüssel, den beide tragen, den Wert des Release annimmt; ein Provider der Standardbibliothek liest sie aus dieser geschichteten Menge und nie aus dem catalog-Bucket, sodass ein Katalogwert nie über eine davon entscheidet, und ein FeatureRecipe mit Boundary-Geltungsbereich, dessen Kontext keinen aggregate-Bucket trägt, rendert nach den Werten seiner Boundary statt nach denen irgendeiner Komponente. |
source_listing | SourceListing | nein | Die generische Aufzählung der bezogenen Quelle, die der Host dem Guest für einen quellbasierten Provider übergibt: die Quellwurzel, ob diese Wurzel ein Verzeichnis ist, und die sortierten wurzelrelativen Einträge darunter. Der Host liest hier keinen Dateiinhalt — er listet nur Namen auf. Der Guest wendet seine eigene Auflösungslogik auf die Auflistung an und bittet den Host, eine gewählte Auswahl über die Host-Funktion pack-source zu packen, sodass die gesamte Provider-spezifische Intelligenz zur Quellauflösung im Guest liegt. Vorhanden bei quellbasierten Providern; andernfalls fehlend. |
workload_projection | WorkloadProjection | nein | Die vorab ausgewertete Workload, die der Host dem Guest übergibt, damit er daraus Provider-native Manifeste synthetisiert; vorhanden, wenn das gebundene Recipe statt einer Chart-Quelle eine Workload deklariert, andernfalls fehlend. |
artifacts_projection | ArtifactsProjection | nein | Die vorab ausgewertete Artefaktmenge, die der Host dem Guest übergibt, damit er sie in die Ausgabe des Knotens legt, vorhanden, wenn das gebundene Recipe Artefakte deklariert. Der Host hat die Quelle jedes Eintrags bereits gelesen, sie als Go-Template gegen den Render-Kontext ausgewertet und die Schlüsselmengen der Build-Herkunft berechnet; der Guest entscheidet über das Ausgabeformat, die Platzierung der Herkunft, den Pfad auf dem Datenträger und die endgültigen Bytes. Fehlt, wenn der Knoten keine Artefakte deklariert. |
omits | OmitEntry[] | nein | Die Einträge, die gerenderte Einheiten nennen, die der Guest aus der Ausgabe dieses Knotens weglässt, in der Reihenfolge, in der der Autor sie deklariert hat. Jeder Eintrag kommt aufgelöst an, seine Felder einfache Zeichenketten, und ein Eintrag, der für diesen Build nicht gilt, wird nicht getragen. Was kind, name, namespace und subchart eines Eintrags auswählen, ist der eigene dokumentierte Vertrag dieses Providers, nicht der dieses Sockets: Der Guest gleicht jeden Eintrag in den Begriffen seines eigenen Formats mit dem ab, was er gerendert hat, lässt jede Einheit, auf die ein Eintrag passt, aus allem weg, was er zurückgibt — seinen Dateien, den Namen, die er in derived_keys deklariert, und den Fakten, die er in render_facts meldet —, und meldet in omitted der Ausgabe, auf wie viele Einheiten jeder Eintrag gepasst hat. Die Einträge begleiten eine Quellauflistung und keine andere Eingabe: Ein Rendering einer synthetisierten Workload oder einer Artefaktmenge trägt sie nie. Fehlt, wenn es keine Einträge gibt, und ein Guest, dem keine übergeben werden, rendert genau so, wie er es täte, wenn das Feld nicht existierte. |
Zusätzliche Eigenschaften sind nicht zulässig.
IRNodeProjection
Die IR-Daten pro Knoten, die ein Provider-Guest rendert — eine begrenzte Projektion des vollständigen IR-Knotens, die die Identität pro Knoten und die Herkunft trägt, die der Guest auf jedes ausgegebene Manifest stempelt: seine id, den Typ, das aufgelöste Rezept, die Werte, ob ein Werte-Mapping diese Werte erzeugt hat, die Feature-Anbindungen, die Sensitivitätsmarkierung über seine gerenderten Schlüssel und über die Werte als Ganzes, ausgehende uses-Kanten, den Boundary-Pfad, die sync wave, die Recipe-Identität, die Überschreibung der Komponenten-ID, die Basis des abgeleiteten Namens und die Build-Herkunft. Die Identität und die Basis des abgeleiteten Namens werden getrennt getragen, weil sie zwei Fragen beantworten — wozu eine Ressource gehört und wogegen die eigene Quelle eines Autors rendert —, und eine Feature-Anbindung, die von ihrem Autor geschriebene Quelle liefert, ist der Fall, in dem sich die beiden Antworten unterscheiden. Inhalte von Quelldateien werden hier nicht getragen; sie werden getrennt in der Quellprojektion übertragen. Jede Schlüsselmenge hier hat eine feste Reihenfolge — features und uses in Autorenreihenfolge, values und die Sensitivitätsmarkierung in sortierter Schlüsselreihenfolge —, sodass die übertragene Payload über Läufe mit identischer Eingabe hinweg byte-identisch ist.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
id | string | ja | Die absolute ID des Knotens innerhalb des Topologiegraphen. |
type | string | ja | Deklariert und bewusst zurückgehalten: Der Host gibt dies immer als leere Zeichenkette aus. Das Komponententyp-Label des Knotens ist ein opakes Metadatum statt eines Verhaltensschalters, daher würde es, hier getragen, einen Guest nur dazu verleiten, danach zu verzweigen. Ein Guest liest eine leere Zeichenkette und darf das nicht als einen Knoten lesen, dessen Komponententyp nicht gesetzt ist. (Die Form des Boundary-Zusammensetzungsknotens trägt einen eigenen Typ, für einen anderen Zweck.) |
resolved_recipe | string | ja | Deklariert und bewusst zurückgehalten: Der Host gibt dies immer als leere Zeichenkette aus. Die Identität des gebundenen Recipe erreicht den Guest bereits als Rezeptname und -version, die er in die Herkunft stempelt, sodass der aufgelöste URI nichts hinzufügt, woraus ein Guest rendert. Ein Guest, der Ausgabe einem Recipe zuordnen muss, liest stattdessen diese Herkunftsfelder. |
values | object | nein | Das gerenderte Werte-Dictionary des Knotens, die Schlüsselmenge, aus der der Guest rendert. Schlüssel kommen in sortierter Reihenfolge an, nicht in Autorenreihenfolge, und diese Sortierung macht die Payload über Läufe mit identischer Eingabe hinweg byte-identisch; ein Guest, der eine andere Reihenfolge braucht, stellt sie selbst her. |
features | object | nein | Die Feature-Anbindungen des Knotens, nach Feature-Alias geschlüsselt, mit derselben Form der Feature-Anbindung pro Knoten, die das IR trägt. Jeder Eintrag trägt values, infra und das inject-Mapping der Anbindung zusammen mit ihrer abgeleiteten Sensitivitätsmarkierung, sodass ein Guest allein aus der Payload liest, ob eine Anbindung als sensibel deklariertes Material verarbeitet. Bewahrt die Autorenreihenfolge, sodass die Payload über Läufe mit identischer Eingabe hinweg byte-identisch ist. Auf dieser Schemaebene opak; der Guest liest die Form des Feature-Eintrags über den IR-Übertragungsvertrag. |
sensitive_rendered_keys | Map von string | nein | Gerenderte Schlüssel, deren Identität aus einem Datum zurückgewonnen wird, das ein Autor als sensibel deklariert hat, jeweils der Deklaration zugeordnet, von der sie diese Sensitivität geerbt haben. Wird vom Host zum Guest über die Render-Eingabe übertragen — die entgegengesetzte Richtung zu den Namen, die ein Guest in der Render-Ausgabe deklariert. Was ein Schlüssel benennt, folgt der Form, die diese Payload trägt: Bei einer Payload, die die Werte des Knotens trägt, ist er einer der Schlüssel dieser Map; bei einer Payload, die eine Workload trägt, benennt er einen Eintrag in den eigenen Anbindungs-Maps der Workload, wo die Werte des Knotens leer sind. Ein Schlüssel ist nur vorhanden, wo die Rückgewinnung exakt ist, indem sie eine Deklaration mit einer gerenderten Identität verbindet, ohne etwas aus dem eigenen Text des Schlüssels zu lesen und ohne eine Markierung pro Knoten oder pro Anbindung über einzelne Schlüssel zu verteilen. Ein Schlüssel, den ein Template erfunden hat, fehlt daher, weil keine Deklaration ihn benennt: Die Ausgabeschlüssel des valuesMapping eines Rezepts und der Inhalt eines Artefakts sind vom Template verfasst, sodass keines von beiden hier einen Schlüssel ergibt — ob eine solche Payload aus einem als sensibel deklarierten Wert erzeugt wurde, wird stattdessen von sensitive_values getragen und vom eigenen sensitive_content eines Artefakteintrags. Das Fehlen besagt daher, dass die Identität keines Schlüssels zurückgewonnen werden konnte, niemals, dass nichts in dieser Payload sensibles Material trägt — ein Guest, der einen fehlenden Schlüssel als Erlaubnis liest, einen Wert im Klartext anzuzeigen oder auszugeben, hat ihn verkehrt herum gelesen. Schlüssel kommen in sortierter Reihenfolge an, und das macht die Payload über Läufe mit identischer Eingabe hinweg byte-identisch. |
sensitive_values | boolesch | nein | Wahr, wenn die Werte, die diese Payload trägt, von einem Template erzeugt wurden, das einen Wert liest, den ein Autor als sensibel deklariert hat, oder einen auf einen solchen zurückgeführten Wert: das valuesMapping eines Recipe oder eines FeatureRecipe, ein einzelnes Template, dessen Ausgabeschlüssel und -werte seine eigene Erfindung sind, sodass kein Schlüssel dieser Ausgabe auf das Datum zurückgeführt werden kann, aus dem er stammt, und stattdessen die gesamte Map markiert wird. Es wird aus den eigenen Referenzen des Templates gegenüber den Deklarationen gelesen — eine Referenz, die einen deklarierten Wert erreicht, das Template, das die Gesamtheit seiner Daten weitergibt, oder ein Template, das sich nicht parsen lässt, zählen alle — und nie aus dem Inhalt eines Werts oder dem Namen eines Schlüssels. Ein Guest, der Text verfasst, den ein Mensch liest, eine Ablehnung oder eine Warnung, hält jeden Wert der Werte des Knotens aus diesem Text heraus, wenn dies wahr ist, und hält den Wert unter jedem Schlüssel heraus, den sensitive_rendered_keys nennt, ob es wahr ist oder nicht: Die beiden wirken zusammen, das eine benennt die Schlüssel, deren Identität exakt zurückgewonnen wird, und dieses deckt die Map ab, wo keine zurückgewonnen werden kann. Fehlt, wenn kein solches Template einen solchen Wert gelesen hat, was Werte einschließt, die selbst die deklarierten Blätter sind und stattdessen pro Schlüssel in sensitive_rendered_keys markiert werden, und fehlt bei einer Payload, die keine Werte trägt. Das Fehlen besagt nie, dass kein Wert sensibel ist. |
values_mapped | boolesch | nein | Wahr, wenn die Werte, die diese Payload trägt, die Ausgabe des valuesMapping des gebundenen Recipe oder FeatureRecipe sind statt der Werte des Knotens, die so weitergegeben werden, wie der Autor sie geschrieben hat. Ein Guest, dessen eigener Vertrag nur die Werte, die ein Mapping erzeugt hat, an die Eingaben bindet, die seine Quelle deklariert, liest dies und lässt Werte, die für etwas anderes geschrieben wurden, etwa für die Artefakte des Recipe, ungelesen; ein Guest, der die Werte des Knotens an seine Quelle bindet, gleich wie sie erzeugt wurden, liest es nicht. Es hält fest, wie die Werte erzeugt wurden, und wird nie aus dem Namen eines Schlüssels oder dem Inhalt eines Werts abgeleitet. Fehlt, wo kein valuesMapping ausgeführt wurde, und bei einer Payload, die keine Werte trägt. |
uses | Map von string[] | nein | Deklariert und bewusst zurückgehalten: Der Host befüllt dies nie, daher fehlt die Map in jeder Render-Payload. Eine ausgehende Kante wird vor dem Dispatch verbraucht — die veröffentlichten Werte der Kante werden in die eigene inject-Pipe des Knotens rehydriert, die das Recipe bereits zu den Werten und der Workload ausgewertet hat, die der Guest erhält —, und ein Guest, der eine Boundary zusammensetzt, erhält die Kantenliste stattdessen über seine eigene Eingabe. Wäre sie befüllt, würde sie die ausgehenden uses-Kanten des Knotens nach Socket-Alias schlüsseln, jede mit den geordneten Zielknoten-IDs dieses Sockets in Autorenreihenfolge. |
boundary_path | string | nein | Der Boundary-Pfad des Knotens, als Annotation aggrega.ai/boundary-path auf jedes ausgegebene Manifest gestempelt, das einen metadata-Block trägt. |
sync_wave | integer | nein | Die Bereitstellungswelle, geerbt von der Boundary, die diesen Knoten enthält (Standardwert 0; negative Werte zulässig), mit dem Wert, den der IR-Knoten als sync_wave hält. Was ein Guest damit tut, ist seine eigene Wahl, und den Wert festzuhalten und danach zu ordnen sind voneinander unabhängig statt Alternativen — ein Guest kann das eine oder das andere tun, beides oder keines. Unter den Providern der Standardbibliothek: helm und helm-chart geben sie als Annotation argocd.argoproj.io/sync-wave auf jeder gerenderten Ressource aus und zusätzlich als helm.sh/hook-weight auf einer Ressource, die das Chart bereits als Helm-Hook markiert; compose hält sie als Service-Label fest und ordnet die Services der Datei, in die es rendert, über depends_on zwischen ihnen; cloudformation ordnet die Provisionierung des zusammengesetzten Stacks, indem es jede Ressource einer Welle als abhängig von den Ressourcen der vorherigen Welle deklariert; terraform ordnet die Modulblöcke der Root-Konfiguration, zu der sich eine Boundary zusammensetzt, indem es jedes Modul einer Welle als abhängig von den Modulen der vorherigen Welle deklariert, und hält sie außerdem mit der Build-Herkunft des Knotens fest. |
recipe_name | string | nein | Der Name des gebundenen Recipe, mit recipe_version gepaart, um die Annotation aggrega.ai/recipe-uri zu bilden; ist eine der beiden Hälften leer, wird die Annotation nicht gestempelt. |
recipe_version | string | nein | Die Version des gebundenen Recipe, mit recipe_name gepaart, um die Annotation aggrega.ai/recipe-uri zu bilden; ist eine der beiden Hälften leer, wird die Annotation nicht gestempelt. |
label_component_id | string | nein | Die Kubernetes-sichere Komponentenidentität — wozu eine Ressource, die dieser Knoten ausgibt, GEHÖRT, was die Herkunft festhält und was ein Selektor abfragt. Wenn sie nicht leer ist, ersetzt sie die Knoten-ID als Wert der Labels app.kubernetes.io/name und aggrega.ai/component-id; leer bedeutet, dass die Knoten-ID bereits als Label gültig ist und direkt verwendet wird. Sie wird für jede Ressource getragen, die eine Feature-Anbindung ausgibt, gleich auf welchem Weg die Anbindung sie liefert, sodass die Ressourcen einer Anbindung allein am Label von denen ihrer Host-Komponente unterscheidbar sind. Woraus ein Guest seine eigenen Namen ableitet, wird getrennt getragen, als derived_name_basis, und die beiden beantworten unterschiedliche Fragen. |
derived_name_basis | string | nein | Die Identität, aus der ein Guest seine eigenen Namen ableitet — der Release-Name, den die Templates eines Chart-Installers lesen, nach dem ein solcher Guest auch die Ressourcen benennen kann, die er für eine Komponente synthetisiert, und das Präfix der Dateien, die ein Quell-Rendering ausgibt. Leer bedeutet, dass die Knoten-ID direkt verwendet wird, was der Wert für eine gewöhnliche Komponente und für eine Feature-Anbindung pro Komponente ist: Eine Anbindung, die ein Chart oder ein Fragment liefert, das ihr Autor geschrieben hat, rendert es gegen den Namen der HOST-Komponente, weil die eigenen Templates des Autors Ressourcen nach diesem Namen benennen und ein anderer bereits bereitgestellte Ressourcen umbenennen würde. Ein Knoten, dessen ID Markierungssyntax trägt, die das Namensalphabet eines Ziels ablehnt, trägt stattdessen dies explizit, sodass der Name, den ein Guest ableitet, einer bleibt, den das Ziel akzeptiert. Es ist bewusst von label_component_id getrennt: Ein Guest, der für eine Feature-Anbindung Ressourcen ERSTELLT, statt die Quelle ihres Autors zu rendern, benennt sie nach der Identität, sodass die eigenen Ressourcen der Anbindung nicht mit denen ihres Hosts kollidieren können, während der Name, gegen den die Quelle eines Autors rendert, unverändert bleibt. Die beiden tragen denselben Wert überall dort, wo die Identität eines Knotens auch das ist, wogegen seine Quelle rendert. |
output_labels | Map von string | nein | Die vom Rezeptautor deklarierten Ausgabe-Labels, die der Guest neben der Build-Identitäts-Herkunft auf jedes ausgegebene Manifest stempelt, nach Label-Namen geschlüsselt. Zwei verfasste Blöcke werden in diese eine Map zusammengeführt: die literalen Schlüssel-Wert-Paare, die ein Rezept in outputLabels schreibt, und ein Eintrag für jeden Schlüssel, den ein Rezept in outputComponentLabels nennt, dessen Wert aus diesem Schlüssel in den eigenen Labels der gerenderten Komponente gelesen wird — sodass ein hochgestufter Wert der Komponente folgt, aus der er stammt, statt im Rezept wiederholt zu werden. Beide Blöcke sind durch die Validierung zur Ladezeit vom Schlüsselraum der Herkunft getrennt (kein aggrega.ai/- oder app.kubernetes.io/-Schlüssel), sodass das Stempeln nie mit einem Herkunfts-Label kollidiert. Ein hochgestufter Schlüssel, den die Komponente nicht deklariert, stempelt nichts und löst einen Hinweis aus statt eines leeren Labels. Ein Guest, dessen Ausgabe kein Kubernetes-YAML ist, überträgt sie auf seine eigene Label-Oberfläche (Compose-Service-Labels) oder ignoriert sie. |
provenance | NodeProvenance | ja | Die Build-Identitäts-Herkunft, die der Guest als aggrega.ai-Labels auf jedes ausgegebene Manifest stempelt. |
Zusätzliche Eigenschaften sind nicht zulässig.
NodeProvenance
Die Build-Identitäts-Herkunft für einen Knoten — die Identität von Compiler, Aggregat und Umgebung, die der Guest als aggrega.ai-Labels auf jedes ausgegebene Manifest stempelt. Jedes Feld entfällt, wenn es leer ist, sodass eine teilweise Identität nur die Labels stempelt, die sie trägt.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
compiler_version | string | nein | Die Compiler-Version, als Label aggrega.ai/compiler-version gestempelt, wenn sie nicht leer ist. |
aggregate_name | string | nein | Der Aggregat-Name, als Label aggrega.ai/aggregate-name gestempelt, wenn er nicht leer ist. |
environment | string | nein | Der Umgebungsname, als Label aggrega.ai/environment gestempelt, wenn er nicht leer ist. |
provider_name | string | nein | Die reine Provider-Art, als Label aggrega.ai/provider gestempelt, wenn sie nicht leer ist. |
provider_version | string | nein | Die aufgelöste Version des Provider-Render-Plugins, als Label aggrega.ai/provider-version gestempelt, wenn sie nicht leer ist. |
Zusätzliche Eigenschaften sind nicht zulässig.
RenderNodeOutput
Die Payload, die ein Provider-Guest aus seinem Export render_node zurückgibt: die serialisierten Bytes jeder Ausgabedatei, die der Guest ausgegeben hat, die Namen, die er in jeden seiner eigenen Schlüsselräume abgeleitet hat, die Fakten, die er über das Ausgegebene meldet, auf wie viele gerenderte Einheiten jeder ihm übergebene omits-Eintrag gepasst hat, und alle Diagnosen, die der Guest beim Rendern ausgelöst hat. Der Guest gibt die serialisierten Bytes jeder Datei zurück; der Host schreibt sie unverändert und führt keinen Serialisierer aus. Determinismus liegt in der Verantwortung des Guests: Identische Eingabe muss identische Bytes erzeugen.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
files | RenderedFile[] | ja | Die Ausgabedateien, die der Guest ausgegeben hat, in Ausgabereihenfolge. Jede nennt ihren Pfad auf dem Datenträger und trägt die serialisierten Bytes, die der Host unverändert schreibt. |
derived_keys | Map von string[] | nein | Die Namen, die der Guest beim Rendern dieses Knotens abgeleitet hat, geschlüsselt nach dem Schlüsselraum, in den er sie abgeleitet hat, wobei jeder Raum seine Namen in Ableitungsreihenfolge trägt. Ein Guest, der den Namen ableitet, unter dem seine Ausgabe eine Ressource adressiert, hat diesen Namen in die Dateibytes gelegt, die der Host unverändert schreibt, wo der Host ihn nicht sehen kann; ihn hier zu deklarieren ist der Weg, auf dem der Guest den Host bittet zu bestätigen, dass keine zwei Ableitungen auf demselben Namen gelandet sind. Der Host vergleicht deklarierte Namen innerhalb eines deklarierten Raums auf Gleichheit und tut sonst nichts — er parst keinen Namen, erfährt nicht, was ein Raum oder ein Name bedeutet, und leitet nie selbst einen ab. Zwei Beitragende zur selben zusammengesetzten Ausgabe, die im selben Raum denselben Namen deklarieren, halten den Build an, und der Abbruch nennt den Raum, den Namen und beide Beitragenden. Sowohl die Raumnamen als auch die Namen darin sind das eigene Vokabular des Guests: Ein Guest, der Eindeutigkeit über einen engeren oder weiteren Geltungsbereich als eine zusammengesetzte Ausgabe wünscht, drückt diesen Geltungsbereich im Raumnamen aus, den er deklariert. Bewahrt die Deklarationsreihenfolge, sodass die Payload über Läufe mit identischer Eingabe hinweg byte-identisch ist. Fehlt, wenn der Guest keine Namen ableitet, die er geprüft haben möchte, was die Prüfung für diesen Guest wirkungslos lässt. |
render_facts | RenderFact[] | nein | Fakten, die der Guest über das meldet, was er für diesen Knoten ausgegeben hat, in der Reihenfolge, in der der Guest sie auflistet. Jeder Fakt paart einen Namen mit einem Wert, und beide sind das eigene Vokabular des Guests: Welche Fakten ein Provider meldet, was jeder Name bedeutet und was seine Einträge enthalten, ist Teil des dokumentierten Vertrags dieses Providers, nicht dieses Sockets. Der Wert jedes Fakts ist eine Liste, auch wenn sie einen Eintrag enthält: Der Host lehnt einen Fakt ab, dessen Wert etwas anderes ist, nennt den Provider und den Fakt und hält den Build an. Das ist das Einzige, was der Host über einen Wert erfährt. Er schlüsselt Fakten nach Namen und übergibt jede Liste an die Templates, die sie lesen, wobei er die Listen eines Namens, die von mehr als einem Rendering desselben Knotens gemeldet werden, in der Reihenfolge zusammenführt, in der diese Renderings liefen, und er erfährt nie, was ein Name oder ein Eintrag bedeutet, und leitet nie selbst einen Fakt ab — so kann ein Provider etwas melden, das nur sein eigenes Formatwissen sehen kann, etwa eine Eigenschaft der Dokumente, die er geschrieben hat, ohne dass der Host dieses Format kennenlernt. Das Melden von Fakten ändert nie, was geschrieben wird: Die Dateien, die der Host schreibt, sind die Dateien, die der Guest zurückgegeben hat, ob Fakten sie begleiten oder nicht. Der Guest listet seine Fakten in einer festen Reihenfolge auf, sodass die Payload über Läufe mit identischer Eingabe hinweg byte-identisch ist. Fehlt, wenn der Guest nichts meldet, was eine vollständige Antwort ist und keine fehlende. |
omitted | integer[] | nein | Auf wie viele gerenderte Einheiten jeder Eintrag von omits der Eingabe gepasst hat: eine Zahl pro Eintrag, der dem Guest übergeben wurde, in derselben Reihenfolge, jeweils die Anzahl der Einheiten, auf die dieser Eintrag gepasst hat, unabhängig davon, ob auch ein anderer Eintrag auf sie gepasst hat. Eine Zahl von null ist eine vollständige Antwort — der Eintrag hat auf nichts gepasst, was der Guest gerendert hat. Die Zahlen sind alles, was der Socket über das Weggelassene zurückträgt: Die Einheiten selbst fehlen einfach in dem, was der Guest zurückgegeben hat. Fehlt, wenn dem Guest keine Einträge übergeben wurden. |
diagnostics | Diagnostic[] | nein | Diagnosen, die der Guest beim Rendern ausgelöst hat. Jedes Element hat die gemeinsame Diagnoseform der Wasm-Plugins. |
error | string | nein | Eine Fehlermeldung, die gesetzt wird, wenn der Guest lief, die Operation aber nicht abschließen konnte; fehlt bei Erfolg. Sie ist von allen Diagnosen getrennt, die die Ausgabe trägt: Diagnosen melden Probleme, die während eines Laufs gefunden wurden, der dennoch ein Ergebnis erzeugt hat, während error meldet, dass die Operation selbst nicht abgeschlossen wurde. Der Host meldet einen vorhandenen Fehler als fehlgeschlagenen Plugin-Aufruf. |
condition_code | string | nein | Die beschreibende, maschinell abgleichbare Identität der Bedingung, die der Fehlschlag benennt — der Code, unter dem die Bedingung registriert ist, in derselben offenen Menge, in der der Compiler seine eigenen Abbruchbedingungen registriert, und kein Element des geschlossenen Katalogs der Fehlercodes für Host-Funktionen, aus dem der hostfunc_error_code eines Antwort-Umschlags stammt. Neben der für Menschen lesbaren Fehlermeldung gesetzt; fehlt bei Erfolg und fehlt, wenn der Guest keine solche Bedingung benennt. Ein Guest, der abbricht, meldet hier den Bezeichner der Bedingung, die seine Meldung benennt, sodass ein Verbraucher danach verzweigt, statt eine Identität durch Lesen der Meldung zu rekonstruieren. Der Host löst diesen Bezeichner gegen die Bedingungen auf, die der Compiler deklariert, und veröffentlicht die eigenen Bezeichner der aufgelösten Bedingung in der strukturierten Diagnose, sodass ein Code, der einen Leser erreicht, sich immer auflöst; ein Bezeichner, der keine solche Bedingung benennt, oder einer, den die Nummerierung zurückgezogen hat, hält den Build an. Ein Guest ohne genaue Bedingung, die er benennen könnte, greift stattdessen auf eine der generischen Plugin-Fehlerbedingungen zurück, die der Compiler zu diesem Zweck deklariert, und schreibt die Einzelheiten in seine eigene Meldung. Dieser Bezeichner und condition_short_code werden zusammen gemeldet, weil sie eine Bedingung in zwei Formen benennen: Ein Guest, der den einen setzt und den anderen nicht, hat eine Bedingung benannt, die der Host nicht auflösen kann, und der Host meldet dann stattdessen seine eigene generische Plugin-Fehlerbedingung, während die Meldung weiterhin den gesamten Fehlschlag trägt. |
condition_short_code | string | nein | Der kompakte Bezeichner derselben Bedingung — der Buchstabe E und vier Ziffern, die Form, die ein Leser zitiert, sucht und in einen Bericht einfügt —, neben der für Menschen lesbaren Fehlermeldung gesetzt; fehlt bei Erfolg und fehlt, wenn der Guest keine solche Bedingung benennt. Der Host gibt ihn im Kopf in eckigen Klammern der Diagnose aus, die er für diesen Fehlschlag rendert, sodass eine Bedingung, die ein Guest auslöst, genauso zitierbar ist wie eine, die der Compiler auslöst. Der Host löst den Wert gegen die Bedingungen auf, die der Compiler deklariert, statt ihn auf Treu und Glauben zu tragen: Ein Wert, der keine solche Bedingung benennt, ein Wert, den die Nummerierung zurückgezogen hat, oder eine Schreibweise, die die Registrierung nicht trägt, hält den Build an und zitiert den betreffenden Wert, wobei die eigene Meldung des Guests weiterhin gemeldet wird. Er wird zusammen mit condition_code gemeldet, aus dem dort genannten Grund. |
Zusätzliche Eigenschaften sind nicht zulässig.
ValidateNodeOutput
Die Payload, die ein Provider-Guest aus seinem optionalen Export validate_node_input zurückgibt: die Diagnosen, die eine strukturelle Prüfung der aufgelösten Eingabe des Knotens ausgelöst hat. Der Export verarbeitet dieselbe RenderNodeInput-Projektion, die render_node erhält, und gibt keine Dateien aus — er meldet nur Diagnosen. Eine Diagnose mit Schweregrad halt hält den Build unübersehbar an und nennt dabei den Knoten und den Provider; eine Diagnose mit Schweregrad warn oder info wird im Build-Ergebnis ausgegeben, ohne die gerenderte Ausgabe zu verändern. Eine leere Diagnoseliste bedeutet, dass die Eingabe die strukturelle Prüfung bestanden hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
diagnostics | Diagnostic[] | nein | Diagnosen, die der Guest beim Validieren der Eingabe des Knotens ausgelöst hat. Jedes Element ist die gemeinsame Diagnoseform der Wasm-Plugins. Leer, wenn die Eingabe die strukturelle Prüfung bestanden hat. |
error | string | nein | Eine Fehlermeldung, die gesetzt wird, wenn der Guest lief, die Operation aber nicht abschließen konnte; fehlt bei Erfolg. Sie ist von allen Diagnosen getrennt, die die Ausgabe trägt: Diagnosen melden Probleme, die während eines Laufs gefunden wurden, der dennoch ein Ergebnis erzeugt hat, während error meldet, dass die Operation selbst nicht abgeschlossen wurde. Der Host meldet einen vorhandenen Fehler als fehlgeschlagenen Plugin-Aufruf. |
condition_code | string | nein | Die beschreibende, maschinell abgleichbare Identität der Bedingung, die der Fehlschlag benennt — der Code, unter dem die Bedingung registriert ist, in derselben offenen Menge, in der der Compiler seine eigenen Abbruchbedingungen registriert, und kein Element des geschlossenen Katalogs der Fehlercodes für Host-Funktionen, aus dem der hostfunc_error_code eines Antwort-Umschlags stammt. Neben der für Menschen lesbaren Fehlermeldung gesetzt; fehlt bei Erfolg und fehlt, wenn der Guest keine solche Bedingung benennt. Ein Guest, der abbricht, meldet hier den Bezeichner der Bedingung, die seine Meldung benennt, sodass ein Verbraucher danach verzweigt, statt eine Identität durch Lesen der Meldung zu rekonstruieren. Der Host löst diesen Bezeichner gegen die Bedingungen auf, die der Compiler deklariert, und veröffentlicht die eigenen Bezeichner der aufgelösten Bedingung in der strukturierten Diagnose, sodass ein Code, der einen Leser erreicht, sich immer auflöst; ein Bezeichner, der keine solche Bedingung benennt, oder einer, den die Nummerierung zurückgezogen hat, hält den Build an. Ein Guest ohne genaue Bedingung, die er benennen könnte, greift stattdessen auf eine der generischen Plugin-Fehlerbedingungen zurück, die der Compiler zu diesem Zweck deklariert, und schreibt die Einzelheiten in seine eigene Meldung. Dieser Bezeichner und condition_short_code werden zusammen gemeldet, weil sie eine Bedingung in zwei Formen benennen: Ein Guest, der den einen setzt und den anderen nicht, hat eine Bedingung benannt, die der Host nicht auflösen kann, und der Host meldet dann stattdessen seine eigene generische Plugin-Fehlerbedingung, während die Meldung weiterhin den gesamten Fehlschlag trägt. |
condition_short_code | string | nein | Der kompakte Bezeichner derselben Bedingung — der Buchstabe E und vier Ziffern, die Form, die ein Leser zitiert, sucht und in einen Bericht einfügt —, neben der für Menschen lesbaren Fehlermeldung gesetzt; fehlt bei Erfolg und fehlt, wenn der Guest keine solche Bedingung benennt. Der Host gibt ihn im Kopf in eckigen Klammern der Diagnose aus, die er für diesen Fehlschlag rendert, sodass eine Bedingung, die ein Guest auslöst, genauso zitierbar ist wie eine, die der Compiler auslöst. Der Host löst den Wert gegen die Bedingungen auf, die der Compiler deklariert, statt ihn auf Treu und Glauben zu tragen: Ein Wert, der keine solche Bedingung benennt, ein Wert, den die Nummerierung zurückgezogen hat, oder eine Schreibweise, die die Registrierung nicht trägt, hält den Build an und zitiert den betreffenden Wert, wobei die eigene Meldung des Guests weiterhin gemeldet wird. Er wird zusammen mit condition_code gemeldet, aus dem dort genannten Grund. |
Zusätzliche Eigenschaften sind nicht zulässig.
RenderedFile
Eine Ausgabedatei, die ein Provider-Guest ausgegeben hat: ihr Pfad auf dem Datenträger relativ zur Ausgabewurzel des Knotens und ihre serialisierten Bytes genau so, wie der Guest sie erzeugt hat. Der Host schreibt diese Bytes unverändert und führt keinen Serialisierer aus, sodass die Ausgabe auf dem Datenträger byte-identisch mit dem ist, was der Guest ausgegeben hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
path | string | ja | Der Pfad der Ausgabedatei relativ zur Ausgabewurzel des Knotens (zum Beispiel Chart.yaml oder templates/deployment.yaml). |
content | string | ja | Die serialisierten Bytes der Datei genau so, wie der Guest sie erzeugt hat; der Host schreibt diese Bytes unverändert und führt keinen Serialisierer aus, sodass die Ausgabe byte-identisch mit dem ist, was der Guest ausgegeben hat. Jedes Kit trägt sie in seinem eigenen Feldtyp — roh, wo dieser Typ ein Bytetyp ist, base64-kodiert, wo er eine Zeichenkette ist, die der Guest dekodiert, um sie zurückzugewinnen —, und der generierte Encoder konvertiert zwischen dem Feld und der Form, in der das Übertragungsformat Bytes trägt. |
format | string | nein | Das Format, in dem die ausgegebene Datei laut Deklaration des Guests gerendert wurde, damit der Host die Datei an einen passenden Parser weiterleiten kann. Fehlt, wenn der Guest kein Format deklariert; in diesem Fall leitet der Host das Format aus der Dateiendung ab. |
Zusätzliche Eigenschaften sind nicht zulässig.
RenderFact
Ein Fakt, den ein Provider-Guest über das meldet, was er für einen Knoten ausgegeben hat: ein Name und eine Liste von Einträgen, beide vom Provider definiert und dokumentiert. Der Host trägt den Fakt so, wie der Guest ihn geschrieben hat, weist einen Fakt zurück, dessen Wert keine Liste ist, und erfährt über keine der beiden Hälften sonst etwas.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
name | string | ja | Der Name des Fakts, aus dem eigenen dokumentierten Vokabular des Providers. |
value | array | ja | Der Wert des Fakts: ein JSON-Array — immer eine Liste, auch mit einem Eintrag oder keinem —, dessen Einträge beliebige JSON-Werte in der Form sind, die der Provider für diesen Namen dokumentiert. Eine Liste ist das, was es erlaubt, dass ein Name von mehr als einem Rendering eines Knotens gemeldet wird: Der Host fügt die Listen zu einer zusammen. Sie wird als das JSON-Dokument getragen, das der Guest geschrieben hat, Byte für Byte, sodass die Reihenfolge der Listeneinträge und der Schlüssel jedes Objekts die eigene des Guests ist. |
Zusätzliche Eigenschaften sind nicht zulässig.
OmitEntry
Ein Eintrag, der gerenderte Einheiten nennt, die ein Provider-Guest aus der Ausgabe eines Knotens weglässt, seine Felder bereits zu einfachen Zeichenketten aufgelöst und dort markiert, wo eines davon aus einem als sensibel deklarierten Wert erzeugt wurde. Der Socket misst ihnen keine Bedeutung bei: Jeder Provider dokumentiert, was kind, name, namespace und subchart in seinem eigenen Format auswählen, und gleicht sie selbst ab.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
kind | string | ja | Die Art der gerenderten Einheit, die der Eintrag nennt, im eigenen Vokabular des Providers. |
name | string | ja | Der Name der gerenderten Einheit, die der Eintrag nennt, im eigenen Vokabular des Providers. |
namespace | string | nein | Der Namespace, in dem die genannte Einheit liegt, für einen Provider, dessen Format Einheiten in einem Namespace platziert. Fehlt, wenn der Autor keinen geschrieben hat; worauf ein Eintrag ohne Namespace passt, ist der eigene Vertrag des Providers. |
subchart | string | nein | Die verschachtelte Quelle, aus der die genannte Einheit stammt, für einen Provider, dessen Quelle aus verschachtelten Quellen zusammengesetzt ist, wie ein Chart aus seinen Subcharts. Fehlt, wenn der Autor keine geschrieben hat; worauf ein Eintrag ohne Subchart passt und was ein Provider, dessen Quelle keine verschachtelten Quellen hat, mit einem Eintrag tut, der eine nennt, ist der eigene Vertrag des Providers. |
sensitive | boolesch | nein | Wahr, wenn das Template, das kind, name, namespace oder subchart des Eintrags erzeugt hat, einen Wert liest, den ein Autor als sensibel deklariert hat, oder einen Wert, der auf einen solchen zurückgeführt wird. Dies wird aus dem Template jedes Felds gegenüber den Deklarationen gelesen — eine Referenz, die einen deklarierten Wert erreicht, das Template, das die Gesamtheit seiner Daten weitergibt, oder ein Template, das sich nicht parsen lässt, zählen alle — und nie aus den aufgelösten Zeichenketten. Die Markierung deckt den gesamten Eintrag ab, statt das Feld zu nennen, sodass ein Guest einen markierten Eintrag so behandelt wie jeden anderen markierten Wert seiner Eingabe: Er gleicht den Eintrag weiterhin anhand seiner Felder ab und zählt ihn, wozu der Eintrag da ist, und hält jedes seiner Felder aus jedem Text heraus, den ein Mensch liest — einer Ablehnung, einer Warnung oder einer Logzeile. Fehlt, wenn kein Feld-Template einen solchen Wert liest; das Fehlen besagt nie, dass kein Feld sensibel ist. |
Zusätzliche Eigenschaften sind nicht zulässig.
SourceFile
Eine Datei einer vorab gepackten Quellprojektion: ihr Pfad relativ zur Quellwurzel und ihre Rohbytes, genau so, wie der Host sie zur Kompilierzeit aus der lokalen Quelle gelesen hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
path | string | ja | Der Pfad der Datei relativ zur Quellwurzel (zum Beispiel Chart.yaml oder templates/deployment.yaml). |
content | string | ja | Die Rohbytes der Datei genau so, wie der Host sie aus der lokalen Quelle gelesen hat. Jedes Kit trägt sie in seinem eigenen Feldtyp — roh, wo dieser Typ ein Bytetyp ist, base64-kodiert, wo er eine Zeichenkette ist, die der Guest dekodiert, um sie zurückzugewinnen —, und der generierte Encoder konvertiert zwischen dem Feld und der Form, in der das Übertragungsformat Bytes trägt. |
Zusätzliche Eigenschaften sind nicht zulässig.
SourceProjection
Der gepackte Quellinhalt (z. B. die Dateien eines Helm-Charts, jede nach ihrem Pfad relativ zur Quellwurzel benannt, in Durchlaufreihenfolge), den der Host als Antwort auf eine pack-source-Anfrage liest und an den Guest zurückgibt, sodass der Guest die ausgewählte Quelle im Speicher rekonstruiert und kein Dateisystem berührt. Er ist die Erfolgs-Payload der Host-Funktion pack-source.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
files | SourceFile[] | ja | Die Quelldateien, jede nach ihrem Pfad relativ zur Quellwurzel benannt, in der deterministischen Durchlaufreihenfolge des Hosts. |
Zusätzliche Eigenschaften sind nicht zulässig.
SourceEntry
Ein Eintrag einer Quellauflistung: sein Pfad relativ zur Quellwurzel und ob er ein Verzeichnis ist. Der Host listet nur Namen auf und liest keinen Inhalt, daher trägt ein Eintrag keine Bytes.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
path | string | ja | Der Pfad des Eintrags relativ zur Quellwurzel, durch Schrägstriche getrennt (zum Beispiel Chart.yaml oder templates/deployment.yaml). |
is_dir | boolesch | ja | Ob der Eintrag ein Verzeichnis ist. Ein Guest, der in der Auflistung eine Chart-Wurzel oder eine einzelne Quelldatei auflöst, liest dies, um Verzeichnisse von Dateien zu unterscheiden, ohne das Dateisystem zu berühren. |
Zusätzliche Eigenschaften sind nicht zulässig.
SourceListing
Die generische Aufzählung einer bezogenen Quelle, die der Host dem Guest eines quellbasierten Providers übergibt: die Quellwurzel, ob diese Wurzel ein Verzeichnis ist, und die sortierten wurzelrelativen Einträge darunter. Der Host durchläuft die bezogene Quelle ohne Domänenwissen und liest keinen Dateiinhalt — er listet nur Namen auf. Der Guest wendet seine eigene Auflösungslogik auf die Auflistung an (er lokalisiert eine Chart-Wurzel, wählt ein einzelnes Compose-Dokument aus, vendort einen Modulbaum) und bittet den Host, eine gewählte Auswahl über die Host-Funktion pack-source zu packen. Die Einträge sind nach Pfad sortiert, sodass die Auflistung über Läufe mit identischer Eingabe hinweg byte-identisch ist.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
root | string | ja | Der Ort der bezogenen Quelle, den der Host aufgezählt hat. Der Guest übernimmt ihn in seine eigenen Diagnosen, wenn er die Quelle nicht auflösen kann, sodass ein Auflösungsabbruch die vom Autor gelieferte Quelle nennt. |
root_is_dir | boolesch | nein | Ob die Wurzel der bezogenen Quelle ein Verzeichnis ist. Falsch bei einer Einzeldatei-Quelle (ein einzelnes Compose-Dokument, eine einzelne Moduldatei, ein Archiv); in diesem Fall ist entries leer, und der Guest packt die Wurzel selbst. |
entries | SourceEntry[] | ja | Die wurzelrelativen Einträge unter einer Quellwurzel, die ein Verzeichnis ist, nach Pfad sortiert. Leer bei einer Quellwurzel, die eine einzelne Datei ist. |
Zusätzliche Eigenschaften sind nicht zulässig.
SourcePackRequest
Die Auswahl, die ein Guest den Host über die Host-Funktion pack-source aus der bezogenen Quelle zu packen bittet. op nennt die Form der Auswahl und path nennt sie relativ zur Quellwurzel; der Host löst den Pfad unterhalb der Quellwurzel auf, weist jedes Entweichen darüber zurück und gibt die gepackten Bytes als SourceProjection zurück.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
op | string (enum) | ja | Die Form der Auswahl: file packt die einzelne Datei unter path; dir packt die unmittelbaren Dateien des Verzeichnisses unter path; tree packt rekursiv den gesamten Teilbaum mit Wurzel bei path, in der deterministischen Durchlaufreihenfolge des Hosts. Zulässige Werte: "file", "dir", "tree" |
path | string | ja | Der Ort der Auswahl relativ zur Quellwurzel, durch Schrägstriche getrennt. Die leere Zeichenkette (oder ”.”) nennt die Quellwurzel selbst, sodass eine Einzeldatei-Quelle mit einem leeren Pfad gepackt wird. |
Zusätzliche Eigenschaften sind nicht zulässig.
SourcePackResponse
Die Antwort der Host-Funktion pack-source: bei Erfolg die gepackte Quelle, bei einem Fehlschlag eine Fehlermeldung. Genau eines der beiden Felder ist befüllt. Ein Fehlschlag wird In-Band übermittelt statt per Trap, sodass ein Guest eine Ablehnung durch die Sandbox oder einen Lesefehler als deterministischen Render-Fehlschlag in seine eigenen Diagnosen übernimmt.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
source_projection | SourceProjection | nein | Die gepackte Quelle bei Erfolg; fehlt bei einem Fehlschlag. |
error | string | nein | Die Fehlermeldung bei einem Fehlschlag, die die Auswahl und den Grund nennt; fehlt bei Erfolg. |
hostfunc_error_code | string (enum) | nein | Die maschinell abgleichbare Identität des Fehlschlags bei einem Fehlschlag, aus dem geschlossenen Katalog der Fehlercodes für Host-Funktionen, neben der für Menschen lesbaren Fehlermeldung gesetzt; fehlt bei Erfolg. Dieser Katalog ist ein festes Vokabular, das die Arten benennt, auf die eine Host-Funktion fehlschlagen kann, und er ist ein anderes Vokabular als die Abbruchbedingungen, die der Compiler registriert und deren Bezeichner ein Guest auf einer Socket-Ausgabe als condition_code und condition_short_code meldet — der Schlüsselname sagt, zu welchem der beiden ein Wert gehört, sodass die beiden nie als eine Menge gelesen werden. Ein Guest verzweigt nach diesem Code, ohne die Meldung zu parsen, und toleriert einen fehlenden Code (älterer Host) oder einen nicht erkannten (neuerer Host), indem er auf die Meldung zurückfällt. Zulässige Werte: "fetch_request_unreadable", "fetch_input_unavailable", "fetch_failed", "request_unreadable", "request_undecodable", "source_root_unavailable", "source_read_failed", "unknown_selection_op", "source_escape", "producer_consumption_reentry", "no_source_parser", "no_parser_for_format", "parse_failed" |
Zusätzliche Eigenschaften sind nicht zulässig.
SourceFileRequest
Das Lesen des Inhalts einer einzelnen Datei, das ein Guest den Host über die Host-Funktion read-source-file auszuführen bittet, für einen Guest, dessen Auflösungslogik den Inhalt einer Datei prüfen muss, bevor er wählt, was gepackt wird. Der Host löst den Pfad unterhalb der Quellwurzel auf, weist jedes Entweichen darüber zurück und gibt die Bytes der Datei zurück.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
path | string | ja | Der Ort der Datei relativ zur Quellwurzel, durch Schrägstriche getrennt. |
Zusätzliche Eigenschaften sind nicht zulässig.
SourceFileResponse
Die Antwort der Host-Funktion read-source-file: bei Erfolg die Bytes der Datei, bei einem Fehlschlag eine Fehlermeldung. Genau eines der beiden Felder ist befüllt. Ein Fehlschlag wird In-Band übermittelt statt per Trap, sodass ein Guest eine Ablehnung durch die Sandbox oder einen Lesefehler als deterministischen Render-Fehlschlag in seine eigenen Diagnosen übernimmt.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
content | string | nein | Die Rohbytes der Datei bei Erfolg; fehlen bei einem Fehlschlag. Jedes Kit trägt sie in seinem eigenen Feldtyp — roh, wo dieser Typ ein Bytetyp ist, base64-kodiert, wo er eine Zeichenkette ist, die der Guest dekodiert, um sie zurückzugewinnen —, und der generierte Encoder konvertiert zwischen dem Feld und der Form, in der das Übertragungsformat Bytes trägt. |
error | string | nein | Die Fehlermeldung bei einem Fehlschlag, die die Datei und den Grund nennt; fehlt bei Erfolg. |
hostfunc_error_code | string (enum) | nein | Die maschinell abgleichbare Identität des Fehlschlags bei einem Fehlschlag, aus dem geschlossenen Katalog der Fehlercodes für Host-Funktionen, neben der für Menschen lesbaren Fehlermeldung gesetzt; fehlt bei Erfolg. Dieser Katalog ist ein festes Vokabular, das die Arten benennt, auf die eine Host-Funktion fehlschlagen kann, und er ist ein anderes Vokabular als die Abbruchbedingungen, die der Compiler registriert und deren Bezeichner ein Guest auf einer Socket-Ausgabe als condition_code und condition_short_code meldet — der Schlüsselname sagt, zu welchem der beiden ein Wert gehört, sodass die beiden nie als eine Menge gelesen werden. Ein Guest verzweigt nach diesem Code, ohne die Meldung zu parsen, und toleriert einen fehlenden Code (älterer Host) oder einen nicht erkannten (neuerer Host), indem er auf die Meldung zurückfällt. Zulässige Werte: "fetch_request_unreadable", "fetch_input_unavailable", "fetch_failed", "request_unreadable", "request_undecodable", "source_root_unavailable", "source_read_failed", "unknown_selection_op", "source_escape", "producer_consumption_reentry", "no_source_parser", "no_parser_for_format", "parse_failed" |
Zusätzliche Eigenschaften sind nicht zulässig.
FetchExternalInputResponse
Die Antwort der Host-Funktion fetch-external-input: bei Erfolg der abgerufene Inhalt, bei einem Fehlschlag eine Fehlermeldung und ihr Code. Eine Antwort, die keines der beiden Fehlschlagfelder trägt, ist ein Erfolg, sodass eine Payload der Länge null die Antwort ist, in der jedes Feld fehlt. Ein Fehlschlag wird In-Band übermittelt statt per Trap, sodass ein Guest eine nicht auflösbare URL oder einen Abruffehler als deterministischen Render-Fehlschlag in seine eigenen Diagnosen übernimmt. Die Anfrage ist eine bloße URL-Zeichenkette statt einer strukturierten Payload, daher hat nur die Antwort eine deklarierte Form.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
content | string | nein | Die Rohbytes der abgerufenen Payload bei Erfolg; fehlen bei einem Fehlschlag und fehlen, wenn die Payload leer ist. Die Bytes werden im Übertragungsformat als Bytefolge übertragen, nie als base64-Text. Das Go-Kit hält sie als Byte-Slice; die Kits für Rust und TypeScript halten sie als base64-Zeichenkette, die der Fetch-Wrapper jedes Kits dekodiert, sodass jeder Wrapper die Rohbytes der Payload zurückgibt. |
error | string | nein | Die Fehlermeldung bei einem Fehlschlag, die die URL und die Abhilfe nennt; fehlt bei Erfolg. |
hostfunc_error_code | string (enum) | nein | Die maschinell abgleichbare Identität des Fehlschlags bei einem Fehlschlag, aus dem geschlossenen Katalog der Fehlercodes für Host-Funktionen, neben der für Menschen lesbaren Fehlermeldung gesetzt; fehlt bei Erfolg. Dieser Katalog ist ein festes Vokabular, das die Arten benennt, auf die eine Host-Funktion fehlschlagen kann, und er ist ein anderes Vokabular als die Abbruchbedingungen, die der Compiler registriert und deren Bezeichner ein Guest auf einer Socket-Ausgabe als condition_code und condition_short_code meldet — der Schlüsselname sagt, zu welchem der beiden ein Wert gehört, sodass die beiden nie als eine Menge gelesen werden. Ein Guest verzweigt nach diesem Code, ohne die Meldung zu parsen, und toleriert einen fehlenden Code (älterer Host) oder einen nicht erkannten (neuerer Host), indem er auf die Meldung zurückfällt. Zulässige Werte: "fetch_request_unreadable", "fetch_input_unavailable", "fetch_failed", "request_unreadable", "request_undecodable", "source_root_unavailable", "source_read_failed", "unknown_selection_op", "source_escape", "producer_consumption_reentry", "no_source_parser", "no_parser_for_format", "parse_failed" |
Zusätzliche Eigenschaften sind nicht zulässig.
WorkloadProjection
Der vorab ausgewertete Workload-Inhalt, den der Host einem Provider-Guest übergibt, damit der Guest daraus im Speicher Provider-native Manifeste synthetisiert, vorhanden, wenn das gebundene Recipe statt einer Chart-Quelle eine Workload deklariert. Der Determinismus liegt in der Verantwortung des Guests: Identische Eingabe muss identische Bytes erzeugen.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workload | object | ja | Die vom Host ausgewertete, bereits validierte Workload, die der Guest synthetisiert; auf dieser Schemaebene opak, damit das Socket-Schema den Entitätsvertrag der Workload nicht erneut bindet. |
sensitive_workload | boolesch | nein | Wahr, wenn das Template, das workload erzeugt hat, einen Wert liest, den ein Autor als sensibel deklariert hat, oder einen Wert, der auf einen solchen zurückgeführt wird. Dies wird aus den eigenen Referenzen des Templates gegenüber den Deklarationen gelesen — eine Referenz, die einen deklarierten Wert erreicht, das Template, das die Gesamtheit seiner Daten weitergibt, oder ein Template, das sich nicht parsen lässt, zählen alle — und nie aus dem Inhalt irgendeines Felds. Die Felder einer gerenderten Workload tragen keine Verbindung zurück zu den Daten, die ihr Template gelesen hat, daher markiert dies das gesamte Dokument: Ein Guest, der einen Text verfasst, den ein Mensch liest — eine Ablehnung oder eine Warnung —, hält jeden Wert, den die Workload trägt, aus diesem Text heraus, wenn dies wahr ist, während die Form des Dokuments — seine Schlüssel und wo ein Wert steht — lesbar bleibt. Die Anbindungseinträge, die sensitive_rendered_keys der Knotenprojektion nennt, sind dort markiert, unabhängig davon, ob dies gesetzt ist. Fehlt, wenn das Template keinen solchen Wert liest; das Fehlen besagt nie, dass kein Feld sensibel ist. |
attachment_provides | object | nein | Jede Anbindung am Knoten, projiziert auf ihre aufgelösten provides und nach dem Anbindungsinstanznamen geschlüsselt, den eine Workload-Anbindungsreferenz trägt; fehlt, wenn der Knoten keine Anbindungen trägt. Der Host kopiert die Zeichenketten durch, ohne sie zu interpretieren, sodass der Guest diejenigen Einträge der provides einer Anbindung liest, die er braucht, um eine Referenz auf die Ressource aufzulösen, die diese Anbindung erzeugt hat. Ob eine Anbindung als sensibel deklariertes Material verarbeitet, wird hier nicht wiederholt: Das wird im passenden Feature-Eintrag der Knotenprojektion übertragen, den ein Guest unter demselben Instanznamen liest. |
Zusätzliche Eigenschaften sind nicht zulässig.
ArtifactsProjection
Die vorab ausgewertete Artefaktmenge, die der Host einem Provider-Guest übergibt, damit er sie in die Ausgabe des Knotens legt. Der Host hat die Quelle jedes Eintrags bereits aufgelöst (Inline-Inhalt oder eine importierte Datei, die er gelesen hat), sie mit dem vom Guest deklarierten Delimiter-Paar für Artefakt-Templates als Go-Template gegen den Render-Kontext ausgewertet und die Label- und Annotationsschlüsselmengen der Build-Herkunft berechnet. Der Guest verantwortet die Formatentscheidung, die Platzierung der Herkunft, den Pfad auf dem Datenträger und die endgültigen Bytes. Die Einträge bewahren die Autorenreihenfolge, sodass die platzierte Ausgabe über Läufe mit identischer Eingabe hinweg byte-identisch ist.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
entries | ArtifactProjectionEntry[] | ja | Die Artefakteinträge, die der Guest platziert, in Autorenreihenfolge. |
Zusätzliche Eigenschaften sind nicht zulässig.
ArtifactProjectionEntry
Ein vorab ausgewerteter Artefakteintrag, den der Host einem Provider-Guest zum Platzieren übergibt: sein vom Host aufgelöster Ausgabename, sein Ursprung, die bereits als Template ausgewerteten Inhaltsbytes, ob das Template, aus dem diese Bytes stammen, einen als sensibel deklarierten Wert liest, und die Label- und Annotationsschlüsselmengen der Build-Herkunft, die der Host für den Knoten berechnet hat. Der Guest entscheidet, wie er die Herkunft platziert (indem er sie in die Metadaten eines Manifests einfügt, sie als Kommentar voranstellt oder eine Begleitdatei ausgibt) und wo die Datei landet.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
name | string | ja | Der vom Host aufgelöste Ausgabename für den Eintrag: der vom Autor deklarierte Map-Schlüssel, wobei eine von einem Bibliotheks-Bundle gelieferte Datei unter diesem Schlüssel verschachtelt ist. Der Guest platziert den Eintrag unter diesem Namen oder unter einem daraus abgeleiteten Provider-spezifischen Unterpfad. |
origin | string (enum) | ja | Ob der Eintrag als Inline-Inhalt oder als importierte Datei verfasst wurde. Ein Guest, der eine der beiden Formen zurückweist (ein Umbrella-Chart-Provider weist Inline-Inhalt zurück), liest dies, um unübersehbar anzuhalten. Zulässige Werte: "inline", "import" |
content | string | ja | Die bereits als Template ausgewerteten Inhaltsbytes, die der Host aus dem Inline-Inhalt oder der importierten Datei des Eintrags erzeugt hat, ausgewertet gegen den Render-Kontext mit dem vom Guest deklarierten Delimiter-Paar für Artefakt-Templates. Jedes Kit trägt sie in seinem eigenen Feldtyp — roh, wo dieser Typ ein Bytetyp ist, base64-kodiert, wo er eine Zeichenkette ist, die der Guest dekodiert, um sie zurückzugewinnen —, und der generierte Encoder konvertiert zwischen dem Feld und der Form, in der das Übertragungsformat Bytes trägt. |
sensitive_content | boolesch | nein | Wahr, wenn das Template, aus dem der Inhalt dieses Eintrags ausgewertet wurde, einen Wert liest, den ein Autor als sensibel deklariert hat, oder einen Wert, der auf einen solchen zurückgeführt wird. Dies wird aus den eigenen Referenzen des Templates gegenüber den Deklarationen gelesen, mit dem Delimiter-Paar, mit dem der Inhalt ausgewertet wurde — eine Referenz, die einen deklarierten Wert erreicht, das Template, das die Gesamtheit seiner Daten weitergibt, oder ein Template, das sich nicht parsen lässt, zählen alle — und nie aus dem Inhalt selbst. Der Inhalt ist die Ausgabe dieses Templates, daher lässt sich nichts darin auf das Datum zurückführen, aus dem es stammt: Ein Guest, der einen Text verfasst, den ein Mensch liest — eine Ablehnung oder eine Warnung —, hält jeden Teil des Inhalts aus diesem Text heraus, wenn dies wahr ist, die eigene Meldung eines Parsers über den Inhalt eingeschlossen. Es wird pro Eintrag gesetzt, sodass das Template eines Eintrags, das einen solchen Wert liest, nichts über das eines anderen aussagt. Fehlt, wenn das Template keinen solchen Wert liest; das Fehlen besagt nie, dass der Inhalt nicht sensibel ist. |
labels | object | nein | Die Kubernetes-Label-sichere Schlüsselmenge der Build-Herkunft, die der Host für den Knoten berechnet hat, nach Label-Namen geschlüsselt. Ein Guest, der die Herkunft in metadata.labels eines Manifests stempelt, fügt diese ein; ein Guest, dessen Ausgabe kein Kubernetes-YAML ist, ignoriert sie. |
annotations | object | nein | Die vom Host für den Knoten berechnete Schlüsselmenge der Build-Herkunft, die ein Kubernetes-Label nicht darstellen kann, nach Annotationsnamen geschlüsselt. Ein Guest, der die Herkunft in metadata.annotations eines Manifests stempelt, fügt diese ein; ein Guest, dessen Ausgabe kein Kubernetes-YAML ist, ignoriert sie. |
Zusätzliche Eigenschaften sind nicht zulässig.
AssembleBoundaryInput
Die Payload, die ein Provider-Guest über seinen Export assemble_boundary erhält — den Export, der die Render-Ausgaben pro Knoten an einer Dispatch-Gruppe zu einem einzigen zusammengesetzten Artefakt zusammenführt (einem Umbrella-Chart, einer zusammengeführten Compose-Datei). Sie trägt die Render-Ausgaben pro Knoten mit ihren zusammengeführten Annotationen und Bereitstellungswellen, den Ausgabepfad der Dispatch-Gruppe, an dem das zusammengesetzte Artefakt landet, die uses-Kanten des Graphen zur Ableitung von Abhängigkeiten pro Service und den Kontext zur Render-Zeit. Nicht jeder Provider deklariert den Export: Provider, die nur flache Ausgabe pro Knoten ausgeben, lassen ihn weg.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
rendered_nodes | RenderedNode[] | ja | Die Render-Ausgaben pro Knoten, die in diese Dispatch-Gruppe eingeflossen sind, in Knotenreihenfolge. |
context | object | ja | Der Kontext zur Render-Zeit, getragen als die Bytes seines JSON-Dokuments. Bei diesem Export setzt der Host nur yaml_indent, die für das gesamte Rendering geltende Einrückungsbreite, mit der die zusammengesetzten Dateien serialisiert werden; die übrigen Mitglieder des Kontexts tragen hier nichts, weil eine Zusammensetzung Beitragende zusammenführt, deren Annotationen und Boundaries sich unterscheiden, und die Annotationen jedes Beitragenden stattdessen über seinen Eintrag in rendered_nodes ankommen. |
boundary_path | string | ja | Der ausgewertete Ausgabepfad der Dispatch-Gruppe, an dem das zusammengesetzte Artefakt landet; ein Boundary-Assembler verwendet ihn als Ausweichidentität auf Boundary-Ebene (z. B. den Compose-Netzwerknamen für einen Knoten, der keine namespace-Annotation trägt). |
edges | RenderEdge[] | nein | Die gerichteten uses-Kanten des Graphen, damit ein Boundary-Assembler die Reihenfolge/Abhängigkeiten pro Service über die Beitragenden der Dispatch-Gruppe hinweg ableiten kann (z. B. depends_on bei compose). |
sub_charts | SubChart[] | nein | Die Payload pro Sub-Chart, die ein Umbrella-Chart-Assembler verarbeitet, um pro Beitragendem eine Abhängigkeit und einen Werte-Geltungsbereich auszugeben. Jeder Eintrag trägt die Identität des Sub-Charts, die Werte pro Instanz und, bei einem aus einer Chart-Quelle gevendorten Sub-Chart, die unveränderten Bytes der Datei Chart.yaml dieses Charts. Vorhanden bei der Umbrella-Chart-Zusammensetzung; ein flach zusammenführender Assembler lässt es weg. |
chart_name | string | nein | Der Chart-Name, den ein Umbrella-Chart-Assembler für das zusammengesetzte Chart verwendet, wenn für die Dispatch-Gruppe ein Name geliefert wird; leer, wenn der Assembler den Namen aus dem Ausgabepfad der Dispatch-Gruppe ableitet. |
aggregate_name | string | nein | Der Aggregat-Name der obersten Ebene, den ein Umbrella-Chart-Assembler in den abgeleiteten Namen des zusammengesetzten Charts einbezieht; leer, wenn keine Aggregat-Identität zum Namen beiträgt. |
Zusätzliche Eigenschaften sind nicht zulässig.
RenderedNode
Die Render-Ausgabe eines Knotens, wie sie in einer Eingabe von assemble_boundary erscheint: die Knoten-ID, sein Typ, seine zusammengeführten Annotationen, seine sync wave, die Werte, die der Compiler für ihn aufgelöst hat, wo diese vom Compiler zu liefern sind, und ob ein Werte-Mapping sie erzeugt hat, sowie die Dateien, die der Export render_node für ihn erzeugt hat — getragen in der Form der Render-Ausgabe, wobei jedes Mitglied dieser Form außer seinen Dateien fehlend gelassen wird.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
id | string | ja | Die absolute ID des Knotens innerhalb des Topologiegraphen. Ein Beitragender, der keiner der Knoten des Graphen ist — ein Feature, das an einer Boundary statt an einer Komponente angebunden ist —, trägt hier stattdessen die eigene Dispatch-Identität des Compilers für ihn, die dieselbe Identität ist, die der Aufruf von render_node für diesen Beitragenden trug; sie unterscheidet einen Beitragenden von einem anderen und ist kein Name, den irgendein Ziel akzeptiert. Woraus ein solcher Beitragender innerhalb des zusammengesetzten Artefakts Namen ableitet, ist ein getrennt getragener Wert, derived_name_basis. |
type | string | ja | Das Komponententyp-Label des Knotens, auf dieser Form getragen — anders als die Render-Projektion pro Knoten, die es zurückhält. Opakes Metadatum statt eines Verhaltensschalters: Es ist hier, damit ein Assembler die Knoten, die er zusammenführt, gruppieren und kennzeichnen kann, nicht damit ein Guest danach verzweigen kann. |
derived_name_basis | string | nein | Die Identität, aus der dieser Beitragende innerhalb des zusammengesetzten Artefakts seine eigenen Namen ableitet — eine logische ID, die ein Assembler für einen der veröffentlichten Einträge des Beitragenden prägt, ein Geltungsbereich pro Beitragendem in einem zusammengeführten Dokument, der Name einer untergeordneten Einheit, die an einer eigenen Position platziert ist. Leer bedeutet, dass die ID direkt verwendet wird, was der Wert für eine gewöhnliche Komponente ist. Ein Beitragender, dessen ID eine Dispatch-Identität ist, die das Namensalphabet eines Ziels ablehnt, trägt dies explizit, sodass das zusammengesetzte Artefakt seinen Inhalt unter einem Namen adressiert, den das Ziel akzeptiert, und zwei Beitragende, die ein Autor unterscheiden kann, nicht unter einem ankommen können. Wo der Inhalt des Beitragenden in ein Dokument einbezogen wird, das der Assembler zusammenführt, ist dies derselbe getragene Wert, den der Aufruf von render_node für diesen Beitragenden erhalten hat, und ihn auf beiden zu tragen ist das, was die beiden Antworten gleich hält: Ein Name, den der Beitragende beim Rendern deklariert hat, und der Name, unter dem das zusammengeführte Dokument diesen Inhalt adressiert, werden aus einer Identität abgeleitet statt aus zweien, die zufällig übereinstimmen. Wo der Beitragende stattdessen an einer eigenen Position platziert wird, ist dies die für diesen Beitragenden gebildete Identität — bei einem an eine Komponente angebundenen Feature seine eigene statt der der Host-Komponente, gegen die sein Rendering lief —, sodass eine neben ihrem Host platzierte untergeordnete Einheit getrennt von ihm adressiert wird. |
output_directory | string | nein | Das Verzeichnis, in dem die gerenderten Dateien dieses Beitragenden liegen, relativ zur eigenen Position des zusammengesetzten Artefakts, ohne abschließendes Trennzeichen. Ein Guest, der die Dateien eines Beitragenden aus dem zusammengesetzten Artefakt heraus benennen muss — den Quellpfad eines Modulblocks, eine include-Direktive —, liest die Position von hier, statt eine aus der Identität des Beitragenden zu bilden, sodass der Pfad, auf den das zusammengesetzte Artefakt verweist, der Pfad ist, in den die Dateien geschrieben wurden. Die beiden liegen nicht immer ein Verzeichnis auseinander: Ein Beitragender, den der Host innerhalb der Position eines anderen Beitragenden platziert hat, liegt tiefer als die Beitragenden, die direkt unter der Zusammensetzung platziert sind. Nur vorhanden, wo der zusammensetzende Provider jeden Beitragenden unter einer eigenen Position platziert; ein Provider, der seine Beitragenden in ein Dokument einbezieht, platziert kein Verzeichnis pro Beitragendem und erhält keines. |
rendered | RenderNodeOutput | ja | Die Payload, die ein Provider-Guest aus seinem Export render_node zurückgibt: die serialisierten Bytes jeder Ausgabedatei, die der Guest ausgegeben hat, die Namen, die er in jeden seiner eigenen Schlüsselräume abgeleitet hat, die Fakten, die er über das Ausgegebene meldet, auf wie viele gerenderte Einheiten jeder ihm übergebene omits-Eintrag gepasst hat, und alle Diagnosen, die der Guest beim Rendern ausgelöst hat. Der Guest gibt die serialisierten Bytes jeder Datei zurück; der Host schreibt sie unverändert und führt keinen Serialisierer aus. Determinismus liegt in der Verantwortung des Guests: Identische Eingabe muss identische Bytes erzeugen. |
annotations | Map von string | nein | Die zusammengeführten Annotationen des Knotens, damit ein Boundary-Assembler die Platzierung pro Knoten zuordnen kann (z. B. das Compose-Netzwerk, abgeleitet aus der Annotation aggrega.ai/namespace). |
sync_wave | integer | nein | Die Bereitstellungswelle, geerbt von der Boundary, die diesen Knoten enthält (Standardwert 0; negative Werte zulässig), damit ein Boundary-Assembler die Beitragenden, die er zusammenführt, relativ zueinander ordnen kann. Eine Dispatch-Gruppe kann Beitragende aus mehreren Boundaries zusammenführen, von denen jeder seine eigene Welle trägt, daher wird die Welle hier mit jedem Knoten übertragen statt einmal für die gesamte Payload. Ein Assembler, dessen Ausgabeform keine Reihenfolge ausdrückt, ignoriert sie. |
values | object | nein | Die Werte, die der Compiler für diesen Knoten aufgelöst hat, nur vorhanden bei einem Knoten, der aus einer Quelle gerendert wurde — der Aufruf von render_node, der seine Dateien erzeugt hat, trug ein source_listing. Das ist der einzige Fall, in dem die Dateien von anderswo stammen und die Werte nicht in sie geschrieben werden konnten, daher muss eine Position außerhalb von ihnen sie liefern: Ein Boundary-Assembler platziert ein vorhandenes Dictionary als die Eingaben dieses Beitragenden im zusammengesetzten Artefakt selbst statt neben den eigenen Dateien des Beitragenden, und wo das zusammengesetzte Artefakt die einzige Position ist, die das Ziel auswertet, ist das der Unterschied zwischen einer Eingabe, die das Ziel liest, und einer, die es nie erreicht. Ein Knoten, der aus einer workload_projection oder einer artifacts_projection gerendert wurde, hat diese Werte in die Dateien aufgelöst, die er erzeugt hat, daher trägt er hier keine, und das Feld fehlt: Sie ein zweites Mal zu liefern, würde dem zusammengesetzten Artefakt Eingaben anbieten, die die eigenen Dateien dieses Knotens nie deklarieren und die das Ziel ablehnen darf. Schlüssel kommen in sortierter Reihenfolge an, nicht in Autorenreihenfolge, und diese Sortierung macht die Payload über Läufe mit identischer Eingabe hinweg byte-identisch; ein Guest, der eine andere Reihenfolge braucht, stellt sie selbst her. Ein Assembler, dessen Ausgabeform keine Eingaben pro Beitragendem trägt, ignoriert das Feld. |
values_mapped | boolesch | nein | Wahr, wenn die Werte, die dieser Knoten trägt, die Ausgabe des valuesMapping seines gebundenen Recipe oder FeatureRecipe sind (das Recipe einer Komponente, das FeatureRecipe eines angebundenen Feature) statt der Werte des Knotens, die so weitergegeben werden, wie der Autor sie geschrieben hat — dieselbe Markierung, die der Aufruf von render_node für diesen Knoten auf seiner Knotenprojektion trug, hier neben den Werten getragen, die sie beschreibt. Fehlt, wo kein valuesMapping ausgeführt wurde, und überall dort, wo values fehlt. Ob ein Assembler es liest, ist der eigene Vertrag dieses Assemblers: Einer, dessen render_node die Werte eines gemappten Knotens an die Eingaben bindet, die seine Quelle deklariert, kann daraus erfahren, welche Namen diese Bindung gefüllt hat, während einer, der die Werte eines Knotens als seine Eingaben platziert, gleich wie sie erzeugt wurden, es nicht liest. Es hält fest, wie die Werte erzeugt wurden, und wird nie aus dem Namen eines Schlüssels oder dem Inhalt eines Werts abgeleitet. |
Zusätzliche Eigenschaften sind nicht zulässig.
RenderEdge
Eine gerichtete uses-Kante des Graphen, benannt durch ihre beiden Knoten-IDs: source ist der verbrauchende Knoten und target der verbrauchte. Die Liste trägt jede uses-Kante des Graphen, daher kann jedes der beiden Enden ein Knoten außerhalb dieser Dispatch-Gruppe sein.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
source | string | ja | Die ID des verbrauchenden Knotens — das source-Ende einer gerichteten uses-Kante. |
target | string | ja | Die ID des verbrauchten Knotens — das target-Ende, auf das eine gerichtete uses-Kante zeigt. |
Zusätzliche Eigenschaften sind nicht zulässig.
SubChart
Ein Sub-Chart, das zu einem Umbrella-Chart beiträgt: seine Instanzidentität, die Version, die das Umbrella festlegt, die Werte pro Instanz, die das Umbrella unter dem Alias des Sub-Charts einordnet, und, bei einem aus einer Chart-Quelle gevendorten Sub-Chart, die unveränderten Bytes der Datei Chart.yaml dieses Charts. Ein Umbrella-Chart-Assembler baut die Abhängigkeiten und die Werte-Datei des Umbrella allein aus diesen reinen Datenansichten und berührt kein Dateisystem.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
instance_id | string | ja | Die Instanzidentität des Sub-Charts innerhalb der Dispatch-Gruppe; das Umbrella ordnet den Abhängigkeitsalias des Sub-Charts und seine Werte darunter ein, sodass mehrere Instanzen eines Quell-Charts unterscheidbar bleiben. |
version | string | nein | Die Version, die das Umbrella für das Sub-Chart festlegt. Ein aus einer Chart-Quelle gevendortes Sub-Chart bezieht seinen Abhängigkeitsnamen und seine Version stattdessen aus der Datei Chart.yaml dieses Charts, damit die Abhängigkeit bindet; dieser Wert gilt für ein generatives Sub-Chart, das kein gevendortes Chart trägt. |
values | object | nein | Die Werte pro Instanz, die das Umbrella in der Umbrella-Datei values.yaml unter dem Alias des Sub-Charts einordnet. Schlüssel kommen in sortierter Reihenfolge an, nicht in Autorenreihenfolge, und diese Sortierung macht die Payload über Läufe mit identischer Eingabe hinweg byte-identisch; ein Guest, der eine andere Reihenfolge braucht, stellt sie selbst her. |
chart_yaml | string | nein | Die unveränderten Bytes der Chart.yaml des gevendorten Charts, zur Kompilierzeit aus der lokalen Quelle gelesen, aus denen das Umbrella Namen und Version der Abhängigkeit des Sub-Charts bezieht. Leer bei einem generativen Sub-Chart, das kein gevendortes Chart trägt. Jedes Kit trägt sie in seinem eigenen Feldtyp — roh, wo dieser Typ ein Bytetyp ist, base64-kodiert, wo er eine Zeichenkette ist, die der Guest dekodiert, um sie zurückzugewinnen —, und der generierte Encoder konvertiert zwischen dem Feld und der Form, in der das Übertragungsformat Bytes trägt. |
Zusätzliche Eigenschaften sind nicht zulässig.
AssembleBoundaryOutput
Die Payload, die ein Provider-Guest aus seinem Export assemble_boundary zurückgibt: die serialisierten Bytes jeder zusammengesetzten Datei und alle Diagnosen, die der Guest beim Zusammensetzen ausgelöst hat. Wo die Dateien pro Knoten der zusammengesetzten Gruppe liegen, ist nicht Teil dieser Antwort — es ist eine statische Eigenschaft des Providers, einmal in seinem describe()-Vertrag deklariert und verfügbar, bevor irgendein Knoten rendert. Der Guest gibt die serialisierten Bytes jeder Datei zurück; der Host schreibt sie unverändert und führt keinen Serialisierer aus. Determinismus liegt in der Verantwortung des Guests: Identische Eingabe muss identische Bytes erzeugen.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
files | RenderedFile[] | ja | Die zusammengesetzten Ausgabedateien, die der Guest ausgegeben hat, in Ausgabereihenfolge. Jede nennt ihren Pfad auf dem Datenträger und trägt die serialisierten Bytes, die der Host unverändert schreibt. |
diagnostics | Diagnostic[] | nein | Diagnosen, die der Guest beim Zusammensetzen ausgelöst hat. Jedes Element ist die gemeinsame Diagnoseform der Wasm-Plugins. |
error | string | nein | Eine Fehlermeldung, die gesetzt wird, wenn der Guest lief, die Operation aber nicht abschließen konnte; fehlt bei Erfolg. Sie ist von allen Diagnosen getrennt, die die Ausgabe trägt: Diagnosen melden Probleme, die während eines Laufs gefunden wurden, der dennoch ein Ergebnis erzeugt hat, während error meldet, dass die Operation selbst nicht abgeschlossen wurde. Der Host meldet einen vorhandenen Fehler als fehlgeschlagenen Plugin-Aufruf. |
condition_code | string | nein | Die beschreibende, maschinell abgleichbare Identität der Bedingung, die der Fehlschlag benennt — der Code, unter dem die Bedingung registriert ist, in derselben offenen Menge, in der der Compiler seine eigenen Abbruchbedingungen registriert, und kein Element des geschlossenen Katalogs der Fehlercodes für Host-Funktionen, aus dem der hostfunc_error_code eines Antwort-Umschlags stammt. Neben der für Menschen lesbaren Fehlermeldung gesetzt; fehlt bei Erfolg und fehlt, wenn der Guest keine solche Bedingung benennt. Ein Guest, der abbricht, meldet hier den Bezeichner der Bedingung, die seine Meldung benennt, sodass ein Verbraucher danach verzweigt, statt eine Identität durch Lesen der Meldung zu rekonstruieren. Der Host löst diesen Bezeichner gegen die Bedingungen auf, die der Compiler deklariert, und veröffentlicht die eigenen Bezeichner der aufgelösten Bedingung in der strukturierten Diagnose, sodass ein Code, der einen Leser erreicht, sich immer auflöst; ein Bezeichner, der keine solche Bedingung benennt, oder einer, den die Nummerierung zurückgezogen hat, hält den Build an. Ein Guest ohne genaue Bedingung, die er benennen könnte, greift stattdessen auf eine der generischen Plugin-Fehlerbedingungen zurück, die der Compiler zu diesem Zweck deklariert, und schreibt die Einzelheiten in seine eigene Meldung. Dieser Bezeichner und condition_short_code werden zusammen gemeldet, weil sie eine Bedingung in zwei Formen benennen: Ein Guest, der den einen setzt und den anderen nicht, hat eine Bedingung benannt, die der Host nicht auflösen kann, und der Host meldet dann stattdessen seine eigene generische Plugin-Fehlerbedingung, während die Meldung weiterhin den gesamten Fehlschlag trägt. |
condition_short_code | string | nein | Der kompakte Bezeichner derselben Bedingung — der Buchstabe E und vier Ziffern, die Form, die ein Leser zitiert, sucht und in einen Bericht einfügt —, neben der für Menschen lesbaren Fehlermeldung gesetzt; fehlt bei Erfolg und fehlt, wenn der Guest keine solche Bedingung benennt. Der Host gibt ihn im Kopf in eckigen Klammern der Diagnose aus, die er für diesen Fehlschlag rendert, sodass eine Bedingung, die ein Guest auslöst, genauso zitierbar ist wie eine, die der Compiler auslöst. Der Host löst den Wert gegen die Bedingungen auf, die der Compiler deklariert, statt ihn auf Treu und Glauben zu tragen: Ein Wert, der keine solche Bedingung benennt, ein Wert, den die Nummerierung zurückgezogen hat, oder eine Schreibweise, die die Registrierung nicht trägt, hält den Build an und zitiert den betreffenden Wert, wobei die eigene Meldung des Guests weiterhin gemeldet wird. Er wird zusammen mit condition_code gemeldet, aus dem dort genannten Grund. |
Zusätzliche Eigenschaften sind nicht zulässig.
CarveInput
Die Payload, die ein Provider-Guest über seinen optionalen Export carve erhält: eine benannte Ausgabedatei, die die Pipeline in adressierbare Einheiten zerlegt, bevor ein FeatureRecipe-Schritt einige davon bearbeitet. Ein Provider, dessen Ausgabeform der Standard-YAML-Codec nicht direkt zerlegen kann (etwa ein templatebasiertes Chart), kündigt carve und reassemble an, sodass sein eigenes Wissen über die Ausgabeform im Guest liegt; ein Provider, der die Exports weglässt, greift auf den Standard-YAML-Codec des Hosts zurück.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
name | string | ja | Der Name der Ausgabedatei, damit der Codec jede namensbezogene Zerlegungsregel anwenden kann. |
body | string | ja | Die Bytes der Ausgabedatei, die in adressierbare Einheiten zu zerlegen sind. Jedes Kit trägt sie in seinem eigenen Feldtyp — roh, wo dieser Typ ein Bytetyp ist, base64-kodiert, wo er eine Zeichenkette ist, die der Guest dekodiert, um sie zurückzugewinnen —, und der generierte Encoder konvertiert zwischen dem Feld und der Form, in der das Übertragungsformat Bytes trägt. |
yaml_indent | integer | nein | Die Einrückungsbreite, die der Codec verwendet, wenn er neuen strukturierten Text synthetisieren muss; getragen, damit die Zerlegung des Guests der für das gesamte Rendering geltenden Einrückung entspricht. |
Zusätzliche Eigenschaften sind nicht zulässig.
CarveOutput
Die Payload, die ein Provider-Guest aus seinem Export carve zurückgibt: die geordneten adressierbaren Einheiten, in die er die Datei zerlegt hat. Eine strukturierte Einheit trägt einen Baum (ein PATCH-Ziel); eine opake Einheit trägt nur ihren Medientyp und ihre Bytes.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
units | object[] | ja | Die geordneten adressierbaren Einheiten, in die der Guest die Datei zerlegt hat. |
Zusätzliche Eigenschaften sind nicht zulässig.
ReassembleInput
Die Payload, die ein Provider-Guest über seinen optionalen Export reassemble erhält: die ursprüngliche Datei sowie ihre zerlegten Einheiten und die gepatchten Einheiten, die ein Pipeline-Schritt erzeugt hat, damit der Guest die Änderungen chirurgisch in die ursprünglichen Bytes zurückfügt. Ein Token, das in der gepatchten Menge fehlt, wird unverändert aus seinen ursprünglichen Bytes wieder zusammengefügt; bei einem gepatchten Token werden nur seine adressierten Byte-Bereiche bearbeitet.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
name | string | ja | Der Name der Ausgabedatei, passend zu dem Namen, unter dem dieselbe Datei zerlegt wurde. |
body | string | ja | Die ursprünglichen Dateibytes, in die die Wiederzusammensetzung die gepatchten Einheiten zurückfügt. Jedes Kit trägt sie in seinem eigenen Feldtyp — roh, wo dieser Typ ein Bytetyp ist, base64-kodiert, wo er eine Zeichenkette ist, die der Guest dekodiert, um sie zurückzugewinnen —, und der generierte Encoder konvertiert zwischen dem Feld und der Form, in der das Übertragungsformat Bytes trägt. |
segs | object[] | nein | Die Einheiten, in die die Datei zerlegt wurde, so wie carve sie zurückgegeben hat. |
patched | object[] | nein | Die Einheiten, die ein Pipeline-Schritt geändert hat, jede mit ihrem Token, dem gepatchten Baum und den ops, die die Änderung erzeugt haben. |
yaml_indent | integer | nein | Die Einrückungsbreite, die der Codec verwendet, wenn eine op neuen strukturierten Text synthetisieren muss; getragen, damit die Wiederzusammensetzung der für das gesamte Rendering geltenden Einrückung entspricht. |
Zusätzliche Eigenschaften sind nicht zulässig.
ReassembleOutput
Die Payload, die ein Provider-Guest aus seinem Export reassemble zurückgibt: die Bytes der Datei mit den wieder eingefügten gepatchten Einheiten. Die Wiederzusammensetzung ist bytegetreu — jedes Byte, das die ops nicht berührt haben, bleibt unverändert erhalten.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
body | string | ja | Die wieder zusammengesetzten Dateibytes, die der Host unverändert schreibt. Jedes Kit trägt sie in seinem eigenen Feldtyp — roh, wo dieser Typ ein Bytetyp ist, base64-kodiert, wo er eine Zeichenkette ist, die der Guest dekodiert, um sie zurückzugewinnen —, und der generierte Encoder konvertiert zwischen dem Feld und der Form, in der das Übertragungsformat Bytes trägt. |
Zusätzliche Eigenschaften sind nicht zulässig.
NameBoundInput
Die Payload, die ein Provider-Guest über seinen optionalen Export name_bound erhält: ein Name, den der Host als Komponentenidentität eines Knotens zu verwenden vorschlägt, damit der Guest ihn gegen jeden Namen beurteilt, den er daraus für sein Ziel ableiten würde, zusammen mit den Fakten der aufgelösten Workload des Knotens, von denen einige dieser Namen abhängen, wenn die Identität erst nach der Auflösung dieser Workload festgelegt wird. Der Guest antwortet mit einer Einschränkung statt mit einem eigenen Namen — ein zurückgegebener abgeleiteter Name würde den Host in die Lage bringen, Namen für ein Ziel zu bilden, über das er nichts weiß, und genau das beseitigt das Stellen der Frage. Ein Provider, dessen Ziel die Namen, die es akzeptiert, begrenzt oder einschränkt, kündigt den Export an; ein Provider, dessen Ziel jeden Namen akzeptiert, lässt ihn weg und wird nie gefragt, und sein Rendering bleibt unverändert.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
proposed | string | ja | Der Name, den der Host als Komponentenidentität des Knotens vorschlägt. Der Guest leitet daraus im Speicher jeden Namen ab, den er aus einer Komponentenidentität ableitet, und meldet, ob jeder davon ein Name ist, den sein Ziel akzeptiert. Ein Urteil spricht über den VORSCHLAG statt über den Knoten: Der Host stellt überall dort, wo er eine Identität bildet, eine einzige Frage und sagt nicht, für welche der Namen dieses Knotens diese Identität am Ende die Basis sein wird, daher antwortet ein Guest so, als wäre sie die Basis für alle. Das ist die konservative Richtung, weil der Host auf die Antwort hin immer nur kürzt und nie verlängert — ein Name, den der Knoten tatsächlich aus einem anderen getragenen Wert ableiten wird, wird daher zu streng statt zu locker beurteilt. |
authored | boolesch | nein | Ob der vorgeschlagene Name einer ist, den eine Person geschrieben hat, statt einer, den der Compiler aus verfassten Teilen gebildet hat. Er wird getragen, damit ein Guest seine Begründung für den Leser formulieren kann, der darauf reagieren kann. Er entscheidet nicht, was eine Ablehnung bewirkt: Ein verfasster Name wird abgelehnt und ein gebildeter gekürzt, und diese Entscheidung liegt beim Host. |
workload_form | string | nein | Die Form der Workload, zu der das Recipe oder FeatureRecipe des Knotens aufgelöst wird, so wie ihr Workload-Template sie erzeugt hat; übermittelt, wenn die Identität nach der Auflösung dieser Workload festgelegt wird und die Workload eine Form angibt. Sie wird so übermittelt, wie sie geschrieben ist; der Host interpretiert sie nicht. Ein Guest, dessen Ziel einen Namen begrenzt, den er nur für eine Form emittiert — einen geplanten Job, dessen Namen das Ziel kürzer hält als seine anderen Namen, weil für jeden Lauf ein Suffix angehängt wird —, liest sie, um diesen Namen zu beurteilen. Fehlend bedeutet, dass der Host für diese Frage keine Form übermittelt: Der Knoten deklariert keine Workload, seine Workload gibt keine an, oder die Identität wird festgelegt, bevor irgendeine Workload aufgelöst ist. Ein Guest beurteilt dann keinen Namen, der von der Form abhängt, und antwortet genau so, wie er es täte, wenn das Feld nicht existierte. |
service_keys | string[] | nein | Die Schlüssel der Services, die die aufgelöste Workload des Knotens deklariert, in der Reihenfolge, in der die Workload sie deklariert; übermittelt, wenn die Identität nach der Auflösung dieser Workload festgelegt wird und die Workload welche deklariert. Ein Guest, dessen Ziel jeden Service, den er für den Knoten emittiert, aus der Komponentenidentität und dem Schlüssel des Service benennt, liest sie, um jeden solchen Namen zu beurteilen. Ein Schlüssel wird vom Autor des Recipe oder FeatureRecipe geschrieben und nicht von demjenigen, der die Identität geschrieben hat, daher formuliert ein Guest eine Ablehnung, die ein Schlüssel verursacht, auch für diesen Autor. Fehlend bedeutet, dass der Host für diese Frage keine Schlüssel übermittelt: Der Knoten deklariert keine Workload, seine Workload deklariert keinen Service, oder die Identität wird festgelegt, bevor irgendeine Workload aufgelöst ist. Ein Guest beurteilt dann keinen aus einem Service-Schlüssel gebildeten Namen und antwortet genau so, wie er es täte, wenn das Feld nicht existierte. |
Zusätzliche Eigenschaften sind nicht zulässig.
DerivedNameVerdict
Das Urteil einer Namensart über eine vorgeschlagene Identität: ob der Name, den der Guest für diese Art ableiten würde, einer ist, den sein Ziel akzeptiert, und — wo eine kürzere Identität akzeptiert würde — die größte Länge, bei der das der Fall wäre. Es trägt eine Einschränkung und eine Begründung, nie einen vom Guest gebildeten Namen.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
kind | string | ja | Der eigene Name des Guests für die Namensart, die dieses Urteil abdeckt, im Vokabular des Ziels statt in dem des Compilers geschrieben — der Release-Name eines Chart-Installers, der Service-Name eines Container-Orchestrators. Er erreicht einen Leser unverändert in einer Ablehnung, daher ist er für jemanden geschrieben, der das Ziel kennt. |
usable | boolesch | ja | Ob der Name, den der Guest für diese Art aus der vorgeschlagenen Identität ableiten würde, einer ist, den das Ziel akzeptiert. |
bound | integer | nein | Die größte Anzahl von Zeichen, die eine vorgeschlagene Identität tragen darf, damit der abgeleitete Name dieser Art einer ist, den das Ziel akzeptiert. Nur vorhanden bei einer Ablehnung, die eine kürzere Identität erfüllen würde. FEHLEND bedeutet, dass die Länge nicht das ist, woran das Ziel Anstoß genommen hat — entweder gibt es überhaupt keine Längenbegrenzung, oder der Einwand ist einer, den keine Kürzung behebt, etwa ein Zeichen, das die Grammatik des Ziels an der Position ablehnt, an der es gelandet ist. Fehlend unterscheidet sich daher von einer Grenze von null, die sehr wohl eine Länge angibt: dass keine Identität irgendeiner Länge einen akzeptablen Namen dieser Art ergibt. Der Host kürzt auf eine vorhandene Grenze und fragt erneut; bei einer fehlenden Grenze hört er auf, weil nichts mehr zu versuchen bleibt. |
reason | string | nein | Warum das Ziel den abgeleiteten Namen nicht akzeptiert, in den eigenen Begriffen des Ziels, für einen Leser, der entscheidet, was er stattdessen schreiben soll. Leer, wenn das Urteil verwendbar ist. |
Zusätzliche Eigenschaften sind nicht zulässig.
NameBoundOutput
Die Payload, die ein Provider-Guest aus seinem Export name_bound zurückgibt: ein Urteil pro Art von Namen, den er aus der vorgeschlagenen Identität ableiten würde. Ein Vorschlag ist verwendbar, wenn jedes Urteil es ist; wo eines es nicht ist, kürzt der Host den Vorschlag auf die kleinste Grenze, die die ablehnenden Urteile tragen, und fragt erneut, und er hört auf, wenn ein ablehnendes Urteil keine Grenze trägt. Eine leere Liste von Urteilen bedeutet, dass der Guest keinen Namen aus einer Komponentenidentität ableitet, was dieselbe Antwort ist wie das Akzeptieren des Vorschlags.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
names | DerivedNameVerdict[] | nein | Ein Eintrag pro Art von Namen, den der Guest aus einer Komponentenidentität ableitet, in der eigenen Reihenfolge des Guests. Ein Guest meldet jede Art, die er ableiten würde, statt nur die Arten, die abgelehnt haben, sodass ein Leser sieht, welche Namen beurteilt wurden, und ein Host, der die Einträge liest, keinen zweiten Aufruf braucht, um den Rest zu erfahren. |
error | string | nein | Eine Fehlermeldung, die gesetzt wird, wenn der Guest lief, den Vorgang aber nicht abschließen konnte; fehlt bei Erfolg. Sie unterscheidet sich von einem ablehnenden Urteil: Ein Urteil meldet einen Namen, den das Ziel nicht akzeptieren wird, während error meldet, dass die Frage selbst nicht beantwortet werden konnte. Der Host meldet ein vorhandenes error als fehlgeschlagenen Plugin-Aufruf. |
condition_code | string | nein | Die beschreibende, maschinell abgleichbare Identität der Bedingung, die der Fehlschlag benennt — der Code, unter dem die Bedingung registriert ist, in derselben offenen Menge, in der der Compiler seine eigenen Abbruchbedingungen registriert, und kein Element des geschlossenen Katalogs der Fehlercodes für Host-Funktionen, aus dem der hostfunc_error_code eines Antwort-Umschlags stammt. Neben der für Menschen lesbaren Fehlermeldung gesetzt; fehlt bei Erfolg und fehlt, wenn der Guest keine solche Bedingung benennt. Ein Guest, der abbricht, meldet hier den Bezeichner der Bedingung, die seine Meldung benennt, sodass ein Verbraucher danach verzweigt, statt eine Identität durch Lesen der Meldung zu rekonstruieren. Der Host löst diesen Bezeichner gegen die Bedingungen auf, die der Compiler deklariert, und veröffentlicht die eigenen Bezeichner der aufgelösten Bedingung in der strukturierten Diagnose, sodass ein Code, der einen Leser erreicht, sich immer auflöst; ein Bezeichner, der keine solche Bedingung benennt, oder einer, den die Nummerierung zurückgezogen hat, hält den Build an. Ein Guest ohne genaue Bedingung, die er benennen könnte, greift stattdessen auf eine der generischen Plugin-Fehlerbedingungen zurück, die der Compiler zu diesem Zweck deklariert, und schreibt die Einzelheiten in seine eigene Meldung. Dieser Bezeichner und condition_short_code werden zusammen gemeldet, weil sie eine Bedingung in zwei Formen benennen: Ein Guest, der den einen setzt und den anderen nicht, hat eine Bedingung benannt, die der Host nicht auflösen kann, und der Host meldet dann stattdessen seine eigene generische Plugin-Fehlerbedingung, während die Meldung weiterhin den gesamten Fehlschlag trägt. |
condition_short_code | string | nein | Der kompakte Bezeichner derselben Bedingung — der Buchstabe E und vier Ziffern, die Form, die ein Leser zitiert, sucht und in einen Bericht einfügt —, neben der für Menschen lesbaren Fehlermeldung gesetzt; fehlt bei Erfolg und fehlt, wenn der Guest keine solche Bedingung benennt. Der Host gibt ihn im Kopf in eckigen Klammern der Diagnose aus, die er für diesen Fehlschlag rendert, sodass eine Bedingung, die ein Guest auslöst, genauso zitierbar ist wie eine, die der Compiler auslöst. Der Host löst den Wert gegen die Bedingungen auf, die der Compiler deklariert, statt ihn auf Treu und Glauben zu tragen: Ein Wert, der keine solche Bedingung benennt, ein Wert, den die Nummerierung zurückgezogen hat, oder eine Schreibweise, die die Registrierung nicht trägt, hält den Build an und zitiert den betreffenden Wert, wobei die eigene Meldung des Guests weiterhin gemeldet wird. Er wird zusammen mit condition_code gemeldet, aus dem dort genannten Grund. |
Zusätzliche Eigenschaften sind nicht zulässig.
RenderedNameInput
Die Payload, die ein Provider-Guest über seinen optionalen Export rendered_name erhält: die beiden Identitäten, aus denen ein Ziel seine eigenen Namen ableitet, und welche Eingabearten das Recipe des Knotens deklariert — vom Autor gelieferte Quelle, eine Workload, die der Guest synthetisiert. Der Guest antwortet mit dem Namen, den sein Ziel den Ressourcen geben wird, die er für diesen Knoten rendert: bei gelieferter Quelle der Name, gegen den die eigenen Templates des Autors rendern, etwa der Release-Name, den ein Chart liest; bei einer synthetisierten Workload der Name, den der Guest den Ressourcen gibt, die er erstellt, wo er einen ableitet, statt die Identität des Knotens so zu schreiben, wie sie ist. Ein Guest, der keinen solchen Namen ableitet, meldet keinen, was die ehrliche Antwort ist für ein Ziel, dessen Ressourcennamen ein Recipe unverändert schreibt, und für eines, dessen Name davon abhängt, wo die Dateien platziert werden, statt vom Knoten. Dieser Export meldet einen Namen, den der Guest selbst bildet, und ist nicht der Austausch, der den Guest bittet, einen vom Host vorgeschlagenen Namen zu beurteilen; das sind verschiedene Fragen, und jede hat ihren eigenen Export.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
node_id | string | ja | Die eigene Identität des Knotens, wie sie verfasst wurde. Sie wird unkodiert getragen: Ein Ziel engt sie über sein eigenes Alphabet ein, daher würde ein vorheriges Kodieren ein Escape in ein anderes setzen und den Namen anders schreiben als den, nach dem der Autor eines Rezepts ihn vorhersagt. |
derived_name_basis | string | nein | Die Identität, gegen die die eigene Quelle eines Beitragenden rendert, wenn sie nicht die eigene des Knotens ist — gesetzt für einen Beitragenden, dessen Identität das Namensalphabet eines Ziels ablehnt, andernfalls fehlend. Ein Guest löst das Paar auf dieselbe Weise auf wie jede andere Oberfläche: dieser Wert, wenn er vorhanden ist, die Knoten-ID, wenn nicht. |
sourced | boolesch | nein | Ob das gebundene Recipe des Knotens vom Autor gelieferte Quelle deklariert, gelesen aus dem Text, den der Autor geschrieben hat. Es wird zusammen mit synthesized getragen, sodass die Frage für jeden Knoten gestellt und korrekt beantwortet werden kann: Ein Guest meldet keinen Namen für einen Knoten, der keines von beiden deklariert und dessen Ausgabe allein eine Artefaktmenge ist, weil die Ressourcen in einer solchen Menge nach den Artefakten benannt sind, die der Autor geschrieben hat, statt nach einem Namen, den der Guest ableitet. |
synthesized | boolesch | nein | Ob das gebundene Recipe des Knotens eine Workload deklariert, die der Guest synthetisieren soll, gelesen aus dem Text, den der Autor geschrieben hat, wie sourced. Ein Guest, dessen Ziel die Ressourcen, die er synthetisiert, nach einem Namen benennt, den er ableitet, statt nach der Identität des Knotens, wie sie geschrieben ist, meldet diesen Namen für einen solchen Knoten, sodass eine Adresse, die ein Recipe für eine dieser Ressourcen veröffentlicht, aus dem Namen gebildet werden kann, den die Ressource trägt. |
Zusätzliche Eigenschaften sind nicht zulässig.
RenderedNameOutput
Die Payload, die ein Provider-Guest aus seinem Export rendered_name zurückgibt: der Name, den sein Ziel den Ressourcen gibt, die er für den Knoten rendert — aus der vom Autor gelieferten Quelle des Knotens oder aus der Workload, die er synthetisiert — oder gar kein Name. Ein fehlender oder leerer Name ist eine positive Antwort und kein Fehlschlag — er besagt, dass dieses Ziel keinen solchen Namen ableitet —, und der Host verwendet, was ihm mitgeteilt wurde, ohne es zu lesen, sodass kein Wissen über die Benennung des Ziels die Grenze überschreitet.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
name | string | nein | Der Name, unter dem der Guest die vom Autor gelieferte Quelle dieses Knotens rendert oder den er den Ressourcen gibt, die er für den Knoten synthetisiert, bereits in dem Alphabet geschrieben, das sein Ziel an dieser Position akzeptiert. Leer oder fehlend bedeutet, dass der Guest keinen solchen Namen ableitet. |
error | string | nein | Eine Fehlermeldung, die gesetzt wird, wenn der Guest lief, den Vorgang aber nicht abschließen konnte; fehlt bei Erfolg. Sie unterscheidet sich davon, keinen Namen zu melden: Kein Name ist eine Antwort über das Ziel, während error meldet, dass die Frage selbst nicht beantwortet werden konnte. Der Host meldet ein vorhandenes error als fehlgeschlagenen Plugin-Aufruf. |
condition_code | string | nein | Die beschreibende, maschinell abgleichbare Identität der Bedingung, die der Fehlschlag benennt — der Code, unter dem die Bedingung registriert ist, in derselben offenen Menge, in der der Compiler seine eigenen Abbruchbedingungen registriert. Neben der für Menschen lesbaren Fehlermeldung gesetzt; fehlt bei Erfolg und fehlt, wenn der Guest keine solche Bedingung benennt. Der Host löst diesen Bezeichner gegen die Bedingungen auf, die der Compiler deklariert, und veröffentlicht die eigenen Bezeichner der aufgelösten Bedingung in der strukturierten Diagnose, sodass ein Code, der einen Leser erreicht, sich immer auflöst; ein Bezeichner, der keine solche Bedingung benennt, oder einer, den die Nummerierung zurückgezogen hat, hält den Build an. Ein Guest ohne genaue Bedingung, die er benennen könnte, greift stattdessen auf eine der generischen Plugin-Fehlerbedingungen zurück, die der Compiler zu diesem Zweck deklariert, und schreibt die Einzelheiten in seine eigene Meldung. Dieser Bezeichner und condition_short_code werden zusammen gemeldet, weil sie eine Bedingung in zwei Formen benennen: Ein Guest, der den einen setzt und den anderen nicht, hat eine Bedingung benannt, die der Host nicht auflösen kann, und der Host meldet dann stattdessen seine eigene generische Plugin-Fehlerbedingung, während die Meldung weiterhin den gesamten Fehlschlag trägt. |
condition_short_code | string | nein | Der kompakte Bezeichner derselben Bedingung — der Buchstabe E und vier Ziffern, die Form, die ein Leser zitiert, sucht und in einen Bericht einfügt —, neben der für Menschen lesbaren Fehlermeldung gesetzt; fehlt bei Erfolg und fehlt, wenn der Guest keine solche Bedingung benennt. Der Host gibt ihn im Kopf in eckigen Klammern der Diagnose aus, die er für diesen Fehlschlag rendert, sodass eine Bedingung, die ein Guest auslöst, genauso zitierbar ist wie eine, die der Compiler auslöst. Der Host löst den Wert gegen die Bedingungen auf, die der Compiler deklariert, statt ihn auf Treu und Glauben zu tragen: Ein Wert, der keine solche Bedingung benennt, ein Wert, den die Nummerierung zurückgezogen hat, oder eine Schreibweise, die die Registrierung nicht trägt, hält den Build an und zitiert den betreffenden Wert, wobei die eigene Meldung des Guests weiterhin gemeldet wird. Er wird zusammen mit condition_code gemeldet, aus dem dort genannten Grund. |
Zusätzliche Eigenschaften sind nicht zulässig.
LinkEndpoint
Ein Endpunkt eines Boundary-übergreifenden Links: der Knoten, der Boundary-Pfad, in den seine gerenderte Ausgabe zusammengesetzt wird, und der Provider, der ihn gerendert hat. Die beiden Endpunkte eines Links benennen das konsumierende und das konsumierte Ende einer uses-Kante, deren Enden in unterschiedliche Dispatch-Gruppen zusammengesetzt werden.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
node | string | ja | Die absolute ID des Endpunktknotens innerhalb des Topologiegraphen. |
boundary | string | ja | Der Boundary-Pfad des Endpunkts — die Dispatch-Gruppe, in die seine gerenderte Ausgabe zusammengesetzt wird. |
provider | string | ja | Der Provider, der den Endpunkt gerendert hat (der bloße Provider-Name). Beide Endpunkte eines verdrahteten Links nennen denselben Provider; der Host leitet keinen Link weiter, dessen Endpunkte unterschiedliche Provider nennen. |
release | string | nein | Das Release, zu dem die gerenderte Ausgabe des Endpunkts gehört — der Geltungsbereich, innerhalb dessen ihre zusammengesetzten Artefakte benannt werden. Der Host setzt es aus dem Release zusammen, das der Build aufgelöst hat, und übergibt es unverändert; er leitet aus dem Wert keine Bedeutung ab. Ein Provider liest es, um einen Querverweisnamen auf das Release einzugrenzen. Ein fehlender Wert ist die leere Zeichenkette, die ein Provider als nicht eingegrenzten Namen behandelt. |
Zusätzliche Eigenschaften sind nicht zulässig.
LinkEdge
Die verallgemeinerte, domänenagnostische Payload pro Kante, die der Host für eine uses-Kante zusammensetzt, deren konsumierendes und konsumiertes Ende in unterschiedliche Dispatch-Gruppen zusammengesetzt werden. Sie trägt beide Endpunkte, die Platzierungsannotationen beider Endpunkte als opake Skalar-Maps, die der Host nicht interpretiert, die provides-Ausgabe des konsumierten Endpunkts sowie den Socket und das inject-Mapping, das die Kante verdrahtet. Ein Provider liest sie, um die Provider-native Querverweis-Verdrahtung zu erzeugen, die die beiden Enden brauchen; der Host setzt sie zusammen und übergibt die Annotations-Map als opake Skalare, ohne aus irgendeinem Wert eine Bedeutung abzuleiten.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
source | LinkEndpoint | ja | Der konsumierende Endpunkt — das Quellende der gerichteten uses-Kante, in dessen zusammengesetzte Ausgabe die konsumentenseitige Verdrahtung injiziert wird. |
target | LinkEndpoint | ja | Der konsumierte Endpunkt — das Zielende, auf das die uses-Kante zeigt, dessen zusammengesetzte Ausgabe die produzentenseitige Verdrahtung veröffentlicht. |
target_annotations | Map von string | nein | Die Platzierungsannotationen des konsumierten (Ziel-)Endpunkts als opake Skalar-Map, nach Annotationsnamen geschlüsselt. Der Host setzt sie aus den aufgelösten Annotationen des Ziels zusammen und übergibt sie unverändert; er leitet aus keinem Wert eine Bedeutung ab. Ein Provider liest sie, um zu entscheiden, wie ein Querverweis zu formen ist (zum Beispiel, ob die beiden Enden eine Platzierung teilen oder einen platzierungsübergreifenden Verweis brauchen). Schlüssel werden sortiert serialisiert, sodass die Payload über Läufe mit identischer Eingabe hinweg byte-identisch ist. |
source_annotations | Map von string | nein | Die Platzierungsannotationen des konsumierenden (Quell-)Endpunkts als opake Skalar-Map, nach Annotationsnamen geschlüsselt. Der Host setzt sie aus den aufgelösten Annotationen der Quelle zusammen und übergibt sie unverändert; er leitet aus keinem Wert eine Bedeutung ab. Ein Provider liest sie, um die Platzierung der beiden Enden zu vergleichen — zum Beispiel, ob Quelle und Ziel eine Platzierung teilen oder in unterschiedlichen liegen. Schlüssel werden sortiert serialisiert, sodass die Payload über Läufe mit identischer Eingabe hinweg byte-identisch ist. |
socket | string | ja | Der Socket-Alias, unter dem die uses-Kante gebunden ist. |
provides | Map von string | ja | Die provides-Ausgabe des konsumierten Endpunkts, eine in Autorenreihenfolge geordnete Schlüsselmenge, die die deklarierten Ausgaben des Ziels bereitstellt. Bewahrt die Autorenreihenfolge, sodass die Payload über Läufe mit identischer Eingabe hinweg byte-identisch ist. |
inject | object | ja | Das inject-Mapping des konsumierenden Endpunkts, nach Zustellmechanismus auf eine in Autorenreihenfolge geordnete Schlüsselmenge geschlüsselt, das beschreibt, wie das konsumierende Ende die Ausgabe des konsumierten Endpunkts erhält. Bewahrt die Autorenreihenfolge, sodass die Payload über Läufe mit identischer Eingabe hinweg byte-identisch ist. |
read_provides_keys | string[] | nein | Die Schlüssel der provides-Ausgabe des konsumierten Endpunkts, die die Templates des konsumierenden Endpunkts direkt über .context.uses lesen, unabhängig davon, ob das inject-Mapping sie ebenfalls zustellt, in der Autorenreihenfolge von provides. Jeder Eintrag ist einer der Schlüssel, die provides trägt. Die Liste reist auf der Kante mit, sodass das produzentenseitige Veröffentlichen und das konsumentenseitige Auflösen eine Liste lesen. Fehlt, wenn der konsumierende Endpunkt keinen provides-Schlüssel direkt gelesen hat, und ein Provider, dem keine übergeben werden, verdrahtet den Link genau so, wie er es täte, wenn das Feld nicht existierte. |
Zusätzliche Eigenschaften sind nicht zulässig.
LinkPatch
Ein strukturelles Patch pro Datei, das ein Provider als Artefakt-Verdrahtung zurückgibt: die Ausgabedatei und die geordneten strukturellen Operationen, die auf sie anzuwenden sind. Ein späterer Host-Durchlauf zerlegt die genannte Datei, wendet die Operationen an und setzt sie bytegetreu wieder zusammen. Die Form der Operation ist das gemeinsame Vokabular der Pipeline-Patch-Operationen; sie ist auf dieser Schemaebene opak, sodass ein Guest jede Operation unverändert trägt, während der Host die typisierte Operation realisiert, die seine Pipeline anwendet.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
file | string | ja | Die Ausgabedatei, auf die die Operationen angewendet werden, benannt, wie der Provider sie ausgegeben hat. |
ops | any[] | ja | Die geordneten strukturellen Operationen, die auf die Datei anzuwenden sind, in Anwendungsreihenfolge. |
Zusätzliche Eigenschaften sind nicht zulässig.
LinkPublishInput
Die Payload, die ein Provider über seinen Export link_publish erhält: ein Boundary-übergreifender Link, dessen Ausgabe des konsumierten Endpunkts über eine Boundary hinweg referenziert wird, und die zusammengesetzten Dateien dieses Endpunkts. Der Export gibt die veröffentlichte Identität zurück, gegen die der Konsument auflöst, sowie jede produzentenseitige Artefakt-Verdrahtung, die die Ausgabe des konsumierten Endpunkts braucht.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
edge | LinkEdge | ja | Der Boundary-übergreifende Link, der veröffentlicht wird, von der Seite des konsumierten (Ziel-)Endpunkts aus gelesen. |
producer_files | RenderedFile[] | nein | Die zusammengesetzten Dateien des konsumierten Endpunkts, damit der Provider lesen kann, was dieser Endpunkt bereits deklariert, und die Namen, die er gleich veröffentlichen wird, dagegen prüfen kann. Jede nennt ihren Pfad auf dem Datenträger und trägt die zusammengesetzten Bytes. Fehlt, wenn der Host keine zusammengesetzte Produzentenausgabe hat, die er dem Veröffentlichen übergeben könnte; ein Provider, der kein Dokument braucht, um seine Verdrahtung zu verfassen, ignoriert es. |
Zusätzliche Eigenschaften sind nicht zulässig.
LinkPublishOutput
Die Payload, die ein Provider aus seinem Export link_publish zurückgibt: das Handle der veröffentlichten Identität, gegen das der Konsument auflöst, und die produzentenseitige Artefakt-Verdrahtung, die auf die zusammengesetzte Ausgabe des konsumierten Endpunkts anzuwenden ist.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
handle | Map von string | ja | Die veröffentlichte Identität, die der konsumierte Endpunkt bereitstellt, damit der Konsument dagegen auflöst, eine opake Map deterministischer Zeiger-Zeichenketten, nach Feldnamen geschlüsselt (zum Beispiel ein Exportname, ein Stack-Name, eine Region, eine Rollenreferenz). Die Werte sind deterministische Zeiger-Zeichenketten, die der Compiler durchleitet und nie auflöst; die Laufzeitumgebung löst sie zum Bereitstellungszeitpunkt auf. Schlüssel werden sortiert serialisiert, sodass die Payload über Läufe mit identischer Eingabe hinweg byte-identisch ist. |
patches | LinkPatch[] | nein | Die produzentenseitige Artefakt-Verdrahtung, ein strukturelles Patch pro Ausgabedatei des konsumierten Endpunkts, die das Veröffentlichen bearbeiten muss. Leer, wenn die Ausgabe des konsumierten Endpunkts für den Link keine Änderung braucht. |
error | string | nein | Eine Fehlermeldung, die gesetzt wird, wenn der Guest lief, den Link aber nicht veröffentlichen konnte; fehlt bei Erfolg. Der Host meldet ein vorhandenes error als fehlgeschlagenen Plugin-Aufruf. Ein Veröffentlichen, das nicht fortfahren kann — etwa ein Exportname, den der Stack bereits unter einem anderen Eintrag deklariert —, wird hier gemeldet statt nur als Absturz, sodass die Bedingung dahinter benannt werden kann. |
condition_code | string | nein | Die beschreibende, maschinell abgleichbare Identität der Bedingung, die der Fehlschlag benennt — der Code, unter dem die Bedingung registriert ist, in derselben offenen Menge, in der der Compiler seine eigenen Abbruchbedingungen registriert, und kein Element des geschlossenen Katalogs der Fehlercodes für Host-Funktionen, aus dem der hostfunc_error_code eines Antwort-Umschlags stammt. Neben der für Menschen lesbaren Fehlermeldung gesetzt; fehlt bei Erfolg und fehlt, wenn der Guest keine solche Bedingung benennt. Ein Guest, der abbricht, meldet hier den Bezeichner der Bedingung, die seine Meldung benennt, sodass ein Verbraucher danach verzweigt, statt eine Identität durch Lesen der Meldung zu rekonstruieren. Der Host löst diesen Bezeichner gegen die Bedingungen auf, die der Compiler deklariert, und veröffentlicht die eigenen Bezeichner der aufgelösten Bedingung in der strukturierten Diagnose, sodass ein Code, der einen Leser erreicht, sich immer auflöst; ein Bezeichner, der keine solche Bedingung benennt, oder einer, den die Nummerierung zurückgezogen hat, hält den Build an. Ein Guest ohne genaue Bedingung, die er benennen könnte, greift stattdessen auf eine der generischen Plugin-Fehlerbedingungen zurück, die der Compiler zu diesem Zweck deklariert, und schreibt die Einzelheiten in seine eigene Meldung. Dieser Bezeichner und condition_short_code werden zusammen gemeldet, weil sie eine Bedingung in zwei Formen benennen: Ein Guest, der den einen setzt und den anderen nicht, hat eine Bedingung benannt, die der Host nicht auflösen kann, und der Host meldet dann stattdessen seine eigene generische Plugin-Fehlerbedingung, während die Meldung weiterhin den gesamten Fehlschlag trägt. |
condition_short_code | string | nein | Der kompakte Bezeichner derselben Bedingung — der Buchstabe E und vier Ziffern, die Form, die ein Leser zitiert, sucht und in einen Bericht einfügt —, neben der für Menschen lesbaren Fehlermeldung gesetzt; fehlt bei Erfolg und fehlt, wenn der Guest keine solche Bedingung benennt. Der Host gibt ihn im Kopf in eckigen Klammern der Diagnose aus, die er für diesen Fehlschlag rendert, sodass eine Bedingung, die ein Guest auslöst, genauso zitierbar ist wie eine, die der Compiler auslöst. Der Host löst den Wert gegen die Bedingungen auf, die der Compiler deklariert, statt ihn auf Treu und Glauben zu tragen: Ein Wert, der keine solche Bedingung benennt, ein Wert, den die Nummerierung zurückgezogen hat, oder eine Schreibweise, die die Registrierung nicht trägt, hält den Build an und zitiert den betreffenden Wert, wobei die eigene Meldung des Guests weiterhin gemeldet wird. Er wird zusammen mit condition_code gemeldet, aus dem dort genannten Grund. |
Zusätzliche Eigenschaften sind nicht zulässig.
LinkResolveInput
Die Payload, die ein Provider über seinen Export link_resolve erhält: ein Boundary-übergreifender Link, das Handle der veröffentlichten Identität, das sein konsumierter Endpunkt bereitgestellt hat, und die zusammengesetzten Dateien des konsumierenden Endpunkts. Der Export gibt die konsumentenseitige Artefakt-Verdrahtung zurück, die die Referenz in die zusammengesetzte Ausgabe des konsumierenden Endpunkts injiziert.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
edge | LinkEdge | ja | Der Boundary-übergreifende Link, der aufgelöst wird, von der Seite des konsumierenden (Quell-)Endpunkts aus gelesen. |
handle | Map von string | ja | Das Handle der veröffentlichten Identität, das link_publish des konsumierten Endpunkts zurückgegeben hat und gegen das der Konsument seine Referenz auflöst. Opake deterministische Zeiger-Zeichenketten, nach Feldnamen geschlüsselt; der Compiler leitet sie durch und löst sie nie auf. Schlüssel werden sortiert serialisiert, sodass die Payload über Läufe mit identischer Eingabe hinweg byte-identisch ist. |
consumer_files | RenderedFile[] | nein | Die zusammengesetzten Dateien des konsumierenden Endpunkts, damit der Provider den Platzhalter finden kann, den der Host in die konsumierende Ausgabe gestempelt hat, und dessen Ersatz am tatsächlichen Pfad des Platzhalters verfassen kann. Jede nennt ihren Pfad auf dem Datenträger und trägt die zusammengesetzten Bytes. Fehlt, wenn der Host keine zusammengesetzte Konsumentenausgabe hat, die er dem Auflösen übergeben könnte; ein Provider, der kein Dokument braucht, um seine Verdrahtung zu verfassen, ignoriert es. |
Zusätzliche Eigenschaften sind nicht zulässig.
LinkResolveOutput
Die Payload, die ein Provider aus seinem Export link_resolve zurückgibt: die konsumentenseitige Artefakt-Verdrahtung, die auf die zusammengesetzte Ausgabe des konsumierenden Endpunkts anzuwenden ist und die Referenz auf die veröffentlichte Identität des konsumierten Endpunkts injiziert.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
patches | LinkPatch[] | ja | Die konsumentenseitige Artefakt-Verdrahtung, ein strukturelles Patch pro Ausgabedatei des konsumierenden Endpunkts, die das Auflösen bearbeiten muss. |
error | string | nein | Eine Fehlermeldung, die gesetzt wird, wenn der Guest lief, den Link aber nicht auflösen konnte; fehlt bei Erfolg. Der Host meldet ein vorhandenes error als fehlgeschlagenen Plugin-Aufruf. Ein Auflösen, das nicht fortfahren kann — eine Referenz, die das Ziel nur als ganzen Skalar tragen kann, angetroffen innerhalb einer längeren Zeichenkette —, wird hier gemeldet statt nur als Absturz, sodass die Bedingung dahinter benannt werden kann. |
condition_code | string | nein | Die beschreibende, maschinell abgleichbare Identität der Bedingung, die der Fehlschlag benennt — der Code, unter dem die Bedingung registriert ist, in derselben offenen Menge, in der der Compiler seine eigenen Abbruchbedingungen registriert, und kein Element des geschlossenen Katalogs der Fehlercodes für Host-Funktionen, aus dem der hostfunc_error_code eines Antwort-Umschlags stammt. Neben der für Menschen lesbaren Fehlermeldung gesetzt; fehlt bei Erfolg und fehlt, wenn der Guest keine solche Bedingung benennt. Ein Guest, der abbricht, meldet hier den Bezeichner der Bedingung, die seine Meldung benennt, sodass ein Verbraucher danach verzweigt, statt eine Identität durch Lesen der Meldung zu rekonstruieren. Der Host löst diesen Bezeichner gegen die Bedingungen auf, die der Compiler deklariert, und veröffentlicht die eigenen Bezeichner der aufgelösten Bedingung in der strukturierten Diagnose, sodass ein Code, der einen Leser erreicht, sich immer auflöst; ein Bezeichner, der keine solche Bedingung benennt, oder einer, den die Nummerierung zurückgezogen hat, hält den Build an. Ein Guest ohne genaue Bedingung, die er benennen könnte, greift stattdessen auf eine der generischen Plugin-Fehlerbedingungen zurück, die der Compiler zu diesem Zweck deklariert, und schreibt die Einzelheiten in seine eigene Meldung. Dieser Bezeichner und condition_short_code werden zusammen gemeldet, weil sie eine Bedingung in zwei Formen benennen: Ein Guest, der den einen setzt und den anderen nicht, hat eine Bedingung benannt, die der Host nicht auflösen kann, und der Host meldet dann stattdessen seine eigene generische Plugin-Fehlerbedingung, während die Meldung weiterhin den gesamten Fehlschlag trägt. |
condition_short_code | string | nein | Der kompakte Bezeichner derselben Bedingung — der Buchstabe E und vier Ziffern, die Form, die ein Leser zitiert, sucht und in einen Bericht einfügt —, neben der für Menschen lesbaren Fehlermeldung gesetzt; fehlt bei Erfolg und fehlt, wenn der Guest keine solche Bedingung benennt. Der Host gibt ihn im Kopf in eckigen Klammern der Diagnose aus, die er für diesen Fehlschlag rendert, sodass eine Bedingung, die ein Guest auslöst, genauso zitierbar ist wie eine, die der Compiler auslöst. Der Host löst den Wert gegen die Bedingungen auf, die der Compiler deklariert, statt ihn auf Treu und Glauben zu tragen: Ein Wert, der keine solche Bedingung benennt, ein Wert, den die Nummerierung zurückgezogen hat, oder eine Schreibweise, die die Registrierung nicht trägt, hält den Build an und zitiert den betreffenden Wert, wobei die eigene Meldung des Guests weiterhin gemeldet wird. Er wird zusammen mit condition_code gemeldet, aus dem dort genannten Grund. |
Zusätzliche Eigenschaften sind nicht zulässig.