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

Схема контексту шаблонів Aggrega

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

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

Подання, яке компілятор збирає й передає в шаблони сутностей Recipe і FeatureRecipe під час рендерингу. Під час рендерингу FeatureRecipe вкладення компілятор додатково заповнює .attachment_name і .inject контекстом в межах вкладення, .context.render_facts — тим, що provider хоста повідомив про рендеринг хоста, а в шаблонах, що створюють власні ресурси вкладення, — .context.used_by компонентами, які використовують його хост. Для FeatureRecipe з областю межі (spec.executionScope: boundary) шаблони, які він виконує один раз для межі, — серед них його locals, provides, source, valuesMapping, artifacts і кроки pipeline, — не мають стовпів .context, .workload, .attachment_name, .inject і .inject_raw, а замість них мають заповнений стовп .boundary.* — див. блок boundary наприкінці властивостей; його injectMapping виконується один раз для кожного компонента, до якого сягає вкладення, у контексті цього компонента, тож він читає .context.* і .attachment_name, а .boundary там не задано. Це НЕ зберігається на диску; воно існує лише в пам’яті компілятора під час рендерингу. Ця схема документує контракт між компілятором і авторами шаблонів Ops.

Доступність на етапах базового рендерингу в порядку виконання етапів:

  • Обчислення provides (преамбула locals, потім provides): лише локальні стовпи вузла. Запис locals читає записи над ним у власному блоці; шаблон provides читає всі розв’язані .locals вузла. Самопосилання заборонено (жоден запис provides не читає інший).
  • Розв’язання джерела (публікація locals + обчислення source): усі стовпи; .source і .workload відсутні. Тут ці locals публікуються в .locals, а потім source: обчислюється з їх використанням.
  • Відображення значень (valuesMapping): усі стовпи + .source; .workload відсутній.
  • Синтез Workload (обчислення workload): усі стовпи + .source; .workload обчислюється (відсутній для самопосилання).
  • Обчислення артефактів (artifacts): усі стовпи + .source + .workload (найповніший контекст).

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

Властивості

