Перейти до вмісту
AggregaAggrega
Обрати мову: Українська
Цю сторінку перекладено машинним способом. Читати оригінал англійською.

Схема 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_nodeRenderNodeInputRenderNodeOutput
validate_node_inputRenderNodeInputValidateNodeOutput
assemble_boundaryAssembleBoundaryInputAssembleBoundaryOutput
carveCarveInputCarveOutput
reassembleReassembleInputReassembleOutput
name_boundNameBoundInputNameBoundOutput
rendered_nameRenderedNameInputRenderedNameOutput
link_publishLinkPublishInputLinkPublishOutput
link_resolveLinkResolveInputLinkResolveOutput

Визначення

RenderNodeInput

Корисне навантаження, яке гість Provider отримує через свій експорт render_node: повузлова проєкція IR, яку рендерить гість, контекст часу рендерингу, попередньо обчислені вхідні дані, які оголошує прив’язаний до вузла Recipe, — перелік отриманого джерела, робоче навантаження, набір артефактів, — кожне з яких присутнє лише тоді, коли цей Recipe його оголошує, а також записи, що називають відрендерені одиниці, які гість вилучає з рендерингу джерела.

ВластивістьТипОбов’язковаОпис
nodeIRNodeProjectionтакПовузлові дані IR, які рендерить гість Provider, — обмежена проєкція повного вузла IR, що несе повузлову ідентичність і походження, яке гість проставляє на кожному згенерованому маніфесті: його id, тип, розв’язаний recipe, значення, чи створило ці значення відображення значень, приєднання функцій, позначку чутливості для його відрендерених ключів і для значень загалом, вихідні ребра uses, шлях межі, хвилю синхронізації, ідентичність Recipe, перевизначення component-id, основу похідних імен і походження збірки. Ідентичність і основа похідних імен передаються окремо, бо відповідають на два питання — чому належить ресурс і щодо чого рендериться власне джерело автора, — і приєднання Feature, що постачає джерело, написане його автором, — це саме той випадок, коли дві відповіді різняться. Вміст файлів джерела тут не передається; він надходить окремо в проєкції джерела. Кожен набір ключів тут має фіксований порядок — функції та uses в авторському порядку, значення й позначка чутливості в порядку сортування ключів, — тож корисне навантаження в каналі побайтово ідентичне між запусками з ідентичними вхідними даними.
contextobjectтакКонтекст часу рендерингу, який хост передає гостьовому модулю, у вигляді байтів його 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_listingSourceListingніЗагальний перелік отриманого джерела, який хост передає гостю для провайдера з джерелом: корінь джерела, чи є цей корінь каталогом, і відсортовані відносно кореня записи під ним. Хост тут не читає вмісту файлів — він лише перелічує імена. Гість застосовує до переліку власну логіку розв’язання й просить хост запакувати обрану вибірку через функцію хоста pack-source, тож уся логіка розв’язання джерела, специфічна для провайдера, міститься в гостеві. Присутній для провайдерів із джерелом; інакше відсутній.
workload_projectionWorkloadProjectionніПопередньо обчислене робоче навантаження, яке хост передає гостю для синтезу нативних для провайдера маніфестів; присутнє, коли прив’язаний Recipe оголошує робоче навантаження, а не джерело чарту, інакше відсутнє.
artifacts_projectionArtifactsProjectionніПопередньо обчислений набір артефактів, який хост передає гостю для розміщення у виводі вузла; присутній, коли прив’язаний Recipe оголошує артефакти. Хост уже прочитав джерело кожного запису, обчислив його як шаблон Go щодо контексту рендерингу та обчислив набори ключів походження збірки; гість визначає формат виводу, розміщення походження, шлях на диску й остаточні байти. Відсутній, коли вузол не оголошує артефактів.
omitsOmitEntry[]ніЗаписи, що називають відрендерені одиниці, які гість вилучає з виводу цього вузла, у порядку, в якому їх оголосив автор. Кожен запис надходить розв’язаним, його поля — прості рядки, а запис, що не стосується цієї збірки, не передається. Що саме вибирають kind, name, namespace і subchart запису — це власний задокументований контракт цього провайдера, а не цього сокета: гість зіставляє кожен запис із тим, що він відрендерив, у термінах власного формату, вилучає кожну одиницю, якій відповідає запис, з усього, що повертає, — своїх файлів, імен, які він оголошує в derived_keys, і фактів, про які звітує в render_facts, — і повідомляє в полі omitted виводу, скільком одиницям відповідав кожен запис. Записи супроводжують лише перелік джерела й жодні інші вхідні дані: рендеринг синтезованого робочого навантаження чи набору артефактів ніколи їх не несе. Відсутнє, коли записів немає, і гість, якому їх не передано, рендерить точно так само, як якби цього поля не існувало.

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

IRNodeProjection

Повузлові дані IR, які рендерить гість Provider, — обмежена проєкція повного вузла IR, що несе повузлову ідентичність і походження, яке гість проставляє на кожному згенерованому маніфесті: його id, тип, розв’язаний recipe, значення, чи створило ці значення відображення значень, приєднання функцій, позначку чутливості для його відрендерених ключів і для значень загалом, вихідні ребра uses, шлях межі, хвилю синхронізації, ідентичність Recipe, перевизначення component-id, основу похідних імен і походження збірки. Ідентичність і основа похідних імен передаються окремо, бо відповідають на два питання — чому належить ресурс і щодо чого рендериться власне джерело автора, — і приєднання Feature, що постачає джерело, написане його автором, — це саме той випадок, коли дві відповіді різняться. Вміст файлів джерела тут не передається; він надходить окремо в проєкції джерела. Кожен набір ключів тут має фіксований порядок — функції та uses в авторському порядку, значення й позначка чутливості в порядку сортування ключів, — тож корисне навантаження в каналі побайтово ідентичне між запусками з ідентичними вхідними даними.

ВластивістьТипОбов’язковаОпис
idstringтакАбсолютний id вузла в графі топології.
typestringтакОголошене й навмисно приховане: хост завжди видає його як порожній рядок. Мітка типу компонента вузла — це непрозорі метадані, а не перемикач поведінки, тож передавання її тут лише спонукало б гостя розгалужуватися за нею. Гість читає порожній рядок і не повинен трактувати його як вузол, тип компонента якого не задано. (Форма вузла для збирання межі має власний тип, з іншою метою.)
resolved_recipestringтакОголошене й навмисно приховане: хост завжди видає його як порожній рядок. Ідентичність прив’язаного Recipe вже доходить до гостя як ім’я та версія recipe, які він проставляє в походження, тож розв’язаний URI не додає нічого, з чого рендерить гість. Гість, якому потрібно приписати вивід певному Recipe, читає натомість ці поля походження.
valuesobjectніВідрендерений словник значень вузла — набір ключів, з якого рендерить гість. Ключі надходять у відсортованому порядку, а не в авторському, і саме це сортування робить корисне навантаження побайтово ідентичним між запусками з ідентичними вхідними даними; гість, якому потрібен інший порядок, встановлює його сам.
featuresobjectніПриєднання функцій вузла, впорядковані за ключем-псевдонімом функції, що несуть ту саму повузлову форму приєднання функції, що й IR. Кожен запис несе значення, infra та відображення inject приєднання разом із його похідною позначкою чутливості, тож гість дізнається, чи працює приєднання з оголошено чутливим матеріалом, лише з корисного навантаження. Зберігає авторський порядок, тож корисне навантаження побайтово ідентичне між запусками з ідентичними вхідними даними. Непрозоре на цьому рівні схеми; гість читає форму запису функції через контракт IR у каналі.
sensitive_rendered_keysmap of stringніВідрендерені ключі, ідентичність яких відновлено з даних, що їх автор оголосив чутливими; кожен зіставлено з оголошенням, від якого він успадкував цю чутливість. Передається від хоста до гостя у вхідних даних рендерингу — у напрямку, протилежному до імен, які гість оголошує у вихідних даних рендерингу. Те, що називає ключ, залежить від форми, яку несе цей payload: у payload, що несе values вузла, це один із ключів цієї мапи; у payload, що несе workload, він називає запис у власних мапах приєднань workload, де values вузла порожні. Ключ присутній лише там, де відновлення точне: воно поєднує оголошення з відрендереною ідентичністю, нічого не зчитуючи з власного тексту ключа і не поширюючи позначку рівня вузла чи приєднання на окремі ключі. Тому ключ, який вигадав шаблон, відсутній, бо жодне оголошення його не називає: вихідні ключі valuesMapping рецепта та вміст артефакту створено шаблоном, тож жоден із них не дає тут ключа — те, чи такий payload створено зі значення, оголошеного чутливим, натомість передають sensitive_values та власний sensitive_content запису артефакту. Отже, відсутність означає, що ідентичність жодного ключа не вдалося відновити, і ніколи — що ніщо в цьому payload не несе чутливих матеріалів; гість, який сприймає відсутній ключ як дозвіл показати чи вивести значення відкритим текстом, прочитав його навпаки. Ключі надходять у відсортованому порядку, завдяки чому payload побайтово ідентичний між запусками з ідентичними вхідними даними.
sensitive_valuesбулеваніTrue, коли values, які несе цей payload, створено шаблоном, що зчитує значення, оголошене автором чутливим, або значення, простежене до такого: valuesMapping сутності Recipe чи FeatureRecipe — це єдиний шаблон, вихідні ключі та значення якого є його власним витвором, тож жоден ключ цього виводу не можна простежити до даних, з яких він походить, і натомість позначається вся мапа. Це визначається з власних посилань шаблону на оголошення — враховуються посилання, що досягає оголошеного значення, шаблон, який передає всі свої дані, і шаблон, що не розбирається, — і ніколи з вмісту значення чи імені ключа. Гість, що складає текст для людини, відмову чи попередження, не включає до цього тексту жодного значення з values вузла, коли це поле true, і не включає значення під будь-яким ключем, який називає sensitive_rendered_keys, незалежно від цього поля: обидва поля поєднуються — одне називає ключі, ідентичність яких відновлено точно, а це охоплює мапу там, де це неможливо. Відсутнє, коли жоден такий шаблон не зчитував такого значення, зокрема для values, що самі є оголошеними листками (їх натомість позначено поключово в sensitive_rendered_keys), а також у payload без values. Відсутність ніколи не означає, що жодне значення не є чутливим.
values_mappedбулеваніTrue, коли values, які несе цей payload, є виводом valuesMapping прив’язаної сутності Recipe чи FeatureRecipe, а не values вузла, переданими так, як їх написав автор. Гість, чий власний контракт прив’язує до вхідних параметрів, які оголошує його джерело, лише values, створені мапінгом, зчитує це поле і не зчитує values, написані для іншого, наприклад для артефактів сутності Recipe; гість, що прив’язує values вузла до свого джерела незалежно від того, як їх створено, це поле не зчитує. Воно фіксує, як створено values, і ніколи не виводиться з імені ключа чи вмісту значення. Відсутнє, коли жоден valuesMapping не виконувався, а також у payload без values.
usesmap of string[]ніОголошене і навмисно не передається: хост ніколи його не заповнює, тож мапа відсутня в кожному payload рендерингу. Вихідне ребро споживається до диспетчеризації — опубліковані значення ребра відновлюються у власний inject-канал вузла, який Recipe вже обчислив у values і workload, що їх отримує гість, — а гість, який збирає межу, натомість отримує список ребер у власних вхідних даних. Якби поле заповнювалося, воно індексувало б вихідні ребра uses вузла за псевдонімом сокета, кожне з упорядкованими ідентифікаторами цільових вузлів цього сокета в авторському порядку.
boundary_pathstringніШлях межі вузла, що проставляється як анотація aggrega.ai/boundary-path на кожному виведеному маніфесті, який має блок metadata.
sync_waveintegerніХвиля розгортання, яку цей вузол успадкував від межі, що його містить (типово 0; від’ємні значення дозволені); несе значення, яке вузол IR зберігає як sync_wave. Що гість із ним робить — його власний вибір, а фіксація значення і впорядкування за ним незалежні, а не взаємовиключні: гість може робити одне, обидва або жодне. Серед провайдерів стандартної бібліотеки: helm і helm-chart виводять його як анотацію argocd.argoproj.io/sync-wave на кожному відрендереному ресурсі, а також як helm.sh/hook-weight на ресурсі, який чарт уже позначає як хук Helm; compose і фіксує його як мітку сервісу, і впорядковує сервіси файлу, в який рендерить, через depends_on між ними; cloudformation впорядковує створення зібраного стека, оголошуючи кожен ресурс хвилі залежним від ресурсів попередньої хвилі; terraform впорядковує блоки модулів кореневої конфігурації, в яку збирається межа, оголошуючи кожен модуль хвилі залежним від модулів попередньої хвилі, а також фіксує його разом із походженням збірки вузла.
recipe_namestringніІм’я прив’язаної сутності Recipe, що в парі з recipe_version утворює анотацію aggrega.ai/recipe-uri; якщо будь-яка половина порожня, анотація не проставляється.
recipe_versionstringніВерсія прив’язаної сутності Recipe, що в парі з recipe_name утворює анотацію aggrega.ai/recipe-uri; якщо будь-яка половина порожня, анотація не проставляється.
label_component_idstringніБезпечна для Kubernetes ідентичність компонента — те, ЧОМУ НАЛЕЖИТЬ ресурс, який виводить цей вузол, тобто те, що фіксує походження і що запитує селектор. Якщо не порожня, вона замінює ідентифікатор вузла як значення міток app.kubernetes.io/name та aggrega.ai/component-id; порожнє значення означає, що ідентифікатор вузла вже придатний для мітки й використовується безпосередньо. Вона передається для кожного ресурсу, який виводить приєднання Feature, хоч би як приєднання їх постачало, тож ресурси приєднання відрізняються від ресурсів його компонента-хоста лише за міткою. Те, з чого гість виводить власні імена, — окреме поле, derived_name_basis, і ці два поля відповідають на різні питання.
derived_name_basisstringніІдентичність, з якої гість виводить власні імена, — ім’я релізу, яке зчитують шаблони інсталятора чартів, за яким такий гість може також називати ресурси, що синтезує для компонента, і префікс файлів, які виводить рендеринг джерела. Порожнє значення означає, що ідентифікатор вузла використовується безпосередньо; це значення для звичайного компонента і для покомпонентного приєднання Feature: приєднання, що постачає чарт або фрагмент, написаний його автором, рендерить його відносно імені компонента-ХОСТА, бо власні шаблони автора називають ресурси за цим ім’ям, а інше ім’я перейменувало б уже розгорнуті ресурси. Вузол, ідентифікатор якого містить синтаксис маркерів, що його відкидає алфавіт імен цілі, натомість несе це поле явно, щоб ім’я, яке виводить гість, лишалося прийнятним для цілі. Воно навмисно відокремлене від label_component_id: гість, що БУДУЄ ресурси для приєднання Feature, а не рендерить джерело його автора, називає їх за ідентичністю, тож власні ресурси приєднання не можуть конфліктувати з ресурсами хоста, тоді як ім’я, відносно якого рендериться джерело автора, лишається незмінним. Обидва поля мають однакове значення скрізь, де ідентичність вузла водночас є тим, відносно чого рендериться його джерело.
output_labelsmap of stringніОголошені автором рецепта вихідні мітки, які гостьовий модуль проставляє на кожному згенерованому маніфесті поряд із походженням ідентичності збірки, з ключами за назвою мітки. У цю одну мапу зливаються два авторські блоки: буквальні пари ключ-значення, які рецепт записує в outputLabels, і по одному запису для кожного ключа, який рецепт називає в outputComponentLabels, значення якого зчитується з цього ключа у власних мітках відрендереного компонента — тож перенесене значення слідує за компонентом, з якого воно походить, а не повторюється в рецепті. Обидва блоки не перетинаються з простором ключів походження завдяки валідації під час завантаження (жодного ключа aggrega.ai/ чи app.kubernetes.io/), тож проставлення ніколи не конфліктує з міткою походження. Перенесений ключ, який компонент не оголошує, нічого не проставляє і спричиняє рекомендаційне повідомлення, а не порожню мітку. Гостьовий модуль, вивід якого не є Kubernetes YAML, переносить їх на власну поверхню міток (мітки сервісів Compose) або ігнорує їх.
provenanceNodeProvenanceтакПоходження ідентичності збірки, яке гостьовий модуль проставляє на кожному згенерованому маніфесті як мітки aggrega.ai.

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

