Схема Aggrega Wasm Provider Render Socket
Сгенерированный справочник. Не редактируйте вручную — сгенерируйте заново из опубликованной JSON Schema.
Идентификатор схемы: https://aggrega.ai/schemas/wasm-provider-v1beta1.schema.json
Формы передаваемых данных, которые принимает и выдаёт сокет плагина рендеринга Provider. Гостевой модуль Provider рендерит один узел IR в выходные файлы через свой экспорт render_node (из RenderNodeInput в RenderNodeOutput) и, при необходимости, объединяет выходные данные отдельных узлов на одной границе в единый собранный артефакт через свой экспорт assemble_boundary (из AssembleBoundaryInput в AssembleBoundaryOutput). AssembleBoundaryOutput содержит собранные файлы и все диагностические сообщения; расположение файлов каждого участника объявляется один раз в контракте describe() гостевого модуля, а не в этом ответе. Гостевой модуль может также объявить необязательный экспорт validate_node_input, который структурно проверяет разрешённые входные данные узла перед диспетчеризацией рендеринга: он принимает ту же проекцию RenderNodeInput, что и render_node, и возвращает ValidateNodeOutput, содержащий только диагностические сообщения: диагностика с уровнем halt явно останавливает сборку, а диагностика с уровнем warn передаётся в результат сборки. Гостевой модуль, целевая платформа которого ограничивает или сужает допустимые имена, может также объявить необязательный экспорт name_bound, к которому хост обращается, прежде чем установить идентичность компонента узла: он принимает NameBoundInput с одним предлагаемым именем и возвращает NameBoundOutput с одним вердиктом для каждого вида имени, которое гостевой модуль из него выведет. Вердикт содержит ограничение — имя пригодно или ограничено меньшей длиной — и никогда не содержит имени, построенного гостевым модулем, поэтому знание о том, что допускает целевая платформа, остаётся в гостевом модуле. Отдельно от этого гостевой модуль, целевая платформа которого выводит собственное имя для рендерящихся ресурсов — из предоставленного автором исходного кода или из синтезируемой им рабочей нагрузки, — может объявить необязательный экспорт rendered_name, к которому хост обращается, чтобы автор Recipe мог прочитать это имя и опубликовать построенный на его основе адрес: он принимает RenderedNameInput с идентичностями, из которых целевая платформа выводит имя, и видами входных данных, которые объявляет Recipe узла, и возвращает RenderedNameOutput с именем, под которым гостевой модуль сам выполнит рендеринг, или без имени, если он его не выводит. Эти два экспорта — противоположные направления одной темы, и ни один не заменяет другой: name_bound просит гостевой модуль оценить имя, предложенное хостом, а rendered_name сообщает имя, составленное гостевым модулем, которое хост передаёт, не читая. Гостевой модуль может также объявить carve и reassemble, которые разрезают его собственный вывод на адресуемые единицы для шага конвейера и сшивают изменённые единицы обратно, а также link_publish и link_resolve, которые связывают ребро uses, концы которого собираются в разные группы диспетчеризации. Форма каждой полезной нагрузки — это определение, которое называет её экспорт: таблица x-aggrega-exports сопоставляет каждый экспорт, через который хост вызывает гостевой модуль, — включая carve и reassemble — с определением его входных данных и определением его выходных данных, каждое в виде JSON Pointer в $defs этого документа, поэтому инструмент, проверяющий полезную нагрузку, ищет её определение там. Корень документа не объявляет собственной формы, поскольку один документ может быть допустимой полезной нагрузкой нескольких экспортов (пустой объект — допустимый ответ и от validate_node_input, и от name_bound, и от rendered_name). Гостевой модуль возвращает сериализованные байты каждого выходного файла; хост записывает их без изменений и не запускает сериализатор, поэтому за детерминированность отвечает гостевой модуль: одинаковые входные данные должны давать одинаковые байты. Типы полезной нагрузки для Go, Rust и TypeScript генерируются из этой схемы в пакеты plugin-ABI, поэтому все три языка читают и записывают одни и те же передаваемые данные; гостевой модуль импортирует их из этих пакетов или через свой набор для разработки плагинов, если тот их реэкспортирует.
Экспорты
Таблица x-aggrega-exports схемы сопоставляет каждый экспорт, через который хост вызывает гостевой модуль, с определением его входных данных и определением его выходных данных. Форма полезной нагрузки — это определение, которое называет её экспорт.
| Экспорт | Вход | Вывод |
|---|---|---|
render_node | RenderNodeInput | RenderNodeOutput |
validate_node_input | RenderNodeInput | ValidateNodeOutput |
assemble_boundary | AssembleBoundaryInput | AssembleBoundaryOutput |
carve | CarveInput | CarveOutput |
reassemble | ReassembleInput | ReassembleOutput |
name_bound | NameBoundInput | NameBoundOutput |
rendered_name | RenderedNameInput | RenderedNameOutput |
link_publish | LinkPublishInput | LinkPublishOutput |
link_resolve | LinkResolveInput | LinkResolveOutput |
Определения
RenderNodeInput
Полезная нагрузка, которую гость Provider получает в своём экспорте render_node: проекция IR для отдельного узла, которую рендерит гость, контекст времени рендеринга, предварительно вычисленные входные данные, объявленные связанным с узлом Recipe, — листинг полученного источника, рабочая нагрузка, набор артефактов, — каждое из которых присутствует только тогда, когда этот Recipe его объявляет, а также записи, именующие отрендеренные единицы, которые гость исключает из рендеринга источника.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
node | IRNodeProjection | да | Данные IR для отдельного узла, которые рендерит гость Provider, — ограниченная проекция полного узла IR, несущая идентичность узла и сведения о происхождении, которые гость проставляет на каждый выпускаемый манифест: его id, тип, разрешённый рецепт, значения, признак того, были ли эти значения получены сопоставлением значений, подключения фич, пометку чувствительности для его отрендеренных ключей и для значений в целом, исходящие рёбра uses, путь границы, волну синхронизации, идентичность Recipe, переопределение component-id, основу производных имён и сведения о происхождении сборки. Идентичность и основа производных имён передаются отдельно, поскольку отвечают на два вопроса — чему принадлежит ресурс и относительно чего рендерится собственный источник автора, — и именно подключение Feature, доставляющее источник, написанный его автором, является случаем, когда эти два ответа различаются. Содержимое исходных файлов здесь не передаётся; оно передаётся отдельно в проекции источника. Каждый набор ключей здесь имеет фиксированный порядок — фичи и uses в авторском порядке, значения и пометка чувствительности в отсортированном порядке ключей, — поэтому передаваемая полезная нагрузка побайтно идентична между запусками на одинаковых входных данных. |
context | object | да | Контекст времени рендеринга, который хост передаёт гостевому модулю, в виде байтов его JSON-документа; эта схема не объявляет этот объект. Это контекст, который получает шаг конвейера того же узла, плюс ширина отступа: parameters — значения параметров Release, отсортированные по имени, отсутствующие, если их нет; annotations — аннотации узла, разделённые по месту записи на aggregate, release и catalog, каждая отсутствует, если пуста; boundary — граница, в которой находится узел: name, path (его сегменты), sync_wave (отсутствует при 0), directory, sub_directory (отсутствует, если его нет) и annotations (набор, который границы Release каскадно передают узлу, причём аннотации собственной записи Release накладываются последними; отсутствует, если пуст); и yaml_indent — ширина отступа для всего рендеринга, с которой гостевой модуль сериализует свой вывод. Рендеринг сущности FeatureRecipe с областью границы, у которой нет компонента-хоста, получает контекст, который получает её шаг конвейера, плюс yaml_indent: parameters; annotations, содержащие только корзину release, то есть собственный набор аннотаций границы; и boundary, содержащую её name, path и тот же набор в качестве annotations. Общеизвестные аннотации aggrega.ai/* читаются из корзины aggregate, поверх которой записана корзина release, поэтому ключ, присутствующий в обеих, получает значение Release; провайдер стандартной библиотеки читает их из этого наложенного набора и никогда — из корзины catalog, поэтому значение из каталога никогда не определяет ни одну из них, а FeatureRecipe с областью границы, контекст которой не содержит корзины aggregate, рендерится по значениям своей границы, а не какого-либо компонента. |
source_listing | SourceListing | нет | Обобщённое перечисление полученного источника, которое хост передаёт гостю для провайдера с источником: корень источника, признак того, является ли этот корень каталогом, и отсортированные записи относительно корня под ним. Хост не читает здесь содержимое файлов — он перечисляет только имена. Гость применяет к листингу собственную логику разрешения и просит хост упаковать выбранное подмножество через хост-функцию pack-source, поэтому вся логика разрешения источников, специфичная для провайдера, находится в госте. Присутствует для провайдеров с источником; в остальных случаях отсутствует. |
workload_projection | WorkloadProjection | нет | Предварительно вычисленная рабочая нагрузка, которую хост передаёт гостю для синтеза нативных для провайдера манифестов; присутствует, когда связанный Recipe объявляет рабочую нагрузку, а не источник чарта, в остальных случаях отсутствует. |
artifacts_projection | ArtifactsProjection | нет | Предварительно вычисленный набор артефактов, который хост передаёт гостю для размещения в выходных данных узла; присутствует, когда связанный Recipe объявляет артефакты. Хост уже прочитал источник каждой записи, вычислил его как шаблон Go относительно контекста рендеринга и вычислил наборы ключей происхождения сборки; гость определяет формат вывода, размещение сведений о происхождении, путь на диске и итоговые байты. Отсутствует, когда узел не объявляет артефактов. |
omits | OmitEntry[] | нет | Записи, именующие отрендеренные единицы, которые гость исключает из выходных данных этого узла, в порядке, в котором их объявил автор. Каждая запись поступает уже разрешённой, её поля — простые строки, а запись, не относящаяся к данной сборке, не передаётся. Что выбирают вид, имя, пространство имён и сабчарт записи, определяется собственным документированным контрактом этого провайдера, а не этого сокета: гость сопоставляет каждую запись с тем, что он отрендерил, в терминах своего формата, исключает каждую единицу, совпавшую с записью, из всего, что он возвращает, — своих файлов, имён, объявляемых в derived_keys, и фактов, сообщаемых в render_facts, — и сообщает в поле omitted выходных данных, сколько единиц совпало с каждой записью. Записи сопровождают листинг источника и никакие другие входные данные: рендеринг синтезированной рабочей нагрузки или набора артефактов никогда их не несёт. Отсутствует, когда записей нет, и гость, не получивший ни одной, рендерит точно так же, как если бы этого поля не существовало. |
Дополнительные свойства не допускаются.
IRNodeProjection
Данные IR для отдельного узла, которые рендерит гость Provider, — ограниченная проекция полного узла IR, несущая идентичность узла и сведения о происхождении, которые гость проставляет на каждый выпускаемый манифест: его id, тип, разрешённый рецепт, значения, признак того, были ли эти значения получены сопоставлением значений, подключения фич, пометку чувствительности для его отрендеренных ключей и для значений в целом, исходящие рёбра uses, путь границы, волну синхронизации, идентичность Recipe, переопределение component-id, основу производных имён и сведения о происхождении сборки. Идентичность и основа производных имён передаются отдельно, поскольку отвечают на два вопроса — чему принадлежит ресурс и относительно чего рендерится собственный источник автора, — и именно подключение Feature, доставляющее источник, написанный его автором, является случаем, когда эти два ответа различаются. Содержимое исходных файлов здесь не передаётся; оно передаётся отдельно в проекции источника. Каждый набор ключей здесь имеет фиксированный порядок — фичи и uses в авторском порядке, значения и пометка чувствительности в отсортированном порядке ключей, — поэтому передаваемая полезная нагрузка побайтно идентична между запусками на одинаковых входных данных.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
id | string | да | Абсолютный id узла в графе топологии. |
type | string | да | Объявлено и намеренно не передаётся: хост всегда выдаёт здесь пустую строку. Метка типа компонента узла — непрозрачные метаданные, а не переключатель поведения, поэтому её передача здесь лишь побуждала бы гостя ветвиться по ней. Гость читает пустую строку и не должен трактовать её как узел, у которого тип компонента не задан. (Форма узла для сборки границы несёт собственный тип, для другой цели.) |
resolved_recipe | string | да | Объявлено и намеренно не передаётся: хост всегда выдаёт здесь пустую строку. Идентичность связанного Recipe уже доходит до гостя в виде имени и версии рецепта, которые он проставляет в сведения о происхождении, поэтому разрешённый URI не добавляет ничего, из чего гость рендерит. Гость, которому нужно отнести выходные данные к Recipe, читает вместо этого эти поля происхождения. |
values | object | нет | Словарь отрендеренных значений узла — набор ключей, из которого рендерит гость. Ключи поступают в отсортированном порядке, а не в авторском, и именно эта сортировка делает полезную нагрузку побайтно идентичной между запусками на одинаковых входных данных; гость, которому нужен иной порядок, устанавливает его сам. |
features | object | нет | Подключения фич узла с ключами по псевдониму фичи, несущие ту же форму подключения фичи для узла, что и IR. Каждая запись несёт значения, infra и сопоставление inject подключения вместе с его производной пометкой чувствительности, поэтому гость по одной лишь полезной нагрузке определяет, обрабатывает ли подключение материал, объявленный чувствительным. Сохраняет авторский порядок, чтобы полезная нагрузка была побайтно идентичной между запусками на одинаковых входных данных. На этом уровне схемы непрозрачно; гость читает форму записи фичи через контракт передачи IR. |
sensitive_rendered_keys | map of string | нет | Отрисованные ключи, идентичность которых восстановлена из данных, объявленных автором как чувствительные; каждый сопоставлен с объявлением, от которого он унаследовал эту чувствительность. Передаётся от хоста к гостю во входных данных отрисовки — в направлении, противоположном именам, которые гость объявляет в выходных данных отрисовки. Что именует ключ, зависит от формы, которую несёт эта полезная нагрузка: в полезной нагрузке со значениями узла это один из ключей этой карты; в полезной нагрузке с рабочей нагрузкой он именует запись в собственных картах вложений рабочей нагрузки, где значения узла пусты. Ключ присутствует только там, где восстановление точное: объявление связывается с отрисованной идентичностью без чтения чего-либо из собственного текста ключа и без распространения маркировки на уровне узла или вложения на отдельные ключи. Поэтому ключ, придуманный шаблоном, отсутствует, так как его не называет ни одно объявление: выходные ключи valuesMapping рецепта и содержимое артефакта создаются шаблоном, поэтому ни то, ни другое не даёт здесь ключа — была ли такая полезная нагрузка получена из значения, объявленного чувствительным, передаётся вместо этого в sensitive_values и в собственном sensitive_content записи артефакта. Таким образом, отсутствие означает, что идентичность ни одного ключа не удалось восстановить, но никогда — что ничто в этой полезной нагрузке не содержит чувствительных данных: гость, который считает отсутствие ключа разрешением показать или вывести значение в открытом виде, понял его наоборот. Ключи поступают в отсортированном порядке, благодаря чему полезная нагрузка побайтно идентична между запусками на одинаковых входных данных. |
sensitive_values | логическая | нет | True, если значения, которые несёт эта полезная нагрузка, получены шаблоном, читающим значение, объявленное автором как чувствительное, или значение, прослеживаемое до такого: valuesMapping сущности Recipe или FeatureRecipe — единственный шаблон, выходные ключи и значения которого являются его собственным изобретением, поэтому ни один ключ этого вывода нельзя проследить до исходных данных и вместо этого маркируется вся карта. Это определяется по собственным ссылкам шаблона относительно объявлений — учитываются ссылка, достигающая объявленного значения, передача шаблоном всех своих данных целиком или шаблон, который не удаётся разобрать, — и никогда по содержимому значения или имени ключа. Гость, составляющий текст для чтения человеком, — отказ или предупреждение, — исключает из этого текста все значения узла, когда это поле равно true, и исключает значение под любым ключом, названным в sensitive_rendered_keys, независимо от этого поля: они дополняют друг друга — одно называет ключи, идентичность которых восстановлена точно, а это покрывает карту там, где это невозможно. Отсутствует, если ни один такой шаблон не читал такое значение, в том числе для значений, которые сами являются объявленными листьями и вместо этого маркируются по ключам в sensitive_rendered_keys, а также в полезной нагрузке без значений. Отсутствие никогда не означает, что ни одно значение не является чувствительным. |
values_mapped | логическая | нет | True, если значения, которые несёт эта полезная нагрузка, являются выводом valuesMapping связанной сущности Recipe или FeatureRecipe, а не значениями узла, переданными в том виде, в каком их написал автор. Гость, собственный контракт которого связывает с входными данными, объявленными его источником, только значения, полученные сопоставлением, читает это поле и оставляет непрочитанными значения, написанные для другого, например для артефактов сущности Recipe; гость, который связывает значения узла со своим источником независимо от того, как они получены, это поле не читает. Оно фиксирует, как были получены значения, и никогда не выводится из имени ключа или содержимого значения. Отсутствует, если valuesMapping не выполнялся, а также в полезной нагрузке без значений. |
uses | map of string[] | нет | Объявлено и намеренно не передаётся: хост никогда не заполняет это поле, поэтому карта отсутствует во всех полезных нагрузках отрисовки. Исходящее ребро потребляется до диспетчеризации — опубликованные значения ребра восстанавливаются в собственный inject-канал узла, который Recipe уже вычислил в значения и рабочую нагрузку, получаемые гостем, — а гость, собирающий границу, получает список рёбер в собственных входных данных. Если бы поле заполнялось, оно сопоставляло бы исходящие рёбра uses узла по псевдониму сокета, и каждое содержало бы упорядоченные идентификаторы целевых узлов этого сокета в авторском порядке. |
boundary_path | string | нет | Путь границы узла, проставляемый как аннотация aggrega.ai/boundary-path на каждом выпускаемом манифесте, содержащем блок metadata. |
sync_wave | integer | нет | Волна развёртывания, унаследованная этим узлом от содержащей его границы (по умолчанию 0; отрицательные значения допускаются); несёт значение, которое узел IR хранит как sync_wave. Что гость делает с ним — выбор самого гостя, причём запись значения и упорядочивание по нему независимы, а не являются альтернативами: гость может сделать что-то одно, оба или ни одного. Среди провайдеров стандартной библиотеки: helm и helm-chart выводят его как аннотацию argocd.argoproj.io/sync-wave на каждом отрисованном ресурсе и дополнительно как helm.sh/hook-weight на ресурсе, который чарт уже помечает как хук Helm; compose одновременно записывает его как метку сервиса и упорядочивает сервисы файла, в который выполняет отрисовку, через depends_on между ними; cloudformation упорядочивает подготовку собранного стека, объявляя каждый ресурс волны зависимым от ресурсов предыдущей волны; terraform упорядочивает блоки module корневой конфигурации, в которую собирается граница, объявляя каждый модуль волны зависимым от модулей предыдущей волны, а также записывает значение вместе с provenance сборки узла. |
recipe_name | string | нет | Имя связанной сущности Recipe, которое в паре с recipe_version образует аннотацию aggrega.ai/recipe-uri; если любая из половин пуста, аннотация не проставляется. |
recipe_version | string | нет | Версия связанной сущности Recipe, которая в паре с recipe_name образует аннотацию aggrega.ai/recipe-uri; если любая из половин пуста, аннотация не проставляется. |
label_component_id | string | нет | Безопасная для Kubernetes идентичность компонента — то, ЧЕМУ ПРИНАДЛЕЖИТ ресурс, выпускаемый этим узлом: именно это записывает provenance и это запрашивает селектор. Если значение не пустое, оно заменяет идентификатор узла в качестве значения меток app.kubernetes.io/name и aggrega.ai/component-id; пустое значение означает, что идентификатор узла уже допустим для метки и используется напрямую. Оно передаётся для каждого ресурса, выпускаемого вложением Feature, каким бы способом вложение их ни поставляло, поэтому ресурсы вложения отличимы от ресурсов его компонента-хоста по одной лишь метке. То, из чего гость выводит собственные имена, передаётся отдельно, в derived_name_basis, и эти два поля отвечают на разные вопросы. |
derived_name_basis | string | нет | Идентичность, из которой гость выводит собственные имена, — имя релиза, которое читают шаблоны установщика чартов, по которому такой гость может также называть ресурсы, синтезируемые им для компонента, и префикс файлов, выпускаемых отрисовкой источника. Пустое значение означает, что идентификатор узла используется напрямую; это значение для обычного компонента и для вложения Feature на уровне компонента: вложение, поставляющее чарт или фрагмент, написанный его автором, отрисовывает его относительно имени компонента-ХОСТА, поскольку собственные шаблоны автора называют ресурсы по этому имени, а другое имя переименовало бы уже развёрнутые ресурсы. Узел, идентификатор которого содержит синтаксис маркеров, недопустимый в алфавите имён цели, вместо этого передаёт это значение явно, чтобы выводимое гостем имя оставалось допустимым для цели. Оно намеренно отделено от label_component_id: гость, который СТРОИТ ресурсы для вложения Feature, а не отрисовывает источник его автора, называет их по идентичности, поэтому собственные ресурсы вложения не могут конфликтовать с ресурсами хоста, а имя, относительно которого отрисовывается источник автора, остаётся неизменным. Оба поля имеют одинаковое значение везде, где идентичность узла совпадает с тем, относительно чего отрисовывается его источник. |
output_labels | map of string | нет | Объявленные автором рецепта выходные метки, которые гостевой модуль проставляет на каждом выпускаемом манифесте наряду с метками происхождения, задающими идентичность сборки; ключами служат имена меток. В эту одну карту сливаются два авторских блока: литеральные пары «ключ — значение», которые рецепт записывает в outputLabels, и по одной записи на каждый ключ, который рецепт называет в outputComponentLabels; значение такой записи читается из этого ключа в собственных метках отрисованного компонента, так что продвинутое значение следует за компонентом, из которого оно пришло, а не повторяется в рецепте. Проверка при загрузке гарантирует, что оба блока не пересекаются с пространством ключей происхождения (никаких ключей aggrega.ai/ или app.kubernetes.io/), поэтому проставление никогда не конфликтует с меткой происхождения. Продвигаемый ключ, который компонент не объявляет, ничего не проставляет и вызывает рекомендательное предупреждение, а не пустую метку. Гостевой модуль, вывод которого не является YAML для Kubernetes, переносит их на собственную поверхность меток (метки сервисов Compose) или игнорирует. |
provenance | NodeProvenance | да | Сведения о происхождении, задающие идентичность сборки, которые гостевой модуль проставляет на каждом выпускаемом манифесте в виде меток aggrega.ai. |
Дополнительные свойства не допускаются.
NodeProvenance
Сведения о происхождении, задающие идентичность сборки, для одного узла: идентичность компилятора, агрегата и окружения, которую гостевой модуль проставляет на каждом выпускаемом манифесте в виде меток aggrega.ai. Каждое поле опускается, если оно пусто, поэтому частичная идентичность проставляет только те метки, которые она содержит.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
compiler_version | string | нет | Версия компилятора; проставляется как метка aggrega.ai/compiler-version, если не пуста. |
aggregate_name | string | нет | Имя агрегата; проставляется как метка aggrega.ai/aggregate-name, если не пусто. |
environment | string | нет | Имя окружения; проставляется как метка aggrega.ai/environment, если не пусто. |
provider_name | string | нет | Голый вид провайдера; проставляется как метка aggrega.ai/provider, если не пуст. |
provider_version | string | нет | Разрешённая версия плагина отрисовки провайдера; проставляется как метка aggrega.ai/provider-version, если не пуста. |
Дополнительные свойства не допускаются.
RenderNodeOutput
Полезная нагрузка, которую гостевой модуль Provider возвращает из своего экспорта render_node: сериализованные байты каждого выходного файла, выданного гостевым модулем, имена, которые он вывел в каждое из своих пространств ключей, факты, которые он сообщает о выданном, сколько отрисованных единиц совпало с каждой переданной ему записью omit, и все диагностики, выданные гостевым модулем во время отрисовки. Гостевой модуль возвращает сериализованные байты каждого файла; хост записывает их дословно и не запускает никакого сериализатора. За детерминированность отвечает гостевой модуль: одинаковый ввод должен давать одинаковые байты.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
files | RenderedFile[] | да | Выходные файлы, выданные гостевым модулем, в порядке выдачи. Каждый указывает свой путь на диске и несёт сериализованные байты, которые хост записывает дословно. |
derived_keys | map of string[] | нет | Имена, выведенные гостевым модулем при отрисовке этого узла, с ключами по пространству ключей, в которое он их вывел; каждое пространство несёт свои имена в порядке вывода. Гостевой модуль, который выводит имя, по которому его вывод обращается к ресурсу, помещает это имя внутрь байтов файла, записываемых хостом дословно, где хост его не видит; объявляя его здесь, гостевой модуль просит хост подтвердить, что никакие два вывода не пришлись на одно имя. Хост сравнивает объявленные имена на равенство внутри одного объявленного пространства и больше ничего не делает — он не разбирает имя, не узнаёт, что означает пространство или имя, и никогда не выводит имя сам. Два участника одного собранного вывода, объявившие одно и то же имя в одном и том же пространстве, останавливают сборку, и остановка называет пространство, имя и обоих участников. И имена пространств, и имена внутри них — собственный словарь гостевого модуля: гостевой модуль, которому нужна уникальность в области уже или шире одного собранного вывода, выражает эту область в объявляемом имени пространства. Порядок объявления сохраняется, чтобы полезная нагрузка была побайтово идентичной между запусками на одинаковом вводе. Отсутствует, когда гостевой модуль не выводит имён, которые нужно проверять, и тогда проверка для этого гостевого модуля бездействует. |
render_facts | RenderFact[] | нет | Факты, которые гостевой модуль сообщает о том, что он выдал для этого узла, в порядке, в котором гостевой модуль их перечисляет. Каждый факт связывает имя со значением, и оба — собственный словарь гостевого модуля: какие факты сообщает провайдер, что означает каждое имя и что содержат его элементы, входит в документированный контракт этого провайдера, а не этого сокета. Значение каждого факта — список, даже если в нём один элемент: хост отклоняет факт с любым другим значением, называя провайдер и факт, и останавливает сборку. Это единственное, что хост узнаёт о значении. Он индексирует факты по имени и передаёт каждый список шаблонам, которые его читают, объединяя списки одного имени, сообщённые несколькими отрисовками одного узла, в порядке выполнения этих отрисовок, и никогда не узнаёт, что означает имя или элемент, и не выводит факт сам — поэтому провайдер может сообщить то, что видно только благодаря его собственному знанию формата, например свойство записанных им документов, без того чтобы хост узнал этот формат. Сообщение фактов никогда не меняет записываемое: хост записывает те файлы, которые вернул гостевой модуль, независимо от того, сопровождают ли их факты. Гостевой модуль перечисляет свои факты в фиксированном порядке, чтобы полезная нагрузка была побайтово идентичной между запусками на одинаковом вводе. Отсутствует, когда гостевой модуль ничего не сообщает, и это полный ответ, а не недостающий. |
omitted | integer[] | нет | Сколько отрисованных единиц совпало с каждой записью omits из ввода: по одному счётчику на каждую переданную гостевому модулю запись, в том же порядке, каждый — число единиц, совпавших с этой записью, независимо от того, совпали ли они также с другой записью. Счётчик, равный нулю, — полный ответ: запись не совпала ни с чем, что отрисовал гостевой модуль. Счётчики — всё, что сокет возвращает о пропущенном: сами единицы просто отсутствуют в том, что вернул гостевой модуль. Отсутствует, когда гостевому модулю не передано ни одной записи. |
diagnostics | Diagnostic[] | нет | Диагностики, выданные гостевым модулем во время отрисовки. Каждый элемент имеет общую форму диагностики Wasm-плагина. |
error | string | нет | Сообщение о сбое, задаваемое, когда гостевой модуль выполнился, но не смог завершить операцию; отсутствует при успехе. Оно отличается от любых диагностик, которые несёт вывод: диагностики сообщают о проблемах, найденных во время выполнения, которое всё же дало результат, а error сообщает, что сама операция не завершилась. Присутствующую ошибку хост представляет как неудачный вызов плагина. |
condition_code | string | нет | Описательная, машинно сопоставляемая идентичность условия, которое называет сбой, — код, под которым условие зарегистрировано, в том же открытом наборе, в котором компилятор регистрирует свои собственные условия остановки, а не элемент закрытого каталога кодов ошибок хост-функций, из которого берётся hostfunc_error_code конверта ответа. Задаётся рядом с сообщением об ошибке для человека; отсутствует при успехе и отсутствует, когда гостевой модуль не называет такого условия. Гостевой модуль, который останавливается, сообщает здесь идентификатор условия, названного его сообщением, чтобы потребитель ветвился по нему, а не восстанавливал идентичность чтением сообщения. Хост сопоставляет этот идентификатор с условиями, объявленными компилятором, и публикует собственные идентификаторы найденного условия в структурированной диагностике, поэтому код, дошедший до читателя, всегда разрешается; идентификатор, не называющий такого условия, или выведенный из нумерации останавливает сборку. Гостевой модуль, которому нечего назвать точно, обращается вместо этого к одному из общих условий сбоя плагина, объявленных компилятором для этой цели, и излагает подробности в собственном сообщении. Этот идентификатор и condition_short_code сообщаются вместе, потому что называют одно условие в двух формах: гостевой модуль, задавший одно без другого, назвал условие, которое хост не может разрешить, и тогда хост сообщает вместо него собственное общее условие сбоя плагина, а сообщение по-прежнему несёт весь сбой. |
condition_short_code | string | нет | Компактный идентификатор того же условия — буква E и четыре цифры, форма, которую читатель цитирует, ищет и вставляет в отчёт, — задаётся рядом с сообщением об ошибке для человека; отсутствует при успехе и отсутствует, когда гостевой модуль не называет такого условия. Хост выводит его в заголовке в квадратных скобках диагностики, которую он формирует для этого сбоя, так что условие, выданное гостевым модулем, можно процитировать точно так же, как условие, выданное компилятором. Хост сопоставляет значение с условиями, объявленными компилятором, а не принимает его на веру: значение, не называющее такого условия, значение, выведенное из нумерации, или написание, которого нет в регистрации, останавливает сборку с цитированием ошибочного значения, при этом собственное сообщение гостевого модуля по-прежнему сообщается. Сообщается вместе с condition_code по указанной там причине. |
Дополнительные свойства не допускаются.
ValidateNodeOutput
Полезная нагрузка, которую гостевой модуль Provider возвращает из необязательного экспорта validate_node_input: диагностики, выданные структурной проверкой разрешённого входа узла. Экспорт принимает ту же проекцию RenderNodeInput, что получает render_node, и не выдаёт файлов — он только сообщает диагностики. Диагностика с серьёзностью halt явно останавливает сборку, называя узел и провайдер; диагностика с серьёзностью warn или info попадает в результат сборки, не меняя отрисованный вывод. Пустой список diagnostics означает, что вход прошёл структурную проверку.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
diagnostics | Diagnostic[] | нет | Диагностики, выданные гостевым модулем при проверке входа узла. Каждый элемент имеет общую для Wasm-плагинов форму диагностики. Пусто, если вход прошёл структурную проверку. |
error | string | нет | Сообщение о сбое, задаваемое, когда гостевой модуль выполнился, но не смог завершить операцию; отсутствует при успехе. Оно отличается от любых диагностик, которые несёт вывод: диагностики сообщают о проблемах, найденных во время выполнения, которое всё же дало результат, а error сообщает, что сама операция не завершилась. Присутствующую ошибку хост представляет как неудачный вызов плагина. |
condition_code | string | нет | Описательная, машинно сопоставляемая идентичность условия, которое называет сбой, — код, под которым условие зарегистрировано, в том же открытом наборе, в котором компилятор регистрирует свои собственные условия остановки, а не элемент закрытого каталога кодов ошибок хост-функций, из которого берётся hostfunc_error_code конверта ответа. Задаётся рядом с сообщением об ошибке для человека; отсутствует при успехе и отсутствует, когда гостевой модуль не называет такого условия. Гостевой модуль, который останавливается, сообщает здесь идентификатор условия, названного его сообщением, чтобы потребитель ветвился по нему, а не восстанавливал идентичность чтением сообщения. Хост сопоставляет этот идентификатор с условиями, объявленными компилятором, и публикует собственные идентификаторы найденного условия в структурированной диагностике, поэтому код, дошедший до читателя, всегда разрешается; идентификатор, не называющий такого условия, или выведенный из нумерации останавливает сборку. Гостевой модуль, которому нечего назвать точно, обращается вместо этого к одному из общих условий сбоя плагина, объявленных компилятором для этой цели, и излагает подробности в собственном сообщении. Этот идентификатор и condition_short_code сообщаются вместе, потому что называют одно условие в двух формах: гостевой модуль, задавший одно без другого, назвал условие, которое хост не может разрешить, и тогда хост сообщает вместо него собственное общее условие сбоя плагина, а сообщение по-прежнему несёт весь сбой. |
condition_short_code | string | нет | Компактный идентификатор того же условия — буква E и четыре цифры, форма, которую читатель цитирует, ищет и вставляет в отчёт, — задаётся рядом с сообщением об ошибке для человека; отсутствует при успехе и отсутствует, когда гостевой модуль не называет такого условия. Хост выводит его в заголовке в квадратных скобках диагностики, которую он формирует для этого сбоя, так что условие, выданное гостевым модулем, можно процитировать точно так же, как условие, выданное компилятором. Хост сопоставляет значение с условиями, объявленными компилятором, а не принимает его на веру: значение, не называющее такого условия, значение, выведенное из нумерации, или написание, которого нет в регистрации, останавливает сборку с цитированием ошибочного значения, при этом собственное сообщение гостевого модуля по-прежнему сообщается. Сообщается вместе с condition_code по указанной там причине. |
Дополнительные свойства не допускаются.
RenderedFile
Один выходной файл, выданный гостевым модулем Provider: его путь на диске относительно корня вывода узла и его сериализованные байты ровно в том виде, в каком их создал гостевой модуль. Хост записывает эти байты дословно и не запускает сериализатор, поэтому вывод на диске побайтово идентичен тому, что выдал гостевой модуль.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
path | string | да | Путь выходного файла относительно корня вывода узла (например, Chart.yaml или templates/deployment.yaml). |
content | string | да | Сериализованные байты файла ровно в том виде, в каком их создал гостевой модуль; хост записывает эти байты дословно и не запускает сериализатор, поэтому вывод побайтово идентичен тому, что выдал гостевой модуль. Каждый набор средств хранит их в своём типе поля — как есть, если этот тип байтовый, и в кодировке base64, если это строка, которую гостевой модуль декодирует, чтобы получить байты, — а сгенерированный кодировщик выполняет преобразование между полем и формой, в которой байты передаются по проводу. |
format | string | нет | Формат, в котором, по объявлению гостевого модуля, отрисован выданный файл, чтобы хост мог направить файл подходящему парсеру. Отсутствует, если гостевой модуль не объявляет формат; в этом случае хост выводит формат из расширения файла. |
Дополнительные свойства не допускаются.
RenderFact
Один факт, который гостевой модуль Provider сообщает о том, что он выдал для узла: имя и список записей, оба определены и документированы провайдером. Хост передаёт факт так, как его записал гостевой модуль, отклоняет факт, значение которого не является списком, и больше ничего не узнаёт ни о той, ни о другой части.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
name | string | да | Имя факта из собственного документированного словаря провайдера. |
value | array | да | Значение факта: массив JSON — всегда список, даже с одной записью или без записей, — записи которого являются любыми значениями JSON в форме, которую провайдер документирует для этого имени. Именно список позволяет сообщать одно имя из нескольких отрисовок узла: хост объединяет списки в один. Он передаётся как JSON-документ, записанный гостевым модулем, байт в байт, поэтому порядок записей списка и ключей каждого объекта определяет сам гостевой модуль. |
Дополнительные свойства не допускаются.
OmitEntry
Одна запись, называющая отрисованные единицы, которые гостевой модуль Provider исключает из вывода узла; её поля уже разрешены в простые строки и помечены, если какое-либо из них получено из значения, объявленного конфиденциальным. Сокет не придаёт им никакого смысла: каждый провайдер документирует, что выбирают kind, name, namespace и subchart в его собственном формате, и сопоставляет их сам.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
kind | string | да | Вид отрисованной единицы, которую называет запись, в собственном словаре провайдера. |
name | string | да | Имя отрисованной единицы, которую называет запись, в собственном словаре провайдера. |
namespace | string | нет | Пространство имён, в котором находится названная единица, для провайдера, формат которого размещает единицы в пространствах имён. Отсутствует, если автор его не указал; чему соответствует запись без пространства имён, определяет собственный контракт провайдера. |
subchart | string | нет | Вложенный источник, из которого получена названная единица, для провайдера, чей источник собирается из вложенных источников, как чарт собирается из своих сабчартов. Отсутствует, если автор его не указал; с чем совпадает запись без subchart и что провайдер, у источника которого нет вложенных источников, делает с записью, указывающей такой источник, определяется собственным контрактом провайдера. |
sensitive | логическая | нет | True, если шаблон, из которого получено любое из полей kind, name, namespace или subchart записи, читает значение, объявленное автором конфиденциальным, или значение, прослеживаемое до такого. Это определяется по шаблону каждого поля с учётом объявлений — учитываются ссылка, достигающая объявленного значения, шаблон, передающий дальше все свои данные, и шаблон, который не разбирается, — и никогда по разрешённым строкам. Пометка относится ко всей записи, а не называет поле, поэтому гостевой модуль обращается с помеченной записью так же, как с любым другим помеченным значением на своём входе: он по-прежнему сопоставляет и подсчитывает запись по её полям, для чего запись и предназначена, и не допускает ни одно её поле в текст, который читает человек, — отказ, предупреждение или строку журнала. Отсутствует, если шаблон ни одного поля не читает такое значение; отсутствие никогда не означает, что ни одно поле не конфиденциально. |
Дополнительные свойства не допускаются.
SourceFile
Один файл предварительно упакованной проекции источника: его путь относительно корня источника и его необработанные байты ровно в том виде, в каком хост прочитал их из локального источника во время компиляции.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
path | string | да | Путь файла относительно корня источника (например, Chart.yaml или templates/deployment.yaml). |
content | string | да | Необработанные байты файла ровно в том виде, в каком хост прочитал их из локального источника. Каждый набор средств хранит их в своём типе поля — как есть, если этот тип байтовый, и в кодировке base64, если это строка, которую гостевой модуль декодирует, чтобы получить байты, — а сгенерированный кодировщик выполняет преобразование между полем и формой, в которой байты передаются по проводу. |
Дополнительные свойства не допускаются.
SourceProjection
Упакованное содержимое источника (например, файлы чарта Helm, каждый из которых назван своим путём относительно корня источника, в порядке обхода), которое хост считывает и возвращает гостевому модулю в ответ на запрос pack-source, так что гостевой модуль восстанавливает выбранный источник в памяти и не обращается к файловой системе. Это полезная нагрузка успешного ответа хост-функции pack-source.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
files | SourceFile[] | да | Файлы источника, каждый из которых назван своим путём относительно корня источника, в детерминированном порядке обхода хоста. |
Дополнительные свойства не допускаются.
SourceEntry
Одна запись листинга источника: её путь относительно корня источника и признак того, является ли она каталогом. Хост перечисляет только имена и не читает содержимое, поэтому запись не несёт байтов.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
path | string | да | Путь записи относительно корня источника с разделителем «/» (например, Chart.yaml или templates/deployment.yaml). |
is_dir | логическая | да | Является ли запись каталогом. Гостевой модуль, который определяет корень чарта или отдельный файл источника в листинге, читает это поле, чтобы отличать каталоги от файлов, не обращаясь к файловой системе. |
Дополнительные свойства не допускаются.
SourceListing
Обобщённое перечисление полученного источника, которое хост передаёт гостевому модулю провайдера с источником: корень источника, признак того, является ли этот корень каталогом, и отсортированные записи под ним относительно корня. Хост обходит полученный источник без знания предметной области и не читает содержимое файлов — он перечисляет только имена. Гостевой модуль применяет к листингу собственную логику разрешения (поиск корня чарта, выбор отдельного документа compose, вендоринг дерева модулей) и просит хост упаковать выбранную часть через хост-функцию pack-source. Записи отсортированы по пути, поэтому листинг побайтово идентичен между запусками на идентичных входных данных.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
root | string | да | Расположение полученного источника, которое перечислил хост. Гостевой модуль включает его в собственные диагностики, когда не может разрешить источник, так что остановка при разрешении называет источник, указанный автором. |
root_is_dir | логическая | нет | Является ли корень полученного источника каталогом. False для однофайлового источника (отдельный документ compose, один файл модуля, архив); в этом случае entries пуст, и гостевой модуль упаковывает сам корень. |
entries | SourceEntry[] | да | Записи относительно корня под корнем источника-каталога, отсортированные по пути. Пусто для однофайлового корня источника. |
Дополнительные свойства не допускаются.
SourcePackRequest
Выборка, которую гостевой модуль просит хост упаковать из полученного источника через хост-функцию pack-source. Поле op задаёт форму выборки, а path — её расположение относительно корня источника; хост разрешает путь внутри корня источника, отклоняя любой выход за его пределы, и возвращает упакованные байты как SourceProjection.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
op | string (enum) | да | Форма выборки: file упаковывает один файл по пути path; dir упаковывает файлы, непосредственно лежащие в каталоге по пути path; tree рекурсивно упаковывает всё поддерево с корнем в path в детерминированном порядке обхода хоста. Допустимые значения: "file", "dir", "tree" |
path | string | да | Расположение выборки относительно корня источника с разделителем «/». Пустая строка (или «.») обозначает сам корень источника, поэтому однофайловый источник упаковывается с пустым путём. |
Дополнительные свойства не допускаются.
SourcePackResponse
Ответ хост-функции pack-source: при успехе — упакованный источник, при сбое — сообщение об ошибке. Заполнено ровно одно из двух полей. Сбой передаётся внутри ответа, а не через trap, поэтому гостевой модуль включает отказ песочницы или сбой чтения в собственные диагностики как детерминированный сбой рендеринга.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
source_projection | SourceProjection | нет | Упакованный источник при успехе; отсутствует при сбое. |
error | string | нет | Сообщение о сбое при сбое, называющее выборку и причину; отсутствует при успехе. |
hostfunc_error_code | string (enum) | нет | Машинно сопоставимый идентификатор сбоя при сбое, взятый из закрытого каталога кодов ошибок хост-функций и задаваемый рядом с понятным человеку сообщением об ошибке; отсутствует при успехе. Этот каталог — фиксированный словарь, называющий способы, которыми может завершиться сбоем хост-функция, и он отличается от словаря условий остановки, регистрируемых компилятором, идентификаторы которых гостевой модуль сообщает в выводе сокета как condition_code и condition_short_code, — имя ключа указывает, к какому из двух относится значение, поэтому они никогда не читаются как один набор. Гостевой модуль выбирает ветвь по этому коду, не разбирая сообщение, а при отсутствии кода (более старый хост) или неизвестном коде (более новый хост) возвращается к сообщению. Допустимые значения: "fetch_request_unreadable", "fetch_input_unavailable", "fetch_failed", "request_unreadable", "request_undecodable", "source_root_unavailable", "source_read_failed", "unknown_selection_op", "source_escape", "producer_consumption_reentry", "no_source_parser", "no_parser_for_format", "parse_failed" |
Дополнительные свойства не допускаются.
SourceFileRequest
Чтение содержимого одного файла, которое гостевой модуль просит хост выполнить через хост-функцию read-source-file, — для гостевого модуля, логике разрешения которого нужно изучить содержимое файла, прежде чем выбрать, что упаковать. Хост разрешает путь внутри корня источника, отклоняя любой выход за его пределы, и возвращает байты файла.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
path | string | да | Расположение файла относительно корня источника с разделителем «/». |
Дополнительные свойства не допускаются.
SourceFileResponse
Ответ хост-функции read-source-file: при успехе — байты файла, при сбое — сообщение об ошибке. Заполнено ровно одно из двух полей. Сбой передаётся внутри ответа, а не через trap, поэтому гостевой модуль включает отказ песочницы или сбой чтения в собственные диагностики как детерминированный сбой рендеринга.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
content | string | нет | Исходные байты файла при успехе; отсутствуют при сбое. Каждый набор инструментов хранит их в собственном типе поля — как есть, если этот тип байтовый, и в кодировке base64, если это строка, которую гостевой модуль декодирует, чтобы получить байты, — а сгенерированный кодировщик выполняет преобразование между полем и формой, в которой байты передаются по каналу. |
error | string | нет | Сообщение о сбое при сбое, называющее файл и причину; отсутствует при успехе. |
hostfunc_error_code | string (enum) | нет | Машинно сопоставимый идентификатор сбоя при сбое, взятый из закрытого каталога кодов ошибок хост-функций и задаваемый рядом с понятным человеку сообщением об ошибке; отсутствует при успехе. Этот каталог — фиксированный словарь, называющий способы, которыми может завершиться сбоем хост-функция, и он отличается от словаря условий остановки, регистрируемых компилятором, идентификаторы которых гостевой модуль сообщает в выводе сокета как condition_code и condition_short_code, — имя ключа указывает, к какому из двух относится значение, поэтому они никогда не читаются как один набор. Гостевой модуль выбирает ветвь по этому коду, не разбирая сообщение, а при отсутствии кода (более старый хост) или неизвестном коде (более новый хост) возвращается к сообщению. Допустимые значения: "fetch_request_unreadable", "fetch_input_unavailable", "fetch_failed", "request_unreadable", "request_undecodable", "source_root_unavailable", "source_read_failed", "unknown_selection_op", "source_escape", "producer_consumption_reentry", "no_source_parser", "no_parser_for_format", "parse_failed" |
Дополнительные свойства не допускаются.
FetchExternalInputResponse
Ответ хост-функции fetch-external-input: при успехе — полученное содержимое, при сбое — сообщение об ошибке и её код. Ответ, в котором нет ни одного поля сбоя, считается успешным, поэтому полезная нагрузка нулевой длины — это ответ, в котором отсутствуют все поля. Сбой передаётся внутри канала, а не через ловушку (trap), поэтому гостевой модуль переносит неразрешимый URL или сбой получения в собственную диагностику как детерминированный сбой рендеринга. Запрос — это просто строка URL, а не структурированная полезная нагрузка, поэтому объявленную форму имеет только ответ.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
content | string | нет | Необработанные байты полученной полезной нагрузки при успехе; отсутствует при сбое, а также если полезная нагрузка пуста. Байты передаются по проводному формату как байтовая строка, никогда как текст base64. Набор для Go хранит их как байтовый срез; наборы для Rust и TypeScript хранят их как строку base64, которую декодирует обёртка получения каждого набора, поэтому каждая обёртка возвращает необработанные байты полезной нагрузки. |
error | string | нет | Сообщение о сбое при сбое, называющее URL и способ исправления; отсутствует при успехе. |
hostfunc_error_code | string (enum) | нет | Машинно сопоставимый идентификатор сбоя при сбое, взятый из закрытого каталога кодов ошибок хост-функций и задаваемый рядом с понятным человеку сообщением об ошибке; отсутствует при успехе. Этот каталог — фиксированный словарь, называющий способы, которыми может завершиться сбоем хост-функция, и он отличается от словаря условий остановки, регистрируемых компилятором, идентификаторы которых гостевой модуль сообщает в выводе сокета как condition_code и condition_short_code, — имя ключа указывает, к какому из двух относится значение, поэтому они никогда не читаются как один набор. Гостевой модуль выбирает ветвь по этому коду, не разбирая сообщение, а при отсутствии кода (более старый хост) или неизвестном коде (более новый хост) возвращается к сообщению. Допустимые значения: "fetch_request_unreadable", "fetch_input_unavailable", "fetch_failed", "request_unreadable", "request_undecodable", "source_root_unavailable", "source_read_failed", "unknown_selection_op", "source_escape", "producer_consumption_reentry", "no_source_parser", "no_parser_for_format", "parse_failed" |
Дополнительные свойства не допускаются.
WorkloadProjection
Предварительно вычисленное содержимое рабочей нагрузки, которое хост передаёт гостевому модулю сущности Provider, чтобы гостевой модуль синтезировал из него в памяти манифесты в собственном формате провайдера; присутствует, когда связанная сущность Recipe объявляет рабочую нагрузку, а не источник чарта. За детерминированность отвечает гостевой модуль: идентичные входные данные должны давать идентичные байты.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
workload | object | да | Вычисленная хостом и прошедшая валидацию сущность Workload, которую синтезирует гостевой модуль; непрозрачна на этом уровне схемы, чтобы схема сокета не переопределяла контракт сущности Workload. |
sensitive_workload | логическая | нет | True, когда шаблон, создавший workload, читает значение, объявленное автором как конфиденциальное, или значение, прослеженное до такого. Это определяется по собственным ссылкам шаблона в сопоставлении с объявлениями — учитываются ссылка, достигающая объявленного значения, передача шаблоном всех своих данных целиком и шаблон, который не удаётся разобрать, — и никогда по содержимому какого-либо поля. Поля отрендеренной рабочей нагрузки не несут обратной связи с данными, которые читал её шаблон, поэтому это помечает весь документ: гостевой модуль, составляющий текст для чтения человеком — отказ или предупреждение, — при значении true не включает в этот текст ни одного значения рабочей нагрузки, тогда как форма документа — его ключи и места расположения значений — остаётся читаемой. Записи вложений, которые называет sensitive_rendered_keys проекции узла, помечаются там независимо от того, установлено ли это поле. Отсутствует, когда шаблон не читает такого значения; отсутствие никогда не означает, что ни одно поле не является конфиденциальным. |
attachment_provides | object | нет | Все вложения узла, спроецированные на их разрешённые provides и ключом которых служит имя экземпляра вложения, указанное в ссылке на вложение рабочей нагрузки; отсутствует, когда у узла нет вложений. Хост копирует строки как есть, не интерпретируя их, поэтому гостевой модуль читает те записи provides вложения, которые нужны ему для разрешения ссылки на ресурс, созданный этим вложением. Работает ли вложение с материалом, объявленным конфиденциальным, здесь не повторяется: эта информация передаётся в соответствующей записи feature проекции узла, которую гостевой модуль читает по тому же имени экземпляра. |
Дополнительные свойства не допускаются.
ArtifactsProjection
Предварительно вычисленный набор артефактов, который хост передаёт гостевому модулю сущности Provider для размещения в выводе узла. Хост уже разрешил источник каждой записи (встроенное содержимое или прочитанный им импортированный файл), вычислил его как шаблон Go в контексте рендеринга с объявленной гостевым модулем парой разделителей шаблонов артефактов и вычислил наборы ключей меток и аннотаций происхождения сборки. Гостевой модуль отвечает за выбор формата, размещение сведений о происхождении, путь на диске и итоговые байты. Записи сохраняют авторский порядок, поэтому размещённый вывод побайтно идентичен между запусками на идентичных входных данных.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
entries | ArtifactProjectionEntry[] | да | Записи артефактов, которые размещает гостевой модуль, в авторском порядке. |
Дополнительные свойства не допускаются.
ArtifactProjectionEntry
Одна предварительно вычисленная запись артефакта, которую хост передаёт гостевому модулю сущности Provider для размещения: её разрешённое хостом имя вывода, её происхождение, байты содержимого с уже вычисленным шаблоном, признак того, читает ли шаблон, из которого получены эти байты, значение, объявленное конфиденциальным, а также наборы ключей меток и аннотаций происхождения сборки, вычисленные хостом для узла. Гостевой модуль решает, как разместить сведения о происхождении (вставить их в метаданные манифеста, добавить в начало как комментарий или создать сопутствующий файл) и куда попадает файл.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
name | string | да | Разрешённое хостом имя вывода для записи: объявленный автором ключ словаря, причём файл, предоставленный пакетом библиотеки, вложен под этот ключ. Гостевой модуль размещает запись под этим именем или по производному от него подпути, специфичному для провайдера. |
origin | string (enum) | да | Была ли запись создана как встроенное содержимое или как импортированный файл. Гостевой модуль, отвергающий одну из форм (провайдер зонтичного чарта отвергает встроенное содержимое), читает это поле, чтобы явно остановиться с ошибкой. Допустимые значения: "inline", "import" |
content | string | да | Байты содержимого с уже вычисленным шаблоном, полученные хостом из встроенного содержимого или импортированного файла записи и вычисленные в контексте рендеринга с объявленной гостевым модулем парой разделителей шаблонов артефактов. Каждый набор хранит их в собственном типе поля — как есть, если этот тип байтовый, и в кодировке base64, если это строка, которую гостевой модуль декодирует для их восстановления, — а сгенерированный кодировщик преобразует данные между полем и формой, в которой байты передаются по проводному формату. |
sensitive_content | логическая | нет | True, когда шаблон, из которого вычислено содержимое этой записи, читает значение, объявленное автором как конфиденциальное, или значение, прослеженное до такого. Это определяется по собственным ссылкам шаблона в сопоставлении с объявлениями, с той парой разделителей, с которой вычислялось содержимое, — учитываются ссылка, достигающая объявленного значения, передача шаблоном всех своих данных целиком и шаблон, который не удаётся разобрать, — и никогда по самому содержимому. Содержимое является выводом этого шаблона, поэтому ничто в нём нельзя проследить до исходного элемента данных: гостевой модуль, составляющий текст для чтения человеком — отказ или предупреждение, — при значении true не включает в этот текст никакую часть содержимого, в том числе собственное сообщение парсера о содержимом. Поле устанавливается для каждой записи отдельно, поэтому то, что шаблон одной записи читает такое значение, ничего не говорит о другой. Отсутствует, когда шаблон не читает такого значения; отсутствие никогда не означает, что содержимое не является конфиденциальным. |
labels | object | нет | Безопасный для меток Kubernetes набор ключей происхождения сборки, вычисленный хостом для узла, с именами меток в качестве ключей. Гостевой модуль, записывающий сведения о происхождении в metadata.labels манифеста, вставляет их; гостевой модуль, вывод которого не является YAML для Kubernetes, их игнорирует. |
annotations | object | нет | Набор ключей происхождения сборки, вычисленный хостом для узла, который нельзя представить меткой Kubernetes, с именами аннотаций в качестве ключей. Гостевой модуль, записывающий сведения о происхождении в metadata.annotations манифеста, вставляет их; гостевой модуль, вывод которого не является YAML для Kubernetes, их игнорирует. |
Дополнительные свойства не допускаются.
AssembleBoundaryInput
Полезная нагрузка, которую гостевой модуль Provider получает в своём экспорте assemble_boundary — экспорте, который объединяет поузловые результаты рендеринга в одной группе диспетчеризации в единый собранный артефакт (umbrella-чарт, объединённый compose-файл). Она содержит поузловые результаты рендеринга с их объединёнными аннотациями и волнами развёртывания, выходной путь группы диспетчеризации, по которому размещается собранный артефакт, рёбра uses графа для вывода зависимостей между сервисами и контекст времени рендеринга. Не каждый провайдер объявляет этот экспорт: провайдеры, которые выдают только плоский поузловой вывод, его опускают.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
rendered_nodes | RenderedNode[] | да | Поузловые результаты рендеринга, поступившие в эту группу диспетчеризации, в порядке узлов. |
context | object | да | Контекст времени рендеринга в виде байтов его JSON-документа. В этом экспорте хост задаёт только yaml_indent — ширину отступа для всего рендеринга, с которой сериализуются собранные файлы; остальные члены контекста здесь ничего не несут, потому что сборка объединяет участников с разными аннотациями и границами, и аннотации каждого участника вместо этого поступают в его записи rendered_nodes. |
boundary_path | string | да | Вычисленный выходной путь группы диспетчеризации, по которому размещается собранный артефакт; сборщик границы использует его как резервную идентичность на уровне границы (например, имя сети compose для узла без аннотации пространства имён). |
edges | RenderEdge[] | нет | Направленные рёбра uses графа, чтобы сборщик границы мог вывести порядок и зависимости между сервисами среди участников группы диспетчеризации (например, depends_on в compose). |
sub_charts | SubChart[] | нет | Полезная нагрузка для каждого подчарта, которую использует сборщик umbrella-чарта, чтобы выдать по одной зависимости и одной области значений на каждого участника. Каждая запись содержит идентичность подчарта, значения экземпляра и, для подчарта, взятого из источника чарта, исходные байты файла Chart.yaml этого чарта. Присутствует при сборке umbrella-чарта; сборщик с плоским объединением её опускает. |
chart_name | string | нет | Имя чарта, которое сборщик umbrella-чарта использует для собранного чарта, когда для группы диспетчеризации задано имя; пусто, когда сборщик выводит имя из выходного пути группы диспетчеризации. |
aggregate_name | string | нет | Имя агрегата верхнего уровня, которое сборщик umbrella-чарта включает в производное имя собранного чарта; пусто, когда никакая идентичность агрегата не участвует в имени. |
Дополнительные свойства не допускаются.
RenderedNode
Результат рендеринга одного узла в том виде, в каком он входит во вход assemble_boundary: id узла, его тип, его объединённые аннотации, его волна синхронизации, значения, которые компилятор разрешил для него, если их предоставление относится к компетенции компилятора, и признак того, были ли они получены сопоставлением значений, а также файлы, которые для него создал экспорт render_node, — всё это передаётся в форме результата рендеринга, где все члены этой формы, кроме файлов, отсутствуют.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
id | string | да | Абсолютный id узла в графе топологии. Участник, не являющийся одним из узлов графа, — сущность Feature, присоединённая на границе, а не к компоненту, — передаёт здесь вместо этого собственную диспетчерскую идентичность компилятора для него, ту же самую, что передавал вызов render_node для этого участника; она отличает одного участника от другого и не является именем, которое принимает какая-либо цель. То, из чего такой участник выводит имена внутри собранного артефакта, передаётся отдельно, в derived_name_basis. |
type | string | да | Метка типа компонента узла, передаваемая в этой форме, — в отличие от проекции рендеринга для отдельного узла, которая её не передаёт. Это непрозрачные метаданные, а не переключатель поведения: метка присутствует здесь, чтобы сборщик мог группировать и помечать объединяемые узлы, а не чтобы гостевой модуль ветвился по ней. |
derived_name_basis | string | нет | Идентичность, из которой этот участник выводит собственные имена внутри собранного артефакта, — логический id, который сборщик создаёт для одной из опубликованных записей участника, область участника в объединённом документе, имя дочерней единицы, размещённой в собственной позиции. Пустое значение означает, что id используется напрямую; это значение для обычного компонента. Участник, чей id является диспетчерской идентичностью, которую алфавит имён цели не принимает, передаёт это значение явно, чтобы собранный артефакт обращался к его содержимому по имени, которое цель принимает, и чтобы два участника, которых автор может различить, не оказались под одним именем. Если содержимое участника включается в документ, который объединяет сборщик, это то же значение, которое получил вызов render_node для этого участника, и именно передача его в обоих местах обеспечивает равенство двух ответов: имя, объявленное участником при рендеринге, и имя, по которому объединённый документ обращается к этому содержимому, выводятся из одной идентичности, а не из двух, которые случайно совпадают. Если же участник размещается в собственной позиции, это идентичность, составленная для этого участника, — для Feature, подключённой к компоненту, её собственная, а не идентичность компонента-хоста, относительно которого выполнялся её рендеринг, — поэтому к дочерней единице, размещённой рядом с хостом, обращаются отдельно от него. |
output_directory | string | нет | Каталог, в котором лежат отрендеренные файлы этого участника, относительно собственной позиции собранного артефакта, без завершающего разделителя. Гостевой модуль, которому нужно сослаться на файлы участника изнутри собранного артефакта — путь source блока модуля, директива include, — берёт позицию отсюда, а не составляет её из идентичности участника, чтобы путь, на который указывает собранный артефакт, совпадал с путём, по которому были записаны файлы. Они не всегда отстоят на один каталог: участник, которого хост поместил внутрь позиции другого участника, лежит глубже, чем участники, помещённые непосредственно под сборкой. Присутствует только там, где собирающий провайдер размещает каждого участника в собственной позиции; провайдер, сворачивающий участников в один документ, не размещает каталогов для участников и не получает их. |
rendered | RenderNodeOutput | да | Полезная нагрузка, которую гостевой модуль Provider возвращает из своего экспорта render_node: сериализованные байты каждого выходного файла, выданного гостевым модулем, имена, которые он вывел в каждое из своих пространств ключей, факты, которые он сообщает о выданном, сколько отрисованных единиц совпало с каждой переданной ему записью omit, и все диагностики, выданные гостевым модулем во время отрисовки. Гостевой модуль возвращает сериализованные байты каждого файла; хост записывает их дословно и не запускает никакого сериализатора. За детерминированность отвечает гостевой модуль: одинаковый ввод должен давать одинаковые байты. |
annotations | map of string | нет | Объединённые аннотации узла, чтобы сборщик границы мог определить размещение каждого узла (например, сеть compose, выведенную из аннотации aggrega.ai/namespace). |
sync_wave | integer | нет | Волна развёртывания, которую этот узел унаследовал от содержащей его границы (по умолчанию 0; отрицательные значения допускаются), чтобы сборщик границы мог упорядочить объединяемых участников относительно друг друга. Группа диспетчеризации может объединять участников из нескольких границ, каждая со своей волной, поэтому волна передаётся здесь с каждым узлом, а не один раз для всей полезной нагрузки. Сборщик, форма вывода которого не выражает порядка, её игнорирует. |
values | object | нет | Значения, которые компилятор разрешил для этого узла; присутствуют только для узла, отрендеренного из источника, — вызов render_node, создавший его файлы, передавал source_listing. Это единственный случай, когда файлы взяты извне и значения нельзя было записать в них, поэтому их должна предоставить позиция вне этих файлов: сборщик границы размещает присутствующий словарь как входные данные этого участника в самом собранном артефакте, а не рядом с собственными файлами участника, и там, где собранный артефакт — единственная позиция, которую вычисляет цель, в этом и состоит разница между входными данными, которые цель читает, и теми, до которых она никогда не доходит. Узел, отрендеренный из workload_projection или artifacts_projection, разрешил эти значения в созданные им файлы, поэтому здесь он их не передаёт и поле отсутствует: повторная передача предложила бы собранному артефакту входные данные, которые собственные файлы этого узла никогда не объявляют, и цель вправе их отклонить. Ключи поступают в отсортированном порядке, а не в авторском, и именно эта сортировка делает полезную нагрузку побайтно идентичной между запусками на идентичных входных данных; гостевой модуль, которому нужен другой порядок, устанавливает его сам. Сборщик, форма вывода которого не содержит входных данных для отдельных участников, игнорирует это поле. |
values_mapped | логическая | нет | True, когда значения, которые несёт этот узел, являются результатом valuesMapping привязанной к нему сущности Recipe или FeatureRecipe (Recipe компонента, FeatureRecipe присоединённой сущности Feature), а не значениями узла, переданными в том виде, в каком их записал автор, — та же отметка, которую вызов render_node для этого узла передавал в проекции узла, передаваемая здесь рядом с описываемыми ею значениями. Отсутствует там, где valuesMapping не выполнялся, и везде, где отсутствует values. Читает ли её сборщик — дело собственного контракта этого сборщика: тот, чей render_node привязывает значения сопоставленного узла к входным данным, объявленным его источником, может узнать из неё, какие имена заполнила эта привязка, а тот, что размещает значения узла как его входные данные независимо от того, как они получены, её не читает. Она фиксирует, как были получены значения, и никогда не выводится из имени ключа или содержимого значения. |
Дополнительные свойства не допускаются.
RenderEdge
Одно направленное ребро uses графа, названное двумя id своих узлов: source — потребляющий узел, а target — потребляемый. Список несёт все рёбра uses графа, поэтому любой из концов может быть узлом за пределами этой группы диспетчеризации.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
source | string | да | id потребляющего узла — исходный конец направленного ребра uses. |
target | string | да | id потребляемого узла — целевой конец, на который указывает направленное ребро uses. |
Дополнительные свойства не допускаются.
SubChart
Один подчарт, входящий в зонтичный чарт: его идентичность экземпляра, версия, которую закрепляет зонтичный чарт, значения экземпляра, которые зонтичный чарт помещает под псевдонимом подчарта, и — для подчарта, включённого из источника чарта, — исходные байты файла Chart.yaml этого чарта. Сборщик зонтичного чарта строит зависимости и файл значений зонтичного чарта только из этих представлений с чистыми данными и не обращается к файловой системе.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
instance_id | string | да | Идентичность экземпляра подчарта в группе диспетчеризации; зонтичный чарт помещает под ней псевдоним зависимости подчарта и его значения, так что несколько экземпляров одного исходного чарта остаются различимыми. |
version | string | нет | Версия, которую зонтичный чарт закрепляет для подчарта. Подчарт, включённый из источника чарта, берёт имя и версию зависимости из файла Chart.yaml этого чарта, чтобы зависимость связывалась; это значение применяется к генерируемому подчарту, не несущему включённого чарта. |
values | object | нет | Значения экземпляра, которые зонтичный чарт помещает под псевдонимом подчарта в файле values.yaml зонтичного чарта. Ключи поступают в отсортированном порядке, а не в авторском, и именно эта сортировка делает полезную нагрузку побайтно идентичной между запусками на идентичных входных данных; гостевой модуль, которому нужен иной порядок, устанавливает его сам. |
chart_yaml | string | нет | Исходные байты файла Chart.yaml включённого чарта, прочитанные из локального источника во время компиляции, из которых зонтичный чарт берёт имя и версию зависимости подчарта. Пусто для генерируемого подчарта, не несущего включённого чарта. Каждый набор разработки несёт их в собственном типе поля — как есть, если этот тип байтовый, и в кодировке base64, если это строка, которую гостевой модуль декодирует для их восстановления, — а сгенерированный кодировщик преобразует данные между полем и формой, в которой байты передаются по проводу. |
Дополнительные свойства не допускаются.
AssembleBoundaryOutput
Полезная нагрузка, которую гостевой модуль Provider возвращает из своего экспорта assemble_boundary: сериализованные байты каждого собранного файла и все диагностики, выданные гостевым модулем во время сборки. Расположение файлов отдельных узлов собранной группы не входит в этот ответ — это статическое свойство провайдера, объявленное один раз в его контракте describe() и известное до рендеринга любого узла. Гостевой модуль возвращает сериализованные байты каждого файла; хост записывает их дословно и не запускает сериализатор. За детерминизм отвечает гостевой модуль: идентичные входные данные должны давать идентичные байты.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
files | RenderedFile[] | да | Собранные выходные файлы, выданные гостевым модулем, в порядке выдачи. Каждый указывает свой путь на диске и несёт сериализованные байты, которые хост записывает дословно. |
diagnostics | Diagnostic[] | нет | Диагностики, выданные гостевым модулем во время сборки. Каждый элемент имеет общую форму диагностики Wasm-плагина. |
error | string | нет | Сообщение о сбое, задаваемое, когда гостевой модуль выполнился, но не смог завершить операцию; отсутствует при успехе. Оно отличается от любых диагностик, которые несёт вывод: диагностики сообщают о проблемах, найденных во время выполнения, которое всё же дало результат, а error сообщает, что сама операция не завершилась. Присутствующую ошибку хост представляет как неудачный вызов плагина. |
condition_code | string | нет | Описательная, машинно сопоставляемая идентичность условия, которое называет сбой, — код, под которым условие зарегистрировано, в том же открытом наборе, в котором компилятор регистрирует свои собственные условия остановки, а не элемент закрытого каталога кодов ошибок хост-функций, из которого берётся hostfunc_error_code конверта ответа. Задаётся рядом с сообщением об ошибке для человека; отсутствует при успехе и отсутствует, когда гостевой модуль не называет такого условия. Гостевой модуль, который останавливается, сообщает здесь идентификатор условия, названного его сообщением, чтобы потребитель ветвился по нему, а не восстанавливал идентичность чтением сообщения. Хост сопоставляет этот идентификатор с условиями, объявленными компилятором, и публикует собственные идентификаторы найденного условия в структурированной диагностике, поэтому код, дошедший до читателя, всегда разрешается; идентификатор, не называющий такого условия, или выведенный из нумерации останавливает сборку. Гостевой модуль, которому нечего назвать точно, обращается вместо этого к одному из общих условий сбоя плагина, объявленных компилятором для этой цели, и излагает подробности в собственном сообщении. Этот идентификатор и condition_short_code сообщаются вместе, потому что называют одно условие в двух формах: гостевой модуль, задавший одно без другого, назвал условие, которое хост не может разрешить, и тогда хост сообщает вместо него собственное общее условие сбоя плагина, а сообщение по-прежнему несёт весь сбой. |
condition_short_code | string | нет | Компактный идентификатор того же условия — буква E и четыре цифры, форма, которую читатель цитирует, ищет и вставляет в отчёт, — задаётся рядом с сообщением об ошибке для человека; отсутствует при успехе и отсутствует, когда гостевой модуль не называет такого условия. Хост выводит его в заголовке в квадратных скобках диагностики, которую он формирует для этого сбоя, так что условие, выданное гостевым модулем, можно процитировать точно так же, как условие, выданное компилятором. Хост сопоставляет значение с условиями, объявленными компилятором, а не принимает его на веру: значение, не называющее такого условия, значение, выведенное из нумерации, или написание, которого нет в регистрации, останавливает сборку с цитированием ошибочного значения, при этом собственное сообщение гостевого модуля по-прежнему сообщается. Сообщается вместе с condition_code по указанной там причине. |
Дополнительные свойства не допускаются.
CarveInput
Полезная нагрузка, которую гостевой модуль Provider получает в своём необязательном экспорте carve: один именованный выходной файл, который конвейер разрезает на адресуемые единицы, прежде чем шаг FeatureRecipe отредактирует некоторые из них. Провайдер, чью форму вывода стандартный кодек YAML не может разрезать напрямую (например, шаблонизированный чарт), объявляет carve и reassemble, чтобы его собственное знание формы вывода находилось в гостевом модуле; провайдер, опускающий эти экспорты, использует стандартный кодек YAML хоста.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
name | string | да | Имя выходного файла, чтобы кодек мог применить любое правило разрезания, привязанное к имени. |
body | string | да | Байты выходного файла для разрезания на адресуемые единицы. Каждый набор разработки несёт их в собственном типе поля — как есть, если этот тип байтовый, и в кодировке base64, если это строка, которую гостевой модуль декодирует для их восстановления, — а сгенерированный кодировщик преобразует данные между полем и формой, в которой байты передаются по проводу. |
yaml_indent | integer | нет | Ширина отступа, которую кодек использует, когда должен синтезировать новый структурированный текст; передаётся, чтобы разрезание в гостевом модуле соответствовало отступам всего рендеринга. |
Дополнительные свойства не допускаются.
CarveOutput
Полезная нагрузка, которую гостевой модуль Provider возвращает из своего экспорта carve: упорядоченные адресуемые единицы, на которые он разрезал файл. Структурированная единица несёт дерево (цель PATCH); непрозрачная единица несёт только свой тип медиаданных и байты.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
units | object[] | да | Упорядоченные адресуемые единицы, на которые гостевой модуль разрезал файл. |
Дополнительные свойства не допускаются.
ReassembleInput
Полезная нагрузка, которую гостевой модуль Provider получает в своём необязательном экспорте reassemble: исходный файл вместе с его вырезанными единицами и изменёнными единицами, созданными шагом конвейера, чтобы гостевой модуль точечно встроил изменения обратно в исходные байты. Токен, отсутствующий в наборе изменённых, собирается заново из своих исходных байтов дословно; у изменённого токена правятся только адресуемые им диапазоны байтов.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
name | string | да | Имя выходного файла, совпадающее с именем, под которым этот же файл был разрезан. |
body | string | да | Исходные байты файла, в которые повторная сборка встраивает обратно изменённые единицы. Каждый набор инструментов передаёт их в собственном типе поля — в сыром виде, если этот тип байтовый, и в кодировке base64, если это строка, которую гостевой модуль декодирует, чтобы восстановить их, — а сгенерированный кодировщик выполняет преобразование между полем и формой, в которой байты передаются по проводу. |
segs | object[] | нет | Единицы, на которые был разрезан файл, в том виде, в каком их вернул carve. |
patched | object[] | нет | Единицы, изменённые шагом конвейера; каждая несёт свой токен, изменённое дерево и операции, которые произвели изменение. |
yaml_indent | integer | нет | Ширина отступа, которую кодек использует, когда операции нужно синтезировать новый структурированный текст; передаётся, чтобы повторная сборка соответствовала отступам всего рендеринга. |
Дополнительные свойства не допускаются.
ReassembleOutput
Полезная нагрузка, которую гостевой модуль Provider возвращает из своего экспорта reassemble: байты файла со встроенными обратно изменёнными единицами. Повторная сборка точна до байта — каждый байт, не затронутый операциями, сохраняется дословно.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
body | string | да | Байты повторно собранного файла, которые хост записывает дословно. Каждый набор инструментов передаёт их в собственном типе поля — в сыром виде, если этот тип байтовый, и в кодировке base64, если это строка, которую гостевой модуль декодирует, чтобы восстановить их, — а сгенерированный кодировщик выполняет преобразование между полем и формой, в которой байты передаются по проводу. |
Дополнительные свойства не допускаются.
NameBoundInput
Полезная нагрузка, которую гостевой модуль Provider получает в своём необязательном экспорте name_bound: одно имя, которое хост предлагает использовать как идентичность компонента узла, чтобы гостевой модуль оценил его по каждому имени, которое он вывел бы из этой идентичности для своей цели, вместе с фактами разрешённого workload узла, от которых зависят некоторые из этих имён, если идентичность устанавливается после разрешения этого workload. Гостевой модуль отвечает ограничением, а не собственным именем: выведенное имя, вернувшись обратно, заставило бы хост составлять имена для цели, о которой он ничего не знает, а именно это и устраняет сам вопрос. Провайдер, чья цель ограничивает длину или состав принимаемых имён, объявляет этот экспорт; провайдер, чья цель принимает любое имя, опускает его, и ему этот вопрос никогда не задаётся, а его рендеринг не меняется.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
proposed | string | да | Имя, которое хост предлагает как идентичность компонента узла. Гостевой модуль выводит из него в памяти каждое имя, которое он выводит из идентичности компонента, и сообщает, принимает ли его цель каждое из них. Вердикт относится к ПРЕДЛОЖЕНИЮ, а не к узлу: хост задаёт один вопрос везде, где составляет идентичность, и не сообщает, для каких из имён этого узла эта идентичность в итоге станет основой, поэтому гостевой модуль отвечает так, будто она основа для всех. Это консервативное направление, поскольку по ответу хост только укорачивает и никогда не удлиняет, — поэтому имя, которое узел на деле выведет из иного носителя, оценивается слишком строго, а не слишком мягко. |
authored | логическая | нет | Написано ли предложенное имя человеком, а не составлено компилятором из авторских частей. Передаётся, чтобы гостевой модуль мог сформулировать причину для читателя, способного на неё повлиять. Оно не определяет, что делает отказ: авторское имя отклоняется, а составленное укорачивается, и это решение принимает хост. |
workload_form | string | нет | Форма workload, в который разрешается сущность Recipe или FeatureRecipe узла, в том виде, в каком её создал шаблон workload; передаётся, если идентичность устанавливается после разрешения этого workload и workload указывает форму. Передаётся в написанном виде; хост её не интерпретирует. Гостевой модуль, чья цель ограничивает имя, которое он выпускает только для одной формы, — запланированного задания, имя которого цель держит короче остальных имён, потому что к нему для каждого запуска добавляется суффикс, — читает её, чтобы оценить это имя. Отсутствие означает, что хост не передаёт форму для этого вопроса: узел не объявляет workload, его workload не указывает форму или идентичность устанавливается до разрешения какого-либо workload. Тогда гостевой модуль не оценивает ни одного имени, зависящего от формы, и отвечает ровно так же, как ответил бы, если бы этого поля не существовало. |
service_keys | string[] | нет | Ключи объектов Service, которые объявляет разрешённый workload узла, в порядке их объявления в workload; передаются, если идентичность устанавливается после разрешения этого workload и workload объявляет хотя бы один Service. Гостевой модуль, чья цель называет каждый Service, который он выпускает для узла, по идентичности компонента и ключу Service, читает их, чтобы оценить каждое такое имя. Ключ пишет автор сущности Recipe или FeatureRecipe, а не тот, кто написал идентичность, поэтому отказ, вызванный ключом, гостевой модуль формулирует и для этого автора. Отсутствие означает, что хост не передаёт ключей для этого вопроса: узел не объявляет workload, его workload не объявляет ни одного Service или идентичность устанавливается до разрешения какого-либо workload. Тогда гостевой модуль не оценивает ни одного имени, построенного из ключа Service, и отвечает ровно так же, как ответил бы, если бы этого поля не существовало. |
Дополнительные свойства не допускаются.
DerivedNameVerdict
Вердикт одного вида имени о предложенной идентичности: принимает ли цель имя, которое гостевой модуль вывел бы для этого вида, и — если была бы принята более короткая идентичность — наибольшая допустимая длина. Он несёт ограничение и причину, но никогда не имя, построенное гостевым модулем.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
kind | string | да | Собственное название гостевого модуля для вида имени, к которому относится этот вердикт, в терминах цели, а не компилятора, — имя релиза у установщика чартов, имя сервиса у оркестратора контейнеров. Оно дословно попадает к читателю в сообщении об отказе, поэтому пишется для того, кто знает цель. |
usable | логическая | да | Принимает ли цель имя, которое гостевой модуль вывел бы для этого вида из предложенной идентичности. |
bound | integer | нет | Наибольшее число символов, которое может содержать предложенная идентичность, чтобы цель приняла выведенное имя этого вида. Присутствует только при отказе, который устранила бы более короткая идентичность. ОТСУТСТВИЕ означает, что цель возражает не против длины: либо ограничения длины нет вовсе, либо возражение не устраняется никаким укорачиванием, например символ, который грамматика цели не допускает в той позиции, где он оказался. Поэтому отсутствие отличается от границы, равной нулю, которая указывает длину: никакая идентичность любой длины не даёт допустимого имени этого вида. При заданной границе хост укорачивает до неё и спрашивает снова; при отсутствующей границе он останавливается, поскольку пробовать больше нечего. |
reason | string | нет | Почему цель не принимает выведенное имя, в собственных терминах цели, для читателя, решающего, что написать вместо него. Пусто, если вердикт положительный. |
Дополнительные свойства не допускаются.
NameBoundOutput
Полезная нагрузка, которую гость Provider возвращает из своего экспорта name_bound: по одному вердикту на каждый вид имени, которое он вывел бы из предложенной идентичности. Предложение пригодно, когда пригоден каждый вердикт; если какой-либо нет, хост сокращает предложение до наименьшей границы среди отказывающих вердиктов и спрашивает снова, а останавливается, когда отказывающий вердикт не несёт границы. Пустой список вердиктов означает, что гость не выводит никаких имён из идентичности компонента, что равнозначно принятию предложения.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
names | DerivedNameVerdict[] | нет | По одной записи на каждый вид имени, который гость выводит из идентичности компонента, в собственном порядке гостя. Гость сообщает о каждом виде, который он вывел бы, а не только о видах, получивших отказ, чтобы читатель видел, какие имена были оценены, а хосту, читающему записи, не требовался второй вызов, чтобы узнать остальные. |
error | string | нет | Сообщение о сбое, задаваемое, когда гость запустился, но не смог завершить операцию; отсутствует при успехе. Оно отличается от отказывающего вердикта: вердикт сообщает об имени, которое цель не примет, а error сообщает, что на сам вопрос не удалось ответить. Присутствующий error хост выдаёт как неудачный вызов плагина. |
condition_code | string | нет | Описательная, машинно сопоставляемая идентичность условия, которое называет сбой, — код, под которым условие зарегистрировано, в том же открытом наборе, в котором компилятор регистрирует свои собственные условия остановки, а не элемент закрытого каталога кодов ошибок хост-функций, из которого берётся hostfunc_error_code конверта ответа. Задаётся рядом с сообщением об ошибке для человека; отсутствует при успехе и отсутствует, когда гостевой модуль не называет такого условия. Гостевой модуль, который останавливается, сообщает здесь идентификатор условия, названного его сообщением, чтобы потребитель ветвился по нему, а не восстанавливал идентичность чтением сообщения. Хост сопоставляет этот идентификатор с условиями, объявленными компилятором, и публикует собственные идентификаторы найденного условия в структурированной диагностике, поэтому код, дошедший до читателя, всегда разрешается; идентификатор, не называющий такого условия, или выведенный из нумерации останавливает сборку. Гостевой модуль, которому нечего назвать точно, обращается вместо этого к одному из общих условий сбоя плагина, объявленных компилятором для этой цели, и излагает подробности в собственном сообщении. Этот идентификатор и condition_short_code сообщаются вместе, потому что называют одно условие в двух формах: гостевой модуль, задавший одно без другого, назвал условие, которое хост не может разрешить, и тогда хост сообщает вместо него собственное общее условие сбоя плагина, а сообщение по-прежнему несёт весь сбой. |
condition_short_code | string | нет | Компактный идентификатор того же условия — буква E и четыре цифры, форма, которую читатель цитирует, ищет и вставляет в отчёт, — задаётся рядом с сообщением об ошибке для человека; отсутствует при успехе и отсутствует, когда гостевой модуль не называет такого условия. Хост выводит его в заголовке в квадратных скобках диагностики, которую он формирует для этого сбоя, так что условие, выданное гостевым модулем, можно процитировать точно так же, как условие, выданное компилятором. Хост сопоставляет значение с условиями, объявленными компилятором, а не принимает его на веру: значение, не называющее такого условия, значение, выведенное из нумерации, или написание, которого нет в регистрации, останавливает сборку с цитированием ошибочного значения, при этом собственное сообщение гостевого модуля по-прежнему сообщается. Сообщается вместе с condition_code по указанной там причине. |
Дополнительные свойства не допускаются.
RenderedNameInput
Полезная нагрузка, которую гость Provider получает в своём необязательном экспорте rendered_name: две идентичности, из которых цель выводит собственные имена, и сведения о том, какие виды входных данных объявляет Recipe узла — исходники, предоставленные автором, или рабочую нагрузку, которую синтезирует гость. Гость отвечает именем, которое его цель даст ресурсам, отрисовываемым для этого узла: для предоставленных исходников — именем, относительно которого отрисовываются собственные шаблоны автора, например именем релиза, которое читает чарт; для синтезированной рабочей нагрузки — именем, которое гость даёт создаваемым ресурсам, если он выводит его, а не записывает идентичность узла как есть. Гость, не выводящий такого имени, не сообщает никакого, и это честный ответ для цели, чьи имена ресурсов Recipe записывает дословно, и для цели, чьё имя зависит от того, где размещены файлы, а не от узла. Этот экспорт сообщает имя, которое составляет сам гость, и не является обменом, в котором гостя просят оценить имя, предложенное хостом; это разные вопросы, и у каждого свой экспорт.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
node_id | string | да | Собственная идентичность узла в авторском виде. Она передаётся без кодирования: цель сужает её через собственный алфавит, поэтому предварительное кодирование поместило бы одно экранирование внутрь другого и дало бы имя, написанное иначе, чем то, которое предсказывает автор рецепта. |
derived_name_basis | string | нет | Идентичность, относительно которой отрисовываются собственные исходники участника, когда она не совпадает с идентичностью узла, — задаётся для участника, чью идентичность отвергает алфавит имён цели, и отсутствует в остальных случаях. Гость разрешает эту пару так же, как и любая другая поверхность: это значение, если оно присутствует, и id узла, если нет. |
sourced | логическая | нет | Объявляет ли привязанный к узлу Recipe исходники, предоставленные автором, — определяется по тексту, написанному автором. Поле передаётся вместе с synthesized, чтобы вопрос можно было задать о любом узле и получить правильный ответ: для узла, не объявляющего ни того, ни другого, чей вывод — только набор артефактов, гость не сообщает имени, поскольку ресурсы в таком наборе названы по артефактам, написанным автором, а не по какому-либо имени, выведенному гостем. |
synthesized | логическая | нет | Объявляет ли привязанный к узлу Recipe рабочую нагрузку, которую должен синтезировать гость, — определяется по тексту, написанному автором, как и sourced. Гость, чья цель называет синтезируемые им ресурсы по выведенному имени, а не по идентичности узла в написанном виде, сообщает это имя для такого узла, чтобы адрес, который Recipe публикует для одного из этих ресурсов, можно было построить из имени, которое носит ресурс. |
Дополнительные свойства не допускаются.
RenderedNameOutput
Полезная нагрузка, которую гость Provider возвращает из своего экспорта rendered_name: имя, которое его целевая платформа даёт ресурсам, отрисовываемым для узла, — из исходников, предоставленных автором узла, или из синтезируемой им рабочей нагрузки, — либо отсутствие имени. Отсутствующее или пустое имя — это положительный ответ, а не сбой: он означает, что эта целевая платформа не выводит такого имени, — и хост использует полученное, не читая его, поэтому никакие знания об именовании на целевой платформе не пересекают границу.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
name | string | нет | Имя, под которым гость отрисовывает предоставленные автором исходники этого узла или которое он даёт ресурсам, синтезируемым для узла, уже записанное в алфавите, который его целевая платформа принимает в этой позиции. Пустое или отсутствующее значение означает, что гость не выводит такого имени. |
error | string | нет | Сообщение о сбое, задаваемое, когда гость был запущен, но не смог завершить операцию; отсутствует при успехе. Оно отличается от сообщения об отсутствии имени: отсутствие имени — это ответ о целевой платформе, тогда как error сообщает, что на сам вопрос не удалось ответить. Хост представляет присутствующее значение error как неудачный вызов плагина. |
condition_code | string | нет | Описательный, пригодный для машинного сопоставления идентификатор условия, которое называет сбой, — код, под которым условие зарегистрировано, в том же открытом наборе, в котором компилятор регистрирует собственные условия остановки. Задаётся рядом с человекочитаемым сообщением об ошибке; отсутствует при успехе, а также когда гость не называет такого условия. Хост сопоставляет этот идентификатор с условиями, которые объявляет компилятор, и публикует собственные идентификаторы найденного условия в структурированной диагностике, поэтому код, дошедший до читателя, всегда разрешается; идентификатор, не называющий такого условия, или выведенный из нумерации, останавливает сборку. Гость, у которого нет точного условия, которое можно назвать, обращается вместо этого к одному из общих условий сбоя плагина, которые компилятор объявляет для этой цели, и помещает подробности в собственное сообщение. Этот идентификатор и condition_short_code сообщаются вместе, поскольку они называют одно условие в двух формах: гость, задавший одно без другого, назвал условие, которое хост не может разрешить, и тогда хост сообщает вместо него собственное общее условие сбоя плагина, а сообщение по-прежнему содержит полное описание сбоя. |
condition_short_code | string | нет | Компактный идентификатор того же условия — буква E и четыре цифры, форма, которую читатель цитирует, ищет и вставляет в отчёт, — задаётся рядом с сообщением об ошибке для человека; отсутствует при успехе и отсутствует, когда гостевой модуль не называет такого условия. Хост выводит его в заголовке в квадратных скобках диагностики, которую он формирует для этого сбоя, так что условие, выданное гостевым модулем, можно процитировать точно так же, как условие, выданное компилятором. Хост сопоставляет значение с условиями, объявленными компилятором, а не принимает его на веру: значение, не называющее такого условия, значение, выведенное из нумерации, или написание, которого нет в регистрации, останавливает сборку с цитированием ошибочного значения, при этом собственное сообщение гостевого модуля по-прежнему сообщается. Сообщается вместе с condition_code по указанной там причине. |
Дополнительные свойства не допускаются.
LinkEndpoint
Одна конечная точка межграничной связи: узел, граничный путь, в который собирается его отрисованный вывод, и провайдер, который его отрисовал. Две конечные точки связи называют потребляющий и потребляемый концы ребра uses, концы которого собираются в разные группы диспетчеризации.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
node | string | да | Абсолютный id узла конечной точки в графе топологии. |
boundary | string | да | Граничный путь конечной точки — группа диспетчеризации, в которую собирается её отрисованный вывод. |
provider | string | да | Провайдер, который отрисовал конечную точку (голое имя провайдера). Обе конечные точки связанного соединения называют одного и того же провайдера; хост не маршрутизирует связь, конечные точки которой называют разных провайдеров. |
release | string | нет | Сущность Release, к которой относится отрисованный вывод конечной точки, — область, в пределах которой именуются её собранные артефакты. Хост собирает это значение из сущности Release, разрешённой сборкой, и передаёт его дословно; он не придаёт значению никакого смысла. Провайдер читает его, чтобы ограничить имя перекрёстной ссылки областью сущности Release. Отсутствующее значение — это пустая строка, которую провайдер трактует как имя без области. |
Дополнительные свойства не допускаются.
LinkEdge
Обобщённая, не зависящая от предметной области полезная нагрузка для отдельного ребра, которую хост собирает для ребра uses, потребляющий и потребляемый концы которого собираются в разные группы диспетчеризации. Она содержит обе конечные точки, аннотации размещения обеих конечных точек в виде непрозрачных скалярных карт, которые хост не интерпретирует, вывод provides потребляемой конечной точки, а также сокет и отображение inject, которые связывает ребро. Провайдер читает её, чтобы создать нативную для провайдера связку перекрёстных ссылок, нужную двум концам; хост собирает её и передаёт карту аннотаций как непрозрачные скаляры, не придавая никакого смысла ни одному значению.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
source | LinkEndpoint | да | Потребляющая конечная точка — исходный конец направленного ребра uses, в собранный вывод которого внедряется связка на стороне потребителя. |
target | LinkEndpoint | да | Потребляемая конечная точка — целевой конец, на который указывает ребро uses, собранный вывод которого публикует связка на стороне производителя. |
target_annotations | map of string | нет | Аннотации размещения потребляемой (целевой) конечной точки в виде непрозрачной скалярной карты с ключами по имени аннотации. Хост собирает их из разрешённых аннотаций цели и передаёт дословно; он не придаёт никакого смысла ни одному значению. Провайдер читает их, чтобы решить, как сформировать перекрёстную ссылку (например, разделяют ли два конца одно размещение или нужна ссылка между размещениями). Ключи сериализуются в отсортированном порядке, поэтому полезная нагрузка побайтно идентична между запусками на идентичных входных данных. |
source_annotations | map of string | нет | Аннотации размещения потребляющей (исходной) конечной точки в виде непрозрачной скалярной карты с ключами по имени аннотации. Хост собирает их из разрешённых аннотаций источника и передаёт дословно; он не придаёт никакого смысла ни одному значению. Провайдер читает их, чтобы сравнить размещение двух концов — например, разделяют ли источник и цель одно размещение или находятся в разных. Ключи сериализуются в отсортированном порядке, поэтому полезная нагрузка побайтно идентична между запусками на идентичных входных данных. |
socket | string | да | Псевдоним сокета, под которым привязано ребро uses. |
provides | map of string | да | Вывод provides потребляемой конечной точки — упорядоченный автором набор ключей, открывающий объявленные выходы цели. Сохраняет авторский порядок, поэтому полезная нагрузка побайтно идентична между запусками на идентичных входных данных. |
inject | object | да | Отображение inject потребляющей конечной точки с ключами по механизму доставки, указывающими на упорядоченный автором набор ключей; описывает, как потребляющий конец получает вывод потребляемой конечной точки. Сохраняет авторский порядок, поэтому полезная нагрузка побайтно идентична между запусками на идентичных входных данных. |
read_provides_keys | string[] | нет | Ключи выходных данных provides потребляемой конечной точки, которые шаблоны потребляющей конечной точки читают напрямую через .context.uses, независимо от того, доставляет ли их также отображение inject, в авторском порядке provides. Каждый элемент — один из ключей, которые несёт provides. Список передаётся вместе с ребром, чтобы публикация на стороне производителя и разрешение на стороне потребителя читали один и тот же список. Отсутствует, если потребляющая конечная точка не читала ни одного ключа provides напрямую, и провайдер, не получивший списка, связывает ссылку ровно так, как если бы этого поля не существовало. |
Дополнительные свойства не допускаются.
LinkPatch
Один структурный патч для отдельного файла, который провайдер возвращает как связку артефактов: выходной файл и упорядоченные структурные операции, применяемые к нему. Последующий проход хоста разрезает названный файл, применяет операции и побайтно точно собирает его заново. Форма операции — общий словарь операций патча конвейера; на этом уровне схемы она непрозрачна, поэтому гость передаёт каждую операцию дословно, а хост реализует типизированную операцию, которую применяет его конвейер.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
file | string | да | Выходной файл, к которому применяются операции, названный так, как его выдал провайдер. |
ops | any[] | да | Упорядоченные структурные операции, применяемые к файлу, в порядке применения. |
Дополнительные свойства не допускаются.
LinkPublishInput
Полезная нагрузка, которую provider получает в своём экспорте link_publish: одна межграничная связь, на выход потребляемой конечной точки которой ссылаются через границу, и собранные файлы этой конечной точки. Экспорт возвращает опубликованную идентичность, относительно которой разрешает ссылку потребитель, и любую связку артефактов на стороне производителя, которая нужна выходу потребляемой конечной точки.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
edge | LinkEdge | да | Публикуемая межграничная связь, прочитанная со стороны потребляемой (целевой) конечной точки. |
producer_files | RenderedFile[] | нет | Собранные файлы потребляемой конечной точки, чтобы provider мог прочитать, что эта конечная точка уже объявляет, и сверить с ними имена, которые он собирается опубликовать. Каждый файл указывает свой путь на диске и несёт собранные байты. Отсутствует, когда у хоста нет собранного выхода производителя для передачи публикации; provider, которому для создания связки не нужен документ, его игнорирует. |
Дополнительные свойства не допускаются.
LinkPublishOutput
Полезная нагрузка, которую provider возвращает из своего экспорта link_publish: дескриптор опубликованной идентичности, относительно которого разрешает ссылку потребитель, и связка артефактов на стороне производителя, применяемая к собранному выходу потребляемой конечной точки.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
handle | map of string | да | Опубликованная идентичность, которую потребляемая конечная точка предоставляет потребителю для разрешения ссылки: непрозрачная карта строк — детерминированных указателей, с ключами по имени поля (например, имя экспорта, имя стека, регион, ссылка на роль). Значения — строки детерминированных указателей, которые компилятор передаёт дальше и никогда не разрешает; их разрешает среда выполнения во время развёртывания. Ключи сериализуются в отсортированном порядке, поэтому полезная нагрузка побайтно идентична между запусками на идентичных входных данных. |
patches | LinkPatch[] | нет | Связка артефактов на стороне производителя: по одному структурному патчу на каждый выходной файл потребляемой конечной точки, который публикация должна изменить. Пусто, когда выход потребляемой конечной точки не требует изменений для связи. |
error | string | нет | Сообщение об ошибке, задаваемое, когда гость выполнился, но не смог опубликовать связь; отсутствует при успехе. Хост выдаёт присутствующую ошибку как неудачный вызов плагина. Публикация, которая не может продолжиться — например, имя экспорта, которое стек уже объявляет под другой записью, — сообщается здесь, а не только как аварийное завершение, чтобы можно было назвать стоящее за ней условие. |
condition_code | string | нет | Описательная, машинно сопоставляемая идентичность условия, которое называет сбой, — код, под которым условие зарегистрировано, в том же открытом наборе, в котором компилятор регистрирует свои собственные условия остановки, а не элемент закрытого каталога кодов ошибок хост-функций, из которого берётся hostfunc_error_code конверта ответа. Задаётся рядом с сообщением об ошибке для человека; отсутствует при успехе и отсутствует, когда гостевой модуль не называет такого условия. Гостевой модуль, который останавливается, сообщает здесь идентификатор условия, названного его сообщением, чтобы потребитель ветвился по нему, а не восстанавливал идентичность чтением сообщения. Хост сопоставляет этот идентификатор с условиями, объявленными компилятором, и публикует собственные идентификаторы найденного условия в структурированной диагностике, поэтому код, дошедший до читателя, всегда разрешается; идентификатор, не называющий такого условия, или выведенный из нумерации останавливает сборку. Гостевой модуль, которому нечего назвать точно, обращается вместо этого к одному из общих условий сбоя плагина, объявленных компилятором для этой цели, и излагает подробности в собственном сообщении. Этот идентификатор и condition_short_code сообщаются вместе, потому что называют одно условие в двух формах: гостевой модуль, задавший одно без другого, назвал условие, которое хост не может разрешить, и тогда хост сообщает вместо него собственное общее условие сбоя плагина, а сообщение по-прежнему несёт весь сбой. |
condition_short_code | string | нет | Компактный идентификатор того же условия — буква E и четыре цифры, форма, которую читатель цитирует, ищет и вставляет в отчёт, — задаётся рядом с сообщением об ошибке для человека; отсутствует при успехе и отсутствует, когда гостевой модуль не называет такого условия. Хост выводит его в заголовке в квадратных скобках диагностики, которую он формирует для этого сбоя, так что условие, выданное гостевым модулем, можно процитировать точно так же, как условие, выданное компилятором. Хост сопоставляет значение с условиями, объявленными компилятором, а не принимает его на веру: значение, не называющее такого условия, значение, выведенное из нумерации, или написание, которого нет в регистрации, останавливает сборку с цитированием ошибочного значения, при этом собственное сообщение гостевого модуля по-прежнему сообщается. Сообщается вместе с condition_code по указанной там причине. |
Дополнительные свойства не допускаются.
LinkResolveInput
Полезная нагрузка, которую provider получает в своём экспорте link_resolve: одна межграничная связь, дескриптор опубликованной идентичности, предоставленный её потребляемой конечной точкой, и собранные файлы потребляющей конечной точки. Экспорт возвращает связку артефактов на стороне потребителя, которая внедряет ссылку в собранный выход потребляющей конечной точки.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
edge | LinkEdge | да | Разрешаемая межграничная связь, прочитанная со стороны потребляющей (исходной) конечной точки. |
handle | map of string | да | Дескриптор опубликованной идентичности, возвращённый link_publish потребляемой конечной точки, относительно которого потребитель разрешает свою ссылку. Непрозрачные строки детерминированных указателей с ключами по имени поля; компилятор передаёт их дальше и никогда не разрешает. Ключи сериализуются в отсортированном порядке, поэтому полезная нагрузка побайтно идентична между запусками на идентичных входных данных. |
consumer_files | RenderedFile[] | нет | Собранные файлы потребляющей конечной точки, чтобы provider мог найти заполнитель, который хост вставил в потребляющий выход, и создать его замену по реальному пути заполнителя. Каждый файл указывает свой путь на диске и несёт собранные байты. Отсутствует, когда у хоста нет собранного выхода потребителя для передачи разрешению; provider, которому для создания связки не нужен документ, его игнорирует. |
Дополнительные свойства не допускаются.
LinkResolveOutput
Полезная нагрузка, которую provider возвращает из своего экспорта link_resolve: связывание артефактов на стороне потребителя, применяемое к собранному выводу потребляющей конечной точки и внедряющее ссылку на опубликованную идентичность потребляемой конечной точки.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
patches | LinkPatch[] | да | Связывание артефактов на стороне потребителя: один структурный патч на каждый выходной файл потребляющей конечной точки, который должен изменить resolve. |
error | string | нет | Сообщение об ошибке, задаваемое, когда гостевой модуль выполнился, но не смог разрешить связь; отсутствует при успехе. Хост выдаёт заданную ошибку как неудачный вызов плагина. Resolve, который не может продолжиться — например, ссылка, которую цель может нести только как целое скалярное значение, встреченная внутри более длинной строки, — сообщается здесь, а не только как аварийное завершение, чтобы можно было назвать стоящее за ним условие. |
condition_code | string | нет | Описательная, машинно сопоставляемая идентичность условия, которое называет сбой, — код, под которым условие зарегистрировано, в том же открытом наборе, в котором компилятор регистрирует свои собственные условия остановки, а не элемент закрытого каталога кодов ошибок хост-функций, из которого берётся hostfunc_error_code конверта ответа. Задаётся рядом с сообщением об ошибке для человека; отсутствует при успехе и отсутствует, когда гостевой модуль не называет такого условия. Гостевой модуль, который останавливается, сообщает здесь идентификатор условия, названного его сообщением, чтобы потребитель ветвился по нему, а не восстанавливал идентичность чтением сообщения. Хост сопоставляет этот идентификатор с условиями, объявленными компилятором, и публикует собственные идентификаторы найденного условия в структурированной диагностике, поэтому код, дошедший до читателя, всегда разрешается; идентификатор, не называющий такого условия, или выведенный из нумерации останавливает сборку. Гостевой модуль, которому нечего назвать точно, обращается вместо этого к одному из общих условий сбоя плагина, объявленных компилятором для этой цели, и излагает подробности в собственном сообщении. Этот идентификатор и condition_short_code сообщаются вместе, потому что называют одно условие в двух формах: гостевой модуль, задавший одно без другого, назвал условие, которое хост не может разрешить, и тогда хост сообщает вместо него собственное общее условие сбоя плагина, а сообщение по-прежнему несёт весь сбой. |
condition_short_code | string | нет | Компактный идентификатор того же условия — буква E и четыре цифры, форма, которую читатель цитирует, ищет и вставляет в отчёт, — задаётся рядом с сообщением об ошибке для человека; отсутствует при успехе и отсутствует, когда гостевой модуль не называет такого условия. Хост выводит его в заголовке в квадратных скобках диагностики, которую он формирует для этого сбоя, так что условие, выданное гостевым модулем, можно процитировать точно так же, как условие, выданное компилятором. Хост сопоставляет значение с условиями, объявленными компилятором, а не принимает его на веру: значение, не называющее такого условия, значение, выведенное из нумерации, или написание, которого нет в регистрации, останавливает сборку с цитированием ошибочного значения, при этом собственное сообщение гостевого модуля по-прежнему сообщается. Сообщается вместе с condition_code по указанной там причине. |
Дополнительные свойства не допускаются.