Aller au contenu
AggregaAggrega
Selectionner la langue: Français
Cette page a été traduite automatiquement. Lire l’original en anglais.

Schéma du contexte de template d’Aggrega

Référence générée. Ne pas modifier à la main — régénérer à partir du JSON Schema publié.

Identifiant du schéma : https://aggrega.ai/schemas/template-context-v1beta1.schema.json

La vue que le compilateur assemble et transmet aux templates de Recipe et de FeatureRecipe pendant le rendu. Lors du rendu d’une FeatureRecipe de rattachement, le compilateur renseigne en outre .attachment_name et .inject avec le contexte propre au rattachement, .context.render_facts avec ce que le fournisseur de son hôte a signalé au sujet du rendu de l’hôte et, sur les templates qui produisent les ressources propres du rattachement, .context.used_by avec les composants qui utilisent son hôte. Pour une FeatureRecipe de portée frontière (spec.executionScope: boundary), les templates qu’elle exécute une fois pour la frontière — parmi lesquels ses locals, provides, source, valuesMapping, artifacts et étapes de pipeline — trouvent absents les piliers .context, .workload, .attachment_name, .inject et .inject_raw et renseigné à la place un pilier .boundary.* — voir le bloc de la frontière en bas des propriétés ; son injectMapping s’exécute une fois pour chaque composant qu’atteint le rattachement, dans le contexte de ce composant, de sorte qu’il lit .context.* et .attachment_name, et que .boundary n’y est pas défini. Ceci n’est PAS persisté sur disque ; cela n’existe que dans la mémoire du compilateur pendant le rendu. Ce schéma documente le contrat entre le compilateur et les auteurs de templates Ops.

Disponibilité par étape du rendu de base, dans l’ordre dans lequel les étapes s’exécutent :

  • Évaluation des provides (préambule des locals, puis provides) : piliers locaux au nœud uniquement. Une entrée de locals lit les entrées situées au-dessus d’elle dans son propre bloc ; un template de provides lit l’ensemble du .locals résolu du nœud. Autoréférence interdite (aucune entrée de provides n’en lit une autre).
  • Résolution de la source (publication des locals + évaluation de source) : tous les piliers ; .source et .workload absents. Ces locals sont publiés ici sur .locals, puis source: est évalué par rapport à eux.
  • Mapping des valeurs (valuesMapping) : tous les piliers + .source ; .workload absent.
  • Synthèse du Workload (évaluation de workload) : tous les piliers + .source ; .workload en cours d’évaluation (absent de l’autoréférence).
  • Évaluation des artefacts (artifacts) : tous les piliers + .source + .workload (contexte le plus complet).

Type de premier niveau : object

Propriétés