NodeProvenance

Походження ідентичності збірки для одного вузла — ідентичність компілятора, агрегату та середовища, яку гостьовий модуль проставляє на кожному згенерованому маніфесті як мітки aggrega.ai. Кожне поле пропускається, коли воно порожнє, тож часткова ідентичність проставляє лише ті мітки, які вона містить.

ВластивістьТипОбов’язковаОпис
compiler_versionstringніВерсія компілятора, що проставляється як мітка aggrega.ai/compiler-version, коли вона непорожня.
aggregate_namestringніНазва агрегату, що проставляється як мітка aggrega.ai/aggregate-name, коли вона непорожня.
environmentstringніНазва середовища, що проставляється як мітка aggrega.ai/environment, коли вона непорожня.
provider_namestringніПростий тип провайдера, що проставляється як мітка aggrega.ai/provider, коли він непорожній.
provider_versionstringніВизначена версія плагіна рендерингу провайдера, що проставляється як мітка aggrega.ai/provider-version, коли вона непорожня.

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

RenderNodeOutput

Корисне навантаження, яке гостьовий модуль Provider повертає зі свого експорту render_node: серіалізовані байти кожного вихідного файлу, який згенерував гостьовий модуль, імена, які він вивів у кожен зі своїх просторів ключів, факти, які він повідомляє про згенероване, кількість відрендерених одиниць, з якими збігся кожен переданий йому запис omit, і будь-яку діагностику, яку гостьовий модуль видав під час рендерингу. Гостьовий модуль повертає серіалізовані байти кожного файлу; хост записує їх дослівно й не запускає жодного серіалізатора. Детермінованість — відповідальність гостьового модуля: однакові вхідні дані мають давати однакові байти.

ВластивістьТипОбов’язковаОпис
filesRenderedFile[]такВихідні файли, які згенерував гостьовий модуль, у порядку генерування. Кожен називає свій шлях на диску й містить серіалізовані байти, які хост записує дослівно.
derived_keysmap of string[]ніІмена, які гостьовий модуль вивів під час рендерингу цього вузла, згруповані за простором ключів, у який він їх вивів; кожен простір містить свої імена в порядку виведення. Гостьовий модуль, який виводить ім’я, за яким його вивід адресує ресурс, поміщає це ім’я всередину байтів файлу, які хост записує дослівно і де хост його не бачить; оголошення імені тут — це спосіб, у який гостьовий модуль просить хост підтвердити, що жодні два виведення не дали однакового імені. Хост порівнює оголошені імена на рівність у межах одного оголошеного простору й більше нічого не робить — він не розбирає ім’я, не дізнається, що означає простір чи ім’я, і ніколи сам не виводить імен. Два учасники одного зібраного виводу, які оголошують однакове ім’я в однаковому просторі, зупиняють збірку, і повідомлення про зупинку називає простір, ім’я та обох учасників. І назви просторів, і імена в них належать до власного словника гостьового модуля: гостьовий модуль, якому потрібна унікальність у вужчій або ширшій області, ніж один зібраний вивід, виражає цю область у назві простору, яку оголошує. Зберігає порядок оголошення, щоб корисне навантаження було побайтово ідентичним між запусками з однаковими вхідними даними. Відсутнє, коли гостьовий модуль не виводить імен, які хоче перевірити, і тоді перевірка для цього гостьового модуля не діє.
render_factsRenderFact[]ніФакти, які гостьовий модуль повідомляє про те, що він згенерував для цього вузла, у порядку, в якому гостьовий модуль їх перелічує. Кожен факт поєднує ім’я зі значенням, і обидва належать до власного словника гостьового модуля: які факти повідомляє провайдер, що означає кожне ім’я і що містять його записи — частина документованого контракту цього провайдера, а не цього сокета. Значення кожного факту — список, навіть коли він містить один запис: хост відхиляє факт, значення якого є чимось іншим, називаючи провайдера й факт, і зупиняє збірку. Це єдине, що хост дізнається про значення. Він індексує факти за іменем і передає кожен список шаблонам, які його читають, об’єднуючи списки одного імені, повідомлені кількома рендерингами того самого вузла, у порядку виконання цих рендерингів, і ніколи не дізнається, що означає ім’я чи запис, і сам не виводить фактів — тож провайдер може повідомити те, що бачать лише його власні знання про формат, як-от властивість записаних ним документів, і хост не дізнається про цей формат. Повідомлення фактів ніколи не змінює записаного: файли, які записує хост, — це файли, які повернув гостьовий модуль, незалежно від того, чи супроводжують їх факти. Гостьовий модуль перелічує факти у фіксованому порядку, щоб корисне навантаження було побайтово ідентичним між запусками з однаковими вхідними даними. Відсутнє, коли гостьовий модуль нічого не повідомляє, і це повна відповідь, а не відсутня.
omittedinteger[]ніЗі скількома відрендереними одиницями збігся кожен запис omits вхідних даних: одна кількість на кожен переданий гостьовому модулю запис, у тому самому порядку, кожна — кількість одиниць, з якими збігся цей запис, незалежно від того, чи збігся з ними також інший запис. Нульова кількість — повна відповідь: запис не збігся ні з чим, що відрендерив гостьовий модуль. Ці кількості — усе, що сокет повертає про пропущене: самі одиниці просто відсутні в тому, що повернув гостьовий модуль. Відсутнє, коли гостьовому модулю не передано жодних записів.
diagnosticsDiagnostic[]ніДіагностика, яку гостьовий модуль видав під час рендерингу. Кожен елемент має спільну форму діагностики Wasm-плагіна.
errorstringніПовідомлення про збій, що задається, коли гостьовий модуль виконався, але не зміг завершити операцію; відсутнє в разі успіху. Воно відрізняється від будь-якої діагностики у виводі: діагностика повідомляє про проблеми, виявлені під час виконання, яке все ж дало результат, тоді як error повідомляє, що сама операція не завершилася. Наявну помилку хост показує як невдалий виклик плагіна.
condition_codestringніОписова, придатна для машинного зіставлення ідентичність умови, яку називає збій, — код, під яким умову зареєстровано, у тому самому відкритому наборі, в якому компілятор реєструє власні умови зупинки, а не член закритого каталогу кодів помилок хост-функцій, з якого бере значення hostfunc_error_code конверта відповіді. Задається поруч із людиночитним повідомленням про помилку; відсутнє в разі успіху і відсутнє, коли гостьовий модуль не називає такої умови. Гостьовий модуль, що зупиняється, повідомляє тут ідентифікатор умови, яку називає його повідомлення, щоб споживач розгалужувався за ним, а не відновлював ідентичність, читаючи повідомлення. Хост зіставляє цей ідентифікатор з умовами, які оголошує компілятор, і публікує власні ідентифікатори знайденої умови у структурованій діагностиці, тож код, що доходить до читача, завжди розпізнається; ідентифікатор, що не називає такої умови, або той, який нумерація вивела з ужитку, зупиняє збірку. Гостьовий модуль, що не має точної умови, яку можна назвати, натомість вдається до однієї із загальних умов збою плагіна, які компілятор оголошує для цієї мети, і викладає подробиці у власному повідомленні. Цей ідентифікатор і condition_short_code повідомляються разом, бо називають одну умову у двох формах: гостьовий модуль, який задає одне без іншого, назвав умову, яку хост не може розпізнати, і тоді хост повідомляє натомість власну загальну умову збою плагіна, а повідомлення й далі містить увесь збій.
condition_short_codestringніКомпактний ідентифікатор тієї самої умови — літера E і чотири цифри, форма, яку читач цитує, шукає та вставляє у звіт, — задається поруч із людиночитним повідомленням про помилку; відсутній у разі успіху і відсутній, коли гостьовий модуль не називає такої умови. Хост друкує його в заголовку у квадратних дужках діагностики, яку він виводить для цього збою, тож умову, яку видає гостьовий модуль, можна цитувати так само, як ту, яку видає компілятор. Хост зіставляє значення з умовами, які оголошує компілятор, а не приймає його на віру: значення, що не називає такої умови, значення, яке нумерація вивела з ужитку, або написання, якого немає в реєстрації, зупиняє збірку й цитує хибне значення, а власне повідомлення гостьового модуля все одно повідомляється. Він повідомляється разом із condition_code з причини, наведеної там.

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

