Die eingebauten Tagging-Plugins
Zwei in die CLI kompilierte Governance-Plugins, die Labels auf die Knoten eines Builds schreiben, ohne dass eine Richtlinie verfasst werden muss: was jedes liest, was jedes schreibt, und eine Anbindung von jedem mit den Labels, die es geschrieben hat.
Die CLI enthält zwei Governance-Plugins, die Labels allein aus der Konfiguration gestalten, ohne dass eine Richtliniensprache geschrieben werden muss:
| Plugin | Schreibt |
|---|---|
governance/label-injector | die Labels, die eine Liste von Regeln auf jedem Knoten setzt, dessen Labels der Regel entsprechen |
governance/selector-tagger | ein einziges Label, tag, dessen Wert eine Map von Component-Namen jedem Knoten zuweist |
Beide werden wie jedes Governance-Plugin über plugins.governance in der Workspace-Konfiguration angebunden (siehe Eine Richtlinie anbinden), und beide sind als eingebettete Plugins aufgeführt. Die Anbindungen auf dieser Seite nennen 0.9.0, die Version der Plugin-Entität zu jedem Plugin im Katalog der Standardbibliothek; der Build stellt das in die CLI kompilierte Plugin bereit.
Was die beiden gemeinsam haben
Sie bedienen label-transform und keine andere Rolle. Jedes meldet Label-Änderungen an der Rolle, die Labels gestaltet, nachdem der Build-Graph erstellt und bevor er beurteilt wird (siehe die Transformations-Rollen). An einer anderen Rolle angebunden, wird jedes der beiden abgelehnt, bevor es läuft, weil es für diese Rolle keinen Export deklariert. An ir-verdict stoppt der Build mit:
[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 sandboxAn render-verdict und annotation-transform ist die Ablehnung dasselbe E0085, das stattdessen verdict_render und transform_annotations nennt.
Sie lesen die Labels eines Knotens und seine Component, und sonst nichts. Die Labels eines Knotens sind diejenigen, die er trägt, wenn das Plugin läuft: die eigenen seiner Component und diejenigen, die eine vor ihm aufgeführte Transformation geschrieben hat. Seine Component ist der Name, den ihm das type: des Aggregate gibt, etwa core/datastore/mariadb. Keines der beiden Plugins liest die Werte eines Knotens, das Release oder seine Umgebung: Was eines von beiden auf einen Knoten schreibt, folgt allein aus den Labels und der Component dieses Knotens.
Sie schreiben Labels, und nur Labels. Jede Änderung, die eines der beiden Plugins meldet, benennt ein Label auf einem Knoten des Builds, mit einem Zeichenkettenwert. Das Schreiben eines Labels, das der Knoten bereits trägt, ersetzt dessen Wert — ein eigenes Label der Component eingeschlossen. Keines entfernt ein Label, und keines kann einen Wert, die Component oder Version eines Knotens oder die Menge der Knoten ändern: Die Rolle, die Labels gestaltet, bietet keine Änderung dieser Art an (siehe Labels gestalten).
Ihre Einstellungen werden nicht geprüft, bevor sie laufen. Keines deklariert ein Schema für seine settings, sodass der Build sie dem Plugin so übergibt, wie sie geschrieben sind. Ein Schlüssel, den das Plugin nicht liest, wird ignoriert — ein falsch geschriebenes rules setzt nichts, und der Build wird abgeschlossen —, während ein Schlüssel, den es liest und der einen Wert eines anderen Typs enthält, den Build mit einer Meldung stoppt, die das Plugin nennt, dann decode settings: und den Grund.
Sie lesen die Dateien unter sources als YAML, in der Reihenfolge der Dateinamen. Das Plugin erhält die Dateien nach Dateinamen sortiert, unabhängig von der Reihenfolge, in der die Anbindung sie aufführt. Eine Datei, die kein gültiges YAML ist, stoppt den Build mit einer Meldung, die das Plugin nennt, dann parse source "<file>": und den Grund des Parsers; eine, deren Inhalt nicht die Form hat, die das Plugin liest, stoppt ihn mit decode source "<file>": und dem Grund.
Die Lockfile enthält die Eingaben, die ein Build anwendet. Der Pull, der die Lockfile zu einem Release auflöst — aggrega pull oder ein Build mit --auto-pull —, hält die Einstellungen jeder Anbindung und den Inhalt jeder ihrer Dateien fest, und ein Build wendet an, was festgehalten wurde. Lösen Sie nach dem Bearbeiten der Einstellungen einer Anbindung oder einer ihrer Dateien die Lockfile erneut auf; ein Build, der das nicht tut, schreibt weiterhin die Labels, die die festgehaltenen Eingaben ergeben.
Ohne Block with: angebunden, schreibt keines der beiden etwas, und der Build wird abgeschlossen.
Mehrere Anbindungen an label-transform laufen in der Reihenfolge, in der sie aufgeführt sind, und jede liest die Labels, die die vorherigen geschrieben haben, sodass eine Regel auf ein Label passen kann, das eine frühere Anbindung gesetzt hat. examples/policy-label-transform/ bindet beide Plugins nach einer Rego-Richtlinie an, dazu ein Verdikt, das liest, was alle drei geschrieben haben.
governance/label-injector
Der Label-Injektor fügt jedem Knoten, dessen Labels einer Regel entsprechen, Labels hinzu.
Die Einstellungen des Label-Injektors
| Einstellung | Typ | Standard | Wirkung |
|---|---|---|---|
rules | eine Liste von Regeln | keine | die Regeln, die auf jeden Knoten angewendet werden; ohne Regeln schreibt das Plugin nichts |
Jede Regel trägt zwei Maps von Label-Schlüsseln auf Zeichenkettenwerte:
| Schlüssel | Standard | Wirkung |
|---|---|---|
match | keine Paare | ein Knoten entspricht, wenn er jedes aufgeführte Paar trägt, jedes mit diesem Wert; eine Regel ohne Paare entspricht jedem Knoten |
set | keine Paare | jedes Paar wird auf jeden Knoten geschrieben, dem die Regel entspricht |
Ein Label, das der Knoten nicht trägt, wird als leere Zeichenkette verglichen, sodass ein Paar in match, dessen Wert "" ist, auch einem Knoten entspricht, der diesen Schlüssel nicht trägt.
Die Regeln werden auf jeden Knoten in der Reihenfolge angewendet, in der sie aufgeführt sind, und ein Label, das eine spätere Regel schreibt, ersetzt den Wert, den eine frühere Regel für denselben Schlüssel geschrieben hat.
Woher die Regeln stammen
Das Plugin liest rules aus seinen Einstellungen, wenn die Einstellungen mindestens eine Regel enthalten. Enthalten sie keine, liest es die Dateien unter sources in der Reihenfolge der Dateinamen und übernimmt die Regeln der ersten Datei, deren Liste rules auf oberster Ebene mindestens eine enthält, in derselben Form:
rules: - match: {} set: ops.example.com/owner: shop-teamDie Regeln späterer Dateien werden nicht gelesen. Eine Datei davor, die sich nicht parsen lässt, stoppt den Build.
Der Label-Injektor angebunden, und die Labels, die er geschrieben hat
Diese Anbindung setzt einen Eigentümer auf jeden Knoten, dann einen Backup-Zeitplan und einen anderen Eigentümer auf die Knoten der Kategorie 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-teamAllein an das Aggregate von examples/policy-label-transform/ angebunden — db ist core/datastore/mariadb, cache ist core/datastore/redis, web ist core/devtool/adminer — gibt aggrega build --release release-production.yaml --auto-pull --ir-graph einen Build-Graphen aus, dessen Knoten Folgendes tragen:
"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]}Jeder Knoten entsprach der ersten Regel und erhielt shop-team; db und cache in der Kategorie datastore entsprachen auch der zweiten, die ihn durch data-team ersetzte. Jedes andere Label ist das eigene der Component.
governance/selector-tagger
Der Selektor-Tagger schreibt auf jeden Knoten ein Label tag, dessen Wert anhand der Component des Knotens nachgeschlagen wird.
Map und Einstellungen des Selektor-Taggers
Er schreibt immer den Schlüssel tag; der Schlüssel ist nicht konfigurierbar.
Die Map stammt aus den Dateien unter sources. Jede Datei ist eine YAML-Map von einem Component-Namen auf das Tag, das ihre Knoten erhalten:
core/datastore/mariadb: orderscore/datastore/redis: sessionsJede Datei wird gelesen, in der Reihenfolge der Dateinamen, und ein Eintrag in einer späteren Datei ersetzt den Eintrag derselben Component in einer früheren. Jedes Tag ist eine Zeichenkette: Ein Wert, den YAML als anderen Typ liest, etwa 3, stoppt den Build, setzen Sie ihn also in Anführungszeichen — "3".
| Einstellung | Typ | Standard | Wirkung |
|---|---|---|---|
default | string | leer | das Tag, das ein Knoten erhält, wenn die Map seine Component nicht aufführt; ist der Wert leer, bleibt ein solcher Knoten ohne tag |
Ohne sources erhält jeder Knoten den Wert aus default.
Der Selektor-Tagger angebunden, und die Labels, die er geschrieben hat
Diese Anbindung versieht die Datenbank und den Cache anhand von tags.yaml, der obigen Map, mit einem Tag und jeden anderen Knoten mit untagged:
plugins: governance: - uri: governance/selector-tagger:0.9.0 role: label-transform with: sources: - tags.yaml settings: default: untaggedAllein an dasselbe Aggregate angebunden, gibt aggrega build --release release-production.yaml --auto-pull --ir-graph einen Build-Graphen aus, dessen Knoten Folgendes tragen:
"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 steht nicht in der Map, also erhielt web den Wert aus default. Ohne die Einstellung default trägt web kein tag, und die anderen beiden erhalten ihr Tag wie oben.
Wo der Compiler nicht interpretiert
Weder eines der beiden Plugins noch der Compiler weiß, was ein Eigentümer, ein Backup-Zeitplan oder ein Tag bedeutet. Die Label-Schlüssel und -Werte sind Zeichenketten, die die Anbindung liefert; der Compiler übergibt jedem Plugin die Knoten, wendet die Labels an, die es meldet, und trägt sie im Build-Graphen weiter, wo eine Richtlinie, die sie liest, ihnen ihre Bedeutung gibt.