Os plugins de etiquetagem integrados
Dois plugins de governança compilados na CLI que escrevem rótulos nos nós de um build sem uma política a ser escrita: o que cada um lê, o que cada um escreve, e uma vinculação de cada um com os rótulos que escreveu.
A CLI traz dois plugins de governança que moldam rótulos apenas a partir da configuração, sem nenhuma linguagem de políticas a escrever:
| Plugin | Escreve |
|---|---|
governance/label-injector | os rótulos que uma lista de regras define em cada nó cujos rótulos correspondem à regra |
governance/selector-tagger | um único rótulo, tag, cujo valor um mapa de nomes de Component atribui a cada nó |
Ambos são vinculados como qualquer plugin de governança, por meio de plugins.governance na configuração do espaço de trabalho (veja Vincular uma política), e ambos estão listados entre os plugins embutidos. As vinculações desta página nomeiam 0.9.0, a versão da entidade Plugin de cada plugin no catálogo da biblioteca padrão; o build fornece o plugin compilado na CLI.
O que os dois compartilham
Eles atendem a label-transform e a nenhum outro papel. Cada um relata alterações de rótulos no papel que molda rótulos, depois que o grafo de build é construído e antes que ele seja julgado (veja os papéis de transformação). Vinculado a qualquer outro papel, qualquer um dos dois é recusado antes de ser executado, porque não declara nenhum export para esse papel. Em ir-verdict, o build é interrompido com:
[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 sandboxEm render-verdict e annotation-transform, a recusa é o mesmo E0085, nomeando em vez disso verdict_render e transform_annotations.
Eles leem os rótulos de um nó e o seu Component, e nada mais. Os rótulos de um nó são os que ele carrega quando o plugin é executado: os do seu próprio Component e os que qualquer transformação listada antes dele escreveu. O seu Component é o nome que o type: do Aggregate lhe dá, como core/datastore/mariadb. Nenhum dos dois plugins lê os valores de um nó, a Release ou o seu ambiente: o que qualquer um deles escreve em um nó decorre apenas dos rótulos e do Component desse nó.
Eles escrevem rótulos, e apenas rótulos. Cada alteração que qualquer um dos plugins relata nomeia um rótulo em um nó do build, com um valor string. Escrever um rótulo que o nó já carrega substitui o seu valor — incluindo um rótulo próprio do Component. Nenhum dos dois remove um rótulo, e nenhum pode alterar um valor, o Component ou a versão de um nó, ou o conjunto de nós: o papel que molda rótulos não oferece nenhuma alteração desse tipo (veja Moldar rótulos).
As configurações deles não são verificadas antes de serem executados. Nenhum dos dois declara um esquema para as suas settings, então o build as entrega ao plugin como foram escritas. Uma chave que o plugin não lê é ignorada — um rules com erro de digitação não define nada, e o build é concluído — enquanto uma chave que ele lê contendo um valor de outro tipo interrompe o build com uma mensagem que nomeia o plugin, depois decode settings: e o motivo.
Eles leem os arquivos sob sources como YAML, em ordem de nome de arquivo. O plugin recebe os arquivos ordenados por nome de arquivo, qualquer que seja a ordem em que a vinculação os lista. Um arquivo que não é YAML válido interrompe o build com uma mensagem que nomeia o plugin, depois parse source "<file>": e o motivo do parser; um cujo conteúdo não tem a forma que o plugin lê o interrompe com decode source "<file>": e o motivo.
O arquivo de bloqueio contém as entradas que um build aplica. O pull que resolve o arquivo de bloqueio de uma Release — aggrega pull, ou um build com --auto-pull — registra as configurações de cada vinculação e o conteúdo de cada um dos seus arquivos, e um build aplica o que foi registrado. Depois de editar as configurações de uma vinculação ou um dos seus arquivos, resolva o arquivo de bloqueio novamente; um build que não faz isso continua escrevendo os rótulos que as entradas registradas determinam.
Vinculado sem um bloco with:, nenhum dos dois escreve nada, e o build é concluído.
Várias vinculações em label-transform são executadas na ordem em que estão listadas, cada uma lendo os rótulos que as anteriores escreveram, de modo que uma regra pode corresponder a um rótulo que uma vinculação anterior definiu. examples/policy-label-transform/ vincula os dois plugins depois de uma política Rego, além de um veredito que lê o que os três escreveram.
governance/label-injector
O injetor de rótulos adiciona rótulos a cada nó cujos rótulos correspondem a uma regra.
As configurações do injetor de rótulos
| Configuração | Tipo | Padrão | Efeito |
|---|---|---|---|
rules | uma lista de regras | nenhum | as regras aplicadas a cada nó; sem regras, o plugin não escreve nada |
Cada regra carrega dois mapas de chaves de rótulo para valores string:
| Chave | Padrão | Efeito |
|---|---|---|
match | nenhum par | um nó corresponde quando carrega cada par listado, cada um com esse valor; uma regra sem pares corresponde a todos os nós |
set | nenhum par | cada par é escrito em cada nó ao qual a regra corresponde |
Um rótulo que o nó não carrega é comparado como a string vazia, de modo que um par de match cujo valor é "" também corresponde a um nó que não carrega essa chave.
As regras são aplicadas a cada nó na ordem em que estão listadas, e um rótulo que uma regra posterior escreve substitui o valor que uma regra anterior escreveu para a mesma chave.
De onde vêm as regras
O plugin lê rules das suas configurações quando as configurações contêm pelo menos uma regra. Quando não contêm nenhuma, ele lê os arquivos sob sources, em ordem de nome de arquivo, e usa as regras do primeiro arquivo cuja lista rules de nível superior contém pelo menos uma, na mesma forma:
rules: - match: {} set: ops.example.com/owner: shop-teamAs regras de arquivos posteriores não são lidas. Um arquivo anterior a ele que não pode ser analisado interrompe o build.
O injetor de rótulos vinculado, e os rótulos que ele escreveu
Esta vinculação define um proprietário em cada nó e, depois, um agendamento de backup e um proprietário diferente nos nós da 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-teamVinculado sozinho ao Aggregate de 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 imprime um grafo de build cujos nós carregam:
"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]}Todos os nós corresponderam à primeira regra e receberam shop-team; db e cache, na categoria datastore, corresponderam também à segunda, que o substituiu por data-team. Todos os outros rótulos são os do próprio Component.
governance/selector-tagger
O etiquetador por seletor escreve um rótulo tag em cada nó, com o valor consultado pelo Component do nó.
O mapa e as configurações do etiquetador por seletor
Ele sempre escreve a chave tag; a chave não é configurável.
O mapa vem dos arquivos sob sources. Cada arquivo é um mapa YAML do nome de um Component para a tag que os seus nós recebem:
core/datastore/mariadb: orderscore/datastore/redis: sessionsTodos os arquivos são lidos, em ordem de nome de arquivo, e uma entrada em um arquivo posterior substitui a entrada do mesmo Component em um anterior. Cada tag é uma string: um valor que o YAML lê como outro tipo, como 3, interrompe o build, então coloque-o entre aspas — "3".
| Configuração | Tipo | Padrão | Efeito |
|---|---|---|---|
default | string | vazio | a tag que um nó recebe quando o mapa não lista o seu Component; quando vazio, esse nó fica sem tag |
Sem sources, todo nó recebe o default.
O etiquetador por seletor vinculado, e os rótulos que ele escreveu
Esta vinculação atribui uma tag ao banco de dados e ao cache a partir de tags.yaml, o mapa acima, e untagged a todos os outros nós:
plugins: governance: - uri: governance/selector-tagger:0.9.0 role: label-transform with: sources: - tags.yaml settings: default: untaggedVinculado sozinho ao mesmo Aggregate, aggrega build --release release-production.yaml --auto-pull --ir-graph imprime um grafo de build cujos nós carregam:
"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 não está no mapa, então web recebeu o default. Sem a configuração default, web não carrega nenhuma tag e os outros dois recebem a sua tag como acima.
Onde o compilador não interpreta
Nenhum dos dois plugins, nem o compilador, sabe o que significa um proprietário, um agendamento de backup ou uma tag. As chaves e os valores dos rótulos são strings que a vinculação fornece; o compilador entrega a cada plugin os nós, aplica os rótulos que ele relata e os carrega no grafo de build, onde uma política que os lê lhes dá o seu significado.