Aggrega-Schema für den Template-Kontext
Generierte Referenz. Nicht von Hand bearbeiten — aus dem veröffentlichten JSON Schema neu generieren.
Schema-ID: https://aggrega.ai/schemas/template-context-v1beta1.schema.json
Die Sicht, die der Compiler zusammenstellt und beim Rendern an die Templates von Recipe und FeatureRecipe übergibt. Beim Rendern eines Anbindungs-FeatureRecipe füllt der Compiler zusätzlich .attachment_name und .inject mit dem auf die Anbindung bezogenen Kontext, .context.render_facts mit dem, was der Provider seines Hosts über das Rendern des Hosts gemeldet hat, und, in den Templates, die die eigenen Ressourcen der Anbindung erzeugen, .context.used_by mit den Komponenten, die seinen Host verwenden. Für ein FeatureRecipe mit Boundary-Geltungsbereich (spec.executionScope: boundary) finden die Templates, die es einmal für die Boundary ausführt — darunter seine locals, provides, source, valuesMapping, artifacts und pipeline-Schritte —, die Säulen .context, .workload, .attachment_name, .inject und .inject_raw abwesend und stattdessen eine Säule .boundary.* gefüllt — siehe den Boundary-Block am Ende der Eigenschaften; sein injectMapping läuft einmal für jede Komponente, die die Anbindung erreicht, im Kontext dieser Komponente, liest daher .context.* und .attachment_name, und .boundary ist dort nicht gesetzt. Dies wird NICHT auf der Festplatte persistiert; es existiert nur während des Renderns im Speicher des Compilers. Dieses Schema dokumentiert den Vertrag zwischen dem Compiler und den Ops-Template-Autoren.
Verfügbarkeit nach Phase beim Basis-Rendering, in der Reihenfolge, in der die Phasen laufen:
- Provides-Auswertung (locals-Präambel, dann provides): nur knotenlokale Säulen. Ein locals-Eintrag liest die Einträge oberhalb von ihm in seinem eigenen Block; ein provides-Template liest das gesamte aufgelöste .locals des Knotens. Selbstreferenz verboten (kein provides-Eintrag liest einen anderen).
- Quellauflösung (locals-Veröffentlichung + source-Auswertung): alle Säulen; .source und .workload fehlen. Diese locals werden hier auf .locals veröffentlicht, dann wird source: gegen sie ausgewertet.
- Werte-Mapping (valuesMapping): alle Säulen + .source; .workload fehlt.
- Workload-Synthese (workload-Auswertung): alle Säulen + .source; .workload wird gerade ausgewertet (für die Selbstreferenz nicht vorhanden).
- Artefakt-Auswertung (artifacts): alle Säulen + .source + .workload (vollständigster Kontext).
Typ der obersten Ebene: object
Eigenschaften
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
context | object | ja | Der vom Compiler zusammengestellte Ausführungskontext, der Identitäts-, Topologie- und Zustellungsdaten bereitstellt. |
values | object | ja | Die opake kognitive Nutzlast für diesen Knoten, bei der Auflösung bereits vom Schema-Validator validiert. Unverändert durchgereicht. |
infra | object | ja | Die physische Dimensionierungs-Nutzlast, die für diesen Knoten aus dem Release injiziert wird. Umgeht den Entwickler vollständig. |
locals | Map von string | ja | Der eigene private Zustand des Recipe (z. B. primary_compute, volumes_path). Ausgewertet in der locals-Präambel — vor den provides dieses Knotens — und bei der Quellauflösung auf diese Säule veröffentlicht. Jeder Eintrag ist ein Go-Template, das gegen einen in sich geschlossenen knotenlokalen Kontext ausgewertet wird, der die bis dahin aufgelösten Einträge desselben Blocks trägt, sodass ein Eintrag ein OBERHALB von ihm definiertes Geschwister lesen DARF und den aufgelösten Wert dieses Geschwisters erhält. Die Reihenfolge des Autors ist Teil des Vertrags, wo immer ein Eintrag einen anderen liest: Eine Definition unter ihren Leser zu verschieben, bricht den Build. Eine Referenz ‘.locals. |
provides | Map von string | nein | Der öffentliche API-Vertrag des Recipe. Aus der Provides-Auswertung befüllt. Im valuesMapping des Basis-Renderings für die Selbstreferenz verfügbar (z. B. {{ .provides.host }}). NICHT innerhalb des provides-Templates selbst verfügbar (die Invariante der Selbstabgeschlossenheit von provides). Aufrufer lösen inject-Schlüssel gegen diese Werte auf. |
features | Map von template_attachment | nein | Jede Anbindung an diesem Knoten, nach dem Instanznamen geschlüsselt, den der Autor ihr gegeben hat. Eine Säule trägt sie alle, gleich was sie erzeugen — ein operatives Feature, ein Credential-Feature, ein Identitäts-Feature —, weil sich die Anbindungen darin unterscheiden, was sie erzeugen, nicht darin, wie ein Template sie liest. Ein Recipe liest sie, um sein Rendering an die angebundenen Fähigkeiten anzupassen und zu konsumieren, was eine Anbindung veröffentlicht. Eine Anbindung, die an einer der Verbindungen des Knotens geschrieben ist, gehört nicht dazu: Sie wird unter dieser Verbindung gelesen, unter .context.uses. |
metadata | object | nein | Release- und Kompilierungsmetadaten, die eine globale Identität für deterministische Benennung bereitstellen. In allen Template-Blöcken verfügbar (valuesMapping, injectMapping, pipeline with). |
attachment_name | string | nein | Nur beim Rendern eines Anbindungs-FeatureRecipe befüllt. Enthält den Instanznamen der Anbindung — den Slot, den sie im featuresSchema der besitzenden Entität füllt, oder den freien Namen, den der Autor ihr gegeben hat (z. B. ‘admin_password’, ‘db_credentials’). Wird verwendet, um deterministische Ressourcennamen zu bilden, die sich pro Anbindung unterscheiden, zusammengesetzt nach dem Namen der Host-Komponente: ’{{ .context.rendered_name }}-{{ .attachment_name | replace ”_” ”-” }}’, wo der Provider des Hosts einen gerenderten Namen meldet, wie helm es tut — der Name des Hosts, geschrieben in den Zeichen, die ein Kubernetes-Name zulässt, wobei die Unterstriche des Anbindungsnamens zu Bindestrichen umgewandelt sind —, und ’{{ .context.instance_id }}-{{ .attachment_name }}’, wo der Provider des Hosts keinen meldet. |
inject | object | nein | Nur beim Rendern eines Anbindungs-FeatureRecipe befüllt, das einen verfassten inject-Block trägt (z. B. { env: [ { in: ‘OPENAI_API_KEY’, from: ‘api_token’ } ] }). Unterschieden von .context.inject, das die vorab hydratisierte Zustellungs-Pipe der Basiskomponente aus uses-Kanten ist. Ergibt null/fehlt für Anbindungen ohne verfassten inject und für Basis-Recipes. |
inject_raw | object oder null | nein | Die unveränderliche, nicht mutierte Absicht des Entwicklers für den inject-Block. Jeder Mechanismus, den der Block nennt — env, file, arg oder ein benutzerdefinierter wie ssm_param —, steht unter seinem eigenen Namen und enthält die Einträge genau so, wie sie geschrieben sind (in, mit from oder value), in der geschriebenen Reihenfolge, sodass .inject_raw.ssm_param einen benutzerdefinierten Mechanismus so liest, wie .inject_raw.env einen Kernmechanismus liest. Ergibt null, wenn der Entwickler den inject-Block ganz weggelassen hat. Wird von Ops für logische Prüfungen verwendet (z. B. {{ if not .inject_raw }}), um das Weglassen vor den Mutationen des inject-Mappings zu erkennen. Welche der eigenen values oder provides der Komponente jeder Eintrag liefert, wird unter .context.self_inject gelesen statt aus dem Text der Einträge. |
steps | Map von object | nein | Kommunikation zwischen Pipeline-Schritten. Nur innerhalb von ‘with:’-Blöcken einer Wasm-Pipeline verfügbar. Jeder Schlüssel ist die ID eines Pipeline-Schritts und enthält die von diesem Schritt exportierten Ausgaben. |
source | string oder object oder null | nein | Aufgelöster Inhalt des source-Felds. In den Templates eines Recipe: bei der Quellauflösung aus dem Feld source: des Recipe nach der Go-Template-Auswertung befüllt, ab dem Werte-Mapping verfügbar (valuesMapping, workload, artifacts) und null, wenn das Recipe kein source: hat. In den Templates eines FeatureRecipe: das eigene Feld source: des FeatureRecipe nach der Go-Template-Auswertung, ausgewertet vor seinem valuesMapping und dort sowie in jedem danach ausgewerteten Template gelesen (omits, workload, artifacts, Pipeline-Schritte), nie das der Host-Komponente; null, wenn das FeatureRecipe kein source: hat. Das injectMapping eines FeatureRecipe wird vor seiner Quelle ausgewertet und liest die der Host-Komponente. Zeichenkettenform = URI-Pfad; Objektform = strukturierte Quelle (z. B. OCI-Deskriptor mit aufgelöster Version). |
workload | workload-v1beta1.schema.json oder null | nein | Geparste Workload-Spezifikation für diesen Knoten. Bei der Workload-Synthese aus dem Feld workload: des Recipe nach der Go-Template-Auswertung + der JSON-Schema-Validierung der Workload (gegen workload-v1beta1.schema.json) befüllt. Ab der Artefakt-Auswertung verfügbar (artifacts), sodass Artefakte auf workload-Felder verweisen können, ohne sie zu duplizieren (z. B. ein ServiceMonitor, der .workload.services.metrics.ports.prom liest). Ergibt null, wenn das Recipe keinen Block workload: hat. Versuche eines Templates, .workload.* auf einem null-Wert zu dereferenzieren, schlagen zur Zeit der Template-Auswertung mit einem klaren Fehler fehl. |
boundary | object | nein | Kontext mit Boundary-Geltungsbereich — nur befüllt, wenn ein Template ausgewertet wird, das ein FeatureRecipe, dessen spec.executionScope ‘boundary’ ist, einmal für die Boundary ausführt. FeatureRecipes mit Component-Geltungsbereich erhalten diese Säule nicht; ihre context.instance_id, context.inject, context.uses und die Säule .workload tragen stattdessen Daten pro Komponente. Die für die Boundary ausgeführten Templates eines FeatureRecipe mit Boundary-Geltungsbereich erhalten .boundary.* anstelle dieser Säulen pro Komponente; sein injectMapping läuft im Kontext jeder Komponente, die die Anbindung erreicht, liest diese Säulen pro Komponente und erhält diese nicht. |
Zusätzliche Eigenschaften sind nicht zulässig.
template-context.context
Der vom Compiler zusammengestellte Ausführungskontext, der Identitäts-, Topologie- und Zustellungsdaten bereitstellt.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
instance_id | string | ja | Die absolute, abgeflachte ID des aktuellen Knotens (z. B. ‘backend’ oder ‘data-layer-zdmain-db’ für die Komponente main-db der Modulinstanz data-layer), geschrieben in dem Alphabet, das jeder verfasste Komponentenname erfüllt. Deterministisch und über Kompilierungen hinweg stabil für dasselbe Aggregate. Sie ist der Name der für diesen Knoten erzeugten Ressourcen, für die kein Provider einen Namen ableitet — eine aus dem Recipe platzierte Artefaktmenge und eine Workload, die ein Provider synthetisiert, der sie nach der Identität benennt —, sodass eine für eine davon veröffentlichte Adresse aus diesem Wert gebildet wird. |
rendered_name | string | nein | Der Name, den der an diesen Knoten gebundene Provider den Ressourcen gibt, die er für den Knoten rendert — bei einer vom Autor gelieferten Quelle der Name, gegen den die gelieferten Templates selbst rendern, etwa der Releasename, den ein Chart liest; bei einer Workload, die er synthetisiert, der Name, den er den Ressourcen dieser Workload gibt, wenn er einen ableitet, statt die Identität des Knotens zu schreiben, wie es der helm-Provider mit demselben Releasenamen tut. Lesen Sie ihn überall dort, wo dieses Recipe eine Ressource benennt, die ein geliefertes Chart oder Modul deklariert oder ein solcher Provider synthetisiert hat, ob in einem provides-Eintrag, einem valuesMapping, einem workload, einem artifacts-Eintrag oder im with oder when eines Pipeline-Schritts, denn der Provider kann diesen Namen in einem ärmeren Alphabet schreiben als dem, in dem ein verfasster Komponentenname geschrieben ist, und dann unterscheiden sich die beiden. Leer, wenn der gebundene Provider keinen solchen Namen ableitet: Die Ressourcen einer platzierten Artefaktmenge und einer Workload, die ein Provider synthetisiert, der sie nach der Identität benennt, tragen die Identität des Knotens, lesen Sie für diese also ’{{ .context.instance_id }}’, und ein Recipe, das seine eigenen Ressourcennamen geschrieben hat, kennt sie bereits. Das Lesen dieses Schlüssels, wo der gebundene Provider keinen Namen meldet, hält den Build an und sagt, was stattdessen zu schreiben ist. Die Ablehnung erfasst die Templates, die ein Recipe inline schreibt; ein valuesMapping, ein workload oder ein artifacts-Eintrag, die über ‘$import’ geliefert werden, werden erst aufgelöst, wenn der Render sie erreicht, sodass eine Referenz innerhalb eines davon als leerer Wert gerendert wird, statt den Build anzuhalten. In den Templates eines FeatureRecipe, das an die Anbindung einer Komponente gebunden ist, ist er der Name der HOST-Komponente, wie ihn der eigene Provider des Hosts meldet — der Wert, den das eigene Recipe des Hosts liest, so wie instance_id dort die Identität des Hosts ist —, sodass eine Anbindung daraus eine Ressource nach ihrem Host benennt und einen Namen erhält, den die Plattform des Hosts akzeptiert. Wo der Provider des Hosts keinen Namen meldet, ist er leer, und ihn aus einem Inline-Template der Anbindung außer ihrem injectMapping zu lesen, hält den Build an; lesen Sie dort stattdessen ’{{ .context.instance_id }}’. |
labels | Map von string | nein | Die Duck-Typing- und Ontologie-Labels des aktuellen Knotens, einschließlich jeder Änderung, die ein in der Rolle label-transform angebundenes Governance-Plugin bei der Topologiekonstruktion vorgenommen hat. |
annotations | object | nein | Die drei kaskadierenden Annotations-Buckets des aktuellen Knotens, nach Herkunft getrennt. |
inject | object | ja | Die vorab hydratisierte und abgefangene Zustellungs-Pipe. Beginnt als vom Compiler erzeugte Map, die die inject-Schlüssel des Entwicklers auf die provides-Werte des Ziels auflöst. Wird an Ort und Stelle durch die Deep-Merges von injectMapping verändert. Wenn das Basis-Recipe rendert, enthält sie die vollständig aufgelösten physischen Zeichenketten. |
uses | Map von enriched_edge | ja | Die angereicherte Map der topologischen Kanten. Geschlüsselt nach dem Alias des Entwicklers (z. B. ‘my_db’, ‘my_api’). Jeder Eintrag ist eine vom Compiler zusammengesetzte Sicht auf die Identität des Zielknotens, die aufgelösten provides, das Injection-Mapping und die kaskadierten Annotationen sowie auf die an dieser Verbindung geschriebenen Anbindungen — und, für ein FeatureRecipe, das readsTargetRenderFacts deklariert, auf das, was die Renders des Ziels gemeldet haben. Dies ist NICHT die rohe IR-Kante — es ist eine angereicherte Projektion, die der Compiler eigens für die Verwendung in Templates erstellt. Ein Template, das diese Map durchläuft, sieht die Verbindungen in Schlüsselreihenfolge — nach Alias sortiert —, nicht in der Reihenfolge, in der sie geschrieben wurden. |
self_inject | object | ja | Welche der eigenen values und provides der Komponente der Entwickler bereits mit einem Liefernamen versehen hat, gelesen aus dem auf der Komponente selbst geschriebenen Block inject: — dem Block, den .inject_raw wie geschrieben und .context.inject aufgelöst enthält. Jeder Mechanismus, den der Block nennt (env, file, arg oder ein benutzerdefinierter wie ssm_param), ordnet jeden Namen, den der Entwickler geschrieben hat, dem eigenen Schlüssel zu, den dieser Eintrag liefert, so wie .context.uses. |
used_by | inbound_edge[] | nein | Die Komponenten, die diese verwenden: ein Eintrag pro uses-Verbindung, die eine andere Komponente zu ihr herstellt, in der Reihenfolge, in der die sich verbindenden Komponenten geschrieben sind, und dann in der Reihenfolge der eigenen uses-Einträge jeder einzelnen. Eine Komponente, die sich zweimal verbindet, erscheint zweimal. Nur von einem an die Komponente angebundenen FeatureRecipe gelesen, und nur in den Templates, die die eigenen Ressourcen der Anbindung erzeugen — ihr valuesMapping, workload und artifacts. Fehlt in den Templates des eigenen Recipe der Komponente, in einem injectMapping und im with und when eines Pipeline-Schritts, denn die Ausgabe jedes davon kann in der eigenen gerenderten Ausgabe der Komponente landen, die gleich bleibt, wer auch immer sich mit ihr verbindet. Jeder Eintrag ist ein Listenelement statt eines Schlüssels, sodass ein Template, das diese Liste durchläuft, die Aufrufer in dieser Reihenfolge antrifft. |
render_facts | render_facts | nein | Was der Provider, der diese Komponente gerendert hat, über die von ihm ausgegebene Ausgabe gemeldet hat — die Render-Fakten, die er meldet —, geschlüsselt nach Faktenname. Welche Namen ein Provider meldet und was jeder Eintrag enthält, legt sein eigener dokumentierter Vertrag fest. Jeder Wert ist eine Liste, auch mit nur einem Eintrag, sodass ein Template sie immer durchläuft; wo der Render der Komponente mehr als einen Provider-Aufruf erforderte und ein Name von mehreren davon gemeldet wurde, werden seine Listen in der Reihenfolge, in der die Aufrufe liefen, zu einer zusammengeführt. Vorhanden in jedem Template eines an die Komponente angebundenen FeatureRecipe — seinem valuesMapping, workload, artifacts und dem with und when der Pipeline-Schritte —, sobald die Komponente gerendert wurde, und leer, wo ihr Provider nichts meldet, sodass ein Name, den niemand gemeldet hat, als leere Liste gelesen wird. Fehlt in den Templates des eigenen Recipe der Komponente und in einem injectMapping, die laufen, bevor die Komponente gerendert wurde. |
Zusätzliche Eigenschaften sind nicht zulässig.
template-context.context.annotations
Die drei kaskadierenden Annotations-Buckets des aktuellen Knotens, nach Herkunft getrennt.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
release | Map von string | nein | Physische Topologie-Zeichenketten, die von den Release-Boundaries herabkaskadieren. |
catalog | Map von string | nein | Unveränderliche intrinsische Merkmale, verfasst vom Platform Architect in Domäne 2. |
aggregate | Map von string | nein | Kognitive Metadaten, die von den Subsystemen des Aggregate herabkaskadieren. |
Zusätzliche Eigenschaften sind nicht zulässig.
template-context.context.inject
Die vorab hydratisierte und abgefangene Zustellungs-Pipe. Beginnt als vom Compiler erzeugte Map, die die inject-Schlüssel des Entwicklers auf die provides-Werte des Ziels auflöst. Wird an Ort und Stelle durch die Deep-Merges von injectMapping verändert. Wenn das Basis-Recipe rendert, enthält sie die vollständig aufgelösten physischen Zeichenketten.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
env | Map von string | nein | Zustellung über Umgebungsvariablen. Die Schlüssel sind die lokalen Variablennamen des Entwicklers, die Werte sind die aufgelösten Zeichenketten des Ziels. |
file | Map von string | nein | Zustellung über Datei-Mounts. Die Schlüssel sind lokale Dateipfade, die Werte sind die aufgelösten Zeichenketten des Ziels. |
arg | Map von string | nein | Zustellung über Kommandozeilenargumente. Die Schlüssel sind Flag-Präfixe, die Werte sind die aufgelösten Zeichenketten des Ziels. |
all | Map von string | nein | Vorberechnete flache Zusammenführung der Mechanismen env + file + arg + benutzerdefiniert. Befüllt nach der uses-inject-Auflösung und nach dem inject-Mapping neu berechnet. Templates verwenden {{ toJson .context.inject.all }} für eine universelle Serialisierung. |
template-context.context.self_inject
Welche der eigenen values und provides der Komponente der Entwickler bereits mit einem Liefernamen versehen hat, gelesen aus dem auf der Komponente selbst geschriebenen Block inject: — dem Block, den .inject_raw wie geschrieben und .context.inject aufgelöst enthält. Jeder Mechanismus, den der Block nennt (env, file, arg oder ein benutzerdefinierter wie ssm_param), ordnet jeden Namen, den der Entwickler geschrieben hat, dem eigenen Schlüssel zu, den dieser Eintrag liefert, so wie .context.uses.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
env | Map von string | nein | Lieferung über Umgebungsvariablen: Schlüssel sind die Variablennamen des Entwicklers, Werte sind der eigene Schlüssel, den jeder Eintrag liefert. |
file | Map von string | nein | Lieferung über Datei-Mounts: Schlüssel sind die Dateipfade des Entwicklers, Werte sind der eigene Schlüssel, den jeder Eintrag liefert. |
arg | Map von string | nein | Lieferung über Kommandozeilenargumente: Schlüssel sind die Flag-Präfixe des Entwicklers, Werte sind der eigene Schlüssel, den jeder Eintrag liefert. |
template-context.metadata
Release- und Kompilierungsmetadaten, die eine globale Identität für deterministische Benennung bereitstellen. In allen Template-Blöcken verfügbar (valuesMapping, injectMapping, pipeline with).
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
release_name | string | nein | Der Name des gebauten Release (z. B. ‘prod-billing’). Wird von Ops verwendet, um global eindeutige Cloud-Ressourcennamen zu bilden (S3-Buckets, IAM-Rollen). Wird mit .context.instance_id kombiniert, um Eindeutigkeit über Umgebungen hinweg zu garantieren. |
release_version | string | nein | Die semantische Version des Release. |
environment | string | nein | Die Umgebungszeichenkette aus den Metadaten des Release (z. B. ‘production’, ‘local’). |
aggregate_name | string | nein | Der Name des kompilierten Wurzel-Aggregate. |
Zusätzliche Eigenschaften sind nicht zulässig.
template-context.inject
Nur beim Rendern eines Anbindungs-FeatureRecipe befüllt, das einen verfassten inject-Block trägt (z. B. { env: [ { in: ‘OPENAI_API_KEY’, from: ‘api_token’ } ] }). Unterschieden von .context.inject, das die vorab hydratisierte Zustellungs-Pipe der Basiskomponente aus uses-Kanten ist. Ergibt null/fehlt für Anbindungen ohne verfassten inject und für Basis-Recipes.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
env | Map von string | nein | Zustellung über Umgebungsvariablen im Geltungsbereich der Anbindung. |
file | Map von string | nein | Zustellung über Datei-Mounts im Geltungsbereich der Anbindung. |
arg | Map von string | nein | Zustellung über Argumente im Geltungsbereich der Anbindung. |
all | Map von string | nein | Vom Compiler erzeugte Komfort-Zusammenführung aller inject-Paradigmen der Anbindung. |
template-context.boundary
Kontext mit Boundary-Geltungsbereich — nur befüllt, wenn ein Template ausgewertet wird, das ein FeatureRecipe, dessen spec.executionScope ‘boundary’ ist, einmal für die Boundary ausführt. FeatureRecipes mit Component-Geltungsbereich erhalten diese Säule nicht; ihre context.instance_id, context.inject, context.uses und die Säule .workload tragen stattdessen Daten pro Komponente. Die für die Boundary ausgeführten Templates eines FeatureRecipe mit Boundary-Geltungsbereich erhalten .boundary.* anstelle dieser Säulen pro Komponente; sein injectMapping läuft im Kontext jeder Komponente, die die Anbindung erreicht, liest diese Säulen pro Komponente und erhält diese nicht.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
path | string | nein | Der Pfad der Release-Boundary, an die das FeatureRecipe angebunden ist: die Boundary-Namen von außen nach innen, mit ’/’ verbunden (z. B. ‘bridge’, ‘bridge/frontend’). Er benennt die Boundary, nicht das Verzeichnis, in das ihre Ausgabe geschrieben wird und das directory: der Boundary festlegt. |
assembly_path | string | nein | Das Verzeichnis, relativ zum Ausgabeverzeichnis des Builds, in das die eigene Ausgabe dieser Anbindung zusammengesetzt wird: das ausgewertete directory: und subDirectory: ihrer Boundary, das Verzeichnis, zu dem der Build diese Ausgabe leitet (z. B. ‘bridge/compose’). Es ist genau dann gleich dem source_assembly_path oder target_assembly_path eines Verbindungsendpunkts, wenn dieser Endpunkt in dieselbe zusammengesetzte Datei rendert, sodass ein FeatureRecipe sie vergleicht, um eine Verbindung innerhalb seiner eigenen Datei von einer in einer anderen Datei zu unterscheiden. Opake Daten; der Kern interpretiert sie nicht. |
boundary_name | string | nein | Der Name der Boundary (der Map-Schlüssel in release.spec.boundaries). |
components | object | nein | Map von instance_id auf einen Eintrag für jede Komponente im Teilbaum der Boundary (rekursiv, einschließlich der Komponenten verschachtelter Boundaries). Jeder Eintrag trägt den aufgelösten Typ-URI, die Instanz-ID und die bereitgestellten Werte der Komponente aus der provides-Auswertung pro Komponente. |
internal_uses_edges | object[] | nein | uses-Kanten, bei denen Quelle UND Ziel beide im Teilbaum dieser Boundary liegen. |
outgoing_cross_boundary_uses_edges | object[] | nein | uses-Kanten, deren Quelle im Teilbaum dieser Boundary liegt und deren Ziel außerhalb davon liegt. |
incoming_cross_boundary_uses_edges | object[] | nein | uses-Kanten, bei denen das Ziel im Teilbaum und die Quelle außerhalb liegt. Werden von Aggregatoren im Ingress-Stil verwendet, die wissen müssen, wer von außen aufruft. |
cross_boundary_uses_edges | object[] | nein | Komfort-Vereinigung der ausgehenden und eingehenden Boundary-übergreifenden Kanten. |
labels | Map von string | nein | Vereinigung der Labels der Komponenten im Teilbaum, unter Wahrung der Autorenreihenfolge. |
annotations | Map von string | nein | Die eigenen Annotationen der Boundary, nachdem die Kaskade aufgelöst ist. |
feature_attachments | template_attachment[] | nein | Die Anbindungen direkt an dieser Boundary (für Verweise zwischen Anbindungen innerhalb des Boundary-Geltungsbereichs), in derselben Anbindungsform, die .features trägt. |
Zusätzliche Eigenschaften sind nicht zulässig.
Definitionen
inbound_edge
Eine Verbindung, die eine andere Komponente zu der Komponente herstellt, für die ein angebundenes FeatureRecipe rendert: wer sich verbindet, über welchen Socket, was die sich verbindende Komponente veröffentlicht und der Namespace und die Boundary, in denen sie platziert ist. Jeder Wert ist eine Zeichenkette, die der Compiler trägt, ohne sie zu interpretieren.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
component_id | string | ja | Die abgeflachte Instanz-ID der sich verbindenden Komponente (z. B. ‘frontend’ oder ‘data-layer.etl’) — der Wert, den ein subDirectory-Pfad-Template als .component_id liest, so geschrieben, wie .context.uses. |
socket | string | ja | Die usesSchema-Kategorie, über die die sich verbindende Komponente diese Verbindung zieht (z. B. ‘databases’, ‘apis’). |
provides | Map von string | ja | Die aufgelösten provides der sich verbindenden Komponente, eingeschränkt auf die Schlüssel, die ihre Component deklariert — dieselben Werte, die ein Verbraucher dieser Komponente unter .context.uses. |
source_namespace | string | nein | Der Namespace, in dem die sich verbindende Komponente platziert ist: die Annotation aggrega.ai/namespace, die ihr eigener Render erhält — die Annotationen ihrer Boundaries, wobei die Annotationen ihres eigenen Release-Eintrags zuletzt angewendet werden, sodass eine Komponente, deren Eintrag den Namespace setzt oder löscht, ihre eigene Einstellung statt der ihrer Boundary trägt. Es ist der Wert, den ein FeatureRecipe mit Boundary-Geltungsbereich als source_namespace im Eintrag derselben Verbindung in den uses-Kantenlisten von .boundary liest. Fehlt, wenn für die sich verbindende Komponente kein Namespace gilt; schützen Sie ihn mit if oder with, bevor Sie ihn ausgeben. |
source_boundary_path | string | nein | Der durch Schrägstriche getrennte Pfad der Release-Boundary, die die sich verbindende Komponente enthält (z. B. ‘edge’ oder ‘aws-prod/payments’) — der Wert, den ein FeatureRecipe mit Boundary-Geltungsbereich als source_boundary_path im Eintrag derselben Verbindung in den uses-Kantenlisten von .boundary liest. |
render_facts | render_facts | nein | Was die Renders der sich verbindenden Komponente über die von ihnen ausgegebene Ausgabe gemeldet haben, geschlüsselt nach Faktenname: die Fakten, die ihre eigenen Provider-Aufrufe gemeldet haben, dann die jedes an sie angebundenen Feature, das mit ihr gerendert wurde, in der Reihenfolge, in der sie gerendert wurden, wobei die Listen, die ein Name von mehreren davon erhält, in dieser Reihenfolge zu einer zusammengeführt werden. Jeder Wert ist eine Liste, auch mit nur einem Eintrag, sodass ein Template sie immer durchläuft. Nur vorhanden für ein FeatureRecipe, das readsCallerRenderFacts deklariert — dessen Anbindungen rendern, sobald jede Komponente gerendert wurde, sodass der Render jedes Aufrufers vollständig ist —, und dann in jedem Eintrag, leer für einen Aufrufer, dessen Provider nichts melden. Fehlt für jedes andere FeatureRecipe. |
Zusätzliche Eigenschaften sind nicht zulässig.
render_facts
Render-Fakten, geschlüsselt nach Name: was die Provider, die eine Komponente gerendert haben, über die von ihnen ausgegebene Ausgabe gemeldet haben. Welche Namen ein Provider meldet und was jeder Eintrag enthält, legt sein eigener dokumentierter Vertrag fest; der Compiler erfährt über beides nichts, außer dass jeder Wert eine Liste ist. Eine Liste behält die Reihenfolge ihrer Einträge. Ein Objekteintrag wird mit seinen Schlüsseln in der Reihenfolge getragen, in der der Provider sie geschrieben hat, und ein Template, das ihn durchläuft, trifft sie in Schlüsselreihenfolge an, wie bei jeder geschlüsselten Map dieses Kontexts.
Freiform-Objekt; die Werte sind any[].
template_attachment
Eine Anbindung, wie ein Template sie liest: die Sicht pro Instanz auf ein angebundenes Feature. Jede Anbindung stellt dieselben Felder bereit, unabhängig davon, was sie erzeugt, sodass sich .features.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
type | string | nein | Der Katalog-Feature-URI des angebundenen Feature. |
resolved_version | string | nein | Die Version des angebundenen Feature nach der Manifest-Auflösung — die für diesen Build tatsächlich gebundene Version, gelesen als .features. |
labels | Map von string | nein | Die Katalog-Labels des angebundenen Feature, wörtlich in der Reihenfolge getragen, in der das Feature sie deklariert — nichts wird gefiltert, umbenannt oder um ein Präfix gekürzt, sodass ein Template genau das liest, was der Autor des Feature geschrieben hat. Ermöglicht es einem Template, danach zu verzweigen, was das angebundene Feature ist, statt nach seinem Namen oder seinem URI. Spiegelt .context.uses.if oder durchlaufen Sie die Map, bevor Sie ein einzelnes Label ansprechen. |
values | object | nein | Die eigene Säule der Entwicklerabsicht der Anbindung, wörtlich aus der Deklaration der Anbindung übernommen. |
infra | object | nein | Die eigene Säule der operativen Dimensionierung der Anbindung, wörtlich aus der Deklaration der Anbindung übernommen. |
provides | Map von string | nein | Der aufgelöste öffentliche Vertrag des an diese Anbindung gebundenen FeatureRecipe — der Name der ausgegebenen Ressource, ihr Schlüssel, eine Identität und alle weiteren erzeugten Schlüssel —, dem Verbraucher als .features. |
Zusätzliche Eigenschaften sind nicht zulässig.
enriched_edge
Eine einzelne angereicherte topologische Kante, die der Compiler zusammensetzt. Enthält die aufgelöste Identität des Ziels, die provides und die kaskadierten Annotationen.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
target | string | ja | Die absolute, abgeflachte ID des Zielknotens (z. B. ‘data-layer.main-db’). |
socket | string | ja | Die usesSchema-Kategorie, zu der diese Kante gehört (z. B. ‘databases’, ‘apis’). |
source | string | nein | Die absolute, abgeflachte ID des Quellknotens (Verbraucherknotens). Befüllt für Sichten mit Boundary-Geltungsbereich, die Ausgaben pro Verbraucher nach dem Verbraucherknoten schlüsseln. |
source_namespace | string | nein | Rohe Annotation aggrega.ai/namespace des Quellendpunkts (leer, wenn sie fehlt). Nur für Sichten mit Boundary-Geltungsbereich befüllt, wie source; der eigene .context.uses-Eintrag einer Komponente trägt sie leer. Opake Daten für die Auflösung der Netzwerkidentität durch einen Provider; der Kern interpretiert sie nicht. |
source_boundary_path | string | nein | Boundary-Pfad des Quellendpunkts: der durch Schrägstriche getrennte Pfad der Release-Boundary, die ihn enthält (z. B. ‘bridge/frontend’). Nur für Sichten mit Boundary-Geltungsbereich befüllt, wie source; der eigene .context.uses-Eintrag einer Komponente trägt ihn leer. |
source_assembly_path | string | nein | Zusammensetzungspfad des Quellendpunkts: das Verzeichnis, relativ zum Ausgabeverzeichnis des Builds, in das seine Ausgabe zusammengesetzt wird, gebildet aus dem ausgewerteten directory: und subDirectory: seiner Boundary (z. B. ‘bridge/compose’). Zwei Endpunkte mit demselben Zusammensetzungspfad rendern in eine zusammengesetzte Datei, und ein Endpunkt, dessen Zusammensetzungspfad gleich .boundary.assembly_path ist, rendert in die Datei, in die die eigene Ausgabe des lesenden FeatureRecipe zusammengesetzt wird. Ein FeatureRecipe mit Boundary-Geltungsbereich, das Endpunkte in Netzwerke platziert, kann ihn als Netzwerk des Quellendpunkts lesen, wenn keine aggrega.ai/namespace gilt. Nur für Sichten mit Boundary-Geltungsbereich befüllt, wie source; der eigene .context.uses-Eintrag einer Komponente trägt ihn leer. Opake Daten; der Kern interpretiert sie nicht. |
target_namespace | string | nein | Rohe Annotation aggrega.ai/namespace des Zielendpunkts (leer, wenn sie fehlt). Nur für Sichten mit Boundary-Geltungsbereich befüllt, wie source; der eigene .context.uses-Eintrag einer Komponente trägt sie leer. Opake Daten für die Auflösung der Netzwerkidentität durch einen Provider. |
target_boundary_path | string | nein | Boundary-Pfad des Zielendpunkts: der durch Schrägstriche getrennte Pfad der Release-Boundary, die ihn enthält (z. B. ‘bridge/backend’). Nur für Sichten mit Boundary-Geltungsbereich befüllt, wie source; der eigene .context.uses-Eintrag einer Komponente trägt ihn leer. |
target_assembly_path | string | nein | Zusammensetzungspfad des Zielendpunkts: das Verzeichnis, relativ zum Ausgabeverzeichnis des Builds, in das seine Ausgabe zusammengesetzt wird, gebildet aus dem ausgewerteten directory: und subDirectory: seiner Boundary (z. B. ‘bridge/compose’). Ein Endpunkt, dessen Zusammensetzungspfad gleich .boundary.assembly_path ist, rendert in die Datei, in die die eigene Ausgabe des lesenden FeatureRecipe zusammengesetzt wird. Ein FeatureRecipe mit Boundary-Geltungsbereich, das Endpunkte in Netzwerke platziert, kann ihn als Netzwerk des Zielendpunkts lesen, wenn keine aggrega.ai/namespace gilt. Nur für Sichten mit Boundary-Geltungsbereich befüllt, wie source; der eigene .context.uses-Eintrag einer Komponente trägt ihn leer. Opake Daten; der Kern interpretiert sie nicht. |
provides | Map von string | ja | Das vollständig aufgelöste provides-Wörterbuch des Zielknotens. Bei der provides-Auswertung ausgewertet, vor der inject-Hydratisierung. |
inject | object | ja | Das ursprüngliche inject-Mapping des Entwicklers für diese Kante (Schlüssel = lokale Variablennamen, Werte = provides-Schlüssel des Ziels). Dies ist das ROHE Mapping, nicht die aufgelösten Werte. |
labels | Map von string | nein | Die Duck-Typing- und Ontologie-Labels des Zielknotens (nach den Änderungen bei der Topologiekonstruktion). |
annotations | object | nein | Die drei kaskadierenden Annotations-Buckets des Zielknotens. |
component | string | nein | Der Katalog-Komponententyp-URI des Zielknotens (z. B. ‘core/postgres’). |
resolved_version | string | nein | Die aufgelöste SemVer des Zielknotens. |
boundary_path | string | nein | Die physische räumliche Hierarchie des Zielknotens aus dem Release (z. B. ‘aws-eks-cluster/backend-ns’). |
origin_feature | string | nein | Wenn diese Kante autonom von einem Feature deklariert wurde (einschließlich Zugangsdaten-Features mit dem Label feature.aggrega.ai/kind: secret), der Instanzname des Feature. Null/fehlend bei vom Entwickler deklarierten Kanten. |
origin_release | boolesch | nein | True, wenn das Release diese Verbindung verdrahtet hat, statt dass das Aggregate sie deklariert. Fehlt bei einer Verbindung, die das Aggregate deklariert. |
values | object | nein | Die Entwicklerkonfiguration pro Verbindung, verfasst am uses-Eintrag des Aggregate für diese Verbindung, wörtlich getragen. Fehlt, wenn die Verbindung keine trägt. Sie erreicht nur den Kontext des verbrauchenden Knotens, nie den des Ziels. |
infra | object | nein | Die operative Konfiguration pro Verbindung, verfasst am uses-Eintrag des Release für diese Verbindung, wörtlich getragen. Fehlt, wenn die Verbindung keine trägt. Sie erreicht nur den Kontext des verbrauchenden Knotens, nie den des Ziels. |
features | Map von template_attachment | nein | Die an dieser Verbindung geschriebenen Anbindungen, geschlüsselt nach dem Slot-Namen, den der Socket der Verbindung für jede deklariert, jede in der Anbindungsform, die .features trägt: ihr Typ, die aufgelöste Version, die Labels, values, infra und die aufgelösten provides des an sie gebundenen FeatureRecipe. Ein Recipe liest die Zugangsdaten einer Verbindung als .context.uses. |
render_facts | render_facts | nein | Was die Renders des Ziels über die von ihnen ausgegebene Ausgabe gemeldet haben, geschlüsselt nach Faktenname, in der Form, die der Eintrag eines Aufrufers unter .context.used_by trägt: die Fakten, die seine eigenen Provider-Aufrufe gemeldet haben, dann die jedes an es angebundenen Feature, das mit ihm gerendert wurde, in der Reihenfolge, in der sie gerendert wurden, wobei die Listen, die ein Name von mehreren davon erhält, in dieser Reihenfolge zu einer zusammengeführt werden. Jeder Wert ist eine Liste, auch mit nur einem Eintrag, sodass ein Template sie immer durchläuft. Nur unter .context.uses vorhanden für ein FeatureRecipe, das readsTargetRenderFacts deklariert — dessen Anbindungen rendern, sobald jede Komponente gerendert wurde, sodass der Render jedes Ziels vollständig ist —, und dann in jedem Eintrag, leer für ein Ziel, dessen Provider nichts melden. Fehlt für jedes andere FeatureRecipe, im with und when eines Pipeline-Schritts, in den Templates des eigenen Recipe der Komponente und in den Kantenlisten, die ein FeatureRecipe mit Boundary-Geltungsbereich liest. |
Zusätzliche Eigenschaften sind nicht zulässig.
enriched_edge.inject
Das ursprüngliche inject-Mapping des Entwicklers für diese Kante (Schlüssel = lokale Variablennamen, Werte = provides-Schlüssel des Ziels). Dies ist das ROHE Mapping, nicht die aufgelösten Werte.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
env | Map von string | nein | Zustellung über Umgebungsvariablen: Die Schlüssel sind die Namen der lokalen Variablen des Verbrauchers, die Werte sind die provides-Schlüssel des Ziels. |
file | Map von string | nein | Zustellung über Dateieinhängung: Die Schlüssel sind die lokalen Dateipfade des Verbrauchers, die Werte sind die provides-Schlüssel des Ziels. |
arg | Map von string | nein | Zustellung über Befehlszeilenargumente: Die Schlüssel sind die Flag-Präfixe des Verbrauchers, die Werte sind die provides-Schlüssel des Ziels. |
enriched_edge.annotations
Die drei kaskadierenden Annotations-Buckets des Zielknotens.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
release | Map von string | nein | Physische Topologie-Zeichenketten aus den Release-Boundaries des Zielknotens. |
catalog | Map von string | nein | Unveränderliche Merkmale aus der Katalogentität des Zielknotens. |
aggregate | Map von string | nein | Kognitive Metadaten aus den Subsystemen des Aggregate des Zielknotens. |
Zusätzliche Eigenschaften sind nicht zulässig.