Схема lock-файла зависимостей Aggrega (Manifest)
Сгенерированный справочник. Не редактируйте вручную — сгенерируйте заново из опубликованной JSON Schema.
Идентификатор схемы: https://aggrega.ai/schemas/manifest-v1beta1.schema.json
Единый глобальный lock-файл, который сопоставляет абстрактные типы компонентов и типы 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 | да | Версия lock-файла manifest в строгом формате Semantic Versioning (например, 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, от которого наследуются сопоставления. Сопоставление дочернего Manifest заменяет сопоставление базового для того же ключа. |
mappings | object | да | Сопоставляет абстрактные интерфейсы конкретным реализациям. Сопоставления объявляются под ключами верхнего уровня ‘components’ и ‘features’, каждый из которых сопоставляет URI типов компонентов / типов функций непосредственно с URI Recipe / FeatureRecipe. Эти два ключа составляют всю поверхность; другие ключи здесь не принимаются. На уровне Manifest сопоставление агностично по отношению к capability — capability определяется из spec.capability каждого разрешённого Recipe, когда Aggrega собирает Release. Ключи: один из "components", "features". |
Дополнительные свойства не допускаются.
manifest.spec.mappings
Сопоставляет абстрактные интерфейсы конкретным реализациям. Сопоставления объявляются под ключами верхнего уровня ‘components’ и ‘features’, каждый из которых сопоставляет URI типов компонентов / типов функций непосредственно с URI Recipe / FeatureRecipe. Эти два ключа составляют всю поверхность; другие ключи здесь не принимаются. На уровне Manifest сопоставление агностично по отношению к capability — capability определяется из 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’); при первом разрешении резолвер фиксирует разрешённую версию в lock-файле. Ссылка может дополнительно уточняться capability (‘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. |
Дополнительные свойства не допускаются.