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

Schéma du socket Wasm d’importateur 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/wasm-import-v1beta1.schema.json

Les formes de transmission qu’un socket de plugin d’importateur consomme (ImportInput) et émet (ImportOutput). Un importateur transforme une description d’infrastructure étrangère en entités Aggrega : il lit les octets de la source pour un format nommé, associe chaque nœud source à une entité du catalogue, et renvoie les entités qu’il a émises, les décisions d’association qu’il a prises, les diagnostics qu’il a levés et les fichiers de scaffold qu’il a produits. Un importateur déclare les formats qu’il prend en charge en tant que capacités import: dans son descripteur. L’importateur associe le sens de la source aux entités ; le compilateur transmet les entités émises de manière opaque.

L’une des formes suivantes

  • ImportInput
  • ImportOutput

Définitions

ImportInput

Le payload qu’un invité importateur reçoit : le format source qui détermine comment lire les octets, les octets de la source principale et le nom du fichier dont ils ont été lus, les éventuelles sources nommées pour un import de plusieurs fichiers, un document d’options opaque facultatif que le consommateur fournit pour un comportement propre à l’importateur, une vue des Components que contient le catalogue de l’espace de travail, et la cible pour laquelle l’import rédige des brouillons.

PropriétéTypeObligatoireDescription
formatstringouiLe nom du format source à importer, correspondant à l’une des capacités import: annoncées par l’importateur. L’importateur lit les sources dans ce format.
bytesstringouiLes octets de la source principale à importer, que l’importateur lit dans le format nommé : le fichier entier lorsque la source de l’import est un fichier, et vide lorsqu’il s’agit d’un répertoire, dont les fichiers arrivent plutôt comme sources nommées. Chaque kit les porte dans son propre type de champ — bruts lorsque ce type est un type d’octets, encodés en base64 lorsqu’il s’agit d’une chaîne que l’importateur décode pour les récupérer — et l’encodeur généré convertit entre le champ et la forme sous laquelle le format de transmission porte les octets.
namestringnonLe nom de la source de l’import, sans répertoire devant lui, afin qu’un importateur puisse nommer la source dans ce qu’il signale et dans ce qu’il produit en brouillon. Lorsque la source est un seul fichier, c’est le nom de base du fichier : les octets principaux n’arrivent pas comme une source nommée, c’est donc le seul nom qu’ils portent. Lorsque la source est un répertoire, c’est le nom de base du répertoire, et les fichiers du répertoire arrivent toujours comme sources nommées, chacun sous son propre nom, avec les octets principaux vides. Absent lorsque la source n’a aucun nom à donner.
sourcesImportSource[]nonDes sources nommées, chacune portant ses propres octets, dans une liste unique triée par nom. Lorsque la source de l’import est un répertoire, il y en a une par fichier de celui-ci que sélectionnent les motifs de fichiers déclarés par l’importateur, nommée par son chemin séparé par des barres obliques à l’intérieur du répertoire. Les fichiers que le rattachement qui configure l’importateur déclare sous with.sources sont également portés ici, chacun sous son nom de base, et l’hôte refuse un import dans lequel un fichier lu depuis le répertoire et l’un de ceux-ci portent le même nom. Absent lorsqu’aucun des deux n’en fournit.
settingsanynonUn document d’options d’import opaque que le consommateur fournit pour un comportement propre à l’importateur. L’hôte le transmet sans l’interpréter ; l’importateur lit la forme qu’il documente, quelle qu’elle soit. Absent lorsque le consommateur ne fournit aucune option.
catalogCatalogProjectionnonUne vue des Components que contient le catalogue propre de l’espace de travail — le catalogue à partir duquel l’importateur lui-même a été sélectionné — afin que l’importateur puisse les évaluer comme candidats lorsqu’il associe un nœud source à une entité du catalogue. L’hôte la construit à partir de ce seul catalogue local, et elle ne porte que des noms, des versions, des labels et une structure déclarée : jamais une valeur, une valeur par défaut ou un secret. Son ordre est fixe, de sorte qu’un catalogue produit une seule séquence d’octets. Absente lorsque le catalogue ne contient aucun Component.
targetstringnonLa capacité de fournisseur pour laquelle l’import rédige des brouillons, par exemple compose ou helm : la cible donnée à l’import ou, pour un import qui en actualise un précédent et n’en nomme aucune, la cible que cet import précédent a enregistrée. Un importateur écrit dans les brouillons, sous forme de déclarations, ce dont seule cette cible a besoin, et omet ce dont seule une autre cible a besoin. L’hôte la transmet telle quelle, après avoir vérifié qu’une Recipe du catalogue de l’espace de travail s’y lie. Absent lorsque l’import ne nomme aucune cible.

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

CatalogProjection

Le catalogue de l’espace de travail tel qu’un importateur le voit : une entrée par Component que contient le catalogue, chacune portant les métadonnées qu’un importateur évalue lorsqu’il note un candidat.

