Перейти до вмісту
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такВідрендерений вміст за цим шляхом.
treeanyніРозібране структуроване дерево цього артефакту, наявне, якщо хост розібрав вміст перед передаванням плагіну, — канонічне JSON-подання вихідного формату, який плагін не читає нативно (наприклад, артефакт HCL, розібраний у JSON). Верхній рівень може бути об’єктом, масивом або скаляром відповідно до власної форми розібраного документа. Відсутнє, якщо хост не розбирав артефакт; у такому разі плагін читає нативний вміст безпосередньо. Хост передає дерево непрозоро, без змін і без інтерпретації його вмісту.
formatstringніФормат, у якому відрендерено артефакт, наявний, якщо провайдер, що його створив, оголосив формат. Відсутнє, якщо провайдер, що його створив, не оголосив формату.

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

PolicySource

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

ВластивістьТипОбов’язковаОпис
pathstringтакБазове ім’я вихідного файлу. Хост надає лише базове ім’я, ніколи не абсолютний шлях на хості, тож передані дані переносні й детерміновані.
contentstringтакВміст вихідного файлу, переданий без змін як непрозорий рядок.

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

PrecalculatedPath

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

ВластивістьТипОбов’язковаОпис
path_idstringтакСтабільний ідентифікатор цього шляху; детермінований між запусками з ідентичними вхідними даними.
nodesstring[]такУпорядкована послідовність ідентифікаторів вузлів, через які проходить шлях, від джерела до кінцевого вузла.
attached_featuresstring[]такВідсортоване за алфавітом об’єднання URI типів Feature, приєднаних до будь-якого вузла вздовж шляху. Семантика належності до множини: сутність Feature з’являється один раз, навіть якщо її мають кілька вузлів. Порожнє, якщо жоден вузол уздовж шляху не має приєднаної сутності Feature.

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