PropriétéTypeObligatoireDescription
contextobjectouiLe contexte d’exécution assemblé par le compilateur, qui fournit des données d’identité, de topologie et de livraison.
valuesobjectouiLa charge utile cognitive opaque de ce nœud, déjà validée par le validateur de schéma lors de la résolution. Transmise telle quelle.
infraobjectouiLa charge utile de dimensionnement physique injectée depuis la Release pour ce nœud. Contourne entièrement le développeur.
localsmap de stringouiL’état privé propre de la Recipe (par ex. primary_compute, volumes_path). Évalué dans le préambule des locals — avant les provides de ce nœud — et publié sur ce pilier lors de la résolution de la source. Chaque entrée est un template Go évalué par rapport à un contexte autonome local au nœud qui porte les entrées du même bloc résolues jusque-là, de sorte qu’une entrée PEUT lire une entrée sœur définie AU-DESSUS d’elle et reçoit la valeur résolue de cette entrée sœur. L’ordre de l’auteur fait partie du contrat partout où une entrée en lit une autre : déplacer une définition sous ce qui la lit casse le build. Une référence ‘.locals.’ à une entrée ultérieure, ou à une clé que le bloc ne déclare pas, provoque un arrêt. La vérification lit le chemin vers lequel une référence SE RÉSOUT plutôt que les frappes au clavier, de sorte qu’elle couvre de la même façon la forme directe, une lecture à l’intérieur d’un bloc ’{{ with .locals }}’, une lecture par une variable liée directement à ‘.locals’, et une clé lue sur le bloc entre parenthèses, ‘(.locals).’ ou ’($.locals).’. Une écriture qu’elle ne couvre pas : une référence dont le texte du template ne détermine pas le chemin — une référence atteinte par une fonction, comme ‘index .locals’ ou ‘(default dict .locals).’, ou par un bloc ‘with’ ou une liaison de variable dont le pipeline en applique une. Elle n’est pas analysée, et une clé absente atteinte de cette façon ne provoque pas d’arrêt : elle produit au rendu le texte littéral '' plutôt que rien du tout. La seule exception est ‘index’ lui-même : sur chaque surface de template, il provoque un arrêt, en nommant la clé, lorsque la map qu’il lit ne contient pas la clé demandée, de sorte qu’une clé absente atteinte par ‘index .locals’ provoque un arrêt. Une entrée de locals ne peut pas lire ‘.provides’. Disponible dans provides (lors de l’évaluation des provides, après le préambule), source, valuesMapping, workload, artifacts, assertions, et pour les plugins Wasm en aval via pipeline[].with (et pipeline[].when). Jamais exposé aux appelants.
providesmap de stringnonLe contrat d’API public de la Recipe. Renseigné à partir de l’évaluation des provides. Disponible dans le valuesMapping du rendu de base pour l’autoréférence (par ex. {{ .provides.host }}). PAS disponible à l’intérieur du template de provides lui-même (l’invariant d’autonomie des provides). Les appelants résolvent les clés d’inject par rapport à ces valeurs.
featuresmap de template_attachmentnonChaque rattachement sur ce nœud, indexé par le nom d’instance que l’auteur lui a donné. Un seul pilier les porte tous, quoi qu’ils produisent — une Feature opérationnelle, une Feature d’identifiants, une Feature d’identité — parce que ce qui diffère entre les rattachements est ce qu’ils produisent, et non la façon dont un template les lit. Une Recipe les lit pour adapter son rendu aux capacités rattachées et pour consommer ce que publie un rattachement. Un rattachement écrit sur l’une des connexions du nœud n’en fait pas partie : il est lu sous cette connexion, à .context.uses..features., de sorte qu’un template qui parcourt ce pilier ne rencontre que les rattachements propres du nœud.
metadataobjectnonMétadonnées de la Release et de la compilation qui fournissent une identité globale pour un nommage déterministe. Disponibles dans tous les blocs de template (valuesMapping, injectMapping, pipeline with).
attachment_namestringnonRenseigné uniquement lors du rendu d’une FeatureRecipe de rattachement. Contient le nom d’instance du rattachement — le slot qu’il remplit dans le featuresSchema de l’entité propriétaire, ou le nom libre que l’auteur lui a donné (par ex. ‘admin_password’, ‘db_credentials’). Utilisé pour construire des noms de ressources déterministes qui diffèrent par rattachement, composés après le nom du composant hôte : ’{{ .context.rendered_name }}-{{ .attachment_name | replace ”_” ”-” }}’ lorsque le fournisseur de l’hôte signale un nom rendu, comme le fait helm — le nom de l’hôte écrit dans les caractères qu’autorise un nom Kubernetes, les traits de soulignement du nom du rattachement étant convertis en traits d’union — et ’{{ .context.instance_id }}-{{ .attachment_name }}’ lorsque le fournisseur de l’hôte n’en signale aucun.
injectobjectnonRenseigné uniquement lors du rendu d’une FeatureRecipe de rattachement qui porte un bloc inject rédigé par l’auteur (par ex. { env: [ { in: ‘OPENAI_API_KEY’, from: ‘api_token’ } ] }). Distinct de .context.inject, qui est le pipe de livraison pré-hydraté du composant de base issu des arêtes uses. Vaut null/absent pour les rattachements sans inject rédigé par l’auteur et pour les Recipes de base.
inject_rawobject ou nullnonL’intention immuable et non modifiée du développeur pour le bloc inject. Chaque mécanisme que nomme le bloc — env, file, arg ou un mécanisme personnalisé tel que ssm_param — se trouve sous son propre nom et contient les entrées exactement telles qu’elles sont écrites (in, avec from ou value), dans l’ordre d’écriture, de sorte que .inject_raw.ssm_param lit un mécanisme personnalisé comme .inject_raw.env lit un mécanisme de base. Vaut null si le développeur a entièrement omis le bloc inject. Utilisé par Ops pour des vérifications logiques (par ex. {{ if not .inject_raw }}) afin de détecter l’omission avant les mutations du mapping d’inject. Les values ou provides propres au composant que livre chaque entrée se lisent dans .context.self_inject plutôt que dans le texte des entrées.
stepsmap de objectnonCommunication entre les étapes du pipeline. Disponible uniquement dans les blocs ‘with:’ d’un pipeline Wasm. Chaque clé est l’ID d’une étape du pipeline, contenant les sorties exportées par cette étape.
sourcestring ou object ou nullnonContenu résolu du champ source. Sur les templates d’une Recipe : renseigné lors de la résolution de la source à partir du champ source: de la Recipe après l’évaluation du template Go, disponible à partir du mapping des valeurs (valuesMapping, workload, artifacts), et null lorsque la Recipe n’a pas de source:. Sur les templates d’une FeatureRecipe : le propre champ source: de la FeatureRecipe après l’évaluation du template Go, évalué avant son valuesMapping et lu là ainsi que sur chaque template évalué après lui (omits, workload, artifacts, étapes du pipeline), jamais celui du composant hôte ; null lorsque la FeatureRecipe n’a pas de source:. L’injectMapping d’une FeatureRecipe est évalué avant sa source et lit celle du composant hôte. Forme chaîne = chemin URI ; forme objet = source structurée (par ex. descripteur OCI avec version résolue).
workloadworkload-v1beta1.schema.json ou nullnonSpec du Workload analysée pour ce nœud. Renseignée lors de la synthèse du workload à partir du champ workload: de la Recipe après l’évaluation du template Go + la validation JSON Schema du Workload (par rapport à workload-v1beta1.schema.json). Disponible à partir de l’évaluation des artefacts (artifacts), de sorte que les artefacts peuvent faire référence aux champs du workload sans duplication (par ex. un ServiceMonitor qui lit .workload.services.metrics.ports.prom). Vaut null lorsque la Recipe n’a pas de bloc workload:. Les tentatives d’un template de déréférencer .workload.* sur une valeur null échouent avec une erreur claire au moment de l’évaluation du template.
boundaryobjectnonContexte de portée frontière — renseigné uniquement lors de l’évaluation d’un template qu’une FeatureRecipe dont le spec.executionScope est ‘boundary’ exécute une fois pour la frontière. Les FeatureRecipes de portée Component ne reçoivent pas ce pilier ; leurs context.instance_id, context.inject, context.uses et le pilier .workload portent à la place des données par composant. Les templates d’une FeatureRecipe de portée frontière exécutés pour la frontière reçoivent .boundary.* à la place de ces piliers par composant ; son injectMapping s’exécute dans le contexte de chaque composant qu’atteint le rattachement, lit ces piliers par composant, et ne reçoit pas celui-ci.

