Схема файлу блокування залежностей Aggrega (Manifest)
Згенерований довідник. Не редагуйте вручну — згенеруйте повторно з опублікованої JSON Schema.
Ідентифікатор схеми: https://aggrega.ai/schemas/manifest-v1beta1.schema.json
Єдиний глобальний файл блокування, що зіставляє абстрактні типи компонентів і типи Feature з конкретними реалізаціями Recipe і FeatureRecipe за типом, з перевизначенням для окремого екземпляра за ім’ям.
Див. довідник з написання Manifest, щоб отримати текстові настанови щодо створення сутностей Manifest; ця сторінка документує структурну схему, яку описує той довідник.
Тип верхнього рівня: object
Властивості
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
apiVersion | const “aggrega.ai/v1beta1” | так | Константа: "aggrega.ai/v1beta1" |
kind | const “Manifest” | так | Константа: "Manifest" |
metadata | object | так | |
defs | string[] | ні | Необов’язковий блок для стандартних якорів YAML (& і *), що дає змогу уникати повторень у сутності Manifest, зберігаючи для компілятора плоский словник із доступом за O(1). |
spec | object | так | Оголошення зіставлень сутності Manifest і необов’язкове успадкування від базового: mappings зіставляє абстрактні типи компонентів і функцій із конкретними реалізаціями Recipe і FeatureRecipe; extends успадковує зіставлення від базового Manifest. |
Додаткові властивості не дозволені.
manifest.metadata
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
name | string | так | Щонайменше 1 символ. |
version | string | так | Версія файлу блокування manifest за суворим семантичним версіонуванням (наприклад, 1.0.0). Шаблон: ^(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-]+)*))?$. |
description | string | ні | Що це за сутність і для чого вона призначена — для того, хто вирішує, чи її використовувати. Почніть із речення, що називає її, а потім додайте те, що потрібно читачеві, щоб вибрати її та правильно використовувати: чого вона очікує від сутності Release, яка її використовує, та що в її поведінці може здивувати. Звичайна довжина — короткий абзац. |
maintainers | object[] | ні | Список супровідників, яким належить ця сутність. |
license | string | ні | Ідентифікатор SPDX ліцензії програмного забезпечення, яке описує ця сутність, наприклад MIT або AGPL-3.0. Він фіксує умови цього програмного забезпечення, а не умови цього файлу. |
repository | string | ні | URL репозиторію Git, де зберігаються вихідні файли. |
home | string | ні | URL домашньої сторінки, вікі або документації цієї сутності. |
keywords | string[] | ні | Список описових ключових слів для зручного пошуку в інтерфейсі. |
Додаткові властивості не дозволені.
manifest.metadata.maintainers[]
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
name | string | так | |
email | string | ні | |
url | string | ні |
Додаткові властивості не дозволені.
manifest.spec
Оголошення зіставлень сутності Manifest і необов’язкове успадкування від базового: mappings зіставляє абстрактні типи компонентів і функцій із конкретними реалізаціями Recipe і FeatureRecipe; extends успадковує зіставлення від базового Manifest.
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
extends | string | ні | URI базового Manifest, від якого успадковуються зіставлення. Зіставлення дочірнього замінює зіставлення базового для того самого ключа. |
mappings | object | так | Зіставляє абстрактні інтерфейси з конкретними реалізаціями. Оголошуйте зіставлення під ключами верхнього рівня ‘components’ і ‘features’, кожен із яких зіставляє URI типів компонентів / типів функцій безпосередньо з URI Recipe / FeatureRecipe. Ці два ключі — уся доступна поверхня; жоден інший ключ тут не приймається. На рівні Manifest зіставлення не залежить від можливостей — можливість визначається з spec.capability кожного розв’язаного Recipe, коли Aggrega збирає Release. Ключі: один із "components", "features". |
Додаткові властивості не дозволені.
manifest.spec.mappings
Зіставляє абстрактні інтерфейси з конкретними реалізаціями. Оголошуйте зіставлення під ключами верхнього рівня ‘components’ і ‘features’, кожен із яких зіставляє URI типів компонентів / типів функцій безпосередньо з URI Recipe / FeatureRecipe. Ці два ключі — уся доступна поверхня; жоден інший ключ тут не приймається. На рівні Manifest зіставлення не залежить від можливостей — можливість визначається з spec.capability кожного розв’язаного Recipe, коли Aggrega збирає Release.
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
components | mapping_tier | ні | Зіставлення типу Component з URI сутності Recipe. URI сутності Recipe містить щонайбільше два сегменти — необов’язкову початкову можливість (capability), а потім назву рецепта — плюс необов’язкову версію; посилання з третім сегментом не відповідає жодному рецепту. Форми версії: точна (‘postgres-bitnami:1.2.0’), діапазон (‘postgres-bitnami:^1.2.0’) або без версії (‘postgres-bitnami’); резолвер фіксує розв’язану версію в lockfile під час першого розв’язання. Посилання може додатково уточнюватися можливістю (‘terraform/mariadb-rds:1.0.0’, де сегмент перед першим ’/’ називає spec.capability рецепта) — це обов’язково, коли кілька рецептів мають однакову назву; неоднозначне посилання без уточнення явно зупиняє розв’язання, а не мовчки вибирає один із них. |
features | mapping_tier | ні | Зіставлення типу функції з URI FeatureRecipe. Охоплює як операційні Features, так і Features облікових даних (з міткою feature.aggrega.ai/kind: secret). |
Ключі: один із "components", "features".
Додаткові властивості не дозволені.
Визначення
mapping_tier
Дворівневе розв’язання: ‘type’ зіставляє за типом каталогу (масово, без повторень), ‘name’ зіставляє за іменем екземпляра (точкове перевизначення). Обидва необов’язкові, але принаймні один має бути присутнім. Під час розв’язання name має перевагу над type. Ключі типу з версією мають перевагу над ключами без версії.
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
type | map of string | ні | Зіставляє URI типів каталогу з URI Recipe. Підтримує ключі з версією (‘core/api-server:1.0.0’) для точного збігу, ключі з діапазоном (‘core/api-server:^1.0.0’) для збігу в межах сумісної мажорної версії або ключі без версії (‘core/api-server’) для збігу з будь-якою версією. |
name | map of string | ні | Зіставляє конкретні імена екземплярів з URI Recipe. Має перевагу над зіставленням за типом. |
annotations | map of object | ні | Скорочення Feature на основі анотацій. Зіставляє ключі анотацій з URI Feature та згрупованою за стовпами таблицею маршрутизації від підключа з шляхом через крапку до стовпа Feature (values або infra). Валідація випливає з оголошення spec.schema. |
Додаткові властивості не дозволені.