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

Schéma du fichier de verrouillage des dépendances d’Aggrega (Manifest)

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/manifest-v1beta1.schema.json

Un fichier de verrouillage unique et global qui lie les types abstraits de composant et de Feature à des implémentations concrètes de Recipe et de FeatureRecipe, par type, avec une surcharge par instance selon le nom.

Consultez la référence de rédaction du Manifest pour des conseils rédigés sur l’écriture des entités Manifest ; cette page documente le schéma structurel que décrit cette référence.

Type de premier niveau : object

Propriétés

PropriétéTypeObligatoireDescription
apiVersionconst “aggrega.ai/v1beta1”ouiConstante : "aggrega.ai/v1beta1"
kindconst “Manifest”ouiConstante : "Manifest"
metadataobjectoui
defsstring[]nonBloc facultatif pour les ancres YAML standard (& et *), afin de garder le Manifest DRY tout en conservant pour le compilateur un dictionnaire plat en O(1).
specobjectouiLes déclarations de mappage du Manifest, plus un héritage facultatif depuis une base : mappings relie les types abstraits de composant et de fonctionnalité à des implémentations concrètes de Recipe et de FeatureRecipe ; extends hérite des mappages d’un Manifest de base.

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

manifest.metadata

PropriétéTypeObligatoireDescription
namestringouiAu moins 1 caractère.
versionstringouiVersionnage sémantique strict du fichier de verrouillage du manifeste (par ex. 1.0.0). Motif : ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$.
descriptionstringnonCe qu’est cette entité et à quoi elle sert, écrit pour quelqu’un qui décide s’il va l’utiliser. Commencez par une phrase qui nomme la chose, puis ajoutez ce dont un lecteur a besoin pour la choisir et l’utiliser correctement — ce qu’elle attend de la Release qui l’utilise, et tout ce que son comportement a de surprenant. Un court paragraphe est la longueur habituelle.
maintainersobject[]nonListe des mainteneurs responsables de cette entité.
licensestringnonIdentifiant SPDX de la licence du logiciel que décrit cette entité, par exemple MIT ou AGPL-3.0. Il consigne les conditions de ce logiciel, pas celles de ce fichier.
repositorystringnonL’URL du dépôt Git où se trouvent les fichiers source.
homestringnonL’URL de la page d’accueil, du wiki ou de la documentation de cette entité.
keywordsstring[]nonUne liste de mots-clés descriptifs pour la découvrabilité dans l’interface utilisateur.

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

manifest.metadata.maintainers[]
PropriétéTypeObligatoireDescription
namestringoui
emailstringnon
urlstringnon

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

manifest.spec

Les déclarations de mappage du Manifest, plus un héritage facultatif depuis une base : mappings relie les types abstraits de composant et de fonctionnalité à des implémentations concrètes de Recipe et de FeatureRecipe ; extends hérite des mappages d’un Manifest de base.

PropriétéTypeObligatoireDescription
extendsstringnonURI d’un Manifest de base dont hériter les mappages. Le mappage d’un enfant remplace celui de la base pour la même clé.
mappingsobjectouiAssocie des interfaces abstraites à des implémentations concrètes. Déclarez les mappages sous les clés de premier niveau ‘components’ et ‘features’, chacune mappant directement des URI de type de composant / type de fonctionnalité vers des URI de Recipe / FeatureRecipe. Ces deux clés constituent toute la surface ; aucune autre clé n’est acceptée ici. Le mappage est agnostique vis-à-vis de la capacité au niveau du Manifest — la détermination de la capacité découle du spec.capability de chaque Recipe résolue lorsqu’Aggrega construit la Release. Clés : l’une de "components", "features".

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

manifest.spec.mappings

Associe des interfaces abstraites à des implémentations concrètes. Déclarez les mappages sous les clés de premier niveau ‘components’ et ‘features’, chacune mappant directement des URI de type de composant / type de fonctionnalité vers des URI de Recipe / FeatureRecipe. Ces deux clés constituent toute la surface ; aucune autre clé n’est acceptée ici. Le mappage est agnostique vis-à-vis de la capacité au niveau du Manifest — la détermination de la capacité découle du spec.capability de chaque Recipe résolue lorsqu’Aggrega construit la Release.

PropriétéTypeObligatoireDescription
componentsmapping_tiernonMappage du type de Component vers l’URI de Recipe. Un URI de Recipe porte au plus deux segments — une capacité initiale facultative, puis le nom de la recette — plus une version facultative ; une référence comportant un troisième segment ne correspond à aucune recette. Formes de version : exacte (‘postgres-bitnami:1.2.0’), plage (‘postgres-bitnami:^1.2.0’) ou sans version (‘postgres-bitnami’) ; le résolveur épingle la version résolue dans le fichier de verrouillage lors de la première résolution. Une référence peut en outre être qualifiée par la capacité (‘terraform/mariadb-rds:1.0.0’, le segment avant le premier ’/’ nommant le spec.capability de la recette) — obligatoire lorsque plus d’une recette est publiée sous le même nom ; une référence nue ambiguë arrête la résolution de façon bien visible plutôt que d’en choisir une en silence.
featuresmapping_tiernonMappage du type de Feature vers l’URI de FeatureRecipe. Inclut à la fois les Features opérationnelles et les Features d’identifiants (portant le label feature.aggrega.ai/kind: secret).

Clés : l’une de "components", "features".

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

Définitions

mapping_tier

Résolution à deux niveaux : ‘type’ mappe par type de catalogue (en masse, DRY), ‘name’ mappe par nom d’instance (surcharge fine). Les deux sont facultatifs, mais au moins l’un doit être présent. Lors de la résolution, name l’emporte sur type. Les clés type versionnées l’emportent sur les clés non versionnées.

PropriétéTypeObligatoireDescription
typemap de stringnonMappe des URI de types de catalogue vers des URI de Recipe. Prend en charge des clés versionnées (‘core/api-server:1.0.0’) pour une correspondance exacte, des clés de plage (‘core/api-server:^1.0.0’) pour une correspondance compatible avec la version majeure, ou des clés non versionnées (‘core/api-server’) pour une correspondance avec n’importe quelle version.
namemap de stringnonMappe des noms d’instance précis vers des URI de Recipe. Prévaut sur le mappage fondé sur le type.
annotationsmap de objectnonRaccourcis de Feature pilotés par les annotations. Mappe des clés d’annotation vers un URI de Feature, plus une table de routage groupée par pilier, de la sous-clé en chemin pointé vers le pilier de la Feature (values ou infra). La validation découle de la déclaration spec.schema.. de la Feature cible ; la liaison ne déclare que le routage. L’URI de Feature référencé par ‘feature’ DOIT aussi figurer dans la section ‘type’ (c’est là que réside la liaison à la version de la FeatureRecipe).

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