Les propriétés supplémentaires ne sont pas autorisées.

template-context.context

Le contexte d’exécution assemblé par le compilateur, qui fournit des données d’identité, de topologie et de livraison.

PropriétéTypeObligatoireDescription
instance_idstringouiL’ID absolu aplati du nœud courant (par ex. ‘backend’, ou ‘data-layer-zdmain-db’ pour le composant main-db de l’instance de module data-layer), écrit dans l’alphabet que respecte tout nom de composant rédigé par un auteur. Déterministe et stable d’une compilation à l’autre pour le même Aggregate. C’est le nom des ressources construites pour ce nœud dont aucun fournisseur ne dérive le nom — un ensemble d’artefacts placé à partir de la Recipe, et un workload synthétisé par un fournisseur qui le nomme d’après l’identité —, de sorte qu’une adresse publiée pour l’une d’elles est construite à partir de cette valeur.
rendered_namestringnonLe nom que le fournisseur lié à ce nœud donne aux ressources qu’il rend pour le nœud — pour une source fournie par l’auteur, le nom par rapport auquel les templates fournis eux-mêmes sont rendus, comme le nom de release que lit un chart ; pour un workload qu’il synthétise, le nom qu’il donne aux ressources de ce workload lorsqu’il en dérive un au lieu d’écrire l’identité du nœud, comme le fait le fournisseur helm avec le même nom de release. Lisez-le partout où cette Recipe nomme une ressource qu’un chart ou un module fourni a déclarée ou qu’un tel fournisseur a synthétisée, que ce soit dans une entrée provides, un valuesMapping, un workload, une entrée artifacts ou le with ou le when d’une étape de pipeline, car le fournisseur peut écrire ce nom dans un alphabet plus pauvre que celui dans lequel est écrit un nom de composant rédigé par un auteur, et les deux diffèrent alors. Vide lorsque le fournisseur lié ne dérive aucun nom de ce type : les ressources d’un ensemble d’artefacts placé, et d’un workload synthétisé par un fournisseur qui le nomme d’après l’identité, portent l’identité du nœud, donc lisez ’{{ .context.instance_id }}’ pour celles-ci, et une Recipe qui a écrit ses propres noms de ressources les connaît déjà. Lire cette clé là où le fournisseur lié ne rapporte aucun nom arrête le build et indique quoi écrire à la place. Le refus couvre les templates qu’une Recipe écrit en ligne ; un valuesMapping, un workload ou une entrée artifacts fournis via ‘$import’ ne sont résolus que lorsque le rendu les atteint, de sorte qu’une référence à l’intérieur de l’un d’eux est rendue comme une valeur vide au lieu d’arrêter le build. Dans les templates d’une FeatureRecipe liée au rattachement d’un composant, c’est le nom du composant HÔTE tel que le rapporte le propre fournisseur de l’hôte — la valeur que lit la propre Recipe de l’hôte, tout comme instance_id y est l’identité de l’hôte —, de sorte qu’un rattachement s’en sert pour nommer une ressource d’après son hôte et obtient un nom que la plateforme de l’hôte accepte. Lorsque le fournisseur de l’hôte ne rapporte aucun nom, il est vide, et le lire depuis un template en ligne du rattachement autre que son injectMapping arrête le build ; lisez plutôt ’{{ .context.instance_id }}’ à cet endroit.
labelsmap de stringnonLes labels de duck-typing et d’ontologie du nœud courant, y compris toute modification qu’un plugin de gouvernance rattaché dans le rôle label-transform a apportée lors de la construction de la topologie.
annotationsobjectnonLes trois compartiments d’annotations en cascade du nœud courant, séparés par origine.
injectobjectouiLe pipe de livraison pré-hydraté et intercepté. Commence comme une map générée par le compilateur qui résout les clés inject du développeur vers les valeurs provides de la cible. Modifié sur place par les fusions profondes de injectMapping. Au moment où la Recipe de base effectue le rendu, il contient les chaînes physiques entièrement résolues.
usesmap de enriched_edgeouiLa map enrichie des arêtes topologiques. Indexée par l’alias du développeur (par ex. ‘my_db’, ‘my_api’). Chaque entrée est une vue assemblée par le compilateur de l’identité du nœud cible, des provides résolus, du mapping d’injection et des annotations en cascade, ainsi que des rattachements écrits sur cette connexion — et, pour une FeatureRecipe qui déclare readsTargetRenderFacts, de ce que les rendus de la cible ont rapporté. Ce n’est PAS l’arête IR brute — c’est une projection enrichie construite par le compilateur spécifiquement pour l’usage dans les templates. Un template qui parcourt cette map voit les connexions dans l’ordre des clés — triées par alias — et non dans l’ordre dans lequel elles ont été écrites.
self_injectobjectouiLesquels des values et provides propres au composant le développeur a déjà dotés d’un nom de livraison, lu dans le bloc inject: écrit sur le composant lui-même — le bloc que .inject_raw contient tel qu’écrit et que .context.inject contient résolu. Chaque mécanisme que nomme le bloc (env, file, arg ou un mécanisme personnalisé tel que ssm_param) associe chaque nom écrit par le développeur à la clé propre que livre cette entrée, de la même façon que .context.uses..inject associe les noms d’une connexion aux clés qu’ils lisent : ‘provides.’ pour une entrée écrite avec from: ; ‘values.’ pour une entrée dont le template value: lit exactement une des values propres au composant et rien d’autre, étant la clé de premier niveau de cette valeur, quels que soient le texte ou les fonctions qui entourent la lecture et quelle que soit la profondeur à laquelle elle lit dans la valeur — ’{{ .values.config.port }}’, ’{{ index .values.config “port” }}’ et ’{{ (default dict .values.config).port }}’ correspondent tous à ‘values.config’ ; et une chaîne vide pour toute autre entrée — un littéral, un template qui lit deux valeurs, un template qui lit autre chose que les values, ou un template dont le texte n’attribue pas la lecture des values à une seule clé de premier niveau, comme ’{{ index .values “role” }}’, les values lues en entier, ou le contexte entier passé à une fonction. Ainsi, une Recipe qui livre une valeur propre sous un nom par défaut vérifie si une entrée correspond déjà à ‘values.’ et, le cas échéant, ignore son nom par défaut, par ex. {{ range $name, $key := .context.self_inject.env }}{{ if eq $key “values.role” }}…{{ end }}{{ end }}. Présent et vide lorsque le développeur n’a écrit aucun bloc ; un mécanisme n’apparaît que lorsque le bloc le nomme, et un template rencontre les noms triés, quelle que soit la façon dont il les lit. Lu dans le texte écrit par le développeur, jamais dans une valeur résolue.
used_byinbound_edge[]nonLes composants qui utilisent celui-ci : une entrée par connexion uses qu’un autre composant établit vers lui, dans l’ordre dans lequel les composants qui se connectent sont écrits, puis dans l’ordre des propres entrées uses de chacun. Un composant qui se connecte deux fois apparaît deux fois. Lu uniquement par une FeatureRecipe rattachée au composant, et uniquement dans les templates qui produisent les propres ressources du rattachement — son valuesMapping, workload et artifacts. Absent des templates de la propre Recipe du composant, d’un injectMapping et du with et du when d’une étape de pipeline, car la sortie de chacun d’eux peut aboutir dans la propre sortie rendue du composant, qui reste la même quel que soit celui qui s’y connecte. Chaque entrée est un élément de liste plutôt qu’une clé, de sorte qu’un template qui la parcourt rencontre les appelants dans cet ordre.
render_factsrender_factsnonCe que le fournisseur qui a rendu ce composant a rapporté sur la sortie qu’il a émise — les faits de rendu qu’il rapporte —, indexé par nom de fait. Les noms qu’un fournisseur rapporte, et ce que contient chaque entrée, relèvent du contrat documenté propre à ce fournisseur. Chaque valeur est une liste, même avec une seule entrée, de sorte qu’un template la parcourt toujours ; lorsque le rendu du composant a nécessité plus d’un appel au fournisseur et qu’un nom a été rapporté par plusieurs d’entre eux, ses listes sont jointes en une seule dans l’ordre d’exécution des appels. Présent dans chaque template d’une FeatureRecipe rattachée au composant — son valuesMapping, workload, artifacts et le with et le when des étapes de pipeline — une fois le composant rendu, et vide lorsque son fournisseur ne rapporte rien, de sorte qu’un nom que personne n’a rapporté se lit comme une liste vide. Absent des templates de la propre Recipe du composant et d’un injectMapping, qui s’exécutent avant que le composant ait été rendu.

