Перейти до вмісту
AggregaAggrega
Обрати мову: Українська
Цю сторінку перекладено машинним способом. Читати оригінал англійською.

Схема Aggrega Developer Intent (Aggregate)

Згенерований довідник. Не редагуйте вручну — згенеруйте повторно з опублікованої JSON Schema.

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

Рекурсивна параметризована архітектура ШІ. Виконує роль і кореня збирання, і модуля для повторного використання.

Описові настанови щодо створення сутностей Aggregate див. у довіднику зі створення сутностей Aggregate; ця сторінка документує структурну схему, яку описує той довідник.

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

Властивості

ВластивістьТипОбов’язковаОпис
apiVersionconst “aggrega.ai/v1beta1”такКонстанта: "aggrega.ai/v1beta1"
kindconst “Aggregate”такКонстанта: "Aggregate"
metadataobjectтак
defsstring[]ніНеобов’язковий блок для стандартних якорів YAML (& та *), що дає змогу уникати повторів у сутності Aggregate і водночас зберігати для компілятора плаский словник O(1). Відповідає аналогічному блоку в сутності Manifest.
specobjectтакПоверхня наміру розробника: глобальний контракт параметрів, вкладені імпорти агрегатів, публічний API експортованих компонентів, групування в підсистеми та екземпляри компонентів, з яких складається модуль.

Додаткові властивості не дозволені.

aggregate.metadata

