Aller au contenu
AggregaAggrega
Selectionner la langue: Français
Cette page a été traduite automatiquement. Lire l’original en anglais.

Les plugins de tagging intégrés

Deux plugins de gouvernance compilés dans la CLI qui écrivent des labels sur les nœuds d’un build sans politique à rédiger : ce que chacun lit, ce que chacun écrit, et un rattachement de chacun avec les labels qu’il a écrits.

La CLI comprend deux plugins de gouvernance qui façonnent les labels à partir de la seule configuration, sans langage de politique à écrire :

PluginÉcrit
governance/label-injectorles labels qu’une liste de règles définit sur chaque nœud dont les labels correspondent à la règle
governance/selector-taggerun seul label, tag, dont la valeur est donnée à chaque nœud par une table de noms de Component

Tous deux se rattachent comme n’importe quel plugin de gouvernance, via plugins.governance dans la configuration de l’espace de travail (voir Rattacher une politique), et tous deux figurent parmi les plugins embarqués. Les rattachements de cette page nomment 0.9.0, la version de l’entité Plugin de chaque plugin dans le catalogue de la bibliothèque standard ; le build sert le plugin compilé dans la CLI.

Ce que les deux ont en commun

Ils servent label-transform et aucun autre rôle. Chacun signale des modifications de labels au rôle qui façonne les labels, après que le graphe de build a été construit et avant qu’il ne soit jugé (voir les rôles de transformation). Rattaché à tout autre rôle, l’un comme l’autre est refusé avant de s’exécuter, car il ne déclare aucun export pour ce rôle. À ir-verdict, le build s’arrête avec :

[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

À render-verdict et annotation-transform, le refus est le même E0085, nommant à la place verdict_render et transform_annotations.

Ils lisent les labels d’un nœud et son Component, et rien d’autre. Les labels d’un nœud sont ceux qu’il porte quand le plugin s’exécute : ceux de son Component, et ceux qu’a écrits toute transformation listée avant lui. Son Component est le nom que lui donne le type: de l’Aggregate, comme core/datastore/mariadb. Aucun des deux plugins ne lit les valeurs d’un nœud, la Release ou son environnement : ce que l’un ou l’autre écrit sur un nœud découle des seuls labels et Component de ce nœud.

Ils écrivent des labels, et uniquement des labels. Chaque modification que signale l’un ou l’autre plugin nomme un label sur un nœud du build, avec une valeur de type chaîne. Écrire un label que le nœud porte déjà remplace sa valeur — y compris un label propre au Component. Aucun des deux ne supprime de label, et aucun ne peut modifier une valeur, le Component ou la version d’un nœud, ou l’ensemble des nœuds : le rôle qui façonne les labels n’offre aucune modification de ce genre (voir Façonner les labels).

Leurs paramètres ne sont pas vérifiés avant leur exécution. Aucun ne déclare de schéma pour ses settings, si bien que le build les remet au plugin tels qu’ils sont écrits. Une clé que le plugin ne lit pas est ignorée — un rules mal orthographié ne définit rien, et le build se termine — tandis qu’une clé qu’il lit contenant une valeur d’un autre type arrête le build avec un message nommant le plugin, puis decode settings: et la raison.

Ils lisent les fichiers sous sources comme du YAML, dans l’ordre des noms de fichiers. Le plugin reçoit les fichiers triés par nom de fichier, quel que soit l’ordre dans lequel le rattachement les liste. Un fichier qui n’est pas du YAML valide arrête le build avec un message nommant le plugin, puis parse source "<file>": et la raison de l’analyseur ; un fichier dont le contenu n’a pas la forme que lit le plugin l’arrête avec decode source "<file>": et la raison.

Le fichier de verrouillage contient les entrées qu’applique un build. Le pull qui résout le fichier de verrouillage d’une Release — aggrega pull, ou un build avec --auto-pull — enregistre les paramètres de chaque rattachement et le contenu de chacun de ses fichiers, et un build applique ce qui a été enregistré. Après avoir modifié les paramètres d’un rattachement ou l’un de ses fichiers, résolvez à nouveau le fichier de verrouillage ; un build qui ne le fait pas continue d’écrire les labels que donnent les entrées enregistrées.

Rattaché sans bloc with:, aucun des deux n’écrit rien, et le build se termine.

Plusieurs rattachements à label-transform s’exécutent dans l’ordre où ils sont listés, chacun lisant les labels qu’ont écrits les précédents, si bien qu’une règle peut correspondre à un label défini par un rattachement antérieur. examples/policy-label-transform/ rattache les deux plugins après une politique Rego, ainsi qu’un verdict qui lit ce que les trois ont écrit.

governance/label-injector

L’injecteur de labels ajoute des labels à chaque nœud dont les labels correspondent à une règle.

Les paramètres de l’injecteur de labels

ParamètreTypePar défautEffet
rulesune liste de règlesaucuneles règles appliquées à chaque nœud ; sans règles, le plugin n’écrit rien

Chaque règle porte deux tables de clés de labels vers des valeurs de type chaîne :

CléPar défautEffet
matchaucune paireun nœud correspond lorsqu’il porte chaque paire listée, chacune avec cette valeur ; une règle sans paires correspond à chaque nœud
setaucune pairechaque paire est écrite sur chaque nœud auquel la règle correspond

Un label que le nœud ne porte pas est comparé comme la chaîne vide, si bien qu’une paire match dont la valeur est "" correspond aussi à un nœud qui ne porte pas cette clé.

Les règles sont appliquées à chaque nœud dans l’ordre où elles sont listées, et un label qu’écrit une règle ultérieure remplace la valeur qu’une règle antérieure a écrite pour la même clé.

D’où viennent les règles

Le plugin lit rules dans ses paramètres lorsque les paramètres contiennent au moins une règle. Lorsqu’ils n’en contiennent aucune, il lit les fichiers sous sources, dans l’ordre des noms de fichiers, et prend les règles du premier fichier dont la liste rules de premier niveau en contient au moins une, sous la même forme :

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

Les règles des fichiers suivants ne sont pas lues. Un fichier qui le précède et qui ne s’analyse pas arrête le build.

L’injecteur de labels rattaché, et les labels qu’il a écrits

Ce rattachement définit un propriétaire sur chaque nœud, puis un calendrier de sauvegarde et un propriétaire différent sur les nœuds de la catégorie 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

Rattaché seul à l’Aggregate de examples/policy-label-transform/ — db est core/datastore/mariadb, cache est core/datastore/redis, web est core/devtool/adminer — aggrega build --release release-production.yaml --auto-pull --ir-graph affiche un graphe de build dont les nœuds portent :

"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]
}