Les propriétés supplémentaires ne sont pas autorisées.

template-context.context.annotations

Les trois compartiments d’annotations en cascade du nœud courant, séparés par origine.

PropriétéTypeObligatoireDescription
releasemap de stringnonChaînes de topologie physique qui descendent en cascade des frontières de la Release.
catalogmap de stringnonTraits intrinsèques immuables rédigés par le Platform Architect dans le domaine 2.
aggregatemap de stringnonMétadonnées cognitives qui descendent en cascade des sous-systèmes de l’Aggregate.

Les propriétés supplémentaires ne sont pas autorisées.

template-context.context.inject

Le pipe de livraison pré-hydraté et intercepté. Commence comme une map générée par le compilateur qui résout les clés inject du développeur vers les valeurs provides de la cible. Modifié sur place par les fusions profondes de injectMapping. Au moment où la Recipe de base effectue le rendu, il contient les chaînes physiques entièrement résolues.

PropriétéTypeObligatoireDescription
envmap de stringnonLivraison par variables d’environnement. Les clés sont les noms de variables locales du développeur, les valeurs sont les chaînes résolues de la cible.
filemap de stringnonLivraison par montage de fichiers. Les clés sont des chemins de fichiers locaux, les valeurs sont les chaînes résolues de la cible.
argmap de stringnonLivraison par arguments de ligne de commande. Les clés sont des préfixes de flags, les valeurs sont les chaînes résolues de la cible.
allmap de stringnonFusion plate précalculée des mécanismes env + file + arg + personnalisés. Remplie après la résolution de uses-inject et recalculée après le mapping d’inject. Les templates utilisent {{ toJson .context.inject.all }} pour une sérialisation universelle.
template-context.context.self_inject