ValidateNodeOutput

Корисне навантаження, яке гостьовий модуль Provider повертає зі свого необов’язкового експорту validate_node_input: діагностика, виявлена структурною перевіркою розв’язаних вхідних даних вузла. Експорт отримує ту саму проєкцію RenderNodeInput, що й render_node, і не створює файлів — він лише повідомляє діагностику. Діагностика рівня halt гучно зупиняє збірку, називаючи вузол і провайдера; діагностика рівня warn або info потрапляє до результату збірки, не змінюючи згенерований вивід. Порожній список diagnostics означає, що вхідні дані пройшли структурну перевірку.

ВластивістьТипОбов’язковаОпис
diagnosticsDiagnostic[]ніДіагностика, яку гостьовий модуль виявив під час перевірки вхідних даних вузла. Кожен елемент має спільну форму діагностики Wasm-плагіна. Порожній, коли вхідні дані пройшли структурну перевірку.
errorstringніПовідомлення про збій, що задається, коли гостьовий модуль виконався, але не зміг завершити операцію; відсутнє в разі успіху. Воно відрізняється від будь-якої діагностики у виводі: діагностика повідомляє про проблеми, виявлені під час виконання, яке все ж дало результат, тоді як error повідомляє, що сама операція не завершилася. Наявну помилку хост показує як невдалий виклик плагіна.
condition_codestringніОписова, придатна для машинного зіставлення ідентичність умови, яку називає збій, — код, під яким умову зареєстровано, у тому самому відкритому наборі, в якому компілятор реєструє власні умови зупинки, а не член закритого каталогу кодів помилок хост-функцій, з якого бере значення hostfunc_error_code конверта відповіді. Задається поруч із людиночитним повідомленням про помилку; відсутнє в разі успіху і відсутнє, коли гостьовий модуль не називає такої умови. Гостьовий модуль, що зупиняється, повідомляє тут ідентифікатор умови, яку називає його повідомлення, щоб споживач розгалужувався за ним, а не відновлював ідентичність, читаючи повідомлення. Хост зіставляє цей ідентифікатор з умовами, які оголошує компілятор, і публікує власні ідентифікатори знайденої умови у структурованій діагностиці, тож код, що доходить до читача, завжди розпізнається; ідентифікатор, що не називає такої умови, або той, який нумерація вивела з ужитку, зупиняє збірку. Гостьовий модуль, що не має точної умови, яку можна назвати, натомість вдається до однієї із загальних умов збою плагіна, які компілятор оголошує для цієї мети, і викладає подробиці у власному повідомленні. Цей ідентифікатор і condition_short_code повідомляються разом, бо називають одну умову у двох формах: гостьовий модуль, який задає одне без іншого, назвав умову, яку хост не може розпізнати, і тоді хост повідомляє натомість власну загальну умову збою плагіна, а повідомлення й далі містить увесь збій.
condition_short_codestringніКомпактний ідентифікатор тієї самої умови — літера E і чотири цифри, форма, яку читач цитує, шукає та вставляє у звіт, — задається поруч із людиночитним повідомленням про помилку; відсутній у разі успіху і відсутній, коли гостьовий модуль не називає такої умови. Хост друкує його в заголовку у квадратних дужках діагностики, яку він виводить для цього збою, тож умову, яку видає гостьовий модуль, можна цитувати так само, як ту, яку видає компілятор. Хост зіставляє значення з умовами, які оголошує компілятор, а не приймає його на віру: значення, що не називає такої умови, значення, яке нумерація вивела з ужитку, або написання, якого немає в реєстрації, зупиняє збірку й цитує хибне значення, а власне повідомлення гостьового модуля все одно повідомляється. Він повідомляється разом із condition_code з причини, наведеної там.

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

RenderedFile

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

ВластивістьТипОбов’язковаОпис
pathstringтакШлях вихідного файлу відносно вихідного кореня вузла (наприклад, Chart.yaml або templates/deployment.yaml).
contentstringтакСеріалізовані байти файлу точно в тому вигляді, у якому їх створив гостьовий модуль; хост записує ці байти дослівно і не запускає жодного серіалізатора, тож вивід побайтово ідентичний тому, що створив гостьовий модуль. Кожен набір передає їх у власному типі поля — у сирому вигляді, якщо цей тип байтовий, і в кодуванні base64, якщо це рядок, який гостьовий модуль декодує, щоб відновити байти, — а згенерований кодувальник перетворює значення між полем і формою, у якій байти передаються каналом.
formatstringніФормат, у якому, за декларацією гостьового модуля, згенеровано створений файл, щоб хост міг спрямувати файл до відповідного парсера. Відсутній, коли гостьовий модуль не декларує формату; у такому разі хост визначає формат за розширенням файлу.

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

RenderFact

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

ВластивістьТипОбов’язковаОпис
namestringтакНазва факту з власного задокументованого словника провайдера.
valueмасивтакЗначення факту: масив JSON — завжди список, навіть з одним записом або без жодного, — записи якого є будь-якими значеннями JSON у формі, яку провайдер документує для цієї назви. Саме список дає змогу повідомляти одну назву більш ніж одному рендерингу вузла: хост об’єднує списки в один. Він передається як документ JSON, який записав гостьовий модуль, байт у байт, тож порядок записів списку і ключів кожного об’єкта визначає сам гостьовий модуль.

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

OmitEntry

Один запис, що називає згенеровані одиниці, які гостьовий модуль Provider залишає поза виводом вузла; його поля вже розв’язано до простих рядків і позначено там, де будь-яке з них отримано зі значення, оголошеного чутливим. Сокет не надає їм жодного значення: кожен провайдер документує, що саме kind, name, namespace і subchart вибирають у його власному форматі, і сам їх зіставляє.

ВластивістьТипОбов’язковаОпис
kindstringтакВид згенерованої одиниці, яку називає запис, у власному словнику провайдера.
namestringтакНазва згенерованої одиниці, яку називає запис, у власному словнику провайдера.
namespacestringніПростір імен, у якому розміщено названу одиницю, для провайдера, формат якого розміщує одиниці в просторах імен. Відсутній, коли автор його не вказав; що зіставляє запис без простору імен, визначає власний контракт провайдера.
subchartstringніВкладене джерело, з якого походить названа одиниця, для провайдера, чиє джерело збирається із вкладених джерел, як чарт збирається зі своїх сабчартів. Відсутнє, коли автор його не записав; із чим збігається запис без subchart і що провайдер, джерело якого не має вкладених джерел, робить із записом, що називає таке джерело, — це власний контракт провайдера.
sensitiveбулеваніTrue, коли шаблон, з якого отримано будь-яке з полів kind, name, namespace чи subchart запису, читає значення, яке автор оголосив чутливим, або значення, що походить від такого. Це визначається за шаблоном кожного поля відносно оголошень — враховуються посилання, що досягає оголошеного значення, шаблон, що передає далі всі свої дані, або шаблон, який не вдається розібрати, — і ніколи за розв’язаними рядками. Позначка охоплює весь запис, а не називає поле, тож гостьовий модуль поводиться з позначеним записом так само, як з будь-яким іншим позначеним значенням у своїх вхідних даних: він і далі зіставляє та підраховує запис за його полями, для чого запис і призначений, і не допускає жодного його поля в текст, який читає людина, — відмову, попередження чи рядок журналу. Відсутній, коли шаблон жодного поля не читає такого значення; відсутність ніколи не означає, що жодне поле не є чутливим.

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

SourceFile

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

ВластивістьТипОбов’язковаОпис
pathstringтакШлях файлу відносно кореня джерела (наприклад, Chart.yaml або templates/deployment.yaml).
contentstringтакСирі байти файлу точно в тому вигляді, у якому хост прочитав їх із локального джерела. Кожен набір передає їх у власному типі поля — у сирому вигляді, якщо цей тип байтовий, і в кодуванні base64, якщо це рядок, який гостьовий модуль декодує, щоб відновити байти, — а згенерований кодувальник перетворює значення між полем і формою, у якій байти передаються каналом.

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

SourceProjection

Упакований вміст джерела (наприклад, файли чарту Helm, кожен із яких названо його шляхом відносно кореня джерела, у порядку обходу), який хост зчитує й повертає гостьовому модулю у відповідь на запит pack-source, щоб гостьовий модуль відтворив вибране джерело в пам’яті, не торкаючись файлової системи. Це корисне навантаження успішної відповіді хост-функції pack-source.

ВластивістьТипОбов’язковаОпис
filesSourceFile[]такФайли джерела, кожен із яких названо його шляхом відносно кореня джерела, у детермінованому порядку обходу хоста.

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

SourceEntry

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

ВластивістьТипОбов’язковаОпис
pathstringтакШлях запису відносно кореня джерела, розділений скісними рисками (наприклад, Chart.yaml або templates/deployment.yaml).
is_dirбулеватакЧи є запис каталогом. Гостьовий модуль, який визначає корінь чарту або окремий файл джерела серед переліку, зчитує це поле, щоб відрізнити каталоги від файлів, не торкаючись файлової системи.

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

SourceListing