ВластивістьТипОбов’язковаОпис
contextobjectтакЗібраний компілятором контекст виконання, що надає дані ідентичності, топології та доставки.
valuesobjectтакНепрозоре когнітивне навантаження цього вузла, уже перевірене валідатором схеми під час розв’язання. Передається без змін.
infraobjectтакФізичне навантаження з параметрами розміру, впроваджене із сутності Release для цього вузла. Повністю оминає розробника.
localsmap of stringтакВласний приватний стан сутності Recipe (наприклад, primary_compute, volumes_path). Обчислюється в преамбулі locals — перед provides цього вузла — і публікується в цей стовп під час розв’язання source. Кожен запис — це шаблон Go, що обчислюється відносно самодостатнього локального для вузла контексту, який містить уже розв’язані записи того самого блоку, тож запис МОЖЕ читати сусідній запис, визначений ВИЩЕ за нього, і отримує розв’язане значення цього запису. Порядок, заданий автором, є частиною контракту скрізь, де один запис читає інший: перенесення визначення нижче за запис, що його читає, ламає збирання. Посилання ‘.locals.’ на пізніший запис або на ключ, який блок не оголошує, зупиняє збирання. Перевірка аналізує шлях, до якого посилання РОЗВ’ЯЗУЄТЬСЯ, а не набраний текст, тож однаково охоплює пряму форму, читання всередині блоку ’{{ with .locals }}’, читання через змінну, прив’язану безпосередньо до ‘.locals’, і ключ, прочитаний із блоку в дужках, ‘(.locals).’ або ’($.locals).’. Одне написання вона не охоплює: посилання, шлях якого не визначається текстом шаблону, — отримане через функцію, як-от ‘index .locals’ або ‘(default dict .locals).’, або через блок ‘with’ чи прив’язку змінної, конвеєр яких застосовує таку функцію. Таке посилання не аналізується, і відсутній ключ, отриманий у такий спосіб, не зупиняє збирання: він рендериться як буквальний текст '', а не як порожнє значення. Єдиний виняток — сам ‘index’: на кожній поверхні шаблонів він зупиняє збирання, називаючи ключ, коли мапа, яку він читає, не містить запитаного ключа, тож відсутній ключ, отриманий через ‘index .locals’, зупиняє збирання. Запис locals не може читати ‘.provides’. Доступно в provides (під час обчислення provides, після преамбули), source, valuesMapping, workload, artifacts, assertions, а також для подальших Wasm-плагінів через pipeline[].with (і pipeline[].when). Ніколи не надається викликачам.
providesmap of stringніПублічний API-контракт сутності Recipe. Заповнюється під час обчислення provides. Доступний у valuesMapping базового рендерингу для посилання на себе (наприклад, {{ .provides.host }}). НЕ доступний у самому шаблоні provides (інваріант самодостатності provides). Викликачі розв’язують ключі inject відносно цих значень.
featuresmap of template_attachmentніУсі прикріплення цього вузла, з ключами за іменем екземпляра, яке дав їм автор. Один стовп містить їх усі, що б вони не створювали — операційну сутність Feature, сутність Feature з обліковими даними, сутність Feature ідентичності, — бо прикріплення відрізняються тим, що вони створюють, а не тим, як шаблон їх читає. Сутність Recipe читає їх, щоб адаптувати свій рендеринг до прикріплених можливостей і використовувати те, що публікує прикріплення. Прикріплення, записане на одному з з’єднань вузла, до них не належить: його читають у межах цього з’єднання, за шляхом .context.uses..features., тож шаблон, що перебирає цей стовп, бачить лише власні прикріплення вузла.
metadataobjectніМетадані сутності Release і компіляції, що надають глобальну ідентичність для детермінованого іменування. Доступні в усіх блоках шаблонів (valuesMapping, injectMapping, pipeline with).
attachment_namestringніЗаповнюється лише під час рендерингу прикріплення FeatureRecipe. Містить ім’я екземпляра прикріплення — слот, який воно заповнює у featuresSchema сутності-власника, або довільне ім’я, яке дав йому автор (наприклад, ‘admin_password’, ‘db_credentials’). Використовується для побудови детермінованих імен ресурсів, що різняться для кожного прикріплення і складаються після імені компонента-хоста: ’{{ .context.rendered_name }}-{{ .attachment_name | replace ”_” ”-” }}’, де провайдер хоста повідомляє відрендерене ім’я, як це робить helm, — ім’я хоста, записане символами, дозволеними в імені Kubernetes, із підкресленнями в імені прикріплення, заміненими на дефіси, — і ’{{ .context.instance_id }}-{{ .attachment_name }}’, де провайдер хоста такого імені не повідомляє.
injectobjectніЗаповнюється лише під час рендерингу прикріплення FeatureRecipe, що містить написаний автором блок inject (наприклад, { env: [ { in: ‘OPENAI_API_KEY’, from: ‘api_token’ } ] }). Відрізняється від .context.inject, який є попередньо наповненим каналом доставки базового компонента з ребер uses. Має значення null або відсутній для прикріплень без написаного автором inject і для базових сутностей Recipes.
inject_rawobject або nullніНезмінний, немодифікований намір розробника щодо блоку inject. Кожен механізм, який називає блок, — env, file, arg або власний, як-от ssm_param, — розміщено під його власним ім’ям, і він містить записи точно в тому вигляді, як їх написано (in разом із from або value), у порядку написання, тож .inject_raw.ssm_param читає власний механізм так само, як .inject_raw.env читає базовий. Має значення null, якщо розробник повністю пропустив блок inject. Використовується Ops для логічних перевірок (наприклад, {{ if not .inject_raw }}), щоб виявити пропуск до модифікацій inject mapping. Які з власних values чи provides компонента доставляє кожен запис, слід читати в .context.self_inject, а не з тексту записів.
stepsmap of objectніОбмін даними між кроками конвеєра. Доступний лише всередині блоків ‘with:’ конвеєра Wasm. Кожен ключ — це ID кроку конвеєра, що містить виходи, експортовані цим кроком.
sourcestring or object or nullніРозв’язаний вміст поля source. У шаблонах сутності Recipe: заповнюється під час розв’язання source з поля source: сутності Recipe після обчислення шаблону Go, доступний, починаючи з values mapping (valuesMapping, workload, artifacts), і має значення null, коли сутність Recipe не має source:. У шаблонах сутності FeatureRecipe: власне поле source: сутності FeatureRecipe після обчислення шаблону Go, яке обчислюється перед її valuesMapping і читається там і в кожному шаблоні, обчисленому після нього (omits, workload, artifacts, кроки pipeline), і ніколи не є полем компонента-хоста; має значення null, коли сутність FeatureRecipe не має source:. injectMapping сутності FeatureRecipe обчислюється перед її source і читає source компонента-хоста. Рядкова форма = шлях URI; об’єктна форма = структуроване джерело (наприклад, дескриптор OCI з розв’язаною версією).
workloadworkload-v1beta1.schema.json or nullніРозібрана специфікація сутності Workload для цього вузла. Заповнюється під час синтезу workload з поля workload: сутності Recipe після обчислення шаблону Go + перевірки сутності Workload за JSON-схемою (workload-v1beta1.schema.json). Доступна, починаючи з обчислення артефактів (artifacts), тож artifacts можуть посилатися на поля workload без дублювання (наприклад, ServiceMonitor, що читає .workload.services.metrics.ports.prom). Має значення null, коли сутність Recipe не має блоку workload:. Спроби шаблону розіменувати .workload.* для значення null завершуються зрозумілою помилкою під час обчислення шаблону.
boundaryobjectніКонтекст рівня межі — заповнюється лише під час обчислення шаблону, який FeatureRecipe, у якого spec.executionScope має значення ‘boundary’, виконує один раз для межі. FeatureRecipes рівня Component не отримують цієї опори; натомість дані для кожного компонента несуть їхні context.instance_id, context.inject, context.uses та опора .workload. Шаблони FeatureRecipe рівня межі, що виконуються для межі, отримують .boundary.* замість цих опор для окремих компонентів; його injectMapping виконується в контексті кожного компонента, до якого сягає прикріплення, читає ці опори для окремих компонентів і не отримує цієї.

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

