Ir al contenido
AggregaAggrega
Seleccionar idioma: Español
Esta página se tradujo automáticamente. Lee el original en inglés.

Los plugins de etiquetado integrados

Dos plugins de gobernanza compilados en la CLI que escriben etiquetas en los nodos de una compilación sin una política que redactar: qué lee cada uno, qué escribe cada uno, y una vinculación de cada uno con las etiquetas que escribió.

La CLI incluye dos plugins de gobernanza que dan forma a las etiquetas solo a partir de la configuración, sin ningún lenguaje de políticas que escribir:

PluginEscribe
governance/label-injectorlas etiquetas que una lista de reglas establece en cada nodo cuyas etiquetas coinciden con la regla
governance/selector-taggeruna sola etiqueta, tag, cuyo valor asigna a cada nodo un mapa de nombres de Component

Ambos se vinculan como cualquier plugin de gobernanza, mediante plugins.governance en la configuración del espacio de trabajo (consulta Vincular una política), y ambos figuran entre los plugins integrados. Las vinculaciones de esta página nombran 0.9.0, la versión de la entidad Plugin de cada plugin en el catálogo de la biblioteca estándar; la compilación sirve el plugin compilado en la CLI.

Lo que los dos comparten

Sirven a label-transform y a ningún otro rol. Cada uno informa de cambios de etiquetas en el rol que da forma a las etiquetas, después de construido el grafo de compilación y antes de que se juzgue (consulta los roles de transformación). Vinculado a cualquier otro rol, cualquiera de los dos se rechaza antes de ejecutarse, porque no declara ningún export para ese rol. En ir-verdict la compilación se detiene 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 sandbox

En render-verdict y annotation-transform el rechazo es el mismo E0085, que nombra en su lugar verdict_render y transform_annotations.

Leen las etiquetas de un nodo y su Component, y nada más. Las etiquetas de un nodo son las que lleva cuando se ejecuta el plugin: las propias de su Component y las que haya escrito cualquier transformación enumerada antes que él. Su Component es el nombre que le da el type: del Aggregate, como core/datastore/mariadb. Ninguno de los dos plugins lee los valores de un nodo, la Release ni su entorno: lo que cualquiera de ellos escribe en un nodo se deriva solo de las etiquetas y el Component de ese nodo.

Escriben etiquetas, y solo etiquetas. Cada cambio que informa cualquiera de los dos plugins nombra una etiqueta en un nodo de la compilación, con un valor de cadena. Escribir una etiqueta que el nodo ya lleva reemplaza su valor — incluida una etiqueta propia del Component. Ninguno elimina una etiqueta, y ninguno puede cambiar un valor, el Component o la versión de un nodo, ni el conjunto de nodos: el rol que da forma a las etiquetas no ofrece ningún cambio de ese tipo (consulta Dar forma a las etiquetas).

Sus ajustes no se comprueban antes de que se ejecuten. Ninguno declara un esquema para sus settings, así que la compilación se los entrega al plugin tal como están escritos. Una clave que el plugin no lee se ignora — un rules mal escrito no establece nada, y la compilación se completa — mientras que una clave que lee y que contiene un valor de otro tipo detiene la compilación con un mensaje que nombra el plugin, luego decode settings: y el motivo.

Leen los archivos bajo sources como YAML, en orden de nombre de archivo. El plugin recibe los archivos ordenados por nombre de archivo, sea cual sea el orden en que los enumera la vinculación. Un archivo que no es YAML válido detiene la compilación con un mensaje que nombra el plugin, luego parse source "<file>": y el motivo del analizador; uno cuyo contenido no tiene la forma que lee el plugin la detiene con decode source "<file>": y el motivo.

El archivo de bloqueo contiene las entradas que aplica una compilación. El pull que resuelve el archivo de bloqueo de una Release — aggrega pull, o una compilación con --auto-pull — registra los ajustes de cada vinculación y el contenido de cada uno de sus archivos, y una compilación aplica lo que se registró. Después de editar los ajustes de una vinculación o uno de sus archivos, vuelve a resolver el archivo de bloqueo; una compilación que no lo hace sigue escribiendo las etiquetas que dan las entradas registradas.

Vinculados sin un bloque with:, ninguno de los dos escribe nada, y la compilación se completa.