Загальний перелік отриманого джерела, який хост передає гостьовому модулю постачальника з джерелом: корінь джерела, ознака того, чи є цей корінь каталогом, і відсортовані записи під ним відносно кореня. Хост обходить отримане джерело без жодних знань про предметну область і не зчитує вмісту файлів — він перелічує лише імена. Гостьовий модуль застосовує до переліку власну логіку визначення (пошук кореня чарту, вибір окремого документа compose, вендоринг дерева модулів) і просить хост упакувати обрану вибірку через хост-функцію pack-source. Записи відсортовано за шляхом, тож для ідентичних вхідних даних перелік побайтово ідентичний між запусками.

ВластивістьТипОбов’язковаОпис
rootstringтакРозташування отриманого джерела, яке перелічив хост. Гостьовий модуль додає його до власної діагностики, коли не може визначити джерело, тож зупинка через невдале визначення називає джерело, яке вказав автор.
root_is_dirбулеваніЧи є корінь отриманого джерела каталогом. False для однофайлового джерела (окремого документа compose, окремого файлу модуля, архіву); у такому разі entries порожній, а гостьовий модуль пакує сам корінь.
entriesSourceEntry[]такЗаписи відносно кореня під коренем джерела, що є каталогом, відсортовані за шляхом. Порожні для однофайлового кореня джерела.

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

SourcePackRequest

Вибірка, яку гостьовий модуль просить хост упакувати з отриманого джерела через хост-функцію pack-source. Поле op задає форму вибірки, а path — її розташування відносно кореня джерела; хост визначає шлях у межах кореня джерела, відхиляючи будь-який вихід за його межі, і повертає упаковані байти як SourceProjection.

ВластивістьТипОбов’язковаОпис
opstring (enum)такФорма вибірки: file пакує окремий файл за шляхом path; dir пакує файли безпосередньо в каталозі за шляхом path; tree рекурсивно пакує все піддерево з коренем у path у детермінованому порядку обходу хоста. Допустимі значення: "file", "dir", "tree"
pathstringтакРозташування вибірки відносно кореня джерела, розділене скісними рисками. Порожній рядок (або «.») позначає сам корінь джерела, тож однофайлове джерело пакується з порожнім шляхом.

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

SourcePackResponse

Відповідь хост-функції pack-source: у разі успіху — упаковане джерело, у разі збою — повідомлення про помилку. Заповнено рівно одне з двох полів. Збій передається в межах відповіді, а не через пастку (trap), тож гостьовий модуль додає відмову пісочниці або збій читання до власної діагностики як детермінований збій рендерингу.

