I plugin di tagging integrati
Due plugin di governance compilati nella CLI che scrivono etichette sui nodi di una build senza che occorra scrivere una policy: che cosa legge ciascuno, che cosa scrive ciascuno, e un’associazione di ciascuno con le etichette che ha scritto.
La CLI include due plugin di governance che modellano le etichette a partire dalla sola configurazione, senza alcun linguaggio di policy da scrivere:
| Plugin | Scrive |
|---|---|
governance/label-injector | le etichette che un elenco di regole imposta su ogni nodo le cui etichette corrispondono alla regola |
governance/selector-tagger | una sola etichetta, tag, il cui valore viene assegnato a ciascun nodo da una mappa di nomi di Component |
Entrambi si associano come qualsiasi plugin di governance, tramite plugins.governance nella configurazione del workspace (vedi Associare una policy), ed entrambi sono elencati tra i plugin integrati. Le associazioni in questa pagina nominano 0.9.0, la versione dell’entità Plugin di ciascun plugin nel catalogo della libreria standard; la build serve il plugin compilato nella CLI.
Ciò che i due hanno in comune
Servono label-transform e nessun altro ruolo. Ciascuno riporta modifiche alle etichette nel ruolo che modella le etichette, dopo che il grafo di build è stato costruito e prima che venga giudicato (vedi i ruoli di trasformazione). Associato a qualsiasi altro ruolo, ciascuno dei due viene rifiutato prima di essere eseguito, perché non dichiara alcun export per quel ruolo. In ir-verdict la build si arresta con:
[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 sandboxIn render-verdict e annotation-transform il rifiuto è lo stesso E0085, che nomina invece verdict_render e transform_annotations.
Leggono le etichette di un nodo e il suo Component, e nient’altro. Le etichette di un nodo sono quelle che porta quando il plugin viene eseguito: quelle proprie del suo Component, e quelle scritte da qualsiasi trasformazione elencata prima di esso. Il suo Component è il nome che gli dà il type: dell’Aggregate, come core/datastore/mariadb. Nessuno dei due plugin legge i valori di un nodo, la Release o il suo ambiente: ciò che ciascuno dei due scrive su un nodo deriva soltanto dalle etichette e dal Component di quel nodo.
Scrivono etichette, e soltanto etichette. Ogni modifica riportata da uno dei due plugin nomina un’etichetta su un nodo della build, con un valore stringa. Scrivere un’etichetta che il nodo porta già ne sostituisce il valore — compresa un’etichetta propria del Component. Nessuno dei due rimuove un’etichetta, e nessuno dei due può modificare un valore, il Component o la versione di un nodo, o l’insieme dei nodi: il ruolo che modella le etichette non offre modifiche di questo tipo (vedi Modellare le etichette).
Le loro impostazioni non vengono verificate prima dell’esecuzione. Nessuno dei due dichiara uno schema per le proprie settings, quindi la build le passa al plugin così come sono scritte. Una chiave che il plugin non legge viene ignorata — un rules scritto male non imposta nulla, e la build si completa — mentre una chiave che legge e che contiene un valore di un altro tipo arresta la build con un messaggio che nomina il plugin, poi decode settings: e il motivo.
Leggono i file sotto sources come YAML, in ordine di nome di file. Il plugin riceve i file ordinati per nome di file, qualunque sia l’ordine in cui l’associazione li elenca. Un file che non è YAML valido arresta la build con un messaggio che nomina il plugin, poi parse source "<file>": e il motivo del parser; uno il cui contenuto non ha la forma che il plugin legge la arresta con decode source "<file>": e il motivo.
Il lockfile contiene gli input che una build applica. Il pull che risolve il lockfile di una Release — aggrega pull, o una build con --auto-pull — registra le impostazioni di ciascuna associazione e il contenuto di ciascuno dei suoi file, e una build applica ciò che è stato registrato. Dopo aver modificato le impostazioni di un’associazione o uno dei suoi file, risolvi di nuovo il lockfile; una build che non lo fa continua a scrivere le etichette che danno gli input registrati.
Associato senza un blocco with:, nessuno dei due scrive nulla, e la build si completa.
Più associazioni in label-transform vengono eseguite nell’ordine in cui sono elencate, ciascuna leggendo le etichette scritte da quelle che la precedono, quindi una regola può corrispondere a un’etichetta impostata da un’associazione precedente. examples/policy-label-transform/ associa entrambi i plugin dopo una policy Rego, insieme a un verdetto che legge ciò che hanno scritto tutti e tre.
governance/label-injector
L’iniettore di etichette aggiunge etichette a ogni nodo le cui etichette corrispondono a una regola.
Le impostazioni dell’iniettore di etichette
| Impostazione | Tipo | Predefinito | Effetto |
|---|---|---|---|
rules | un elenco di regole | nessuna | le regole applicate a ogni nodo; senza regole, il plugin non scrive nulla |
Ogni regola porta due mappe da chiavi di etichetta a valori stringa:
| Chiave | Predefinito | Effetto |
|---|---|---|
match | nessuna coppia | un nodo corrisponde quando porta ogni coppia elencata, ciascuna con quel valore; una regola senza coppie corrisponde a ogni nodo |
set | nessuna coppia | ogni coppia viene scritta su ciascun nodo a cui la regola corrisponde |
Un’etichetta che il nodo non porta viene confrontata come la stringa vuota, quindi una coppia match il cui valore è "" corrisponde anche a un nodo che non porta quella chiave.
Le regole vengono applicate a ciascun nodo nell’ordine in cui sono elencate, e un’etichetta scritta da una regola successiva sostituisce il valore che una regola precedente ha scritto per la stessa chiave.
Da dove provengono le regole
Il plugin legge rules dalle sue impostazioni quando le impostazioni contengono almeno una regola. Quando non ne contengono nessuna, legge i file sotto sources, in ordine di nome di file, e prende le regole del primo file il cui elenco rules di primo livello ne contiene almeno una, nella stessa forma:
rules: - match: {} set: ops.example.com/owner: shop-teamLe regole di qualsiasi file successivo non vengono lette. Un file che lo precede e che non si riesce ad analizzare arresta la build.
L’iniettore di etichette associato, e le etichette che ha scritto
Questa associazione imposta un proprietario su ogni nodo, poi una pianificazione dei backup e un proprietario diverso sui nodi della categoria 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-teamAssociato da solo all’Aggregate di 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 stampa un grafo di build i cui nodi portano:
"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]}Ogni nodo ha corrisposto alla prima regola e ha preso shop-team; db e cache, nella categoria datastore, hanno corrisposto anche alla seconda, che lo ha sostituito con data-team. Ogni altra etichetta è propria del Component.
governance/selector-tagger
Il tagger per selettore scrive un’etichetta tag su ciascun nodo, con il valore cercato in base al Component del nodo.
La mappa e le impostazioni del tagger per selettore
Scrive sempre la chiave tag; la chiave non è configurabile.
La mappa proviene dai file sotto sources. Ogni file è una mappa YAML dal nome di un Component al tag che i suoi nodi assumono:
core/datastore/mariadb: orderscore/datastore/redis: sessionsOgni file viene letto, in ordine di nome di file, e una voce in un file successivo sostituisce la voce dello stesso Component in uno precedente. Ogni tag è una stringa: un valore che YAML legge come un altro tipo, come 3, arresta la build, quindi mettilo tra virgolette — "3".
| Impostazione | Tipo | Predefinito | Effetto |
|---|---|---|---|
default | string | vuoto | il tag che un nodo assume quando la mappa non elenca il suo Component; se vuoto, un nodo del genere resta senza tag |
Senza sources, ogni nodo assume il default.
Il tagger per selettore associato, e le etichette che ha scritto
Questa associazione assegna un tag al database e alla cache a partire da tags.yaml, la mappa qui sopra, e a ogni altro nodo untagged:
plugins: governance: - uri: governance/selector-tagger:0.9.0 role: label-transform with: sources: - tags.yaml settings: default: untaggedAssociato da solo allo stesso Aggregate, aggrega build --release release-production.yaml --auto-pull --ir-graph stampa un grafo di build i cui nodi portano:
"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 non è nella mappa, quindi web ha preso il default. Senza l’impostazione default, web non porta alcun tag e gli altri due ricevono il tag come sopra.
Dove il compilatore non interpreta
Né l’uno né l’altro plugin, né il compilatore, sanno che cosa significhino un proprietario, una pianificazione dei backup o un tag. Le chiavi e i valori delle etichette sono stringhe fornite dall’associazione; il compilatore passa a ciascun plugin i nodi, applica le etichette che riporta e le porta nel grafo di build, dove una policy che le legge dà loro il loro significato.