PropriétéTypeObligatoireDescription
componentsCatalogComponent[]ouiUne entrée par nom de Component que contient le catalogue, triée par nom. Lorsque le catalogue contient plusieurs versions d’un même Component, son entrée décrit la version vers laquelle se résout une référence qui nomme le Component sans version.

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

CatalogComponent

Un Component du catalogue de l’espace de travail : son nom et sa version, ses labels, les noms de clés que déclarent ses values et ses provides, et les sockets qu’il déclare pour ses dépendances. Un Component qui en étend un autre porte ce dont il hérite ainsi que ce qu’il déclare lui-même.

PropriétéTypeObligatoireDescription
namestringouiLe nom du Component, tel que le déclare son metadata.name — le nom par lequel un Aggregate y fait référence.
versionstringouiLa version du Component, telle que la déclare son metadata.version.
labelsmap de stringnonLes labels du Component, sous forme de map de chaîne à chaîne. Absent lorsqu’il n’en porte aucun.
valuesstring[]nonLes noms des clés de premier niveau que déclarent les values du Component, triés. Une liste de noms uniquement : elle ne porte jamais une valeur ni une valeur par défaut. Absent lorsque ses values ne déclarent aucune clé.
providesstring[]nonLes noms des clés de premier niveau que déclarent les provides du Component, triés. Une liste de noms uniquement : elle ne porte jamais une valeur. Absent lorsque ses provides ne déclarent aucune clé.
socketsCatalogSocket[]nonLes sockets que le Component déclare pour ses dépendances, dans l’ordre de déclaration : pour un Component qui en étend un autre, les sockets dont il hérite viennent en premier, dans l’ordre dans lequel le Component étendu les déclare, suivis de ceux qu’il ajoute. Absent lorsqu’il n’en déclare aucun.

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

CatalogSocket

Un socket qu’un Component du catalogue déclare pour ses dépendances : le nom du socket et le sélecteur de labels qu’une dépendance câblée à travers lui doit satisfaire.

PropriétéTypeObligatoireDescription
namestringouiLe nom du socket, tel que le déclare le usesSchema du Component.
selectorstringouiLe sélecteur de labels du socket, mot pour mot, dans la grammaire de style Kubernetes dans laquelle le Component l’écrit : les labels qu’une dépendance câblée à travers ce socket doit porter.

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

ImportSource

Une source nommée au sein d’un import de plusieurs fichiers ou d’un répertoire : un nom qui situe la source et ses propres octets.

PropriétéTypeObligatoireDescription
namestringouiLe nom de cette source au sein de l’import, par exemple un chemin de fichier relatif.
bytesstringouiLes octets de cette source. Chaque kit les porte dans son propre type de champ — bruts lorsque ce type est un type d’octets, encodés en base64 lorsqu’il s’agit d’une chaîne que l’importateur décode pour les récupérer — et l’encodeur généré convertit entre le champ et la forme sous laquelle le format de transmission porte les octets.

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

ImportOutput

Le payload qu’un invité importateur renvoie : les entités que l’import a produites, les décisions d’association qui les sous-tendent, les diagnostics que l’import a levés et les fichiers de scaffold qu’il a produits. Chaque champ est facultatif, de sorte qu’un import qui n’a rien résolu peut ne renvoyer que des diagnostics.

PropriétéTypeObligatoireDescription
entitiesEmittedEntity[]nonLes entités que l’import a produites, chacune étant soit une référence à une entité existante du catalogue, soit un corps d’entité rédigé. Absent lorsque l’import n’a émis aucune entité.
decisionsImportDecision[]nonLes décisions d’association que l’import a prises, une par nœud source qu’il a résolu, qui enregistrent les candidats qu’il a évalués et le choix qu’il a fait. Absent lorsque l’import n’a enregistré aucune décision.
diagnosticsDiagnostic[]nonLes diagnostics que l’import a levés — par exemple un nœud source non résolu ou une association ambiguë. Absent lorsque l’import n’en a produit aucun.
filesScaffoldFile[]nonLes fichiers de scaffold que l’import a produits à côté des entités, par exemple un agrégat de départ ou un readme. Absent lorsque l’import n’a produit aucun fichier.
errorstringnonUn message d’échec défini lorsque l’invité s’est exécuté mais n’a pas pu terminer l’opération ; absent en cas de succès. Il est distinct des éventuels diagnostics que porte la sortie : les diagnostics signalent des problèmes trouvés pendant une exécution qui a malgré tout produit un résultat, tandis que error signale que l’opération elle-même ne s’est pas terminée. L’hôte présente une erreur présente comme une invocation de plugin échouée.

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

EmittedEntity

Une entité que l’import a produite : son type, son nom et la manière dont elle est émise — une référence à une entité existante du catalogue ou un corps d’entité nouvellement rédigé.