ВластивістьТипОбов’язковаОпис
source_projectionSourceProjectionніУпаковане джерело в разі успіху; відсутнє в разі збою.
errorstringніПовідомлення про збій у разі збою, що називає вибірку та причину; відсутнє в разі успіху.
hostfunc_error_codestring (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, — для гостьового модуля, логіка визначення якого мусить перевірити вміст файлу, перш ніж вибрати, що пакувати. Хост визначає шлях у межах кореня джерела, відхиляючи будь-який вихід за його межі, і повертає байти файлу.

ВластивістьТипОбов’язковаОпис
pathstringтакРозташування файлу відносно кореня джерела, розділене скісними рисками.

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

SourceFileResponse

Відповідь хост-функції read-source-file: у разі успіху — байти файлу, у разі збою — повідомлення про помилку. Заповнено рівно одне з двох полів. Збій передається в межах відповіді, а не через пастку (trap), тож гостьовий модуль додає відмову пісочниці або збій читання до власної діагностики як детермінований збій рендерингу.

ВластивістьТипОбов’язковаОпис
contentstringніСирі байти файлу в разі успіху; відсутні в разі збою. Кожен набір інструментів зберігає їх у власному типі поля — у сирому вигляді, якщо цей тип байтовий, і в кодуванні base64, якщо це рядок, який гостьовий модуль декодує, щоб їх відновити, — а згенерований кодувальник перетворює між полем і формою, у якій байти передаються каналом.
errorstringніПовідомлення про збій у разі збою, що називає файл і причину; відсутнє в разі успіху.
hostfunc_error_codestring (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, а не структуроване корисне навантаження, тому оголошену форму має лише відповідь.

ВластивістьТипОбов’язковаОпис
contentstringніСирі байти отриманого корисного навантаження у разі успіху; відсутні у разі невдачі, а також коли корисне навантаження порожнє. Байти передаються як байтовий рядок, ніколи як текст base64. Набір для Go зберігає їх як зріз байтів; набори для Rust і TypeScript зберігають їх як рядок base64, який декодує обгортка отримання кожного набору, тож кожна обгортка повертає сирі байти корисного навантаження.
errorstringніПовідомлення про невдачу у разі невдачі, що називає URL і спосіб виправлення; відсутнє у разі успіху.
hostfunc_error_codestring (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 оголошує робоче навантаження, а не джерело чарту. За детермінованість відповідає гість: однакові вхідні дані мають давати однакові байти.

ВластивістьТипОбов’язковаОпис
workloadobjectтакОбчислений хостом Workload після валідації, який синтезує гість; непрозорий на цьому рівні схеми, щоб схема сокета не перевизначала контракт сутності Workload.
sensitive_workloadбулеваніTrue, коли шаблон, що створив workload, читає значення, яке автор оголосив чутливим, або значення, що походить від такого. Це визначається за власними посиланнями шаблону відносно оголошень — враховуються посилання, що досягає оголошеного значення, шаблон, що передає далі всі свої дані, або шаблон, який не вдається розібрати, — і ніколи за вмістом будь-якого поля. Поля відрендереного робочого навантаження не мають зворотного зв’язку з даними, які прочитав його шаблон, тому це позначає весь документ: гість, що складає текст для людини, відмову чи попередження, не включає до цього тексту жодного значення, яке несе робоче навантаження, коли це поле має значення true, тоді як форма документа — його ключі та місце розташування значень — лишається читабельною. Записи вкладень, які називає sensitive_rendered_keys проєкції вузла, позначені там незалежно від того, чи встановлено це поле. Відсутнє, коли шаблон не читає такого значення; відсутність ніколи не означає, що жодне поле не є чутливим.
attachment_providesobjectніКожне вкладення вузла, спроєктоване на його розв’язані provides і з ключем за іменем екземпляра вкладення, яке несе посилання на вкладення робочого навантаження; відсутнє, коли вузол не має вкладень. Хост копіює рядки без інтерпретації, тож гість читає ті записи provides вкладення, які йому потрібні, щоб розв’язати посилання на ресурс, створений цим вкладенням. Те, чи обробляє вкладення матеріал, оголошений чутливим, тут не повторюється: ця інформація передається у відповідному записі функції в проєкції вузла, який гість читає за тим самим іменем екземпляра.

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

ArtifactsProjection

Попередньо обчислений набір артефактів, який хост передає гостю Provider для розміщення у вихідних даних вузла. Хост уже розв’язав джерело кожного запису (вбудований вміст або імпортований файл, який він прочитав), обчислив його як шаблон Go відносно контексту рендерингу з використанням оголошеної гостем пари розділювачів шаблонів артефактів і обчислив набори ключів міток і анотацій походження збірки. Гість відповідає за вибір формату, розміщення відомостей про походження, шлях на диску та остаточні байти. Записи зберігають порядок автора, тож розміщені вихідні дані побайтово ідентичні між запусками з однаковими вхідними даними.

ВластивістьТипОбов’язковаОпис
entriesArtifactProjectionEntry[]такЗаписи артефактів, які розміщує гість, у порядку автора.

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

ArtifactProjectionEntry

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

ВластивістьТипОбов’язковаОпис
namestringтакРозв’язане хостом вихідне ім’я запису: оголошений автором ключ мапи, причому файл, наданий пакетом бібліотеки, вкладено під цей ключ. Гість розміщує запис за цим ім’ям або за похідним від нього підшляхом, специфічним для провайдера.
originstring (enum)такЧи був запис створений як вбудований вміст або як імпортований файл. Гість, який відхиляє одну з форм (провайдер umbrella-чартів відхиляє вбудований вміст), читає це поле, щоб явно зупинитися. Дозволені значення: "inline", "import"
contentstringтакБайти вмісту, уже обчислені як шаблон, які хост створив із вбудованого вмісту або імпортованого файлу запису, обчисленого відносно контексту рендерингу з використанням оголошеної гостем пари розділювачів шаблонів артефактів. Кожен набір зберігає їх у власному типі поля — сирими, де цей тип є байтовим, і закодованими в base64, де це рядок, який гість декодує, щоб їх відновити, — а згенерований кодувальник перетворює між полем і формою, у якій байти передаються.
sensitive_contentбулеваніTrue, коли шаблон, з якого обчислено вміст цього запису, читає значення, яке автор оголосив чутливим, або значення, що походить від такого. Це визначається за власними посиланнями шаблону відносно оголошень, з тією парою розділювачів, з якою обчислювався вміст, — враховуються посилання, що досягає оголошеного значення, шаблон, що передає далі всі свої дані, або шаблон, який не вдається розібрати, — і ніколи за самим вмістом. Вміст є вихідними даними цього шаблону, тож ніщо в ньому не можна простежити до даних, з яких воно походить: гість, що складає текст для людини, відмову чи попередження, не включає до цього тексту жодної частини вмісту, коли це поле має значення true, зокрема й власне повідомлення парсера про вміст. Поле встановлюється для кожного запису окремо, тож те, що шаблон одного запису читає таке значення, нічого не говорить про інший. Відсутнє, коли шаблон не читає такого значення; відсутність ніколи не означає, що вміст не є чутливим.
labelsobjectніБезпечний для міток Kubernetes набір ключів походження збірки, який хост обчислив для вузла, з ключами за іменами міток. Гість, що вносить відомості про походження в metadata.labels маніфесту, вставляє їх; гість, вихідні дані якого не є YAML для Kubernetes, їх ігнорує.
annotationsobjectніНабір ключів походження збірки, який хост обчислив для вузла і який не може бути представлений міткою Kubernetes, з ключами за іменами анотацій. Гість, що вносить відомості про походження в metadata.annotations маніфесту, вставляє їх; гість, вихідні дані якого не є YAML для Kubernetes, їх ігнорує.

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

AssembleBoundaryInput

Корисне навантаження, яке гість Provider отримує у своєму експорті assemble_boundary — експорті, що об’єднує повузлові результати рендерингу в одній групі диспетчеризації в один зібраний артефакт (umbrella-чарт, об’єднаний compose-файл). Воно містить повузлові результати рендерингу з їхніми об’єднаними анотаціями та хвилями розгортання, вихідний шлях групи диспетчеризації, за яким розміщується зібраний артефакт, ребра uses графа для виведення залежностей окремих сервісів, а також контекст часу рендерингу. Не кожен provider оголошує цей експорт: provider-и, що видають лише плаский повузловий результат, його пропускають.

ВластивістьТипОбов’язковаОпис
rendered_nodesRenderedNode[]такПовузлові результати рендерингу, що надійшли до цієї групи диспетчеризації, у порядку вузлів.
contextobjectтакКонтекст часу рендерингу у вигляді байтів його JSON-документа. У цьому експорті хост встановлює лише yaml_indent — ширину відступу для всього рендерингу, з якою серіалізуються зібрані файли; інші члени контексту тут нічого не містять, оскільки збирання об’єднує учасників, чиї анотації та межі різняться, а анотації кожного учасника натомість надходять у його записі rendered_nodes.
boundary_pathstringтакОбчислений вихідний шлях групи диспетчеризації, за яким розміщується зібраний артефакт; збирач межі використовує його як резервну ідентичність на рівні межі (наприклад, назву мережі compose для вузла без анотації простору імен).
edgesRenderEdge[]ніОрієнтовані ребра uses графа, щоб збирач межі міг вивести порядок і залежності окремих сервісів між учасниками групи диспетчеризації (наприклад, depends_on у compose).
sub_chartsSubChart[]ніКорисне навантаження для кожного підчарту, яке споживає збирач umbrella-чарту, щоб видати одну залежність і одну область values для кожного учасника. Кожен запис містить ідентичність підчарту, значення для окремого екземпляра та, для підчарту, вендореного з джерела чарту, незмінені байти файлу Chart.yaml цього чарту. Присутнє для збирання umbrella-чарту; збирач із пласким об’єднанням його пропускає.
chart_namestringніНазва чарту, яку збирач umbrella-чарту використовує для зібраного чарту, коли для групи диспетчеризації задано назву; порожня, коли збирач виводить назву з вихідного шляху групи диспетчеризації.
aggregate_namestringніНазва агрегату верхнього рівня, яку збирач umbrella-чарту включає до виведеної назви зібраного чарту; порожня, коли жодна ідентичність агрегату не входить до назви.

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

RenderedNode

Результат рендерингу одного вузла в тому вигляді, у якому він з’являється у вхідних даних assemble_boundary: id вузла, його тип, його об’єднані анотації, його хвиля синхронізації, значення, які компілятор розв’язав для нього там, де їх постачає компілятор, і ознака того, чи створило їх зіставлення значень, а також файли, які для нього створив експорт render_node, — передані у формі результату рендерингу, де всі члени цієї форми, крім файлів, відсутні.

ВластивістьТипОбов’язковаОпис
idstringтакАбсолютний id вузла в графі топології. Учасник, який не є одним із вузлів графа, — сутність Feature, приєднана до межі, а не до компонента, — натомість передає тут власну ідентичність диспетчеризації, яку компілятор призначив йому, — ту саму, що передавав виклик render_node для цього учасника; вона відрізняє одного учасника від іншого і не є іменем, яке приймає будь-яка ціль. Те, з чого такий учасник виводить імена всередині зібраного артефакту, передається окремо, у derived_name_basis.
typestringтакМітка типу компонента вузла, що передається в цій формі, — на відміну від проєкції рендерингу окремого вузла, яка її приховує. Це непрозорі метадані, а не перемикач поведінки: мітка тут для того, щоб збирач міг групувати й позначати вузли, які він об’єднує, а не для того, щоб гостьовий модуль розгалужувався за нею.
derived_name_basisstringніІдентичність, з якої цей учасник виводить власні імена всередині зібраного артефакту, — логічний id, який збирач створює для одного з опублікованих записів учасника, область окремого учасника в об’єднаному документі, ім’я дочірньої одиниці, розміщеної у власній позиції. Порожнє значення означає, що id використовується безпосередньо; саме таке значення має звичайний компонент. Учасник, чий id є ідентичністю диспетчеризації, яку алфавіт імен цілі не приймає, передає це поле явно, щоб зібраний артефакт звертався до його вмісту за іменем, яке ціль приймає, і щоб два учасники, яких автор може розрізнити, не опинилися під одним іменем. Коли вміст учасника включається в документ, який об’єднує збирач, це те саме значення, яке отримав виклик render_node для цього учасника, і саме передавання його в обох місцях забезпечує рівність двох відповідей: ім’я, яке учасник оголосив під час рендерингу, і ім’я, за яким об’єднаний документ звертається до цього вмісту, виводяться з однієї ідентичності, а не з двох, що випадково збігаються. Коли ж учасника натомість розміщено у власній позиції, це ідентичність, складена для цього учасника, — для сутності Feature, приєднаної до компонента, її власна, а не ідентичність компонента-хоста, відносно якого виконувався її рендеринг, — тож до дочірньої одиниці, розміщеної поруч із хостом, звертаються окремо від нього.
output_directorystringніКаталог, у якому лежать відрендерені файли цього учасника, відносно власної позиції зібраного артефакту, без кінцевого роздільника. Гостьовий модуль, якому треба назвати файли учасника зсередини зібраного артефакту, — шлях джерела блоку module, директиву include, — бере позицію звідси, а не складає її з ідентичності учасника, тож шлях, на який указує зібраний артефакт, — це шлях, куди було записано файли. Ці два місця не завжди відстоять на один каталог: учасник, якого хост розмістив усередині позиції іншого учасника, лежить глибше, ніж учасники, розміщені безпосередньо під збіркою. Присутнє лише там, де провайдер, що виконує збирання, розміщує кожного учасника у власній позиції; провайдер, який згортає своїх учасників в один документ, не розміщує каталогів для окремих учасників і не отримує їх.
renderedRenderNodeOutputтакКорисне навантаження, яке гостьовий модуль Provider повертає зі свого експорту render_node: серіалізовані байти кожного вихідного файлу, який згенерував гостьовий модуль, імена, які він вивів у кожен зі своїх просторів ключів, факти, які він повідомляє про згенероване, кількість відрендерених одиниць, з якими збігся кожен переданий йому запис omit, і будь-яку діагностику, яку гостьовий модуль видав під час рендерингу. Гостьовий модуль повертає серіалізовані байти кожного файлу; хост записує їх дослівно й не запускає жодного серіалізатора. Детермінованість — відповідальність гостьового модуля: однакові вхідні дані мають давати однакові байти.
annotationsmap of stringніОб’єднані анотації вузла, щоб збирач меж міг визначити розміщення окремого вузла (наприклад, мережу compose, виведену з анотації aggrega.ai/namespace).
sync_waveintegerніХвиля розгортання, яку цей вузол успадкував від своєї межі (типово 0; від’ємні значення дозволені), щоб збирач меж міг упорядкувати учасників, яких він об’єднує, один відносно одного. Група диспетчеризації може об’єднувати учасників із кількох меж, кожна з яких має власну хвилю, тому хвиля передається тут із кожним вузлом, а не один раз для всього корисного навантаження. Збирач, форма виводу якого не виражає порядку, ігнорує це поле.
valuesobjectніЗначення, які компілятор розв’язав для цього вузла; присутні лише для вузла, відрендереного з джерела, — виклик 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 графа, тож будь-який із кінців може бути вузлом поза цією групою диспетчеризації.

ВластивістьТипОбов’язковаОпис
sourcestringтакId вузла-споживача — початковий кінець спрямованого ребра uses.
targetstringтакId вузла, що споживається, — кінцевий кінець, на який указує спрямоване ребро uses.

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

SubChart

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

ВластивістьТипОбов’язковаОпис
instance_idstringтакІдентичність екземпляра підчарту в межах групи диспетчеризації; під нею парасольковий чарт розміщує псевдонім залежності підчарту та його значення, тож кілька екземплярів одного вихідного чарту залишаються різними.
versionstringніВерсія, яку парасольковий чарт фіксує для підчарту. Підчарт, вендорений з джерела чарту, натомість бере ім’я та версію своєї залежності з файлу Chart.yaml цього чарту, щоб залежність зв’язалася; це значення застосовується до генеративного підчарту, який не містить вендореного чарту.
valuesobjectніЗначення окремого екземпляра, які парасольковий чарт розміщує під псевдонімом підчарту у файлі values.yaml парасолькового чарту. Ключі надходять у відсортованому порядку, а не в авторському, і саме це сортування робить вміст побайтово ідентичним між запусками з ідентичними вхідними даними; гостьовий модуль, якому потрібен інший порядок, встановлює його сам.
chart_yamlstringніНезмінені байти файлу Chart.yaml вендореного чарту, прочитані з локального джерела під час компіляції, з яких парасольковий чарт бере ім’я та версію залежності підчарту. Порожнє для генеративного підчарту, який не містить вендореного чарту. Кожен набір інструментів зберігає їх у власному типі поля — у сирому вигляді, де цей тип є байтовим, і в кодуванні base64, де це рядок, який гостьовий модуль декодує, щоб їх відновити, — а згенерований кодувальник перетворює між полем і формою, у якій байти передаються по каналу.

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

AssembleBoundaryOutput

Вміст, який гостьовий модуль Provider повертає зі свого експорту assemble_boundary: серіалізовані байти кожного зібраного файлу та будь-яка діагностика, яку гостьовий модуль видав під час збирання. Де розташовані файли окремих вузлів зібраної групи, не є частиною цієї відповіді — це статична властивість провайдера, оголошена один раз у його контракті describe() і відома ще до рендерингу будь-якого вузла. Гостьовий модуль повертає серіалізовані байти кожного файлу; хост записує їх дослівно й не запускає жодного серіалізатора. За детермінованість відповідає гостьовий модуль: ідентичні вхідні дані мають давати ідентичні байти.

ВластивістьТипОбов’язковаОпис
filesRenderedFile[]такЗібрані вихідні файли, які видав гостьовий модуль, у порядку видачі. Кожен називає свій шлях на диску й містить серіалізовані байти, які хост записує дослівно.
diagnosticsDiagnostic[]ніДіагностика, яку гостьовий модуль видав під час збирання. Кожен елемент має спільну форму діагностики Wasm-плагінів.
errorstringніПовідомлення про збій, що задається, коли гостьовий модуль виконався, але не зміг завершити операцію; відсутнє в разі успіху. Воно відрізняється від будь-якої діагностики у виводі: діагностика повідомляє про проблеми, виявлені під час виконання, яке все ж дало результат, тоді як error повідомляє, що сама операція не завершилася. Наявну помилку хост показує як невдалий виклик плагіна.
condition_codestringніОписова, придатна для машинного зіставлення ідентичність умови, яку називає збій, — код, під яким умову зареєстровано, у тому самому відкритому наборі, в якому компілятор реєструє власні умови зупинки, а не член закритого каталогу кодів помилок хост-функцій, з якого бере значення hostfunc_error_code конверта відповіді. Задається поруч із людиночитним повідомленням про помилку; відсутнє в разі успіху і відсутнє, коли гостьовий модуль не називає такої умови. Гостьовий модуль, що зупиняється, повідомляє тут ідентифікатор умови, яку називає його повідомлення, щоб споживач розгалужувався за ним, а не відновлював ідентичність, читаючи повідомлення. Хост зіставляє цей ідентифікатор з умовами, які оголошує компілятор, і публікує власні ідентифікатори знайденої умови у структурованій діагностиці, тож код, що доходить до читача, завжди розпізнається; ідентифікатор, що не називає такої умови, або той, який нумерація вивела з ужитку, зупиняє збірку. Гостьовий модуль, що не має точної умови, яку можна назвати, натомість вдається до однієї із загальних умов збою плагіна, які компілятор оголошує для цієї мети, і викладає подробиці у власному повідомленні. Цей ідентифікатор і condition_short_code повідомляються разом, бо називають одну умову у двох формах: гостьовий модуль, який задає одне без іншого, назвав умову, яку хост не може розпізнати, і тоді хост повідомляє натомість власну загальну умову збою плагіна, а повідомлення й далі містить увесь збій.
condition_short_codestringніКомпактний ідентифікатор тієї самої умови — літера E і чотири цифри, форма, яку читач цитує, шукає та вставляє у звіт, — задається поруч із людиночитним повідомленням про помилку; відсутній у разі успіху і відсутній, коли гостьовий модуль не називає такої умови. Хост друкує його в заголовку у квадратних дужках діагностики, яку він виводить для цього збою, тож умову, яку видає гостьовий модуль, можна цитувати так само, як ту, яку видає компілятор. Хост зіставляє значення з умовами, які оголошує компілятор, а не приймає його на віру: значення, що не називає такої умови, значення, яке нумерація вивела з ужитку, або написання, якого немає в реєстрації, зупиняє збірку й цитує хибне значення, а власне повідомлення гостьового модуля все одно повідомляється. Він повідомляється разом із condition_code з причини, наведеної там.

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

CarveInput

Вміст, який гостьовий модуль Provider отримує у своєму необов’язковому експорті carve: один іменований вихідний файл, який конвеєр розрізає на адресовані одиниці, перш ніж крок FeatureRecipe відредагує деякі з них. Провайдер, чию форму виводу стандартний YAML-кодек не може розрізати напряму (наприклад, шаблонізований чарт), оголошує carve і reassemble, щоб його власні знання про форму виводу містилися в гостьовому модулі; провайдер, який не має цих експортів, використовує стандартний YAML-кодек хоста.

ВластивістьТипОбов’язковаОпис
namestringтакІм’я вихідного файлу, щоб кодек міг застосувати будь-яке правило розрізання, прив’язане до імені.
bodystringтакБайти вихідного файлу, які слід розрізати на адресовані одиниці. Кожен набір інструментів зберігає їх у власному типі поля — у сирому вигляді, де цей тип є байтовим, і в кодуванні base64, де це рядок, який гостьовий модуль декодує, щоб їх відновити, — а згенерований кодувальник перетворює між полем і формою, у якій байти передаються по каналу.
yaml_indentintegerніШирина відступу, яку кодек використовує, коли має синтезувати новий структурований текст; передається, щоб розрізання в гостьовому модулі відповідало відступу всього рендерингу.

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

CarveOutput

Вміст, який гостьовий модуль Provider повертає зі свого експорту carve: упорядковані адресовані одиниці, на які він розрізав файл. Структурована одиниця містить дерево (ціль PATCH); непрозора одиниця містить лише свій тип медіа та байти.

ВластивістьТипОбов’язковаОпис
unitsobject[]такУпорядковані адресовані одиниці, на які гостьовий модуль розрізав файл.

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

ReassembleInput

Корисне навантаження, яке гостьовий модуль Provider отримує у своєму необов’язковому експорті reassemble: вихідний файл разом із його вирізаними одиницями та змінені одиниці, створені кроком конвеєра, щоб гостьовий модуль точково вплів зміни назад у вихідні байти. Токен, відсутній у наборі змінених, знову з’єднується з його вихідних байтів дослівно; у зміненому токені редагуються лише його адресовані діапазони байтів.

ВластивістьТипОбов’язковаОпис
namestringтакІм’я вихідного файлу, що збігається з іменем, під яким цей файл було вирізано.
bodystringтакВихідні байти файлу, у які повторне збирання вплітає змінені одиниці. Кожен набір інструментів передає їх у власному типі поля — як сирі байти, якщо цей тип є байтовим, і в кодуванні base64, якщо це рядок, який гостьовий модуль декодує, щоб їх відновити, — а згенерований кодувальник перетворює між полем і формою, у якій байти передаються каналом.
segsobject[]ніОдиниці, на які було вирізано файл, у тому вигляді, у якому їх повернув carve.
patchedobject[]ніОдиниці, змінені кроком конвеєра; кожна містить свій токен, змінене дерево та операції, що створили зміну.
yaml_indentintegerніШирина відступу, яку кодек використовує, коли операція має синтезувати новий структурований текст; передається, щоб повторне збирання відповідало відступам усього рендерингу.

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

ReassembleOutput

Корисне навантаження, яке гостьовий модуль Provider повертає зі свого експорту reassemble: байти файлу з вплетеними назад зміненими одиницями. Повторне збирання точне до байта — кожен байт, якого не торкнулися операції, зберігається дослівно.

ВластивістьТипОбов’язковаОпис
bodystringтакБайти повторно зібраного файлу, які хост записує дослівно. Кожен набір інструментів передає їх у власному типі поля — як сирі байти, якщо цей тип є байтовим, і в кодуванні base64, якщо це рядок, який гостьовий модуль декодує, щоб їх відновити, — а згенерований кодувальник перетворює між полем і формою, у якій байти передаються каналом.

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

NameBoundInput

Корисне навантаження, яке гостьовий модуль Provider отримує у своєму необов’язковому експорті name_bound: одне ім’я, яке хост пропонує використати як ідентичність компонента вузла, щоб гостьовий модуль оцінив його щодо кожного імені, яке він вивів би з цієї ідентичності для своєї цілі, разом із фактами розв’язаного workload вузла, від яких залежать деякі з цих імен, якщо ідентичність встановлюється після розв’язання цього workload. Гостьовий модуль відповідає обмеженням, а не власним іменем — виведене ім’я, повернуте назад, змусило б хост складати імена для цілі, про яку він нічого не знає, а саме це й усуває поставлене запитання. Провайдер, чия ціль обмежує довжину чи склад імен, які вона приймає, оголошує цей експорт; провайдер, чия ціль приймає будь-яке ім’я, його пропускає, і йому ніколи не ставлять запитання, а його рендеринг не змінюється.

ВластивістьТипОбов’язковаОпис
proposedstringтакІм’я, яке хост пропонує як ідентичність компонента вузла. Гостьовий модуль виводить із нього в пам’яті кожне ім’я, яке він виводить з ідентичності компонента, і повідомляє, чи приймає кожне з них його ціль. Вердикт стосується ПРОПОЗИЦІЇ, а не вузла: хост ставить одне запитання щоразу, коли складає ідентичність, і не повідомляє, для яких саме імен цього вузла ця ідентичність зрештою стане основою, тому гостьовий модуль відповідає так, ніби вона є основою для всіх. Це консервативний напрям, бо за відповіддю хост лише скорочує й ніколи не подовжує — тож ім’я, яке вузол насправді виведе з іншого джерела, оцінюється надто суворо, а не надто м’яко.
authoredбулеваніЧи є запропоноване ім’я таким, що його написала людина, а не таким, що його склав компілятор з авторських частин. Передається, щоб гостьовий модуль міг сформулювати причину для читача, який здатен на неї відреагувати. Воно не визначає, що робить відмова: авторське ім’я відхиляється, а складене — скорочується, і це рішення ухвалює хост.
workload_formstringніФорма workload, у який розв’язується сутність Recipe або FeatureRecipe вузла, у тому вигляді, як її створив шаблон workload; передається, коли ідентичність встановлюється після розв’язання цього workload і workload зазначає форму. Передається в написаному вигляді; хост її не інтерпретує. Гостьовий модуль, чия ціль обмежує ім’я, яке він випускає лише для однієї форми, — запланованого завдання, ім’я якого ціль тримає коротшим за інші імена, бо до нього для кожного запуску додається суфікс, — читає її, щоб оцінити це ім’я. Відсутність означає, що хост не передає форму для цього запитання: вузол не оголошує workload, його workload не зазначає форми або ідентичність встановлюється до розв’язання будь-якого workload. Тоді гостьовий модуль не оцінює жодного імені, що залежить від форми, і відповідає точно так, як відповів би, якби цього поля не існувало.
service_keysstring[]ніКлючі об’єктів Service, які оголошує розв’язаний workload вузла, у порядку, в якому workload їх оголошує; передаються, коли ідентичність встановлюється після розв’язання цього workload і workload оголошує хоча б один Service. Гостьовий модуль, чия ціль називає кожен Service, який він випускає для вузла, за ідентичністю компонента та ключем Service, читає їх, щоб оцінити кожне таке ім’я. Ключ пише автор сутності Recipe або FeatureRecipe, а не той, хто написав ідентичність, тож відмову, спричинену ключем, гостьовий модуль формулює й для цього автора. Відсутність означає, що хост не передає ключів для цього запитання: вузол не оголошує workload, його workload не оголошує жодного Service або ідентичність встановлюється до розв’язання будь-якого workload. Тоді гостьовий модуль не оцінює жодного імені, побудованого з ключа Service, і відповідає точно так, як відповів би, якби цього поля не існувало.

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

DerivedNameVerdict

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

ВластивістьТипОбов’язковаОпис
kindstringтакВласна назва гостьового модуля для виду імені, якого стосується цей вердикт, у термінах цілі, а не компілятора — ім’я релізу інсталятора чартів, ім’я сервісу оркестратора контейнерів. У разі відмови вона дослівно доходить до читача, тому пишеться для того, хто знає ціль.
usableбулеватакЧи приймає ціль ім’я, яке гостьовий модуль вивів би для цього виду із запропонованої ідентичності.
boundintegerніНайбільша кількість символів, яку може мати запропонована ідентичність, щоб виведене ім’я цього виду було прийнятним для цілі. Присутнє лише у відмові, яку задовольнила б коротша ідентичність. ВІДСУТНІСТЬ означає, що заперечення цілі стосується не довжини — або обмеження довжини немає взагалі, або заперечення таке, що жодне скорочення його не усуває, наприклад символ, який граматика цілі не допускає в тій позиції, де він опинився. Отже, відсутність відрізняється від межі нуль, яка таки задає довжину: жодна ідентичність будь-якої довжини не дає прийнятного імені цього виду. Хост скорочує до наявної межі й запитує знову; за відсутньої межі він зупиняється, бо більше нічого спробувати.
reasonstringніЧому ціль не приймає виведене ім’я, у власних термінах цілі, для читача, який вирішує, що написати натомість. Порожнє, якщо вердикт прийнятний.

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

NameBoundOutput

Корисне навантаження, яке гість Provider повертає зі свого експорту name_bound: один вердикт на кожен вид імені, яке він вивів би із запропонованої ідентичності. Пропозиція придатна, коли придатний кожен вердикт; якщо котрийсь непридатний, хост скорочує пропозицію до найменшої межі, яку несуть вердикти з відмовою, і запитує знову, а зупиняється, коли вердикт із відмовою не несе межі. Порожній список вердиктів означає, що гість не виводить жодного імені з ідентичності компонента, і це така сама відповідь, як прийняття пропозиції.

ВластивістьТипОбов’язковаОпис
namesDerivedNameVerdict[]ніОдин запис на кожен вид імені, яке гість виводить з ідентичності компонента, у власному порядку гостя. Гість повідомляє про кожен вид, який він вивів би, а не лише про ті, що отримали відмову, тож читач бачить, які імена було оцінено, а хосту, що читає записи, не потрібен другий виклик, щоб дізнатися решту.
errorstringніПовідомлення про збій, що задається, коли гість запустився, але не зміг завершити операцію; відсутнє в разі успіху. Воно відрізняється від вердикту з відмовою: вердикт повідомляє про ім’я, яке ціль не прийме, а error повідомляє, що на саме запитання не вдалося відповісти. Наявний error хост подає як невдалий виклик плагіна.
condition_codestringніОписова, придатна для машинного зіставлення ідентичність умови, яку називає збій, — код, під яким умову зареєстровано, у тому самому відкритому наборі, в якому компілятор реєструє власні умови зупинки, а не член закритого каталогу кодів помилок хост-функцій, з якого бере значення hostfunc_error_code конверта відповіді. Задається поруч із людиночитним повідомленням про помилку; відсутнє в разі успіху і відсутнє, коли гостьовий модуль не називає такої умови. Гостьовий модуль, що зупиняється, повідомляє тут ідентифікатор умови, яку називає його повідомлення, щоб споживач розгалужувався за ним, а не відновлював ідентичність, читаючи повідомлення. Хост зіставляє цей ідентифікатор з умовами, які оголошує компілятор, і публікує власні ідентифікатори знайденої умови у структурованій діагностиці, тож код, що доходить до читача, завжди розпізнається; ідентифікатор, що не називає такої умови, або той, який нумерація вивела з ужитку, зупиняє збірку. Гостьовий модуль, що не має точної умови, яку можна назвати, натомість вдається до однієї із загальних умов збою плагіна, які компілятор оголошує для цієї мети, і викладає подробиці у власному повідомленні. Цей ідентифікатор і condition_short_code повідомляються разом, бо називають одну умову у двох формах: гостьовий модуль, який задає одне без іншого, назвав умову, яку хост не може розпізнати, і тоді хост повідомляє натомість власну загальну умову збою плагіна, а повідомлення й далі містить увесь збій.
condition_short_codestringніКомпактний ідентифікатор тієї самої умови — літера E і чотири цифри, форма, яку читач цитує, шукає та вставляє у звіт, — задається поруч із людиночитним повідомленням про помилку; відсутній у разі успіху і відсутній, коли гостьовий модуль не називає такої умови. Хост друкує його в заголовку у квадратних дужках діагностики, яку він виводить для цього збою, тож умову, яку видає гостьовий модуль, можна цитувати так само, як ту, яку видає компілятор. Хост зіставляє значення з умовами, які оголошує компілятор, а не приймає його на віру: значення, що не називає такої умови, значення, яке нумерація вивела з ужитку, або написання, якого немає в реєстрації, зупиняє збірку й цитує хибне значення, а власне повідомлення гостьового модуля все одно повідомляється. Він повідомляється разом із condition_code з причини, наведеної там.

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

RenderedNameInput

Корисне навантаження, яке гість Provider отримує у своєму необов’язковому експорті rendered_name: дві ідентичності, з яких ціль виводить власні імена, і те, які види вхідних даних оголошує Recipe вузла, — джерело, яке надав автор, або робоче навантаження, яке синтезує гість. Гість відповідає ім’ям, яке його ціль дасть ресурсам, що він рендерить для цього вузла: для наданого джерела — ім’я, відносно якого рендеряться власні шаблони автора, як-от ім’я релізу, яке читає чарт; для синтезованого робочого навантаження — ім’я, яке гість дає ресурсам, що він будує, якщо він виводить його, а не записує ідентичність вузла як є. Гість, який не виводить такого імені, не повідомляє жодного, і це чесна відповідь для цілі, імена ресурсів якої Recipe записує дослівно, а також для цілі, ім’я якої залежить від того, де розміщено файли, а не від вузла. Цей експорт повідомляє ім’я, яке гість складає сам, і не є обміном, у якому гостя просять оцінити ім’я, запропоноване хостом; це різні запитання, і кожне має власний експорт.

ВластивістьТипОбов’язковаОпис
node_idstringтакВласна ідентичність вузла в тому вигляді, як її написав автор. Вона передається незакодованою: ціль звужує її через власний алфавіт, тож попереднє кодування поклало б одне екранування всередину іншого й записало б ім’я інакше, ніж його передбачає автор рецепта.
derived_name_basisstringніІдентичність, відносно якої рендериться власне джерело учасника, коли вона не збігається з власною ідентичністю вузла, — задається для учасника, ідентичність якого відкидає алфавіт імен цілі, і відсутня в інших випадках. Гість розв’язує цю пару так само, як і будь-яка інша поверхня: це значення, коли воно наявне, і id вузла, коли його немає.
sourcedбулеваніЧи оголошує прив’язаний до вузла Recipe джерело, яке надав автор; зчитується з тексту, який написав автор. Воно передається разом із synthesized, щоб запитання можна було поставити щодо будь-якого вузла й відповісти правильно: гість не повідомляє імені для вузла, який не оголошує жодного з них і вихідні дані якого — лише набір артефактів, бо ресурси в такому наборі названо за артефактами, які написав автор, а не за будь-яким ім’ям, яке виводить гість.
synthesizedбулеваніЧи оголошує прив’язаний до вузла Recipe робоче навантаження, яке має синтезувати гість; зчитується з тексту, який написав автор, так само як sourced. Гість, ціль якого називає синтезовані ним ресурси за виведеним ним ім’ям, а не за ідентичністю вузла в написаному вигляді, повідомляє це ім’я для такого вузла, щоб адресу, яку Recipe публікує для одного з цих ресурсів, можна було побудувати з імені, яке має ресурс.

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

RenderedNameOutput

Корисне навантаження, яке гість Provider повертає зі свого експорту rendered_name: ім’я, яке його ціль дає ресурсам, що він рендерить для вузла, — з наданого автором вихідного коду вузла або з робочого навантаження, яке він синтезує, — або жодного імені. Відсутнє чи порожнє ім’я — це позитивна відповідь, а не збій: вона означає, що ця ціль не виводить такого імені, — і хост використовує отримане, не читаючи його, тож жодне знання про іменування цілі не перетинає межу.

ВластивістьТипОбов’язковаОпис
namestringніІм’я, під яким гість рендерить наданий автором вихідний код цього вузла або яке він дає ресурсам, що синтезує для вузла, уже записане в алфавіті, який його ціль приймає в цій позиції. Порожнє чи відсутнє значення означає, що гість не виводить такого імені.
errorstringніПовідомлення про збій, що задається, коли гість запустився, але не зміг завершити операцію; відсутнє в разі успіху. Воно відрізняється від повідомлення про відсутність імені: відсутність імені — це відповідь про ціль, тоді як error повідомляє, що на саме питання не вдалося відповісти. Хост подає наявну помилку як невдалий виклик плагіна.
condition_codestringніОписова, придатна для машинного зіставлення ідентичність умови, яку називає збій, — код, під яким умову зареєстровано, у тій самій відкритій множині, у якій компілятор реєструє власні умови зупинки. Задається поряд із людським повідомленням про помилку; відсутня в разі успіху й відсутня, коли гість не називає такої умови. Хост зіставляє цей ідентифікатор з умовами, які оголошує компілятор, і публікує власні ідентифікатори зіставленої умови в структурованій діагностиці, тож код, що доходить до читача, завжди зіставляється; ідентифікатор, що не називає такої умови, або той, який нумерація вивела з ужитку, зупиняє збирання. Гість, якому нема чого назвати як точну умову, натомість звертається до однієї із загальних умов збою плагіна, які компілятор оголошує для цієї мети, і викладає подробиці у власному повідомленні. Цей ідентифікатор і condition_short_code повідомляються разом, бо вони називають одну умову у двох формах: гість, що задає одне без іншого, назвав умову, яку хост не може зіставити, і тоді хост натомість повідомляє власну загальну умову збою плагіна, а повідомлення й далі містить увесь збій.
condition_short_codestringніКомпактний ідентифікатор тієї самої умови — літера E і чотири цифри, форма, яку читач цитує, шукає та вставляє у звіт, — задається поруч із людиночитним повідомленням про помилку; відсутній у разі успіху і відсутній, коли гостьовий модуль не називає такої умови. Хост друкує його в заголовку у квадратних дужках діагностики, яку він виводить для цього збою, тож умову, яку видає гостьовий модуль, можна цитувати так само, як ту, яку видає компілятор. Хост зіставляє значення з умовами, які оголошує компілятор, а не приймає його на віру: значення, що не називає такої умови, значення, яке нумерація вивела з ужитку, або написання, якого немає в реєстрації, зупиняє збірку й цитує хибне значення, а власне повідомлення гостьового модуля все одно повідомляється. Він повідомляється разом із condition_code з причини, наведеної там.

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

LinkEndpoint

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

ВластивістьТипОбов’язковаОпис
nodestringтакАбсолютний id вузла кінцевої точки в графі топології.
boundarystringтакШлях межі кінцевої точки — група диспетчеризації, у яку збирається її відрендерений вивід.
providerstringтакПровайдер, що відрендерив кінцеву точку (голе ім’я провайдера). Обидві кінцеві точки підключеного зв’язку називають того самого провайдера; хост не маршрутизує зв’язок, кінцеві точки якого називають різних провайдерів.
releasestringніСутність Release, якій належить відрендерений вивід кінцевої точки, — область, у межах якої іменуються її зібрані артефакти. Хост збирає її із сутності Release, яку визначило збирання, і передає дослівно; він не виводить із цього значення жодного змісту. Провайдер читає його, щоб обмежити ім’я перехресного посилання сутністю Release. Відсутнє значення — це порожній рядок, який провайдер трактує як необмежене ім’я.

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

LinkEdge

Узагальнене, агностичне щодо предметної області корисне навантаження для кожного ребра, яке хост збирає для ребра uses, споживчий і споживаний кінці якого збираються в різні групи диспетчеризації. Воно містить обидві кінцеві точки, анотації розміщення обох кінцевих точок як непрозорі скалярні мапи, які хост не інтерпретує, вивід provides споживаної кінцевої точки, а також сокет і відображення inject, які підключає ребро. Провайдер читає його, щоб створити рідне для провайдера підключення перехресних посилань, потрібне обом кінцям; хост збирає його й передає мапу анотацій як непрозорі скаляри, не виводячи жодного змісту з жодного значення.

ВластивістьТипОбов’язковаОпис
sourceLinkEndpointтакСпоживча кінцева точка — початковий кінець напрямленого ребра uses, у зібраний вивід якого впроваджується підключення на боці споживача.
targetLinkEndpointтакСпоживана кінцева точка — цільовий кінець, на який указує ребро uses, зібраний вивід якого публікує підключення на боці виробника.
target_annotationsmap of stringніАнотації розміщення споживаної (цільової) кінцевої точки як непрозора скалярна мапа з ключами за іменем анотації. Хост збирає їх із визначених анотацій цілі й передає дослівно; він не виводить жодного змісту з жодного значення. Провайдер читає їх, щоб вирішити, як сформувати перехресне посилання (наприклад, чи мають обидва кінці спільне розміщення, чи потрібне посилання між розміщеннями). Ключі серіалізуються у відсортованому порядку, тож корисне навантаження побайтово ідентичне між запусками з ідентичними вхідними даними.
source_annotationsmap of stringніАнотації розміщення споживчої (початкової) кінцевої точки як непрозора скалярна мапа з ключами за іменем анотації. Хост збирає їх із визначених анотацій джерела й передає дослівно; він не виводить жодного змісту з жодного значення. Провайдер читає їх, щоб порівняти розміщення двох кінців — наприклад, чи мають джерело й ціль спільне розміщення, чи перебувають у різних. Ключі серіалізуються у відсортованому порядку, тож корисне навантаження побайтово ідентичне між запусками з ідентичними вхідними даними.
socketstringтакПсевдонім сокета, під яким прив’язано ребро uses.
providesmap of stringтакВивід provides споживаної кінцевої точки — упорядкований автором набір ключів, що відкриває оголошені виводи цілі. Зберігає авторський порядок, тож корисне навантаження побайтово ідентичне між запусками з ідентичними вхідними даними.
injectobjectтакВідображення inject споживчої кінцевої точки з ключами за механізмом доставки до впорядкованого автором набору ключів, що описує, як споживчий кінець отримує вивід споживаної кінцевої точки. Зберігає авторський порядок, тож корисне навантаження побайтово ідентичне між запусками з ідентичними вхідними даними.
read_provides_keysstring[]ніКлючі виводу provides споживаної кінцевої точки, які шаблони кінцевої точки-споживача читають безпосередньо через .context.uses, незалежно від того, чи доставляє їх також відображення inject, в авторському порядку provides. Кожен елемент — один із ключів, які містить provides. Список передається разом із ребром, щоб публікація на боці виробника й розв’язання на боці споживача читали один список. Відсутній, якщо кінцева точка-споживач не читала жодного ключа provides безпосередньо, і провайдер, який не отримав списку, з’єднує зв’язок точно так, як якби цього поля не існувало.

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

LinkPatch

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

ВластивістьТипОбов’язковаОпис
filestringтакФайл виводу, до якого застосовуються операції, названий так, як його видав провайдер.
opsany[]такУпорядковані структурні операції, які слід застосувати до файлу, у порядку застосування.

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

LinkPublishInput

Корисне навантаження, яке провайдер отримує у своєму експорті link_publish: одне міжмежове посилання, на вихід спожитої кінцевої точки якого посилаються через межу, і зібрані файли цієї кінцевої точки. Експорт повертає опубліковану ідентичність, щодо якої виконує розв’язання споживач, і будь-яке зв’язування артефактів на боці виробника, якого потребує вихід спожитої кінцевої точки.

ВластивістьТипОбов’язковаОпис
edgeLinkEdgeтакМіжмежове посилання, що публікується, з погляду спожитої (цільової) кінцевої точки.
producer_filesRenderedFile[]ніЗібрані файли спожитої кінцевої точки, щоб провайдер міг прочитати, що ця кінцева точка вже оголошує, і перевірити щодо них імена, які він збирається опублікувати. Кожен файл називає свій шлях на диску й містить зібрані байти. Відсутнє, коли хост не має зібраного виходу виробника, щоб передати його публікації; провайдер, якому для створення зв’язування не потрібен жоден документ, ігнорує це поле.

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

LinkPublishOutput

Корисне навантаження, яке провайдер повертає зі свого експорту link_publish: дескриптор опублікованої ідентичності, щодо якого виконує розв’язання споживач, і зв’язування артефактів на боці виробника, яке слід застосувати до зібраного виходу спожитої кінцевої точки.

ВластивістьТипОбов’язковаОпис
handlemap of stringтакОпублікована ідентичність, яку спожита кінцева точка надає споживачеві для розв’язання, — непрозора мапа рядків-детермінованих вказівників із ключами за назвою поля (наприклад, ім’я експорту, ім’я стека, регіон, посилання на роль). Значення — це детерміновані рядки-вказівники, які компілятор передає далі й ніколи не розв’язує; їх розв’язує середовище виконання під час розгортання. Ключі серіалізуються у відсортованому порядку, тож корисне навантаження побайтово ідентичне між запусками з ідентичними вхідними даними.
patchesLinkPatch[]ніЗв’язування артефактів на боці виробника: один структурний патч на кожен вихідний файл спожитої кінцевої точки, який публікація має змінити. Порожнє, коли вихід спожитої кінцевої точки не потребує змін для посилання.
errorstringніПовідомлення про збій, що встановлюється, коли гість виконався, але не зміг опублікувати посилання; відсутнє в разі успіху. Хост показує наявну помилку як невдалий виклик плагіна. Публікація, яка не може продовжитися, — наприклад, через ім’я експорту, яке стек уже оголошує під іншим записом, — повідомляється тут, а не лише як аварійне завершення, щоб можна було назвати умову, що стоїть за нею.
condition_codestringніОписова, придатна для машинного зіставлення ідентичність умови, яку називає збій, — код, під яким умову зареєстровано, у тому самому відкритому наборі, в якому компілятор реєструє власні умови зупинки, а не член закритого каталогу кодів помилок хост-функцій, з якого бере значення hostfunc_error_code конверта відповіді. Задається поруч із людиночитним повідомленням про помилку; відсутнє в разі успіху і відсутнє, коли гостьовий модуль не називає такої умови. Гостьовий модуль, що зупиняється, повідомляє тут ідентифікатор умови, яку називає його повідомлення, щоб споживач розгалужувався за ним, а не відновлював ідентичність, читаючи повідомлення. Хост зіставляє цей ідентифікатор з умовами, які оголошує компілятор, і публікує власні ідентифікатори знайденої умови у структурованій діагностиці, тож код, що доходить до читача, завжди розпізнається; ідентифікатор, що не називає такої умови, або той, який нумерація вивела з ужитку, зупиняє збірку. Гостьовий модуль, що не має точної умови, яку можна назвати, натомість вдається до однієї із загальних умов збою плагіна, які компілятор оголошує для цієї мети, і викладає подробиці у власному повідомленні. Цей ідентифікатор і condition_short_code повідомляються разом, бо називають одну умову у двох формах: гостьовий модуль, який задає одне без іншого, назвав умову, яку хост не може розпізнати, і тоді хост повідомляє натомість власну загальну умову збою плагіна, а повідомлення й далі містить увесь збій.
condition_short_codestringніКомпактний ідентифікатор тієї самої умови — літера E і чотири цифри, форма, яку читач цитує, шукає та вставляє у звіт, — задається поруч із людиночитним повідомленням про помилку; відсутній у разі успіху і відсутній, коли гостьовий модуль не називає такої умови. Хост друкує його в заголовку у квадратних дужках діагностики, яку він виводить для цього збою, тож умову, яку видає гостьовий модуль, можна цитувати так само, як ту, яку видає компілятор. Хост зіставляє значення з умовами, які оголошує компілятор, а не приймає його на віру: значення, що не називає такої умови, значення, яке нумерація вивела з ужитку, або написання, якого немає в реєстрації, зупиняє збірку й цитує хибне значення, а власне повідомлення гостьового модуля все одно повідомляється. Він повідомляється разом із condition_code з причини, наведеної там.

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

LinkResolveInput

Корисне навантаження, яке провайдер отримує у своєму експорті link_resolve: одне міжмежове посилання, дескриптор опублікованої ідентичності, який надала його спожита кінцева точка, і зібрані файли споживчої кінцевої точки. Експорт повертає зв’язування артефактів на боці споживача, яке вставляє посилання в зібраний вихід споживчої кінцевої точки.

ВластивістьТипОбов’язковаОпис
edgeLinkEdgeтакМіжмежове посилання, що розв’язується, з погляду споживчої (вихідної) кінцевої точки.
handlemap of stringтакДескриптор опублікованої ідентичності, який повернув link_publish спожитої кінцевої точки і щодо якого споживач розв’язує своє посилання. Непрозорі рядки-детерміновані вказівники з ключами за назвою поля; компілятор передає їх далі й ніколи не розв’язує. Ключі серіалізуються у відсортованому порядку, тож корисне навантаження побайтово ідентичне між запусками з ідентичними вхідними даними.
consumer_filesRenderedFile[]ніЗібрані файли споживчої кінцевої точки, щоб провайдер міг знайти заповнювач, який хост проставив у споживчий вихід, і створити його заміну за справжнім шляхом заповнювача. Кожен файл називає свій шлях на диску й містить зібрані байти. Відсутнє, коли хост не має зібраного виходу споживача, щоб передати його розв’язанню; провайдер, якому для створення зв’язування не потрібен жоден документ, ігнорує це поле.

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

LinkResolveOutput

Корисне навантаження, яке provider повертає зі свого експорту link_resolve: зв’язування артефактів на боці споживача, яке слід застосувати до зібраного виводу кінцевої точки-споживача, вставляючи посилання на опубліковану ідентичність споживаної кінцевої точки.

ВластивістьТипОбов’язковаОпис
patchesLinkPatch[]такЗв’язування артефактів на боці споживача: один структурний патч на кожен файл виводу кінцевої точки-споживача, який має змінити resolve.
errorstringніПовідомлення про збій, яке встановлюється, коли гостьовий модуль запустився, але не зміг розв’язати зв’язок; відсутнє в разі успіху. Хост подає наявну помилку як невдалий виклик plugin. Resolve, який не може продовжитися, — наприклад, посилання, яке ціль може містити лише як цілий скаляр, трапилося всередині довшого рядка, — повідомляється тут, а не лише як аварійне завершення, щоб можна було назвати умову, що за ним стоїть.
condition_codestringніОписова, придатна для машинного зіставлення ідентичність умови, яку називає збій, — код, під яким умову зареєстровано, у тому самому відкритому наборі, в якому компілятор реєструє власні умови зупинки, а не член закритого каталогу кодів помилок хост-функцій, з якого бере значення hostfunc_error_code конверта відповіді. Задається поруч із людиночитним повідомленням про помилку; відсутнє в разі успіху і відсутнє, коли гостьовий модуль не називає такої умови. Гостьовий модуль, що зупиняється, повідомляє тут ідентифікатор умови, яку називає його повідомлення, щоб споживач розгалужувався за ним, а не відновлював ідентичність, читаючи повідомлення. Хост зіставляє цей ідентифікатор з умовами, які оголошує компілятор, і публікує власні ідентифікатори знайденої умови у структурованій діагностиці, тож код, що доходить до читача, завжди розпізнається; ідентифікатор, що не називає такої умови, або той, який нумерація вивела з ужитку, зупиняє збірку. Гостьовий модуль, що не має точної умови, яку можна назвати, натомість вдається до однієї із загальних умов збою плагіна, які компілятор оголошує для цієї мети, і викладає подробиці у власному повідомленні. Цей ідентифікатор і condition_short_code повідомляються разом, бо називають одну умову у двох формах: гостьовий модуль, який задає одне без іншого, назвав умову, яку хост не може розпізнати, і тоді хост повідомляє натомість власну загальну умову збою плагіна, а повідомлення й далі містить увесь збій.
condition_short_codestringніКомпактний ідентифікатор тієї самої умови — літера E і чотири цифри, форма, яку читач цитує, шукає та вставляє у звіт, — задається поруч із людиночитним повідомленням про помилку; відсутній у разі успіху і відсутній, коли гостьовий модуль не називає такої умови. Хост друкує його в заголовку у квадратних дужках діагностики, яку він виводить для цього збою, тож умову, яку видає гостьовий модуль, можна цитувати так само, як ту, яку видає компілятор. Хост зіставляє значення з умовами, які оголошує компілятор, а не приймає його на віру: значення, що не називає такої умови, значення, яке нумерація вивела з ужитку, або написання, якого немає в реєстрації, зупиняє збірку й цитує хибне значення, а власне повідомлення гостьового модуля все одно повідомляється. Він повідомляється разом із condition_code з причини, наведеної там.

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