Lesquels des values et provides propres au composant le développeur a déjà dotés d’un nom de livraison, lu dans le bloc inject: écrit sur le composant lui-même — le bloc que .inject_raw contient tel qu’écrit et que .context.inject contient résolu. Chaque mécanisme que nomme le bloc (env, file, arg ou un mécanisme personnalisé tel que ssm_param) associe chaque nom écrit par le développeur à la clé propre que livre cette entrée, de la même façon que .context.uses..inject associe les noms d’une connexion aux clés qu’ils lisent : ‘provides.’ pour une entrée écrite avec from: ; ‘values.’ pour une entrée dont le template value: lit exactement une des values propres au composant et rien d’autre, étant la clé de premier niveau de cette valeur, quels que soient le texte ou les fonctions qui entourent la lecture et quelle que soit la profondeur à laquelle elle lit dans la valeur — ’{{ .values.config.port }}’, ’{{ index .values.config “port” }}’ et ’{{ (default dict .values.config).port }}’ correspondent tous à ‘values.config’ ; et une chaîne vide pour toute autre entrée — un littéral, un template qui lit deux valeurs, un template qui lit autre chose que les values, ou un template dont le texte n’attribue pas la lecture des values à une seule clé de premier niveau, comme ’{{ index .values “role” }}’, les values lues en entier, ou le contexte entier passé à une fonction. Ainsi, une Recipe qui livre une valeur propre sous un nom par défaut vérifie si une entrée correspond déjà à ‘values.’ et, le cas échéant, ignore son nom par défaut, par ex. {{ range $name, $key := .context.self_inject.env }}{{ if eq $key “values.role” }}…{{ end }}{{ end }}. Présent et vide lorsque le développeur n’a écrit aucun bloc ; un mécanisme n’apparaît que lorsque le bloc le nomme, et un template rencontre les noms triés, quelle que soit la façon dont il les lit. Lu dans le texte écrit par le développeur, jamais dans une valeur résolue.

PropriétéTypeObligatoireDescription
envmap de stringnonLivraison par variables d’environnement : les clés sont les noms de variable du développeur, les valeurs sont la clé propre que livre chaque entrée.
filemap de stringnonLivraison par montage de fichiers : les clés sont les chemins de fichier du développeur, les valeurs sont la clé propre que livre chaque entrée.
argmap de stringnonLivraison par arguments de ligne de commande : les clés sont les préfixes de flag du développeur, les valeurs sont la clé propre que livre chaque entrée.

template-context.metadata

Métadonnées de la Release et de la compilation qui fournissent une identité globale pour un nommage déterministe. Disponibles dans tous les blocs de template (valuesMapping, injectMapping, pipeline with).

PropriétéTypeObligatoireDescription
release_namestringnonLe nom de la Release en cours de build (par ex. ‘prod-billing’). Utilisé par Ops pour construire des noms de ressources cloud globalement uniques (buckets S3, rôles IAM). Combiné avec .context.instance_id pour garantir l’unicité d’un environnement à l’autre.
release_versionstringnonLa version sémantique de la Release.
environmentstringnonLa chaîne d’environnement issue des métadonnées de la Release (par ex. ‘production’, ‘local’).
aggregate_namestringnonLe nom de l’Aggregate racine en cours de compilation.

Les propriétés supplémentaires ne sont pas autorisées.

template-context.inject

Renseigné uniquement lors du rendu d’une FeatureRecipe de rattachement qui porte un bloc inject rédigé par l’auteur (par ex. { env: [ { in: ‘OPENAI_API_KEY’, from: ‘api_token’ } ] }). Distinct de .context.inject, qui est le pipe de livraison pré-hydraté du composant de base issu des arêtes uses. Vaut null/absent pour les rattachements sans inject rédigé par l’auteur et pour les Recipes de base.

PropriétéTypeObligatoireDescription
envmap de stringnonLivraison par variables d’environnement à portée du rattachement.
filemap de stringnonLivraison par montage de fichiers à portée du rattachement.
argmap de stringnonLivraison par arguments à portée du rattachement.
allmap de stringnonFusion de commodité, générée par le compilateur, de tous les paradigmes d’inject du rattachement.

template-context.boundary

Contexte de portée frontière — renseigné uniquement lors de l’évaluation d’un template qu’une FeatureRecipe dont le spec.executionScope est ‘boundary’ exécute une fois pour la frontière. Les FeatureRecipes de portée Component ne reçoivent pas ce pilier ; leurs context.instance_id, context.inject, context.uses et le pilier .workload portent à la place des données par composant. Les templates d’une FeatureRecipe de portée frontière exécutés pour la frontière reçoivent .boundary.* à la place de ces piliers par composant ; son injectMapping s’exécute dans le contexte de chaque composant qu’atteint le rattachement, lit ces piliers par composant, et ne reçoit pas celui-ci.

