Перейти к содержимому
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 с областью boundary (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 evaluation (преамбула locals, затем provides): только локальные для узла столпы. Запись locals читает записи выше неё в своём блоке; шаблон provides читает все разрешённые .locals узла. Ссылка на себя запрещена (ни одна запись provides не читает другую).
  • Source resolution (публикация locals + вычисление source): все столпы; .source и .workload отсутствуют. Здесь эти locals публикуются в .locals, затем source: вычисляется с их использованием.
  • Values mapping (valuesMapping): все столпы + .source; .workload отсутствует.
  • Workload synthesis (вычисление workload): все столпы + .source; .workload вычисляется (недоступен для ссылки на себя).
  • Artifact evaluation (artifacts): все столпы + .source + .workload (наиболее полный контекст).

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

Свойства

СвойствоТипОбязательноОписание
contextobjectдаСобранный компилятором контекст выполнения, содержащий данные об идентичности, топологии и доставке.
valuesobjectдаНепрозрачная когнитивная полезная нагрузка для этого узла, уже проверенная валидатором схемы при разрешении. Передаётся без изменений.
infraobjectдаФизическая полезная нагрузка с параметрами размеров, внедряемая из Release для этого узла. Полностью минует разработчика.
localsmap of stringдаСобственное приватное состояние Recipe (например, primary_compute, volumes_path). Вычисляется в преамбуле locals — до provides этого узла — и публикуется в этот столп при разрешении источника. Каждая запись — это 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: сущности Recipe после вычисления Go-шаблона, доступно начиная с сопоставления значений (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: сущности Recipe после вычисления Go-шаблона и проверки Workload по JSON Schema (по workload-v1beta1.schema.json). Доступно начиная с вычисления артефактов (artifacts), чтобы артефакты могли ссылаться на поля рабочей нагрузки без дублирования (например, 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даАбсолютный «плоский» ID текущего узла (например, ‘backend’ или ‘data-layer-zdmain-db’ для компонента main-db экземпляра модуля data-layer), записанный в алфавите, которому удовлетворяет любое заданное автором имя компонента. Детерминирован и стабилен между компиляциями для одного и того же Aggregate. Это имя ресурсов, построенных для этого узла, для которых ни один провайдер не выводит имя, — набора артефактов, размещённого из Recipe, и рабочей нагрузки, синтезированной провайдером, который называет её по идентичности, — поэтому адрес, публикуемый для одного из них, строится из этого значения.
rendered_namestringнетИмя, которое провайдер, привязанный к этому узлу, даёт ресурсам, отрисовываемым им для узла: для исходного кода, предоставленного автором, — имя, относительно которого отрисовываются сами предоставленные шаблоны, например имя релиза, которое читает чарт; для синтезируемой им рабочей нагрузки — имя, которое он даёт ресурсам этой рабочей нагрузки, если выводит его, а не записывает идентичность узла, как это делает провайдер helm с тем же именем релиза. Читайте его везде, где этот Recipe называет ресурс, объявленный предоставленным чартом или модулем либо синтезированный таким провайдером, — в записи provides, в valuesMapping, в workload, в записи artifacts или в with или when шага конвейера, — поскольку провайдер может записывать это имя в более бедном алфавите, чем тот, в котором записывается заданное автором имя компонента, и тогда они различаются. Пусто, если привязанный провайдер не выводит такого имени: ресурсы размещённого набора артефактов и рабочей нагрузки, синтезированной провайдером, который называет её по идентичности, несут идентичность узла, поэтому для них читайте ’{{ .context.instance_id }}’, а Recipe, который сам записал имена своих ресурсов, уже знает их. Чтение этого ключа там, где привязанный провайдер не сообщает имени, останавливает сборку с указанием того, что следует написать вместо него. Этот отказ распространяется на шаблоны, которые Recipe записывает встроенно; valuesMapping, workload или запись artifacts, предоставленные через ‘$import’, разрешаются только тогда, когда до них доходит отрисовка, поэтому ссылка внутри них отрисовывается как пустое значение, а не останавливает сборку. В шаблонах FeatureRecipe, привязанного к вложению компонента, это имя компонента-ХОСТА в том виде, в каком его сообщает собственный провайдер хоста, — значение, которое читает собственный Recipe хоста, так же как instance_id там является идентичностью хоста, — поэтому вложение называет ресурс по своему хосту с его помощью и получает имя, которое принимает платформа хоста. Если провайдер хоста не сообщает имени, значение пусто, и его чтение из встроенного шаблона вложения, отличного от его injectMapping, останавливает сборку; читайте там вместо него ’{{ .context.instance_id }}’.
labelsmap of stringнетМетки утиной типизации и онтологии текущего узла, включая любые изменения, внесённые при построении топологии плагином управления, прикреплённым в роли 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 шага конвейера, поскольку результат каждого из них может попасть в собственный отрисованный вывод компонента, который остаётся одинаковым, кто бы к нему ни подключался. Каждая запись — элемент списка, а не ключ, поэтому шаблон, перебирающий его, встречает вызывающих в этом порядке.
render_factsrender_factsнетТо, что провайдер, отрисовавший этот компонент, сообщил о сформированном им выводе, — сообщаемые им факты отрисовки, — с ключами по имени факта. Какие имена сообщает провайдер и что содержит каждая запись, определяется собственным документированным контрактом этого провайдера. Каждое значение — список, даже из одной записи, поэтому шаблон всегда перебирает его; если отрисовка компонента потребовала более одного вызова провайдера и одно имя было сообщено несколькими из них, их списки объединяются в один в порядке выполнения вызовов. Присутствует во всех шаблонах FeatureRecipe, вложенного в компонент, — его valuesMapping, workload, artifacts и with и when шагов конвейера — после того как компонент отрисован, и пусто, если его провайдер ничего не сообщает, поэтому имя, которое никто не сообщил, читается как пустой список. Отсутствует в шаблонах собственного 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 + пользовательских. Заполняется после разрешения 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 типа компонента, его ID экземпляра и предоставляемые значения, полученные при вычислении 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 в каталоге для присоединённой 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 целевого узла.

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