Plugin pemberi tag bawaan
Dua plugin tata kelola yang dikompilasi ke dalam CLI yang menulis label pada node sebuah build tanpa perlu menulis kebijakan: apa yang dibaca masing-masing, apa yang ditulis masing-masing, dan contoh pemasangan masing-masing beserta label yang ditulisnya.
CLI menyertakan dua plugin tata kelola yang membentuk label hanya dari konfigurasi, tanpa bahasa kebijakan yang perlu ditulis:
| Plugin | Menulis |
|---|---|
governance/label-injector | label yang ditetapkan sebuah daftar aturan pada setiap node yang labelnya cocok dengan aturan tersebut |
governance/selector-tagger | satu label, tag, yang nilainya diberikan ke setiap node oleh sebuah map nama Component |
Keduanya dipasang seperti plugin tata kelola lainnya, melalui plugins.governance dalam konfigurasi workspace (lihat Memasang kebijakan), dan keduanya tercantum di antara plugin tertanam. Pemasangan di halaman ini menyebut 0.9.0, versi entitas Plugin setiap plugin dalam katalog pustaka standar; build menggunakan plugin yang dikompilasi ke dalam CLI.
Kesamaan keduanya
Keduanya melayani label-transform dan tidak ada peran lain. Masing-masing melaporkan perubahan label pada peran pembentuk label, setelah graf build dibangun dan sebelum graf tersebut dinilai (lihat peran transformasi). Jika dipasang pada peran lain, keduanya ditolak sebelum berjalan, karena tidak mendeklarasikan ekspor untuk peran tersebut. Pada ir-verdict, build berhenti dengan:
[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 sandboxPada render-verdict dan annotation-transform, penolakannya sama, yaitu E0085, tetapi menyebut verdict_render dan transform_annotations.
Keduanya membaca label sebuah node dan Component-nya, dan tidak membaca hal lain. Label sebuah node adalah label yang dimilikinya saat plugin berjalan: label milik Component-nya sendiri, dan label yang ditulis oleh transformasi apa pun yang tercantum sebelumnya. Component-nya adalah nama yang diberikan type: milik Aggregate kepadanya, seperti core/datastore/mariadb. Tidak ada plugin yang membaca nilai node, Release, atau lingkungannya: apa yang ditulis salah satunya pada sebuah node hanya ditentukan oleh label dan Component node tersebut.
Keduanya menulis label, dan hanya label. Setiap perubahan yang dilaporkan salah satu plugin menyebut satu label pada satu node build, dengan nilai string. Menulis label yang sudah dimiliki node akan mengganti nilainya — termasuk label milik Component itu sendiri. Tidak ada yang menghapus label, dan tidak ada yang dapat mengubah nilai, Component atau versi sebuah node, atau himpunan node: peran pembentuk label tidak menawarkan perubahan semacam itu (lihat Membentuk label).
Pengaturannya tidak diperiksa sebelum berjalan. Tidak ada yang mendeklarasikan skema untuk settings-nya, sehingga build menyerahkannya ke plugin apa adanya. Kunci yang tidak dibaca plugin akan diabaikan — rules yang salah eja tidak menetapkan apa pun, dan build tetap selesai — sedangkan kunci yang dibaca plugin tetapi berisi nilai bertipe lain akan menghentikan build dengan pesan yang menyebut plugin, lalu decode settings: dan alasannya.
Keduanya membaca file di bawah sources sebagai YAML, dalam urutan nama file. Plugin menerima file yang diurutkan berdasarkan nama file, apa pun urutan yang dicantumkan pemasangan. File yang bukan YAML valid menghentikan build dengan pesan yang menyebut plugin, lalu parse source "<file>": dan alasan dari parser; file yang isinya tidak berbentuk seperti yang dibaca plugin menghentikannya dengan decode source "<file>": dan alasannya.
Lockfile menyimpan input yang diterapkan sebuah build. Pull yang me-resolve lockfile sebuah Release — aggrega pull, atau build dengan --auto-pull — mencatat pengaturan setiap pemasangan dan isi setiap filenya, dan build menerapkan apa yang dicatat. Setelah mengedit pengaturan sebuah pemasangan atau salah satu filenya, resolve lockfile kembali; build yang tidak melakukannya akan terus menulis label yang dihasilkan input yang tercatat.
Jika dipasang tanpa blok with:, keduanya tidak menulis apa pun, dan build selesai.
Beberapa pemasangan pada label-transform berjalan sesuai urutan pencantumannya, masing-masing membaca label yang ditulis pemasangan sebelumnya, sehingga sebuah aturan dapat mencocokkan label yang ditetapkan pemasangan sebelumnya. examples/policy-label-transform/ memasang kedua plugin setelah sebuah kebijakan Rego, serta sebuah verdict yang membaca apa yang ditulis ketiganya.
governance/label-injector
Label injector menambahkan label ke setiap node yang labelnya cocok dengan sebuah aturan.
Pengaturan label injector
| Pengaturan | Jenis | Default | Efek |
|---|---|---|---|
rules | daftar aturan | tidak ada | aturan yang diterapkan ke setiap node; tanpa aturan, plugin tidak menulis apa pun |
Setiap aturan membawa dua map dari kunci label ke nilai string:
| Kunci | Default | Efek |
|---|---|---|
match | tanpa pasangan | node cocok bila memiliki setiap pasangan yang tercantum, masing-masing dengan nilai tersebut; aturan tanpa pasangan cocok dengan setiap node |
set | tanpa pasangan | setiap pasangan ditulis pada setiap node yang cocok dengan aturan |
Label yang tidak dimiliki node dibandingkan sebagai string kosong, sehingga pasangan match yang bernilai "" juga cocok dengan node yang tidak memiliki kunci tersebut.
Aturan diterapkan ke setiap node sesuai urutan pencantumannya, dan label yang ditulis aturan berikutnya mengganti nilai yang ditulis aturan sebelumnya untuk kunci yang sama.
Asal aturan
Plugin membaca rules dari pengaturannya bila pengaturan memuat setidaknya satu aturan. Bila tidak ada, plugin membaca file di bawah sources, dalam urutan nama file, dan mengambil aturan dari file pertama yang daftar rules tingkat atasnya memuat setidaknya satu aturan, dengan bentuk yang sama:
rules: - match: {} set: ops.example.com/owner: shop-teamAturan dari file berikutnya tidak dibaca. File sebelumnya yang tidak dapat di-parse akan menghentikan build.
Label injector yang dipasang, dan label yang ditulisnya
Pemasangan ini menetapkan pemilik pada setiap node, lalu jadwal cadangan dan pemilik yang berbeda pada node dalam kategori 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-teamJika dipasang sendirian ke Aggregate dari examples/policy-label-transform/ — db adalah core/datastore/mariadb, cache adalah core/datastore/redis, web adalah core/devtool/adminer — aggrega build --release release-production.yaml --auto-pull --ir-graph mencetak graf build yang node-nya membawa:
"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]}Setiap node cocok dengan aturan pertama dan mendapat shop-team; db dan cache, dalam kategori datastore, juga cocok dengan aturan kedua, yang menggantinya dengan data-team. Setiap label lainnya adalah milik Component itu sendiri.
governance/selector-tagger
Selector tagger menulis label tag pada setiap node, yang nilainya dicari berdasarkan Component node tersebut.
Map dan pengaturan selector tagger
Plugin ini selalu menulis kunci tag; kunci tersebut tidak dapat dikonfigurasi.
Map berasal dari file di bawah sources. Setiap file adalah map YAML dari nama Component ke tag yang diterima node-nya:
core/datastore/mariadb: orderscore/datastore/redis: sessionsSetiap file dibaca, dalam urutan nama file, dan entri dalam file berikutnya mengganti entri Component yang sama dalam file sebelumnya. Setiap tag adalah string: nilai yang dibaca YAML sebagai tipe lain, seperti 3, menghentikan build, jadi beri tanda kutip — "3".
| Pengaturan | Jenis | Default | Efek |
|---|---|---|---|
default | string | kosong | tag yang diterima node bila map tidak mencantumkan Component-nya; bila kosong, node seperti itu dibiarkan tanpa tag |
Tanpa sources, setiap node mendapat default.
Selector tagger yang dipasang, dan label yang ditulisnya
Pemasangan ini memberi tag pada database dan cache dari tags.yaml, yaitu map di atas, dan pada setiap node lain dengan untagged:
plugins: governance: - uri: governance/selector-tagger:0.9.0 role: label-transform with: sources: - tags.yaml settings: default: untaggedJika dipasang sendirian ke Aggregate yang sama, aggrega build --release release-production.yaml --auto-pull --ir-graph mencetak graf build yang node-nya membawa:
"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 tidak ada dalam map, sehingga web mendapat default. Tanpa pengaturan default, web tidak membawa tag dan dua node lainnya diberi tag seperti di atas.
Bagian yang tidak ditafsirkan oleh kompiler
Baik plugin maupun compiler tidak tahu apa arti pemilik, jadwal cadangan, atau tag. Kunci dan nilai label adalah string yang disediakan pemasangan; compiler menyerahkan node ke setiap plugin, menerapkan label yang dilaporkannya, dan membawanya dalam graf build, tempat kebijakan yang membacanya memberinya makna.