PropriétéTypeObligatoireDescription
pathstringnonLe chemin de la frontière de la Release à laquelle la FeatureRecipe est rattachée : les noms des frontières de la plus externe vers l’intérieur, joints par ’/’ (par ex. ‘bridge’, ‘bridge/frontend’). Il nomme la frontière, et non le répertoire dans lequel sa sortie est écrite, que fixe le directory: de la frontière.
assembly_pathstringnonLe répertoire, relatif au répertoire de sortie du build, dans lequel est assemblée la propre sortie de ce rattachement : le directory: et le subDirectory: évalués de sa frontière, le répertoire vers lequel le build achemine cette sortie (par ex. ‘bridge/compose’). Il est égal au source_assembly_path ou au target_assembly_path d’une extrémité de connexion exactement lorsque cette extrémité est rendue dans le même fichier assemblé, de sorte qu’une FeatureRecipe les compare pour distinguer une connexion à l’intérieur de son propre fichier d’une connexion dans un autre fichier. Données opaques ; le cœur ne les interprète pas.
boundary_namestringnonLe nom de la frontière (la clé de map dans release.spec.boundaries).
componentsobjectnonMap de instance_id vers une entrée pour chaque composant du sous-arbre de la frontière (récursive, inclut les composants des frontières imbriquées). Chaque entrée porte l’URI de type résolu du composant, l’ID d’instance et les valeurs fournies issues de l’évaluation de provides par composant.
internal_uses_edgesobject[]nonArêtes uses dont la source ET la cible sont toutes deux dans le sous-arbre de cette frontière.
outgoing_cross_boundary_uses_edgesobject[]nonArêtes uses dont la source est dans le sous-arbre de cette frontière et dont la cible est en dehors.
incoming_cross_boundary_uses_edgesobject[]nonArêtes uses dont la cible est dans le sous-arbre et la source en dehors. Utilisées par les agrégateurs de type ingress qui ont besoin de savoir qui appelle de l’extérieur.
cross_boundary_uses_edgesobject[]nonUnion de commodité des arêtes sortantes et entrantes qui traversent la frontière.
labelsmap de stringnonUnion des labels des composants du sous-arbre, avec conservation de l’ordre de l’auteur.
annotationsmap de stringnonLes propres annotations de la frontière après la résolution de la cascade.
feature_attachmentstemplate_attachment[]nonLes rattachements faits directement sur cette frontière (pour les références entre rattachements dans la portée de la frontière), dans la même forme de rattachement que porte .features.

Les propriétés supplémentaires ne sont pas autorisées.

Définitions

inbound_edge

Une connexion qu’un autre composant établit vers le composant pour lequel une FeatureRecipe rattachée effectue le rendu : qui se connecte, par quel socket, ce que publie le composant qui se connecte, et le namespace et la frontière dans lesquels il est placé. Chaque valeur est une chaîne que le compilateur porte sans l’interpréter.

PropriétéTypeObligatoireDescription
component_idstringouiL’ID d’instance aplati du composant qui se connecte (par ex. ‘frontend’ ou ‘data-layer.etl’) — la valeur qu’un template de chemin subDirectory lit comme .component_id, écrite comme .context.uses..target écrit l’autre extrémité d’une connexion.
socketstringouiLa catégorie de usesSchema par laquelle le composant qui se connecte trace cette connexion (par ex. ‘databases’, ‘apis’).
providesmap de stringouiLes provides résolus du composant qui se connecte, restreints aux clés que déclare son Component — les mêmes valeurs qu’un consommateur de ce composant lit en .context.uses..provides. Vide lorsqu’il n’en publie aucun.
source_namespacestringnonLe namespace dans lequel le composant qui se connecte est placé : l’annotation aggrega.ai/namespace que reçoit son propre rendu — les annotations de ses frontières, les annotations de sa propre entrée de Release étant appliquées en dernier, de sorte qu’un composant dont l’entrée définit ou efface le namespace porte son propre réglage plutôt que celui de sa frontière. C’est la valeur qu’une FeatureRecipe de portée frontière lit comme source_namespace dans l’entrée de la même connexion dans les listes d’arêtes uses de .boundary. Absent lorsqu’aucun namespace ne s’applique au composant qui se connecte ; protégez-le avec if ou with avant de l’afficher.
source_boundary_pathstringnonLe chemin séparé par des barres obliques de la frontière de la Release qui contient le composant qui se connecte (par ex. ‘edge’ ou ‘aws-prod/payments’) — la valeur qu’une FeatureRecipe de portée frontière lit comme source_boundary_path dans l’entrée de la même connexion dans les listes d’arêtes uses de .boundary.
render_factsrender_factsnonCe que les rendus du composant qui se connecte ont rapporté sur la sortie qu’ils ont émise, indexé par nom de fait : les faits rapportés par ses propres appels au fournisseur, puis ceux de chaque Feature qui lui est rattachée et qui a été rendue avec lui, dans l’ordre où elles ont été rendues, les listes qu’un nom reçoit de plusieurs d’entre elles étant jointes en une seule dans cet ordre. Chaque valeur est une liste, même avec une seule entrée, de sorte qu’un template la parcourt toujours. Présent uniquement pour une FeatureRecipe qui déclare readsCallerRenderFacts — dont les rattachements sont rendus une fois que chaque composant a été rendu, de sorte que le rendu de chaque appelant est complet —, et alors dans chaque entrée, vide pour un appelant dont les fournisseurs ne rapportent rien. Absent pour toute autre FeatureRecipe.

Les propriétés supplémentaires ne sont pas autorisées.

render_facts

Faits de rendu indexés par nom : ce que les fournisseurs qui ont rendu un composant ont rapporté sur la sortie qu’ils ont émise. Les noms qu’un fournisseur rapporte, et ce que contient chaque entrée, relèvent du contrat documenté propre à ce fournisseur ; le compilateur n’apprend rien de l’un ni de l’autre au-delà du fait que chaque valeur est une liste. Une liste conserve l’ordre de ses entrées. Une entrée objet est portée avec ses clés dans l’ordre où le fournisseur les a écrites, et un template qui la parcourt les rencontre dans l’ordre des clés, comme pour toute map à clés de ce contexte.

Objet libre ; les valeurs sont any[].

template_attachment