template-context.context

Зібраний компілятором контекст виконання, що надає дані ідентичності, топології та доставки.

ВластивістьТипОбов’язковаОпис
instance_idstringтакАбсолютний сплощений ідентифікатор поточного вузла (наприклад, ‘backend’ або ‘data-layer-zdmain-db’ для компонента main-db екземпляра модуля data-layer), записаний в алфавіті, якому відповідає кожне авторське ім’я компонента. Детермінований і стабільний між компіляціями для того самого Aggregate. Це ім’я ресурсів, створених для цього вузла, для яких жоден провайдер не виводить ім’я, — набору артефактів, розміщеного з Recipe, і робочого навантаження, синтезованого провайдером, що називає його за ідентичністю, — тож адреса, опублікована для одного з них, будується з цього значення.
rendered_namestringніІм’я, яке провайдер, прив’язаний до цього вузла, дає ресурсам, що він рендерить для вузла: для джерела, наданого автором, — ім’я, з яким рендеряться самі надані шаблони, як-от ім’я релізу, яке читає chart; для робочого навантаження, яке він синтезує, — ім’я, яке він дає ресурсам цього навантаження, якщо виводить його, а не записує ідентичність вузла, як провайдер helm робить із тим самим ім’ям релізу. Читайте його всюди, де цей Recipe називає ресурс, оголошений наданим chart чи модулем або синтезований таким провайдером, — у записі provides, у valuesMapping, у workload, у записі artifacts або в with чи when кроку pipeline, — бо провайдер може записати це ім’я в біднішому алфавіті, ніж той, яким записано авторське ім’я компонента, і тоді вони відрізняються. Порожнє, коли прив’язаний провайдер не виводить такого імені: ресурси розміщеного набору артефактів і робочого навантаження, синтезованого провайдером, що називає його за ідентичністю, мають ідентичність вузла, тож для них читайте ’{{ .context.instance_id }}’, а Recipe, що сам записав імена своїх ресурсів, уже їх знає. Читання цього ключа там, де прив’язаний провайдер не повідомляє імені, зупиняє збірку й вказує, що слід записати натомість. Ця відмова стосується шаблонів, які Recipe записує вбудовано; valuesMapping, workload або запис artifacts, наданий через ‘$import’, розв’язується лише тоді, коли рендеринг доходить до нього, тож посилання в ньому рендериться як порожнє значення, а не зупиняє збірку. У шаблонах FeatureRecipe, прив’язаного до вкладення компонента, це ім’я компонента-ХОСТА в тому вигляді, як його повідомляє власний провайдер хоста, — значення, яке читає власний Recipe хоста, так само як instance_id там є ідентичністю хоста, — тож вкладення називає ресурс за своїм хостом саме з нього й отримує ім’я, яке приймає платформа хоста. Якщо провайдер хоста не повідомляє імені, воно порожнє, і читання його з будь-якого вбудованого шаблону вкладення, крім його injectMapping, зупиняє збірку; натомість читайте там ’{{ .context.instance_id }}’.
labelsmap of stringніМітки duck-typing та онтології поточного вузла, включно з будь-якими змінами, внесеними під час побудови топології плагіном управління, приєднаним у ролі label-transform.
annotationsobjectніТри каскадні кошики анотацій поточного вузла, розділені за походженням.
injectobjectтакПопередньо заповнений і перехоплений канал доставки. Спочатку це згенерована компілятором мапа, що зіставляє ключі inject розробника зі значеннями provides цілі. Змінюється на місці глибокими злиттями injectMapping. На момент рендерингу базового Recipe містить повністю розв’язані фізичні рядки.
usesmap of enriched_edgeтакЗбагачена мапа топологічних ребер. Ключами є псевдоніми розробника (наприклад, ‘my_db’, ‘my_api’). Кожен запис — це зібране компілятором подання ідентичності цільового вузла, розв’язаних provides, зіставлення ін’єкцій і каскадних анотацій, а також вкладень, записаних на цьому з’єднанні, — і, для FeatureRecipe, що оголошує readsTargetRenderFacts, того, що повідомили рендеринги цілі. Це НЕ сире ребро IR — це збагачена проєкція, яку компілятор будує спеціально для використання в шаблонах. Шаблон, що перебирає цю мапу, бачить з’єднання в порядку ключів — відсортованими за псевдонімом, — а не в порядку, у якому їх записано.
self_injectobjectтакЯкі з власних values і provides компонента розробник уже наділив іменем доставлення; прочитано з написаного на самому компоненті блоку inject: — блоку, який .inject_raw містить у записаному вигляді, а .context.inject — у розв’язаному. Кожен механізм, який називає блок (env, file, arg або власний, як-от ssm_param), зіставляє кожне ім’я, написане розробником, із власним ключем, який доставляє цей запис, так само як .context.uses..inject зіставляє імена з’єднання з ключами, які вони читають: ‘provides.’ для запису, написаного з from: ; ‘values.’ для запису, шаблон value: якого читає рівно одне з власних values компонента і нічого іншого, де — ключ верхнього рівня цього значення, хоч би який текст чи які функції оточували читання і хоч би як глибоко воно заходило в значення, — ’{{ .values.config.port }}’, ’{{ index .values.config “port” }}’ і ’{{ (default dict .values.config).port }}’ усі зіставляються з ‘values.config’; і порожній рядок для кожного іншого запису — літерала, шаблону, що читає два значення, шаблону, що читає будь-що, крім values, або шаблону, чиє читання values текст не приписує одному ключу верхнього рівня, як-от ’{{ index .values “role” }}’, values, прочитані повністю, або весь контекст, переданий функції. Отже, сутність Recipe, яка доставляє власне значення під типовим іменем, перевіряє, чи якийсь запис уже зіставлено з ‘values.’, і якщо так, пропускає своє типове ім’я, наприклад {{ range $name, $key := .context.self_inject.env }}{{ if eq $key “values.role” }}…{{ end }}{{ end }}. Присутній і порожній, якщо розробник не написав жодного блоку; механізм з’являється лише тоді, коли блок його називає, і шаблон отримує імена відсортованими, хоч би як він їх читав. Читається з тексту, який написав розробник, ніколи не з розв’язаного значення.
used_byinbound_edge[]ніКомпоненти, що використовують цей компонент: один запис на кожне з’єднання uses, яке інший компонент створює до нього, у порядку запису компонентів, що з’єднуються, а потім у порядку власних записів uses кожного з них. Компонент, що з’єднується двічі, з’являється двічі. Читається лише FeatureRecipe, вкладеним у компонент, і лише в шаблонах, що створюють власні ресурси вкладення, — його valuesMapping, workload і artifacts. Відсутній у шаблонах власного Recipe компонента, в injectMapping і в with та when кроку pipeline, бо вихід кожного з них може потрапити до власного відрендереного виводу компонента, який залишається тим самим, хоч би хто до нього з’єднувався. Кожен запис є елементом списку, а не ключем, тож шаблон, що його перебирає, зустрічає викликачів у цьому порядку.
render_factsrender_factsніТе, що провайдер, який відрендерив цей компонент, повідомив про згенерований ним вивід, — факти рендерингу, які він повідомляє, — з ключами за назвою факту. Які назви повідомляє провайдер і що містить кожен запис — це власний задокументований контракт цього провайдера. Кожне значення є списком, навіть з одним записом, тож шаблон завжди його перебирає; якщо рендеринг компонента потребував більше ніж одного виклику провайдера і ту саму назву повідомили кілька з них, їхні списки об’єднуються в один у порядку виконання викликів. Присутній у кожному шаблоні FeatureRecipe, вкладеного в компонент, — його valuesMapping, workload, artifacts і with та when кроків pipeline, — щойно компонент відрендерено, і порожній, якщо його провайдер нічого не повідомляє, тож назва, яку ніхто не повідомив, читається як порожній список. Відсутній у шаблонах власного Recipe компонента та в injectMapping, які виконуються до рендерингу компонента.

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

