Перейти к содержимому
AggregaAggrega
Выберите язык: Русский
Эта страница переведена машинным способом. Читать оригинал на английском.

Схема lock-файла зависимостей Aggrega (Manifest)

Сгенерированный справочник. Не редактируйте вручную — сгенерируйте заново из опубликованной JSON Schema.

Идентификатор схемы: https://aggrega.ai/schemas/manifest-v1beta1.schema.json

Единый глобальный lock-файл, который сопоставляет абстрактные типы компонентов и типы Feature конкретным реализациям Recipe и FeatureRecipe по типу, с переопределением для отдельного экземпляра по имени.

Руководство по написанию сущностей Manifest в прозе см. в справочнике по написанию Manifest; на этой странице описана структурная схема, которую описывает этот справочник.

Тип верхнего уровня: object

Свойства

СвойствоТипОбязательноОписание
apiVersionconst “aggrega.ai/v1beta1”даКонстанта: "aggrega.ai/v1beta1"
kindconst “Manifest”даКонстанта: "Manifest"
metadataobjectда
defsstring[]нетНеобязательный блок для стандартных якорей YAML (& и *), позволяющий избежать повторов в Manifest и при этом сохранить для компилятора плоский словарь с поиском за O(1).
specobjectдаОбъявления сопоставлений сущности Manifest и необязательное наследование от базовой: mappings связывает абстрактные типы компонентов и функций с конкретными реализациями Recipe и FeatureRecipe; extends наследует сопоставления от базового Manifest.

Дополнительные свойства не допускаются.

manifest.metadata

СвойствоТипОбязательноОписание
namestringдаНе менее 1 символа.
versionstringдаВерсия 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-]+)*))?$.
descriptionstringнетЧто представляет собой эта сущность и для чего она нужна — для того, кто решает, использовать ли её. Начните с предложения, называющего её, затем добавьте то, что читателю нужно, чтобы выбрать её и правильно использовать: чего она ожидает от сущности Release, которая её использует, и что в её поведении может оказаться неожиданным. Обычная длина — короткий абзац.
maintainersobject[]нетСписок сопровождающих, которым принадлежит эта сущность.
licensestringнетИдентификатор SPDX лицензии программного обеспечения, которое описывает эта сущность, например MIT или AGPL-3.0. Он фиксирует условия этого программного обеспечения, а не условия данного файла.
repositorystringнетURL Git-репозитория, в котором находятся исходные файлы.
homestringнетURL домашней страницы, вики или документации этой сущности.
keywordsstring[]нетСписок описательных ключевых слов для удобства поиска в интерфейсе.

Дополнительные свойства не допускаются.

manifest.metadata.maintainers[]
СвойствоТипОбязательноОписание
namestringда
emailstringнет
urlstringнет

Дополнительные свойства не допускаются.

manifest.spec

Объявления сопоставлений сущности Manifest и необязательное наследование от базовой: mappings связывает абстрактные типы компонентов и функций с конкретными реализациями Recipe и FeatureRecipe; extends наследует сопоставления от базового Manifest.

СвойствоТипОбязательноОписание
extendsstringнетURI базового Manifest, от которого наследуются сопоставления. Сопоставление дочернего Manifest заменяет сопоставление базового для того же ключа.
mappingsobjectдаСопоставляет абстрактные интерфейсы конкретным реализациям. Сопоставления объявляются под ключами верхнего уровня ‘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.

СвойствоТипОбязательноОписание
componentsmapping_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 рецепта) — это обязательно, когда несколько рецептов поставляются с одинаковым именем; неоднозначная голая ссылка явно останавливает разрешение, а не выбирает один из рецептов молча.
featuresmapping_tierнетСопоставление типа функции с URI FeatureRecipe. Включает как эксплуатационные Features, так и Features учётных данных (с меткой feature.aggrega.ai/kind: secret).

Ключи: один из "components", "features".

Дополнительные свойства не допускаются.

Определения

mapping_tier

Двухуровневое разрешение: ‘type’ сопоставляет по типу каталога (массово, без повторов), ‘name’ — по имени экземпляра (точечное переопределение). Оба необязательны, но хотя бы один должен присутствовать. При разрешении name имеет приоритет над type. Ключи типов с версией имеют приоритет над ключами без версии.

СвойствоТипОбязательноОписание
typemap of stringнетСопоставляет URI типов каталога с URI Recipe. Поддерживает ключи с версией (‘core/api-server:1.0.0’) для точного совпадения, ключи-диапазоны (‘core/api-server:^1.0.0’) для совпадения в пределах мажорной версии и ключи без версии (‘core/api-server’) для совпадения с любой версией.
namemap of stringнетСопоставляет конкретные имена экземпляров с URI Recipe. Имеет приоритет над сопоставлением по типу.
annotationsmap of objectнетЯрлыки Feature на основе аннотаций. Сопоставляет ключи аннотаций с URI сущности Feature и таблицей маршрутизации, сгруппированной по столпам, от подключа с путём через точку к столпу Feature (values или infra). Валидация выводится из объявления spec.schema.. целевой сущности Feature; привязка объявляет только маршрутизацию. URI сущности Feature, на который ссылается ‘feature’, ОБЯЗАТЕЛЬНО должен также присутствовать в разделе ‘type’ (именно там находится привязка версии FeatureRecipe).

Дополнительные свойства не допускаются.