Перейти к содержимому
AggregaAggrega
Выберите язык: Русский
Эта страница переведена машинным способом. Читать оригинал на английском.

Схема сокета политик Aggrega Wasm

Сгенерированный справочник. Не редактируйте вручную — сгенерируйте заново из опубликованной JSON Schema.

Идентификатор схемы: https://aggrega.ai/schemas/wasm-policy-v1beta1.schema.json

Формы передаваемых данных, которые плагин управления, подключённый в роли вердикта, принимает — PolicyInput в роли ir-verdict, RenderPolicyInput в роли render-verdict — и выдаёт (PolicyOutput). Вердикт с уровнем серьёзности halt останавливает сборку с диагностикой времени сборки; вердикт warn или info сообщается, и сборка продолжается. Входной граф стадии IR — это полный граф IR, агностичный по отношению к возможностям, на который ссылаются из ir-v1beta1.schema.json, а не объявляют здесь повторно, поэтому плагин политик видит те же сведения об узлах, рёбрах и подключениях, что и компилятор; авторы плагинов отслеживают версию схемы IR. Вход стадии рендеринга вместо графа несёт отрендеренные выходные файлы. Типы полезной нагрузки для Go, Rust и TypeScript генерируются из этой схемы в пакеты plugin-ABI, поэтому все три языка читают и записывают одни и те же передаваемые данные; гостевой модуль импортирует их из этих пакетов или через свой набор для разработки плагинов, если тот их реэкспортирует.

Одна из следующих форм

  • PolicyInput
  • RenderPolicyInput
  • PolicyOutput

Определения

PolicyInput

Полезная нагрузка, которую статический анализ передаёт сокету политик: полный граф IR (та же форма, которую выдаёт Topology Builder) и заранее вычисленные пути маршрутизации, которые анализатор перечисляет вместе с ним.

СвойствоТипОбязательноОписание
graphIRGraphдаПолный граф IR, агностичный по отношению к возможностям, с единственным источником в ir-v1beta1.schema.json. Плагин политик рассуждает над полными сведениями об узлах, рёбрах и подключениях, а не над узкой проекцией.
precalculated_pathsPrecalculatedPath[]даПути маршрутизации, заранее перечисленные анализатором, чтобы политики могли рассуждать о достижимости без повторного обхода графа.
sourcesPolicySource[]нетФайлы определений, которые хост читает во время компиляции и передаёт плагину без изменений, в виде упорядоченного списка, отсортированного по пути. Хост читает байты как непрозрачное содержимое и не разбирает их. Отсутствует, если подключение не объявляет источников.
settingsobjectнетОбъект настроек произвольной формы, который хост передаёт плагину без изменений. Хост не разбирает его содержимое и не действует на его основе. Отсутствует, если подключение не объявляет настроек.

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

PolicyOutput

Форма ответа, которую выдаёт плагин политик: вердикты, сработавшие во время вычисления, по одной диагностике на каждый сработавший вердикт. Разрешающее правило ничего не выдаёт, поэтому пустой массив results означает, что ни один вердикт не сработал.

СвойствоТипОбязательноОписание
resultsDiagnostic[]даСработавшие вердикты, по одной диагностике на каждый, в порядке, в котором их выдаёт плагин. Пусто, если ни один вердикт не сработал.
errorstringнетСообщение о сбое, задаваемое, когда гостевой модуль выполнился, но не смог завершить операцию; отсутствует при успехе. Оно отличается от любых диагностик, которые несёт вывод: диагностики сообщают о проблемах, найденных во время выполнения, которое всё же дало результат, а error сообщает, что сама операция не завершилась. Присутствующую ошибку хост представляет как неудачный вызов плагина.

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

RenderPolicyInput

Полезная нагрузка, которую получает плагин управления, подключённый в роли render-verdict: отрендеренные выходные файлы, над которыми рассуждает политика, вместо графа IR.

СвойствоТипОбязательноОписание
artifactsRenderedArtifact[]даОтрендеренные выходные файлы, над которыми рассуждает политика, в виде упорядоченного списка, отсортированного по пути, чтобы передаваемые данные были побайтно идентичны между запусками на одинаковых входных данных.
sourcesPolicySource[]нетФайлы определений, которые хост читает во время компиляции и передаёт плагину без изменений, в виде упорядоченного списка, отсортированного по пути. Хост читает байты как непрозрачное содержимое и не разбирает их. Отсутствует, если подключение не объявляет источников.
settingsobjectнетОбъект настроек произвольной формы, который хост передаёт плагину без изменений. Хост не разбирает его содержимое и не действует на его основе. Отсутствует, если подключение не объявляет настроек.

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

RenderedArtifact

Один отрендеренный выходной файл: его путь и отрендеренное содержимое по этому пути.

СвойствоТипОбязательноОписание
pathstringдаВыходной путь отрендеренного файла относительно корня рендеринга.
contentstringдаОтрендеренное содержимое по этому пути.
treeлюбойнетРазобранное структурированное дерево этого артефакта; присутствует, если хост разобрал содержимое перед передачей плагину, — каноническое JSON-представление исходного формата, который плагин не читает нативно (например, артефакт HCL, разобранный в JSON). Верхний уровень может быть объектом, массивом или скаляром в соответствии с собственной формой разобранного документа. Отсутствует, если хост не разбирал артефакт; в этом случае плагин читает нативное содержимое напрямую. Хост передаёт дерево непрозрачно, без изменений и без интерпретации его содержимого.
formatstringнетФормат, в котором был отрендерен артефакт; присутствует, если создавший его провайдер объявил его. Отсутствует, если создавший провайдер не объявил формат.

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

PolicySource

Один файл определений, передаваемый плагину: путь в виде базового имени и содержимое файла. Оба передаются без изменений; хост не разбирает содержимое.

СвойствоТипОбязательноОписание
pathstringдаБазовое имя исходного файла. Хост передаёт только базовое имя и никогда — абсолютный путь на хосте, поэтому передаваемые данные переносимы и детерминированы.
contentstringдаСодержимое исходного файла, передаваемое без изменений как непрозрачная строка.

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

PrecalculatedPath

Один заранее перечисленный путь маршрутизации, который материализует анализатор, чтобы правила политик могли рассуждать о достижимости без повторного обхода графа.

СвойствоТипОбязательноОписание
path_idstringдаСтабильный идентификатор этого пути; детерминирован между запусками на одинаковых входных данных.
nodesstring[]даУпорядоченная последовательность идентификаторов узлов, через которые проходит путь, от источника до конечного узла.
attached_featuresstring[]даОтсортированное по алфавиту объединение URI типов Feature, подключённых к любому узлу на пути. Семантика принадлежности множеству: сущность Feature появляется один раз, даже если её несут несколько узлов. Пусто, если ни один узел на пути не несёт подключений Feature.

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