Varias vinculaciones en label-transform se ejecutan en el orden en que están enumeradas, y cada una lee las etiquetas que escribieron las anteriores, así que una regla puede coincidir con una etiqueta que estableció una vinculación anterior. examples/policy-label-transform/ vincula ambos plugins después de una política Rego, además de un veredicto que lee lo que escribieron los tres.

governance/label-injector

El inyector de etiquetas añade etiquetas a cada nodo cuyas etiquetas coinciden con una regla.

Los ajustes del inyector de etiquetas

OpciónTipoPredeterminadoEfecto
rulesuna lista de reglasningunolas reglas aplicadas a cada nodo; sin reglas, el plugin no escribe nada

Cada regla lleva dos mapas de claves de etiqueta a valores de cadena:

ClavePredeterminadoEfecto
matchningún parun nodo coincide cuando lleva cada par enumerado, cada uno con ese valor; una regla sin pares coincide con todos los nodos
setningún parcada par se escribe en cada nodo con el que coincide la regla

Una etiqueta que el nodo no lleva se compara como la cadena vacía, así que un par de match cuyo valor es "" también coincide con un nodo que no lleva esa clave.

Las reglas se aplican a cada nodo en el orden en que están enumeradas, y una etiqueta que escribe una regla posterior reemplaza el valor que una regla anterior escribió para la misma clave.

De dónde vienen las reglas

El plugin lee rules de sus ajustes cuando los ajustes contienen al menos una regla. Cuando no contienen ninguna, lee los archivos bajo sources, en orden de nombre de archivo, y toma las reglas del primer archivo cuya lista rules de nivel superior contenga al menos una, con la misma forma:

rules:
- match: {}
set:
ops.example.com/owner: shop-team

Las reglas de los archivos posteriores no se leen. Un archivo anterior a él que no se puede analizar detiene la compilación.

El inyector de etiquetas vinculado, y las etiquetas que escribió

Esta vinculación establece un propietario en cada nodo, y luego una programación de copias de seguridad y un propietario distinto en los nodos de la categoría 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

Vinculado solo al Aggregate de examples/policy-label-transform/ — db es core/datastore/mariadb, cache es core/datastore/redis, web es core/devtool/adminer — aggrega build --release release-production.yaml --auto-pull --ir-graph imprime un grafo de compilación cuyos nodos llevan:

"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 los nodos coincidieron con la primera regla y tomaron shop-team; db y cache, en la categoría datastore, coincidieron también con la segunda, que lo reemplazó por data-team. Cualquier otra etiqueta es la propia del Component.

governance/selector-tagger

El etiquetador por selector escribe una etiqueta tag en cada nodo, con su valor buscado según el Component del nodo.

El mapa y los ajustes del etiquetador por selector

Siempre escribe la clave tag; la clave no es configurable.

El mapa procede de los archivos bajo sources. Cada archivo es un mapa YAML del nombre de un Component al tag que toman sus nodos:

core/datastore/mariadb: orders
core/datastore/redis: sessions

Se lee cada archivo, en orden de nombre de archivo, y una entrada de un archivo posterior reemplaza la entrada del mismo Component en uno anterior. Cada tag es una cadena: un valor que YAML lee como otro tipo, como 3, detiene la compilación, así que ponlo entre comillas — "3".

OpciónTipoPredeterminadoEfecto
defaultstringvacíoel tag que toma un nodo cuando el mapa no enumera su Component; si está vacío, ese nodo se queda sin tag

Sin sources, cada nodo toma el default.

El etiquetador por selector vinculado, y las etiquetas que escribió

Esta vinculación asigna un tag a la base de datos y a la caché a partir de tags.yaml, el mapa anterior, y untagged a cualquier otro nodo:

plugins:
governance:
- uri: governance/selector-tagger:0.9.0
role: label-transform
with:
sources:
- tags.yaml
settings:
default: untagged

Vinculado solo al mismo Aggregate, aggrega build --release release-production.yaml --auto-pull --ir-graph imprime un grafo de compilación cuyos nodos llevan:

"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 no está en el mapa, así que web tomó el default. Sin el ajuste default, web no lleva ningún tag y los otros dos reciben su tag como arriba.

Dónde el compilador no interpreta

Ninguno de los dos plugins, ni el compilador, sabe lo que significa un propietario, una programación de copias de seguridad o un tag. Las claves y los valores de las etiquetas son cadenas que aporta la vinculación; el compilador entrega a cada plugin los nodos, aplica las etiquetas que este informa y las lleva en el grafo de compilación, donde una política que las lee les da su significado.