PropriétéTypeObligatoireDescription
kindstringouiLe type d’entité émise. Les importateurs du cœur émettent Component, Aggregate et Release ; un lecteur tolère tout autre type.
namestringouiLe nom de l’entité émise.
modestring (enum)ouiLa manière dont l’entité est émise : reference pointe vers une entité existante du catalogue par son nom, et draft porte un corps d’entité nouvellement rédigé. Valeurs autorisées : "reference", "draft"
bodystringnonLe corps YAML brut d’une entité rédigée. Vide pour une pure référence, qui nomme une entité existante au lieu d’en rédiger une.
labelsmap de stringnonLes labels à attacher à l’entité émise, sous forme de map de chaîne à chaîne. Les importateurs du cœur le laissent vide.
annotationsmap de stringnonLes annotations à attacher à l’entité émise, sous forme de map de chaîne à chaîne. Les importateurs du cœur le laissent vide.
sourceRefstringnonUne référence au nœud source à partir duquel cette entité a été émise, afin qu’un lecteur puisse remonter de l’entité jusqu’à son origine dans la source importée.
decisionRefstringnonUne référence à la décision d’association qui a produit cette entité, la reliant aux candidats évalués et au choix effectué.

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

ImportDecision

Une décision d’association : le nœud source que l’importateur a résolu, les entités candidates du catalogue qu’il a évaluées, le candidat qu’il a choisi et le raisonnement derrière ce choix.

PropriétéTypeObligatoireDescription
sourceNodeDecisionSourceNodeouiLe nœud source que cette décision a résolu : le nœud que l’importateur a lu depuis la source et associé à une entité du catalogue.
candidatesImportCandidate[]nonLes entités candidates du catalogue que l’importateur a évaluées pour ce nœud source, chacune avec son score et la ventilation par signal derrière ce score. Absent lorsque l’importateur n’a évalué aucun candidat.
chosenDecisionChoicenonLe candidat que l’importateur a choisi pour ce nœud source, et la manière dont il l’a émis. Absent lorsque l’importateur n’a fait aucun choix.
rationalestringnonUne explication lisible par un humain de la raison pour laquelle l’importateur a fait ce choix.
swapHintstringnonUne indication décrivant comment remplacer l’association choisie par une alternative, afin qu’un lecteur puisse réviser la décision.

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

DecisionSourceNode

Le nœud source qu’une décision d’association a résolu : un identifiant, le type sous lequel la source le nomme et un résumé lisible par un humain de ses paramètres.

PropriétéTypeObligatoireDescription
idstringouiL’identifiant du nœud source au sein de la source importée.
typestringouiLe type du nœud source tel que la source le nomme.
paramsSummarystringouiUn résumé lisible par un humain des paramètres du nœud source, à afficher à côté de la décision.

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

ImportCandidate

Une entité candidate du catalogue que l’importateur a évaluée pour un nœud source : le composant candidat, son score global, le niveau de correspondance dans lequel tombe le score et la ventilation par signal derrière le score.

PropriétéTypeObligatoireDescription
componentNamestringouiLe nom du composant candidat du catalogue.
scorenumberouiLe score de correspondance global du candidat, agrégé à partir de la ventilation par signal.
tierstringouiLe niveau de correspondance dans lequel tombe le candidat, une tranche grossière du score.
signalsCandidateSignalsouiLa ventilation par signal derrière le score du candidat.

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

CandidateSignals

La ventilation par signal derrière le score d’un candidat : une contribution par signal correspondant. Un objet à champs fixes, de sorte que l’ensemble des signaux est stable et que le format de transmission est déterministe.

PropriétéTypeObligatoireDescription
tablenumberouiLa contribution au score du signal de la table d’association.
categorynumberouiLa contribution au score du signal de catégorie.
domainLabelsnumberouiLa contribution au score du signal des labels de domaine.
shapenumberouiLa contribution au score du signal de forme.
namenumberouiLa contribution au score du signal de nom.

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

DecisionChoice

Le candidat qu’une décision d’association a choisi : l’entité cible du catalogue, la manière dont elle est émise et le niveau de correspondance du choix.

PropriétéTypeObligatoireDescription
targetstringouiLe nom de l’entité cible du catalogue choisie.
modestringouiLa manière dont la cible choisie est émise, à l’image du mode d’une entité émise : une référence à une entité existante ou un corps nouvellement rédigé.
tierstringouiLe niveau de correspondance de la cible choisie.

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

ScaffoldFile

Un fichier de scaffold que l’import a produit : un chemin relatif à la racine de sortie de l’import et le contenu du fichier.

PropriétéTypeObligatoireDescription
pathstringouiLe chemin du fichier de scaffold, relatif à la racine de sortie de l’import.
contentstringouiLe contenu du fichier de scaffold.

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