Un rattachement tel qu’un template le lit : la vue par instance d’une Feature rattachée. Chaque rattachement expose les mêmes champs quel que soit ce qu’il produit, de sorte que .features. se lit de la même manière, que ce nom soit un slot déclaré par l’entité ou un rattachement libre.

PropriétéTypeObligatoireDescription
typestringnonL’URI de Feature du catalogue de la Feature rattachée.
resolved_versionstringnonLa version de la Feature rattachée après la résolution du Manifest — la version effectivement liée pour ce build, lue comme .features..resolved_version. Reflète .context.uses..resolved_version, de sorte qu’un rattachement et une arête rapportent une version liée de la même manière. Vide lorsque le type du rattachement ne se résout en aucune entité du catalogue.
labelsmap de stringnonLes labels de catalogue de la Feature rattachée, portés tels quels dans l’ordre où la Feature les déclare — rien n’est filtré, renommé ni dépouillé de son préfixe, de sorte qu’un template lit exactement ce que l’auteur de la Feature a écrit. Permet à un template de bifurquer selon ce qu’est la Feature rattachée plutôt que selon son nom ou son URI. Reflète .context.uses..labels. La clé est totalement absente lorsque la Feature ne déclare aucun label et lorsque le type du rattachement ne se résout en aucune entité du catalogue, donc protégez-la avec if ou parcourez la map avant d’accéder à un label individuel.
valuesobjectnonLe propre pilier d’intention du développeur du rattachement, porté tel quel depuis la déclaration du rattachement.
infraobjectnonLe propre pilier de dimensionnement opérationnel du rattachement, porté tel quel depuis la déclaration du rattachement.
providesmap de stringnonLe contrat public résolu de la FeatureRecipe liée à ce rattachement — le nom de la ressource émise, sa clé, une identité et toute clé produite supplémentaire —, exposé au consommateur comme .features..provides.. Le consommateur lit ces valeurs au lieu de redériver l’identité physique du rattachement. Un rattachement dont la FeatureRecipe liée ne publie rien ne porte aucune clé provides, plutôt qu’une map vide, de sorte qu’un template se protège avant d’accéder à une clé individuelle.

Les propriétés supplémentaires ne sont pas autorisées.

enriched_edge

Une seule arête topologique enrichie assemblée par le compilateur. Contient l’identité résolue de la cible, les provides et les annotations en cascade.

