Схема контексту шаблонів шляхів Aggrega
Згенерований довідник. Не редагуйте вручну — згенеруйте повторно з опублікованої JSON Schema.
Ідентифікатор схеми: https://aggrega.ai/schemas/path-template-context-v1beta1.schema.json
Список дозволених змінних, який використовують шаблони Go, що обчислюються для Release.spec.boundaries[].directory і Release.spec.boundaries[].subDirectory (а також для перевизначення subDirectory для окремого компонента), коли Aggrega збирає Release. Шаблони шляхів використовують missingkey=error (на відміну від глобального режиму missingkey=zero для шаблонів значень), а також перевірку під час розбору: кожне посилання на поле в шаблоні шляху має бути в цьому списку дозволених для відповідного контексту (directory: чи subDirectory:); невідомі поля спричиняють помилку Loud Guardrail під час розбору, а не під час рендерингу. Відмінність від шаблонів значень пояснює сторінка «Змінні шаблонів шляхів» довідника мови.
Тип верхнього рівня: object
Властивості
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
capability | string | ні | Доступно в directory: ТА subDirectory:. Можливість рендерингу, яку Recipe компонента-учасника оголошує в spec.capability, без закріплення версії — наприклад, ‘helm’, ‘helm-chart’ або ‘compose’. Для subDirectory: типове значення — {{ .capability }}, завдяки чому артефакти кожної можливості потрапляють до власної підтеки в каталозі межі. У шаблоні directory: значення обчислюється для кожного компонента окремо, тож межа, піддерево якої додає більше ніж одну можливість, дає по одному каталогу на кожну можливість; окремий обхід меж, який публікує .parent_boundary.directory, виконується до прив’язування будь-якого компонента й залишає це значення порожнім. |
boundary_name | string | ні | Доступно в directory: ТА subDirectory:. Ключ мапи в release.spec.boundaries. |
parameters | object | ні | Доступно в directory: ТА subDirectory:. Типізована мапа параметрів із сутності Release. Шаблони шляхів отримують доступ до .parameters як навмисний виняток із однопрохідного життєвого циклу parameters — шаблони значень НЕ отримують .parameters; значення, що залежать від середовища, потрапляють до шаблонів значень через уже інтерпольований YAML сутності Aggregate. |
component_id | string | ні | Доступно ЛИШЕ в subDirectory:. Ідентичність учасника, якого розміщують. Для компонента — його сплощений ідентифікатор екземпляра на рівні компонента (наприклад, ‘backend’ або ‘data-layer.main-db’). Для сутності Feature, приєднаної на межі, сутність FeatureRecipe якої виконується один раз для межі (executionScope: boundary), — складена ідентичність компонента, яку кожен ресурс, що його випускає це приєднання, несе у своїй мітці aggrega.ai/component-id (наприклад, ‘bfr—app—shared’ для приєднання ‘shared’ на межі ‘app’), скорочена там, де плагін рендерингу приєднання обмежує імена, щоб каталог, який вона називає, збігався з цією міткою. Не має сенсу на рівні межі й відхиляється перевіркою під час розбору в шаблонах directory:. |
parent_boundary | object | ні | Доступно в directory: ТА subDirectory:. Уже обчислені значення батьківської межі. Заповнюються обходом у глибину, який обчислює шаблони кожної межі з обчисленими значеннями її батьківської межі; дочірні межі ніколи не бачать тут власних значень. Межа верхнього рівня не має батьківської, тож читання ключа під parent_boundary у ній зупиняє збірку із зазначенням межі, поля шаблону та відсутнього ключа. |
manifest | object | ні | Доступно в directory: ТА subDirectory:. Містить обчислені метадані Recipe, визначені для кожного компонента окремо. |
Додаткові властивості не дозволені.
path-template-context.parent_boundary
Доступно в directory: ТА subDirectory:. Уже обчислені значення батьківської межі. Заповнюються обходом у глибину, який обчислює шаблони кожної межі з обчисленими значеннями її батьківської межі; дочірні межі ніколи не бачать тут власних значень. Межа верхнього рівня не має батьківської, тож читання ключа під parent_boundary у ній зупиняє збірку із зазначенням межі, поля шаблону та відсутнього ключа.
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
directory | string | ні | Обчислений рядок directory батьківської межі. |
boundary_name | string | ні | Ім’я батьківської межі (ключ мапи в release.spec.boundaries). |
parameters | object | ні | Мапа параметрів Release — та сама мапа, яку несе .parameters. |
annotations | map of string | ні | Анотації батьківської межі після розв’язання каскаду. |
Додаткові властивості не дозволені.
path-template-context.manifest
Доступно в directory: ТА subDirectory:. Містить обчислені метадані Recipe, визначені для кожного компонента окремо.
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
recipe_name | string | ні | Ім’я обчисленої сутності Recipe, отримане з пошуку для окремого компонента. |
Додаткові властивості не дозволені.