template-context.context.annotations

Три каскадні кошики анотацій поточного вузла, розділені за походженням.

ВластивістьТипОбов’язковаОпис
releasemap of stringніРядки фізичної топології, що каскадно надходять від меж Release.
catalogmap of stringніНезмінні внутрішні ознаки, створені архітектором платформи в домені 2.
aggregatemap of stringніКогнітивні метадані, що каскадно надходять від підсистем Aggregate.

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

template-context.context.inject

Попередньо заповнений і перехоплений канал доставки. Спочатку це згенерована компілятором мапа, що зіставляє ключі inject розробника зі значеннями provides цілі. Змінюється на місці глибокими злиттями injectMapping. На момент рендерингу базового Recipe містить повністю розв’язані фізичні рядки.

ВластивістьТипОбов’язковаОпис
envmap of stringніДоставка через змінні середовища. Ключі — локальні імена змінних розробника, значення — розв’язані цільові рядки.
filemap of stringніДоставка через монтування файлів. Ключі — локальні шляхи до файлів, значення — розв’язані цільові рядки.
argmap of stringніДоставка через аргументи командного рядка. Ключі — префікси прапорців, значення — розв’язані цільові рядки.
allmap of stringніПопередньо обчислене пласке злиття механізмів env + file + arg + custom. Заповнюється після розв’язання uses-inject і перераховується після зіставлення inject. Шаблони використовують {{ toJson .context.inject.all }} для універсальної серіалізації.
template-context.context.self_inject