PropriétéTypeObligatoireDescription
targetstringouiL’ID absolu aplati du nœud cible (par ex. ‘data-layer.main-db’).
socketstringouiLa catégorie de usesSchema à laquelle appartient cette arête (par ex. ‘databases’, ‘apis’).
sourcestringnonL’ID absolu aplati du nœud source (consommateur). Rempli pour les vues de portée frontière qui indexent les sorties par consommateur selon le nœud consommateur.
source_namespacestringnonAnnotation aggrega.ai/namespace brute de l’extrémité source (vide lorsqu’elle est absente). Remplie uniquement pour les vues de portée frontière, comme l’est source ; la propre entrée .context.uses d’un composant la porte vide. Données opaques pour la résolution de l’identité réseau par un fournisseur ; le cœur ne les interprète pas.
source_boundary_pathstringnonChemin de frontière de l’extrémité source : le chemin séparé par des barres obliques de la frontière de la Release qui la contient (par ex. ‘bridge/frontend’). Rempli uniquement pour les vues de portée frontière, comme l’est source ; la propre entrée .context.uses d’un composant le porte vide.
source_assembly_pathstringnonChemin d’assemblage de l’extrémité source : le répertoire, relatif au répertoire de sortie du build, dans lequel sa sortie est assemblée, composé à partir du directory: et du subDirectory: évalués de sa frontière (par ex. ‘bridge/compose’). Deux extrémités ayant le même chemin d’assemblage sont rendues dans un seul fichier assemblé, et une extrémité dont le chemin d’assemblage est égal à .boundary.assembly_path est rendue dans le fichier dans lequel est assemblée la propre sortie de la FeatureRecipe qui le lit. Une FeatureRecipe de portée frontière qui place des extrémités sur des réseaux peut le lire comme le réseau de l’extrémité source lorsqu’aucun aggrega.ai/namespace ne s’applique. Rempli uniquement pour les vues de portée frontière, comme l’est source ; la propre entrée .context.uses d’un composant le porte vide. Données opaques ; le cœur ne les interprète pas.
target_namespacestringnonAnnotation aggrega.ai/namespace brute de l’extrémité cible (vide lorsqu’elle est absente). Remplie uniquement pour les vues de portée frontière, comme l’est source ; la propre entrée .context.uses d’un composant la porte vide. Données opaques pour la résolution de l’identité réseau par un fournisseur.
target_boundary_pathstringnonChemin de frontière de l’extrémité cible : le chemin séparé par des barres obliques de la frontière de la Release qui la contient (par ex. ‘bridge/backend’). Rempli uniquement pour les vues de portée frontière, comme l’est source ; la propre entrée .context.uses d’un composant le porte vide.
target_assembly_pathstringnonChemin d’assemblage de l’extrémité cible : le répertoire, relatif au répertoire de sortie du build, dans lequel sa sortie est assemblée, composé à partir du directory: et du subDirectory: évalués de sa frontière (par ex. ‘bridge/compose’). Une extrémité dont le chemin d’assemblage est égal à .boundary.assembly_path est rendue dans le fichier dans lequel est assemblée la propre sortie de la FeatureRecipe qui le lit. Une FeatureRecipe de portée frontière qui place des extrémités sur des réseaux peut le lire comme le réseau de l’extrémité cible lorsqu’aucun aggrega.ai/namespace ne s’applique. Rempli uniquement pour les vues de portée frontière, comme l’est source ; la propre entrée .context.uses d’un composant le porte vide. Données opaques ; le cœur ne les interprète pas.
providesmap de stringouiLe dictionnaire provides entièrement résolu du nœud cible. Évalué lors de l’évaluation des provides, avant l’hydratation d’inject.
injectobjectouiLe mapping inject d’origine du développeur pour cette arête (clés = noms de variables locales, valeurs = clés provides de la cible). Il s’agit du mapping BRUT, et non des valeurs résolues.
labelsmap de stringnonLes labels de duck-typing et d’ontologie du nœud cible (après les modifications apportées lors de la construction de la topologie).
annotationsobjectnonLes trois compartiments d’annotations en cascade du nœud cible.
componentstringnonL’URI du type de composant du catalogue du nœud cible (par ex. ‘core/postgres’).
resolved_versionstringnonLe SemVer résolu du nœud cible.
boundary_pathstringnonLa hiérarchie spatiale physique du nœud cible issue de la Release (par ex. ‘aws-eks-cluster/backend-ns’).
origin_featurestringnonSi cette arête a été déclarée de manière autonome par une Feature (y compris les Features d’identifiants portant le label feature.aggrega.ai/kind: secret), le nom d’instance de la Feature. Null/absent pour les arêtes déclarées par le développeur.
origin_releasebooléennonVaut true lorsque c’est la Release qui a câblé cette connexion plutôt que l’Aggregate qui l’a déclarée. Absent pour une connexion que l’Aggregate déclare.
valuesobjectnonLa configuration de développeur par connexion rédigée sur l’entrée uses de l’Aggregate pour cette connexion, portée telle quelle. Absente lorsque la connexion n’en porte aucune. Elle n’atteint que le contexte du nœud consommateur, jamais celui de la cible.
infraobjectnonLa configuration opérationnelle par connexion rédigée sur l’entrée uses de la Release pour cette connexion, portée telle quelle. Absente lorsque la connexion n’en porte aucune. Elle n’atteint que le contexte du nœud consommateur, jamais celui de la cible.
featuresmap de template_attachmentnonLes rattachements écrits sur cette connexion, indexés par le nom de slot que le socket de la connexion déclare pour chacun, chacun dans la forme de rattachement que porte .features : son type, sa version résolue, ses labels, values, infra, et les provides résolus de la FeatureRecipe qui lui est liée. Une Recipe lit l’identifiant d’une connexion comme .context.uses..features..provides., de sorte qu’un consommateur qui atteint plusieurs cibles lit l’identifiant propre à chaque cible. Ces rattachements ne font jamais partie des propres .features du nœud consommateur, de sorte qu’un template qui parcourt .features pour trouver les rattachements du nœud par type ne rencontre pas ceux d’une connexion. Parcourus dans un template, les slots arrivent dans l’ordre des clés. Absent lorsque la connexion n’en porte aucun.
render_factsrender_factsnonCe que les rendus de la cible ont rapporté sur la sortie qu’ils ont émise, indexé par nom de fait, dans la forme que porte l’entrée d’un appelant sur .context.used_by : les faits rapportés par ses propres appels au fournisseur, puis ceux de chaque Feature qui lui est rattachée et qui a été rendue avec elle, dans l’ordre où elles ont été rendues, les listes qu’un nom reçoit de plusieurs d’entre elles étant jointes en une seule dans cet ordre. Chaque valeur est une liste, même avec une seule entrée, de sorte qu’un template la parcourt toujours. Présent uniquement sur .context.uses pour une FeatureRecipe qui déclare readsTargetRenderFacts — dont les rattachements sont rendus une fois que chaque composant a été rendu, de sorte que le rendu de chaque cible est complet —, et alors dans chaque entrée, vide pour une cible dont les fournisseurs ne rapportent rien. Absent pour toute autre FeatureRecipe, du with et du when d’une étape de pipeline, des templates de la propre Recipe du composant, et des listes d’arêtes que lit une FeatureRecipe de portée frontière.

Les propriétés supplémentaires ne sont pas autorisées.

enriched_edge.inject

Le mapping inject d’origine du développeur pour cette arête (clés = noms de variables locales, valeurs = clés provides de la cible). Il s’agit du mapping BRUT, et non des valeurs résolues.

PropriétéTypeObligatoireDescription
envmap de stringnonLivraison par variables d’environnement : les clés sont les noms des variables locales du consommateur, les valeurs sont les clés provides de la cible.
filemap de stringnonLivraison par montage de fichiers : les clés sont les chemins de fichiers locaux du consommateur, les valeurs sont les clés provides de la cible.
argmap de stringnonLivraison par arguments de ligne de commande : les clés sont les préfixes de flags du consommateur, les valeurs sont les clés provides de la cible.

enriched_edge.annotations

Les trois compartiments d’annotations en cascade du nœud cible.

PropriétéTypeObligatoireDescription
releasemap de stringnonChaînes de topologie physique issues des frontières de la Release du nœud cible.
catalogmap de stringnonTraits immuables issus de l’entité du catalogue du nœud cible.
aggregatemap de stringnonMétadonnées cognitives issues des sous-systèmes de l’Aggregate du nœud cible.

Les propriétés supplémentaires ne sont pas autorisées.