ВластивістьТипОбов’язковаОпис
namestringтакЩонайменше 1 символ.
versionstringтакСтрога семантична версія модуля aggregate. Шаблон: ^(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ні
maintainersobject[]ніСписок супровідників, яким належить ця сутність.
licensestringніІдентифікатор SPDX ліцензії програмного забезпечення, яке описує ця сутність, наприклад MIT або AGPL-3.0. Він фіксує умови цього програмного забезпечення, а не умови цього файлу.
repositorystringніURL репозиторію Git, де зберігаються вихідні файли.
homestringніURL домашньої сторінки, вікі або документації цієї сутності.
keywordsstring[]ніСписок описових ключових слів для зручного пошуку в інтерфейсі.
labelsmap of stringніМітки качиної типізації на рівні модуля для пошуку в каталозі, оцінювання політик і фільтрування в Studio/IDE. Ці мітки описують ідентичність сутності Aggregate як повторно використовуваного модуля (наприклад, aggregate.aggrega.ai/tier: infrastructure, aggregate.aggrega.ai/compliance: pci-dss). Вони НЕ поширюються на дочірні вузли компонентів — мітки компонентів беруться виключно з каталожної сутності Component у домені 2.

Додаткові властивості не дозволені.

aggregate.metadata.maintainers[]
ВластивістьТипОбов’язковаОпис
namestringтак
emailstringні
urlstringні

Додаткові властивості не дозволені.

aggregate.spec

Поверхня наміру розробника: глобальний контракт параметрів, вкладені імпорти агрегатів, публічний API експортованих компонентів, групування в підсистеми та екземпляри компонентів, з яких складається модуль.

ВластивістьТипОбов’язковаОпис
parametersmap of objectніГлобальний контракт середовища. Кожен запис — це об’єкт типізованого контракту, що використовує підмножину словника компактної форми (type, description, default, enum, min/max, minLength/maxLength, pattern, format, validate, validateMessage, required, items, valuesType, properties). Вкладена структура виражається через підполе properties: типізованої форми. Виконання в сутності Release може бути вбудованим (parameters: {…}) або імпортом з одного файлу (parameters: {$import: }); шар контракту параметрів перевіряє об’єднану мапу на відповідність цьому контракту перед інтерполяцією параметрів. Повний словник описано на сторінці Aggregate довідника мови.
aggregatesmap of objectніВкладені агрегати, що діють як імпортовані модулі. Ключі: одна або більше літер, цифр, підкреслень чи дефісів. Крапка не дозволена. Шаблон: ^[a-zA-Z0-9_-]+$.
exportedComponentsmap of stringніІнтерфейс публічного API. Зіставляє відкрите публічне ім’я з внутрішнім ID компонента. Батьківські сутності Aggregates, що імпортують цей модуль, посилаються на компоненти за цими публічними іменами.
subsystemsmap of subsystemніІменовані логічні групування компонентів сутності Aggregate у підсистеми. Взаємовиключні з компонентами верхнього рівня — оголошення обох відхиляється. Підсистема, яку автор назвав default, — це звичайна оголошена підсистема, відмінна від синтезованої default, яку компілятор створює для сутності Aggregate лише з компонентами. Ключі: одна або більше літер, цифр, підкреслень чи дефісів. Крапка не дозволена. Шаблон: ^[a-zA-Z0-9_-]+$.
componentsmap of component_instanceніМапа логічних атомарних компонентів, з яких складається ця сутність Aggregate, задана безпосередньо на верхньому рівні. Компоненти верхнього рівня та підсистеми взаємовиключні — оголошення обох відхиляється. Коли компоненти задано тут (без підсистем), компілятор під час завантаження згортає їх у синтезовану підсистему default, а IR позначає цю підсистему як синтезовану. Ключі: одна або більше літер, цифр, підкреслень чи дефісів. Крапка не дозволена. Шаблон: ^[a-zA-Z0-9_-]+$.

Додаткові властивості не дозволені.

Визначення

inject_delivery

Один механізм доставки, що задається як масив записів. Кожен запис містить ‘in’ (локальний ідентифікатор — ім’я змінної середовища, шлях до файлу, прапорець аргументу або власний ключ, специфічний для механізму) та рівно одне з ‘from’ (ключ provides, який слід розв’язати) або ‘value’ (літеральний рядок, що може містити вирази шаблонів Go, які обчислюються під час розв’язання самоін’єкції). ‘from’ розв’язується відносно provides цілі в контексті uses[].inject, відносно provides, які публікує сутність FeatureRecipe підключення, у контексті features..inject підключення або відносно власних provides компонента в контексті component.inject. У features..inject підключення ‘from’, що називає ключ, який сутність FeatureRecipe не публікує, зупиняє збірку, якщо тільки ця сутність FeatureRecipe сама не читає записи підключення в .inject у шаблоні, який вона обчислює відносно контексту рендерингу підключення (у своєму valuesMapping, workload, artifacts, omits або в with чи when кроку конвеєра — не у своєму injectMapping); у такому разі ключ є таким, який вона споживає, а не таким, що доставляється через .context.inject компонента. ‘value’ доставляється лише в component.inject: запис, що містить його в uses[].inject або в features..inject підключення, зупиняє збірку, бо ці блоки доставляють лише ключі, які публікує інша сутність.

Тип: object[]

inject_block

Агностична маршрутизація ін’єкцій. Зіставляє локальні змінні з ключами provides цілі (uses[].inject), з ключами provides, які публікує сутність FeatureRecipe підключення (features..inject), або з літеральними рядками / виразами шаблонів і власними ключами provides компонента (component.inject). Кожен механізм доставки (env, file, arg або власний) задається як масив записів {in, from?, value?} — явне ‘from’ для посилань на provides і ‘value’ для літералів. Власний механізм може мати будь-яку назву, крім all: шаблон читає всі механізми, об’єднані в одне подання, у .context.inject.all, тож механізм із такою назвою був би ним прихований, і задання такої назви зупиняє збірку.

ВластивістьТипОбов’язковаОпис
envinject_deliveryніОдин механізм доставки, що задається як масив записів. Кожен запис містить ‘in’ (локальний ідентифікатор — ім’я змінної середовища, шлях до файлу, прапорець аргументу або власний ключ, специфічний для механізму) та рівно одне з ‘from’ (ключ provides, який слід розв’язати) або ‘value’ (літеральний рядок, що може містити вирази шаблонів Go, які обчислюються під час розв’язання самоін’єкції). ‘from’ розв’язується відносно provides цілі в контексті uses[].inject, відносно provides, які публікує сутність FeatureRecipe підключення, у контексті features..inject підключення або відносно власних provides компонента в контексті component.inject. У features..inject підключення ‘from’, що називає ключ, який сутність FeatureRecipe не публікує, зупиняє збірку, якщо тільки ця сутність FeatureRecipe сама не читає записи підключення в .inject у шаблоні, який вона обчислює відносно контексту рендерингу підключення (у своєму valuesMapping, workload, artifacts, omits або в with чи when кроку конвеєра — не у своєму injectMapping); у такому разі ключ є таким, який вона споживає, а не таким, що доставляється через .context.inject компонента. ‘value’ доставляється лише в component.inject: запис, що містить його в uses[].inject або в features..inject підключення, зупиняє збірку, бо ці блоки доставляють лише ключі, які публікує інша сутність.
fileinject_deliveryніОдин механізм доставки, що задається як масив записів. Кожен запис містить ‘in’ (локальний ідентифікатор — ім’я змінної середовища, шлях до файлу, прапорець аргументу або власний ключ, специфічний для механізму) та рівно одне з ‘from’ (ключ provides, який слід розв’язати) або ‘value’ (літеральний рядок, що може містити вирази шаблонів Go, які обчислюються під час розв’язання самоін’єкції). ‘from’ розв’язується відносно provides цілі в контексті uses[].inject, відносно provides, які публікує сутність FeatureRecipe підключення, у контексті features..inject підключення або відносно власних provides компонента в контексті component.inject. У features..inject підключення ‘from’, що називає ключ, який сутність FeatureRecipe не публікує, зупиняє збірку, якщо тільки ця сутність FeatureRecipe сама не читає записи підключення в .inject у шаблоні, який вона обчислює відносно контексту рендерингу підключення (у своєму valuesMapping, workload, artifacts, omits або в with чи when кроку конвеєра — не у своєму injectMapping); у такому разі ключ є таким, який вона споживає, а не таким, що доставляється через .context.inject компонента. ‘value’ доставляється лише в component.inject: запис, що містить його в uses[].inject або в features..inject підключення, зупиняє збірку, бо ці блоки доставляють лише ключі, які публікує інша сутність.
arginject_deliveryніОдин механізм доставки, що задається як масив записів. Кожен запис містить ‘in’ (локальний ідентифікатор — ім’я змінної середовища, шлях до файлу, прапорець аргументу або власний ключ, специфічний для механізму) та рівно одне з ‘from’ (ключ provides, який слід розв’язати) або ‘value’ (літеральний рядок, що може містити вирази шаблонів Go, які обчислюються під час розв’язання самоін’єкції). ‘from’ розв’язується відносно provides цілі в контексті uses[].inject, відносно provides, які публікує сутність FeatureRecipe підключення, у контексті features..inject підключення або відносно власних provides компонента в контексті component.inject. У features..inject підключення ‘from’, що називає ключ, який сутність FeatureRecipe не публікує, зупиняє збірку, якщо тільки ця сутність FeatureRecipe сама не читає записи підключення в .inject у шаблоні, який вона обчислює відносно контексту рендерингу підключення (у своєму valuesMapping, workload, artifacts, omits або в with чи when кроку конвеєра — не у своєму injectMapping); у такому разі ключ є таким, який вона споживає, а не таким, що доставляється через .context.inject компонента. ‘value’ доставляється лише в component.inject: запис, що містить його в uses[].inject або в features..inject підключення, зупиняє збірку, бо ці блоки доставляють лише ключі, які публікує інша сутність.

component_uses_block

З’єднання, які компонент проводить до компонентів, від яких залежить, згруповані за сокетом. Кожен сокет перелічує свої цілі або називає кожне з’єднання під псевдонімом. З’єднання, назване під псевдонімом, може містити значення розробника для цього з’єднання та вкладення, що заповнюють слоти, оголошені сокетом.

Ключі: одна або більше літер, цифр, підкреслень чи дефісів. Крапка не допускається. Шаблон: ^[a-zA-Z0-9_-]+$.

Значення мають тип string[] or map of object.

Будь-які інші ключі не допускаються.

feature_uses_block

З’єднання, які проводить приєднана сутність Feature, згруповані за сокетом, який Feature оголошує у своєму usesSchema. Кожен сокет перелічує свої цілі або називає кожне з’єднання під псевдонімом. З’єднання, яке проводить Feature, не має власних вкладень: потрібні йому облікові дані заповнюють слот, який Feature оголошує у власному featuresSchema, і приєднуються поруч із Feature.

Ключі: одна або більше літер, цифр, підкреслень чи дефісів. Крапка не допускається. Шаблон: ^[a-zA-Z0-9_-]+$.

Значення мають тип string[] or map of object.

Будь-які інші ключі не допускаються.

connection_attachment

Одне вкладення, яке містить з’єднання: сутність Feature, що заповнює слот, оголошений сокетом з’єднання, разом із конфігурацією розробника для неї.

ВластивістьТипОбов’язковаОпис
typestringтакURI інтерфейсу Feature, який запитує це вкладення (наприклад, core/referenced-secret:1.0.0).
descriptionstringніНеобов’язкова документація, що пояснює, чому це з’єднання містить вкладення.
valuesobjectніКонфігурація для Feature, надана розробником і перевірена за оголошенням її схеми.

Додаткові властивості не дозволені.

subsystem

ВластивістьТипОбов’язковаОпис
descriptionstringніНеобов’язкова документація, що описує призначення цієї підсистеми та логічне групування, яке вона представляє.
annotationsmap of string or object or nullніАнотації розробника для цієї підсистеми. Значення — рядки, структуровані об’єкти (мапа підключів на значення, що зливається за кожним підключем з успадкованим структурованим значенням) або null; явне null для ключа, успадкованого від батьківської підсистеми, вилучає успадковану прив’язку з цієї підсистеми (відмова від Feature через анотації). Оголошені тут анотації успадковуються вкладеними підсистемами та компонентами, що в ній містяться; для кожного ключа перевагу має ближчий рівень. Каскадно передаються до розділу .context.annotations.aggregate на кожному похідному вузлі IR.
featuresmap of objectніНаскрізні функції, приєднані до всіх компонентів цієї підсистеми. Та сама схема, що й у функцій рівня компонента (type, values, uses, inject). Під час фіналізації графа розгортаються в кожен компонент і розміщуються після функцій рівня компонента в порядку виконання. Ключі: одна або більше літер, цифр, підкреслень чи дефісів. Крапка не допускається. Шаблон: ^[a-zA-Z0-9_-]+$.
subsystemsmap of subsystemніКлючі: одна або більше літер, цифр, підкреслень чи дефісів. Крапка не допускається. Шаблон: ^[a-zA-Z0-9_-]+$.
componentsmap of component_instanceніКлючі: одна або більше літер, цифр, підкреслень чи дефісів. Крапка не допускається. Шаблон: ^[a-zA-Z0-9_-]+$.

Додаткові властивості не дозволені.

component_instance

ВластивістьТипОбов’язковаОпис
typestringтакЗапитувана абстрактна сутність Component у вигляді посилання: її metadata.name разом із необов’язковою :version (наприклад, core/api-server:1.0.0), ніколи не шлях до файлу. Розв’язується за трирівневою моделлю розв’язання сутностей (каталоги каталогу робочого простору → кеш → реєстр): локально створену сутність Component розміщують у catalog/ у корені робочого простору або в каталозі, указаному в workspace.catalog_dirs, а type, записаний як відносний шлях до файлу, зупиняє збирання як сутність, якої немає в жодному каталозі.
activeboolean або stringніЧи присутній цей компонент у скомпільованій топології. Булеве значення або рядковий шаблон над .parameters, який має розв’язатися в булеве значення. Коли він розв’язується в false, компонент вилучається з топології разом із його ребрами uses і його прикріпленнями. Якщо значення залежить від параметра, сутність Release може вмикати й вимикати присутність компонента, задаючи цей параметр. Якщо пропущено, типово true. Типове значення: true
descriptionstringніНеобов’язкова документація, що описує роль цього екземпляра компонента в застосунку. Переноситься до графа IR.
annotationsmap of string or object or nullніАнотації, які розробник задає для цього компонента. Значеннями є рядки, структуровані об’єкти (мапа підключів на значення, що зливається за кожним підключем з успадкованим структурованим значенням) або null; явний null для ключа, успадкованого від батьківської підсистеми, вилучає успадковану прив’язку з цього компонента (відмова від Feature на основі анотацій). Анотації рівня Component перевизначають успадковані анотації рівня підсистеми для кожного ключа окремо; сусідні компоненти в тій самій підсистемі зберігають власні мапи анотацій незалежно.
valuesobjectніНепрозорі когнітивні властивості, що передаються сутності Component і перевіряються її схемою.
usescomponent_uses_blockніЗ’єднання, які компонент проводить до компонентів, від яких залежить, згруповані за сокетом. Кожен сокет перелічує свої цілі або називає кожне з’єднання під псевдонімом. З’єднання, назване під псевдонімом, може містити значення розробника для цього з’єднання та вкладення, що заповнюють слоти, оголошені сокетом.
injectinject_blockніСамоін’єкція на рівні компонента. Впроваджує власні значення компонента (через ‘value:’) або власні ключі provides (через ‘from:’) безпосередньо в канал доставки (.context.inject). Дозволено, лише якщо каталожна сутність Component оголошує ‘spec.inject’ з відповідними механізмами. Ключ inject, що збігається з ключем, оголошеним в uses[].inject, зупиняє збирання як дубльований ключ доставки між джерелами inject.
featuresmap of objectніСутності Features, прикріплені до цього компонента, з ключами — іменами екземплярів, які автор дає кожному прикріпленню. Це єдина поверхня прикріплення: операційна Feature, Feature облікових даних (з міткою feature.aggrega.ai/kind: secret) і Feature ідентичності прикріплюються тут, з тим самим ключовим словом і тією самою формою. Відрізняється між ними те, що створює прикріплення, а не те, як його оголошено. Прикріплення, ім’я екземпляра якого збігається зі слотом, що його Component оголошує у featuresSchema, заповнює цей слот; будь-яке інше ім’я екземпляра — це вільне прикріплення. Ключі: одна або більше літер, цифр, підкреслень чи дефісів. Крапка не допускається. Шаблон: ^[a-zA-Z0-9_-]+$.

Додаткові властивості не дозволені.