Які з власних values і provides компонента розробник уже наділив іменем доставлення; прочитано з написаного на самому компоненті блоку inject: — блоку, який .inject_raw містить у записаному вигляді, а .context.inject — у розв’язаному. Кожен механізм, який називає блок (env, file, arg або власний, як-от ssm_param), зіставляє кожне ім’я, написане розробником, із власним ключем, який доставляє цей запис, так само як .context.uses..inject зіставляє імена з’єднання з ключами, які вони читають: ‘provides.’ для запису, написаного з from: ; ‘values.’ для запису, шаблон value: якого читає рівно одне з власних values компонента і нічого іншого, де — ключ верхнього рівня цього значення, хоч би який текст чи які функції оточували читання і хоч би як глибоко воно заходило в значення, — ’{{ .values.config.port }}’, ’{{ index .values.config “port” }}’ і ’{{ (default dict .values.config).port }}’ усі зіставляються з ‘values.config’; і порожній рядок для кожного іншого запису — літерала, шаблону, що читає два значення, шаблону, що читає будь-що, крім values, або шаблону, чиє читання values текст не приписує одному ключу верхнього рівня, як-от ’{{ index .values “role” }}’, values, прочитані повністю, або весь контекст, переданий функції. Отже, сутність Recipe, яка доставляє власне значення під типовим іменем, перевіряє, чи якийсь запис уже зіставлено з ‘values.’, і якщо так, пропускає своє типове ім’я, наприклад {{ range $name, $key := .context.self_inject.env }}{{ if eq $key “values.role” }}…{{ end }}{{ end }}. Присутній і порожній, якщо розробник не написав жодного блоку; механізм з’являється лише тоді, коли блок його називає, і шаблон отримує імена відсортованими, хоч би як він їх читав. Читається з тексту, який написав розробник, ніколи не з розв’язаного значення.

ВластивістьТипОбов’язковаОпис
envmap of stringніДоставлення через змінні середовища: ключі — це імена змінних розробника, значення — власний ключ, який доставляє кожен запис.
filemap of stringніДоставлення через монтування файлів: ключі — це шляхи до файлів розробника, значення — власний ключ, який доставляє кожен запис.
argmap of stringніДоставлення через аргументи командного рядка: ключі — це префікси прапорців розробника, значення — власний ключ, який доставляє кожен запис.

template-context.metadata

Метадані сутності Release і компіляції, що надають глобальну ідентичність для детермінованого іменування. Доступні в усіх блоках шаблонів (valuesMapping, injectMapping, pipeline with).

ВластивістьТипОбов’язковаОпис
release_namestringніІм’я Release, що збирається (наприклад, ‘prod-billing’). Використовується Ops для побудови глобально унікальних імен хмарних ресурсів (бакети S3, ролі IAM). У поєднанні з .context.instance_id гарантує унікальність між середовищами.
release_versionstringніСемантична версія Release.
environmentstringніРядок середовища з метаданих Release (наприклад, ‘production’, ‘local’).
aggregate_namestringніІм’я кореневого Aggregate, що компілюється.

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

template-context.inject

Заповнюється лише під час рендерингу прикріплення FeatureRecipe, що містить написаний автором блок inject (наприклад, { env: [ { in: ‘OPENAI_API_KEY’, from: ‘api_token’ } ] }). Відрізняється від .context.inject, який є попередньо наповненим каналом доставки базового компонента з ребер uses. Має значення null або відсутній для прикріплень без написаного автором inject і для базових сутностей Recipes.

ВластивістьТипОбов’язковаОпис
envmap of stringніДоставлення змінних середовища в межах вкладення.
filemap of stringніДоставлення монтованих файлів у межах вкладення.
argmap of stringніДоставлення аргументів у межах вкладення.
allmap of stringніЗгенероване компілятором зручне об’єднання всіх парадигм inject вкладення.

template-context.boundary

Контекст рівня межі — заповнюється лише під час обчислення шаблону, який FeatureRecipe, у якого spec.executionScope має значення ‘boundary’, виконує один раз для межі. FeatureRecipes рівня Component не отримують цієї опори; натомість дані для кожного компонента несуть їхні context.instance_id, context.inject, context.uses та опора .workload. Шаблони FeatureRecipe рівня межі, що виконуються для межі, отримують .boundary.* замість цих опор для окремих компонентів; його injectMapping виконується в контексті кожного компонента, до якого сягає прикріплення, читає ці опори для окремих компонентів і не отримує цієї.

