Вбудовані плагіни розмітки
Два плагіни керування, вбудовані в CLI, які записують мітки на вузли збірки без написання політики: що кожен читає, що кожен записує, і приклад підключення кожного з мітками, які він записав.
CLI містить два плагіни керування, які формують мітки лише на основі конфігурації, без написання коду мовою політик:
| Plugin | Записує |
|---|---|
governance/label-injector | мітки, які список правил встановлює на кожному вузлі, чиї мітки відповідають правилу |
governance/selector-tagger | одну мітку, tag, значення якої кожному вузлу задає мапа імен сутностей Component |
Обидва підключаються так само, як будь-який плагін керування, через plugins.governance у конфігурації робочого простору (див. Підключення політики), і обидва перелічено серед вбудованих плагінів. Підключення на цій сторінці вказують 0.9.0 — версію сутності Plugin кожного плагіна в каталозі стандартної бібліотеки; збірка використовує плагін, вбудований у CLI.
Що в них спільного
Вони обслуговують роль label-transform і жодної іншої. Кожен повідомляє про зміни міток у ролі формування міток — після того як граф збірки побудовано і до того як його оцінено (див. ролі перетворення). У разі підключення до будь-якої іншої ролі будь-який із них відхиляється до запуску, бо не оголошує експорту для цієї ролі. На ir-verdict збірка зупиняється з повідомленням:
[E0085] ir-verdict: plugin "governance/label-injector:0.9.0": call "verdict_ir": wasm: plugin "label-injector" does not declare export "verdict_ir" in describe(): wasm: plugin rejected by the sandbox[E0085] ir-verdict: plugin "governance/selector-tagger:0.9.0": call "verdict_ir": wasm: plugin "selector-tagger" does not declare export "verdict_ir" in describe(): wasm: plugin rejected by the sandboxНа render-verdict і annotation-transform відмова — той самий E0085, але з зазначенням verdict_render і transform_annotations відповідно.
Вони читають мітки вузла та його сутність Component — і нічого більше. Мітки вузла — це ті, що він має на момент запуску плагіна: власні мітки його сутності Component і мітки, записані будь-якими перетвореннями, переліченими раніше. Його сутність Component — це ім’я, яке йому дає type: сутності Aggregate, наприклад core/datastore/mariadb. Жоден із плагінів не читає значення вузла, сутність Release чи її середовище: те, що будь-який із них записує на вузол, визначається лише мітками та сутністю Component цього вузла.
Вони записують мітки, і лише мітки. Кожна зміна, про яку повідомляє будь-який із плагінів, вказує одну мітку на одному вузлі збірки з рядковим значенням. Запис мітки, яку вузол уже має, замінює її значення — зокрема й власну мітку сутності Component. Жоден не видаляє мітки і не може змінити значення, сутність Component чи версію вузла або набір вузлів: роль формування міток не пропонує змін такого роду (див. Формування міток).
Їхні налаштування не перевіряються до запуску. Жоден не оголошує схему для своїх settings, тож збірка передає їх плагіну в тому вигляді, у якому їх написано. Ключ, який плагін не читає, ігнорується — rules з помилкою в написанні нічого не встановлює, і збірка завершується, — тоді як ключ, який плагін читає, зі значенням іншого типу зупиняє збірку з повідомленням, у якому зазначено плагін, потім decode settings: і причину.
Вони читають файли з sources як YAML у порядку імен файлів. Плагін отримує файли, відсортовані за іменем, хоч у якому порядку їх перелічує підключення. Файл, що не є коректним YAML, зупиняє збірку з повідомленням, у якому зазначено плагін, потім parse source "<file>": і причину від парсера; файл, вміст якого не відповідає формі, що її читає плагін, зупиняє її з decode source "<file>": і причиною.
Вхідні дані, які застосовує збірка, зберігає lock-файл. Pull, що розв’язує lock-файл сутності Release, — aggrega pull або збірка з --auto-pull — записує налаштування кожного підключення та вміст кожного його файлу, а збірка застосовує записане. Після редагування налаштувань підключення або одного з його файлів розв’яжіть lock-файл знову; збірка без цього продовжить записувати мітки, які дають записані вхідні дані.
У разі підключення без блоку with: жоден із них нічого не записує, і збірка завершується.
Кілька підключень до label-transform виконуються в порядку переліку, і кожне читає мітки, записані попередніми, тож правило може відповідати мітці, встановленій раніше підключеним плагіном. examples/policy-label-transform/ підключає обидва плагіни після політики Rego, а також вердикт, який читає те, що записали всі три.
governance/label-injector
Інжектор міток додає мітки на кожен вузол, чиї мітки відповідають правилу.
Налаштування інжектора міток
| Налаштування | Тип | За замовчуванням | Дія |
|---|---|---|---|
rules | список правил | немає | правила, що застосовуються до кожного вузла; без правил плагін нічого не записує |
Кожне правило містить дві мапи ключів міток у рядкові значення:
| Ключ | За замовчуванням | Дія |
|---|---|---|
match | немає пар | вузол відповідає, якщо має кожну перелічену пару, кожну з цим значенням; правило без пар відповідає кожному вузлу |
set | немає пар | кожна пара записується на кожен вузол, якому відповідає правило |
Мітка, якої вузол не має, порівнюється як порожній рядок, тож пара в match зі значенням "" відповідає і вузлу, що не має цього ключа.
Правила застосовуються до кожного вузла в порядку переліку, і мітка, записана пізнішим правилом, замінює значення, записане ранішим правилом для того самого ключа.
Звідки беруться правила
Плагін читає rules зі своїх налаштувань, якщо в них є щонайменше одне правило. Якщо правил немає, він читає файли з sources у порядку імен файлів і бере правила з першого файлу, чий список rules верхнього рівня містить щонайменше одне правило, у тій самій формі:
rules: - match: {} set: ops.example.com/owner: shop-teamПравила з будь-якого пізнішого файлу не читаються. Файл перед ним, який не вдається розібрати, зупиняє збірку.
Підключений інжектор міток і мітки, які він записав
Це підключення встановлює власника на кожному вузлі, а потім розклад резервного копіювання та іншого власника на вузлах категорії datastore:
plugins: governance: - uri: governance/label-injector:0.9.0 role: label-transform with: settings: rules: - match: {} set: ops.example.com/owner: shop-team - match: component.aggrega.ai/category: datastore set: backup.example.com/schedule: nightly ops.example.com/owner: data-teamУ разі підключення лише його до сутності Aggregate з examples/policy-label-transform/ — db це core/datastore/mariadb, cache це core/datastore/redis, web це core/devtool/adminer — aggrega build --release release-production.yaml --auto-pull --ir-graph виводить граф збірки, вузли якого мають:
"db": { "labels": { "component.aggrega.ai/type": "stateful-server", "component.aggrega.ai/category": "datastore", "component.aggrega.ai/upstream-licensing": "osi-approved", "backup.example.com/schedule": "nightly", "ops.example.com/owner": "data-team" }, [… omitted: the node's Component, its version and the rest of the node]},"cache": { "labels": { "component.aggrega.ai/type": "server", "component.aggrega.ai/category": "datastore", "datastore.aggrega.ai/engine": "kv", "component.aggrega.ai/hosting": "mixed", "component.aggrega.ai/upstream-licensing": "mixed", "backup.example.com/schedule": "nightly", "ops.example.com/owner": "data-team" }, [… omitted: the node's Component, its version and the rest of the node]},"web": { "labels": { "component.aggrega.ai/type": "server", "component.aggrega.ai/category": "devtool", "component.aggrega.ai/upstream-licensing": "osi-approved", "ops.example.com/owner": "shop-team" }, [… omitted: the node's Component, its version and the rest of the node]}Кожен вузол відповідав першому правилу й отримав shop-team; db і cache з категорії datastore відповідали й другому, яке замінило значення на data-team. Усі інші мітки — власні мітки сутності Component.
governance/selector-tagger
Тегувальник за селектором записує на кожен вузол мітку tag, значення якої шукається за сутністю Component вузла.
Мапа та налаштування тегувальника за селектором
Він завжди записує ключ tag; ключ не налаштовується.
Мапа береться з файлів у sources. Кожен файл — це YAML-мапа з імені сутності Component у тег, який отримують її вузли:
core/datastore/mariadb: orderscore/datastore/redis: sessionsЧитаються всі файли в порядку імен, і запис у пізнішому файлі замінює запис тієї самої сутності Component у ранішому. Кожен тег — рядок: значення, яке YAML читає як інший тип, наприклад 3, зупиняє збірку, тож візьміть його в лапки — "3".
| Налаштування | Тип | За замовчуванням | Дія |
|---|---|---|---|
default | string | порожньо | тег, який отримує вузол, коли мапа не містить його сутності Component; якщо порожньо, такий вузол лишається без tag |
Без sources кожен вузол отримує default.
Підключений тегувальник за селектором і мітки, які він записав
Це підключення позначає базу даних і кеш за tags.yaml — мапою вище, — а кожен інший вузол позначає як untagged:
plugins: governance: - uri: governance/selector-tagger:0.9.0 role: label-transform with: sources: - tags.yaml settings: default: untaggedУ разі підключення лише його до тієї самої сутності Aggregate aggrega build --release release-production.yaml --auto-pull --ir-graph виводить граф збірки, вузли якого мають:
"db": { "labels": { "component.aggrega.ai/type": "stateful-server", "component.aggrega.ai/category": "datastore", "component.aggrega.ai/upstream-licensing": "osi-approved", "tag": "orders" }, [… omitted: the node's Component, its version and the rest of the node]},"cache": { "labels": { "component.aggrega.ai/type": "server", "component.aggrega.ai/category": "datastore", "datastore.aggrega.ai/engine": "kv", "component.aggrega.ai/hosting": "mixed", "component.aggrega.ai/upstream-licensing": "mixed", "tag": "sessions" }, [… omitted: the node's Component, its version and the rest of the node]},"web": { "labels": { "component.aggrega.ai/type": "server", "component.aggrega.ai/category": "devtool", "component.aggrega.ai/upstream-licensing": "osi-approved", "tag": "untagged" }, [… omitted: the node's Component, its version and the rest of the node]}core/devtool/adminer немає в мапі, тож web отримав default. Без налаштування default вузол web не має tag, а два інші позначено, як вище.
Де компілятор не інтерпретує
Ні плагін, ні компілятор не знають, що означає власник, розклад резервного копіювання чи тег. Ключі та значення міток — це рядки, які задає підключення; компілятор передає кожному плагіну вузли, застосовує мітки, про які той повідомляє, і переносить їх у граф збірки, де значення їм надає політика, що їх читає.