Chaque nœud a correspondu à la première règle et a pris shop-team ; db et cache, dans la catégorie datastore, ont aussi correspondu à la seconde, qui l’a remplacé par data-team. Tout autre label est celui du Component.

governance/selector-tagger

Le tagger par sélecteur écrit un label tag sur chaque nœud, sa valeur étant recherchée d’après le Component du nœud.

La table et les paramètres du tagger par sélecteur

Il écrit toujours la clé tag ; la clé n’est pas configurable.

La table provient des fichiers sous sources. Chaque fichier est une table YAML qui associe un nom de Component au tag que prennent ses nœuds :

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

Chaque fichier est lu, dans l’ordre des noms de fichiers, et une entrée d’un fichier ultérieur remplace l’entrée du même Component dans un fichier antérieur. Chaque tag est une chaîne : une valeur que YAML lit comme un autre type, comme 3, arrête le build, donc mettez-la entre guillemets — "3".

ParamètreTypePar défautEffet
defaultstringvidele tag que prend un nœud lorsque la table ne liste pas son Component ; s’il est vide, un tel nœud reste sans tag

Sans sources, chaque nœud prend le default.

Le tagger par sélecteur rattaché, et les labels qu’il a écrits

Ce rattachement attribue un tag à la base de données et au cache d’après tags.yaml, la table ci-dessus, et untagged à tout autre nœud :

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

Rattaché seul au même Aggregate, aggrega build --release release-production.yaml --auto-pull --ir-graph affiche un graphe de build dont les nœuds portent :

"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 ne figure pas dans la table, donc web a pris le default. Sans le paramètre default, web ne porte aucun tag et les deux autres reçoivent leur tag comme ci-dessus.

Là où le compilateur n’interprète pas

Ni l’un ni l’autre plugin, ni le compilateur, ne sait ce que signifie un propriétaire, un calendrier de sauvegarde ou un tag. Les clés et les valeurs des labels sont des chaînes que fournit le rattachement ; le compilateur remet à chaque plugin les nœuds, applique les labels qu’il signale et les porte dans le graphe de build, où une politique qui les lit leur donne leur signification.