ВластивістьТипОбов’язковаОпис
pathstringніШлях межі Release, до якої приєднано FeatureRecipe: назви меж від зовнішньої до внутрішньої, з’єднані через ’/’ (наприклад, ‘bridge’, ‘bridge/frontend’). Він називає межу, а не каталог, у який записується її вивід; цей каталог задає directory: межі.
assembly_pathstringніКаталог відносно вихідного каталогу збирання, у який збирається власний вивід цього вкладення: обчислені directory: і subDirectory: його межі, тобто каталог, до якого збирання спрямовує цей вивід (наприклад, ‘bridge/compose’). Він точно дорівнює source_assembly_path або target_assembly_path кінцевої точки з’єднання тоді й лише тоді, коли ця кінцева точка рендериться в той самий зібраний файл, тож FeatureRecipe порівнює їх, щоб відрізнити з’єднання у власному файлі від з’єднання в іншому файлі. Непрозорі дані; ядро їх не інтерпретує.
boundary_namestringніІм’я межі (ключ мапи в release.spec.boundaries).
componentsobjectніМапа instance_id → запис для кожного компонента в піддереві межі (рекурсивно, включно з компонентами вкладених меж). Кожен запис містить розв’язаний URI типу компонента, ідентифікатор екземпляра та надані значення з обчислення provides для кожного компонента.
internal_uses_edgesobject[]ніРебра uses, у яких джерело І ціль обидва перебувають у піддереві цієї межі.
outgoing_cross_boundary_uses_edgesobject[]ніРебра uses, джерело яких перебуває в піддереві цієї межі, а ціль — поза ним.
incoming_cross_boundary_uses_edgesobject[]ніРебра uses, у яких ціль перебуває в піддереві, а джерело — поза ним. Використовується агрегаторами на кшталт ingress, яким потрібно знати, хто звертається ззовні.
cross_boundary_uses_edgesobject[]ніЗручне об’єднання вихідних і вхідних ребер, що перетинають межу.
labelsmap of stringніОб’єднання міток компонентів у піддереві зі збереженням авторського порядку.
annotationsmap of stringніВласні анотації межі після розв’язання каскаду.
feature_attachmentstemplate_attachment[]ніВкладення, прикріплені безпосередньо до цієї межі (для перехресних посилань між вкладеннями в області межі), у тій самій формі вкладення, яку містить .features.

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

Визначення

inbound_edge

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

ВластивістьТипОбов’язковаОпис
component_idstringтакСплощений ідентифікатор екземпляра компонента, який з’єднується (напр., ‘frontend’ або ‘data-layer.etl’), — значення, яке шаблон шляху subDirectory читає як .component_id, записане так само, як .context.uses..target записує інший кінець з’єднання.
socketstringтакКатегорія usesSchema, через яку компонент, що з’єднується, встановлює це з’єднання (напр., ‘databases’, ‘apis’).
providesmap of stringтакРозв’язані provides компонента, що з’єднується, звужені до ключів, які оголошує його Component, — ті самі значення, які споживач цього компонента читає в .context.uses..provides. Порожнє, якщо компонент нічого не публікує.
source_namespacestringніПростір імен, у якому розміщено компонент, що з’єднується: анотація aggrega.ai/namespace, яку отримує його власний рендер, — анотації його меж, до яких останніми застосовано анотації його власного запису в Release, тож компонент, чий запис задає або очищає простір імен, несе власне налаштування, а не налаштування своєї межі. Це значення, яке FeatureRecipe з областю дії межі читає як source_namespace у записі того самого з’єднання в списках uses-ребер .boundary. Відсутнє, якщо до компонента, що з’єднується, не застосовується жоден простір імен; перш ніж виводити його, перевірте його за допомогою if або with.
source_boundary_pathstringніРозділений скісними рисками шлях межі Release, що містить компонент, який з’єднується (напр., ‘edge’ або ‘aws-prod/payments’), — значення, яке FeatureRecipe з областю дії межі читає як source_boundary_path у записі того самого з’єднання в списках uses-ребер .boundary.
render_factsrender_factsніЩо рендери компонента, який з’єднується, повідомили про виведений ними результат, з ключами за назвою факту: факти, про які повідомили виклики його власного провайдера, потім факти кожної приєднаної до нього Feature, що рендерилася разом із ним, у порядку рендерингу; списки, які одна назва отримує від кількох із них, об’єднуються в один у тому самому порядку. Кожне значення — список, навіть з одним записом, тож шаблон завжди перебирає його. Присутнє лише для FeatureRecipe, що оголошує readsCallerRenderFacts, — чиї приєднання рендеряться після того, як відрендерилися всі компоненти, тож рендер кожного викликача завершено, — і тоді в кожному записі, порожнє для викликача, чиї провайдери ні про що не повідомляють. Відсутнє для будь-якого іншого FeatureRecipe.

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

render_facts

Факти рендерингу з ключами за назвою: що провайдери, які рендерили компонент, повідомили про виведений ними результат. Про які назви повідомляє провайдер і що містить кожен запис, визначає власний задокументований контракт цього провайдера; компілятор не дізнається про це нічого, крім того, що кожне значення — список. Список зберігає порядок своїх записів. Запис-об’єкт передається з ключами в тому порядку, в якому їх записав провайдер, а шаблон, що його перебирає, отримує їх у порядку ключів, як і кожну мапу з ключами в цьому контексті.

Об’єкт довільної форми; значення мають тип any[].

template_attachment

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

