Os plugins de etiquetagem integrados
Dois plugins de governação compilados na CLI que escrevem etiquetas nos nós de uma compilação sem que seja preciso escrever uma política: o que cada um lê, o que cada um escreve, e um anexo de cada um com as etiquetas que escreveu.
A CLI inclui dois plugins de governação que moldam etiquetas apenas a partir da configuração, sem nenhuma linguagem de políticas para escrever:
| Plugin | Escreve |
|---|---|
governance/label-injector | as etiquetas que uma lista de regras define em cada nó cujas etiquetas correspondem à regra |
governance/selector-tagger | uma única etiqueta, tag, cujo valor é atribuído a cada nó por um mapa de nomes de Component |
Ambos se anexam como qualquer plugin de governação, através de plugins.governance na configuração do espaço de trabalho (ver Anexar uma política), e ambos constam entre os plugins integrados. Os anexos nesta página nomeiam 0.9.0, a versão da entidade Plugin de cada plugin no catálogo da biblioteca standard; a compilação serve o plugin compilado na CLI.
O que os dois partilham
Servem label-transform e nenhum outro papel. Cada um comunica alterações de etiquetas no papel que molda etiquetas, depois de o grafo de compilação ser construído e antes de ser julgado (ver os papéis de transformação). Anexado 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, a compilação é interrompida 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, que nomeia, em vez disso, verdict_render e transform_annotations.
Leem as etiquetas de um nó e o seu Component, e nada mais. As etiquetas de um nó são as que transporta quando o plugin é executado: as do seu próprio Component e as 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 num nó decorre apenas das etiquetas e do Component desse nó.
Escrevem etiquetas, e apenas etiquetas. Cada alteração que qualquer um dos plugins comunica nomeia uma etiqueta num nó da compilação, com um valor de cadeia de caracteres. Escrever uma etiqueta que o nó já transporta substitui o seu valor — incluindo uma etiqueta própria do Component. Nenhum dos dois remove uma etiqueta, 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 etiquetas não oferece nenhuma alteração desse tipo (ver Moldar etiquetas).
As suas definições não são verificadas antes de serem executados. Nenhum declara um esquema para as suas settings, pelo que a compilação as entrega ao plugin tal como foram escritas. Uma chave que o plugin não lê é ignorada — um rules mal escrito não define nada, e a compilação conclui-se — enquanto uma chave que lê e que contém um valor de outro tipo interrompe a compilação com uma mensagem que nomeia o plugin, depois decode settings: e o motivo.
Leem os ficheiros sob sources como YAML, por ordem de nome de ficheiro. O plugin recebe os ficheiros ordenados por nome de ficheiro, seja qual for a ordem pela qual o anexo os lista. Um ficheiro que não seja YAML válido interrompe a compilação com uma mensagem que nomeia o plugin, depois parse source "<file>": e o motivo do analisador; um cujo conteúdo não tenha a forma que o plugin lê interrompe-a com decode source "<file>": e o motivo.
O ficheiro de bloqueio contém as entradas que uma compilação aplica. O pull que resolve o ficheiro de bloqueio de uma Release — aggrega pull, ou uma compilação com --auto-pull — regista as definições de cada anexo e o conteúdo de cada um dos seus ficheiros, e uma compilação aplica o que foi registado. Depois de editar as definições de um anexo ou um dos seus ficheiros, resolva-se novamente o ficheiro de bloqueio; uma compilação que não o faça continua a escrever as etiquetas que as entradas registadas determinam.
Anexado sem um bloco with:, nenhum dos dois escreve nada, e a compilação conclui-se.
Vários anexos em label-transform são executados pela ordem em que estão listados, cada um a ler as etiquetas que os anteriores escreveram, pelo que uma regra pode corresponder a uma etiqueta que um anexo anterior definiu. examples/policy-label-transform/ anexa os dois plugins depois de uma política Rego, além de um veredicto que lê o que os três escreveram.
governance/label-injector
O injetor de etiquetas acrescenta etiquetas a cada nó cujas etiquetas correspondam a uma regra.
As definições do injetor de etiquetas
| Definição | Tipo | Predefinição | Efeito |
|---|---|---|---|
rules | uma lista de regras | nenhum | as regras aplicadas a cada nó; sem regras, o plugin não escreve nada |
Cada regra transporta dois mapas de chaves de etiqueta para valores de cadeia de caracteres:
| Chave | Predefinição | Efeito |
|---|---|---|
match | nenhum par | um nó corresponde quando transporta 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ó a que a regra corresponde |
Uma etiqueta que o nó não transporta é comparada como a cadeia vazia, pelo que um par de match cujo valor seja "" também corresponde a um nó que não transporta essa chave.
As regras são aplicadas a cada nó pela ordem em que estão listadas, e uma etiqueta 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 definições quando as definições contêm pelo menos uma regra. Quando não contêm nenhuma, lê os ficheiros sob sources, por ordem de nome de ficheiro, e usa as regras do primeiro ficheiro cuja lista rules de nível superior contenha pelo menos uma, na mesma forma:
rules: - match: {} set: ops.example.com/owner: shop-teamAs regras de ficheiros posteriores não são lidas. Um ficheiro anterior a esse que não possa ser analisado interrompe a compilação.
O injetor de etiquetas anexado, e as etiquetas que escreveu
Este anexo define um proprietário em cada nó e, depois, um agendamento de cópias de segurança 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-teamAnexado 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 compilação cujos nós transportam:
"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. Todas as outras etiquetas são as do próprio Component.
governance/selector-tagger
O etiquetador por seletor escreve uma etiqueta tag em cada nó, com o valor procurado pelo Component do nó.
O mapa e as definições do etiquetador por seletor
Escreve sempre a chave tag; a chave não é configurável.
O mapa vem dos ficheiros sob sources. Cada ficheiro é 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 ficheiros são lidos, por ordem de nome de ficheiro, e uma entrada num ficheiro posterior substitui a entrada do mesmo Component num anterior. Cada tag é uma cadeia de caracteres: um valor que o YAML lê como outro tipo, como 3, interrompe a compilação, pelo que deve ser colocado entre aspas — "3".
| Definição | Tipo | Predefiniçã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, todos os nós recebem o default.
O etiquetador por seletor anexado, e as etiquetas que escreveu
Este anexo atribui uma tag à base de dados e à 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: untaggedAnexado sozinho ao mesmo Aggregate, aggrega build --release release-production.yaml --auto-pull --ir-graph imprime um grafo de compilação cujos nós transportam:
"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, pelo que web recebeu o default. Sem a definição default, web não transporta 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 cópias de segurança ou uma tag. As chaves e os valores das etiquetas são cadeias de caracteres que o anexo fornece; o compilador entrega a cada plugin os nós, aplica as etiquetas que este comunica e transporta-as no grafo de compilação, onde uma política que as lê lhes dá o seu significado.