ВластивістьТипОбов’язковаОпис
typestringніURI Feature в Catalog для приєднаної Feature.
resolved_versionstringніВерсія приєднаної Feature після розв’язання Manifest — версія, фактично зв’язана для цієї збірки, яку читають як .features..resolved_version. Відповідає .context.uses..resolved_version, тож приєднання і ребро повідомляють зв’язану версію однаково. Порожня, якщо тип приєднання не розв’язується до жодної сутності Catalog.
labelsmap of stringніМітки Catalog приєднаної Feature, передані дослівно в тому порядку, в якому їх оголошує Feature, — нічого не відфільтровано, не перейменовано й не позбавлено префікса, тож шаблон читає саме те, що написав автор Feature. Дає шаблону змогу розгалужуватися залежно від того, чим є приєднана Feature, а не від її назви чи URI. Відповідає .context.uses..labels. Ключ повністю відсутній, якщо Feature не оголошує міток і якщо тип приєднання не розв’язується до жодної сутності Catalog, тож перш ніж звертатися до окремої мітки, перевірте за допомогою if або переберіть мапу.
valuesobjectніВласна опора намірів розробника для приєднання, передана дослівно з оголошення приєднання.
infraobjectніВласна опора операційного розміру для приєднання, передана дослівно з оголошення приєднання.
providesmap of stringніРозв’язаний публічний контракт FeatureRecipe, зв’язаного з цим приєднанням, — назва виведеного ресурсу, його ключ, ідентичність і будь-які додаткові створені ключі, — наданий споживачеві як .features..provides.. Споживач читає ці значення замість того, щоб повторно виводити фізичну ідентичність приєднання. Приєднання, чий зв’язаний FeatureRecipe нічого не публікує, взагалі не має ключа provides, а не має порожню мапу, тож шаблон виконує перевірку, перш ніж звертатися до окремого ключа.

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

enriched_edge

Одне збагачене топологічне ребро, зібране компілятором. Містить розв’язану ідентичність цілі, provides і каскадні анотації.

ВластивістьТипОбов’язковаОпис
targetstringтакАбсолютний сплощений ID цільового вузла (наприклад, ‘data-layer.main-db’).
socketstringтакКатегорія usesSchema, до якої належить це ребро (наприклад, ‘databases’, ‘apis’).
sourcestringніАбсолютний сплощений ID вихідного (споживацького) вузла. Заповнюється для представлень рівня межі, які впорядковують виходи для кожного споживача за вузлом-споживачем.
source_namespacestringніНеоброблена анотація aggrega.ai/namespace вихідної кінцевої точки (порожня, якщо її немає). Заповнюється лише для представлень рівня межі, як і source; власний запис .context.uses компонента містить її порожньою. Непрозорі дані для розв’язання мережевої ідентичності провайдером; ядро їх не інтерпретує.
source_boundary_pathstringніШлях межі вихідної кінцевої точки: розділений скісними рисками шлях межі Release, що її містить (наприклад, ‘bridge/frontend’). Заповнюється лише для представлень рівня межі, як і source; власний запис .context.uses компонента містить його порожнім.
source_assembly_pathstringніШлях збирання вихідної кінцевої точки: каталог відносно вихідного каталогу збирання, у який збирається її вивід, складений з обчислених directory: і subDirectory: її межі (наприклад, ‘bridge/compose’). Дві кінцеві точки з одним шляхом збирання рендеряться в один зібраний файл, а кінцева точка, шлях збирання якої дорівнює .boundary.assembly_path, рендериться у файл, у який збирається власний вивід FeatureRecipe, що її читає. FeatureRecipe рівня межі, що розміщує кінцеві точки в мережах, може читати його як мережу вихідної кінцевої точки, коли aggrega.ai/namespace не застосовується. Заповнюється лише для представлень рівня межі, як і source; власний запис .context.uses компонента містить його порожнім. Непрозорі дані; ядро їх не інтерпретує.
target_namespacestringніНеоброблена анотація aggrega.ai/namespace цільової кінцевої точки (порожня, якщо її немає). Заповнюється лише для представлень рівня межі, як і source; власний запис .context.uses компонента містить її порожньою. Непрозорі дані для розв’язання мережевої ідентичності провайдером.
target_boundary_pathstringніШлях межі цільової кінцевої точки: розділений скісними рисками шлях межі Release, що її містить (наприклад, ‘bridge/backend’). Заповнюється лише для представлень рівня межі, як і source; власний запис .context.uses компонента містить його порожнім.
target_assembly_pathstringніШлях збирання цільової кінцевої точки: каталог відносно вихідного каталогу збирання, у який збирається її вивід, складений з обчислених directory: і subDirectory: її межі (наприклад, ‘bridge/compose’). Кінцева точка, шлях збирання якої дорівнює .boundary.assembly_path, рендериться у файл, у який збирається власний вивід FeatureRecipe, що її читає. FeatureRecipe рівня межі, що розміщує кінцеві точки в мережах, може читати його як мережу цільової кінцевої точки, коли aggrega.ai/namespace не застосовується. Заповнюється лише для представлень рівня межі, як і source; власний запис .context.uses компонента містить його порожнім. Непрозорі дані; ядро їх не інтерпретує.
providesmap of stringтакПовністю розв’язаний словник provides цільового вузла. Обчислюється на етапі обчислення provides, до гідратації inject.
injectobjectтакПочаткове відображення inject розробника для цього ребра (ключі = імена локальних змінних, значення = ключі provides цілі). Це НЕОБРОБЛЕНЕ відображення, а не розв’язані значення.
labelsmap of stringніМітки качиної типізації та онтології цільового вузла (після мутації під час побудови топології).
annotationsobjectніТри каскадні групи анотацій цільового вузла.
componentstringніURI типу компонента Catalog цільового вузла (наприклад, ‘core/postgres’).
resolved_versionstringніРозв’язана версія SemVer цільового вузла.
boundary_pathstringніФізична просторова ієрархія цільового вузла із сутності Release (наприклад, ‘aws-eks-cluster/backend-ns’).
origin_featurestringніЯкщо це ребро автономно оголосила сутність Feature (зокрема сутності Features облікових даних із міткою feature.aggrega.ai/kind: secret), — ім’я екземпляра Feature. Null/відсутнє для ребер, оголошених розробником.
origin_releaseбулеваніTrue, якщо це з’єднання підключила сутність Release, а не оголосила сутність Aggregate. Відсутнє для з’єднання, яке оголошує Aggregate.
valuesobjectніКонфігурація розробника для окремого з’єднання, задана в записі uses сутності Aggregate для цього з’єднання, передана дослівно. Відсутня, якщо з’єднання її не містить. Вона потрапляє лише в контекст вузла-споживача, ніколи не в контекст цілі.
infraobjectніОпераційна конфігурація для окремого з’єднання, задана в записі uses сутності Release для цього з’єднання, передана дослівно. Відсутня, якщо з’єднання її не містить. Вона потрапляє лише в контекст вузла-споживача, ніколи не в контекст цілі.
featuresmap of template_attachmentніПрикріплення, записані на цьому з’єднанні, за ключем імені слота, який сокет з’єднання оголошує для кожного, кожне у формі прикріплення, яку містить .features: його тип, розв’язана версія, мітки, values, infra і розв’язані provides прив’язаної до нього сутності FeatureRecipe. Сутність Recipe читає облікові дані з’єднання як .context.uses..features..provides., тож споживач, що звертається до кількох цілей, читає власні облікові дані кожної цілі. Ці прикріплення ніколи не входять до власного .features вузла-споживача, тому шаблон, який перебирає .features, щоб знайти прикріплення вузла за типом, не зустрічає прикріплень з’єднання. Під час перебору в шаблоні слоти надходять у порядку ключів. Відсутні, якщо з’єднання їх не містить.
render_factsrender_factsніЩо рендери цілі повідомили про згенерований ними вихід, за ключем імені факту, у формі, яку містить запис викликача в .context.used_by: спершу факти, повідомлені викликами її власного провайдера, потім факти кожної прикріпленої до неї сутності Feature, що рендерилася разом із нею, у порядку рендерингу; списки, які одне ім’я отримує від кількох із них, об’єднуються в один у цьому порядку. Кожне значення — список, навіть з одним записом, тож шаблон завжди перебирає його. Присутнє лише в .context.uses для сутності FeatureRecipe, яка оголошує readsTargetRenderFacts, — її прикріплення рендеряться, коли всі компоненти вже відрендерено, тож рендер кожної цілі завершено, — і тоді в кожному записі, порожнє для цілі, провайдери якої нічого не повідомляють. Відсутнє для будь-якої іншої FeatureRecipe, у with і when кроку конвеєра, у власних шаблонах Recipe компонента та в списках ребер, які читає FeatureRecipe рівня межі.

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

enriched_edge.inject

Початкове відображення inject розробника для цього ребра (ключі = імена локальних змінних, значення = ключі provides цілі). Це НЕОБРОБЛЕНЕ відображення, а не розв’язані значення.

ВластивістьТипОбов’язковаОпис
envmap of stringніДоставка через змінні середовища: ключі — імена локальних змінних споживача, значення — ключі provides цілі.
filemap of stringніДоставка через монтування файлів: ключі — локальні шляхи до файлів споживача, значення — ключі provides цілі.
argmap of stringніДоставка через аргументи командного рядка: ключі — префікси прапорців споживача, значення — ключі provides цілі.

enriched_edge.annotations

Три каскадні групи анотацій цільового вузла.

ВластивістьТипОбов’язковаОпис
releasemap of stringніРядки фізичної топології з меж сутності Release цільового вузла.
catalogmap of stringніНезмінні характеристики із сутності Catalog цільового вузла.
aggregatemap of stringніКогнітивні метадані з підсистем сутності Aggregate цільового вузла.

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