Przejdź do głównej zawartości
AggregaAggrega
Wybierz język: Polski
Ta strona została przetłumaczona maszynowo. Przeczytaj oryginał w języku angielskim.

Wbudowane pluginy tagujące

Dwa pluginy zarządcze wkompilowane w CLI, które zapisują etykiety na węzłach builda bez pisania polityki: co każdy czyta, co każdy zapisuje oraz przykład podłączenia każdego z nich wraz z zapisanymi etykietami.

CLI zawiera dwa pluginy zarządcze, które kształtują etykiety wyłącznie na podstawie konfiguracji, bez pisania czegokolwiek w języku polityk:

PluginZapisuje
governance/label-injectoretykiety, które lista reguł ustawia na każdym węźle, którego etykiety pasują do reguły
governance/selector-taggerjedną etykietę, tag, której wartość każdemu węzłowi nadaje mapa nazw encji Component

Oba podłącza się jak każdy plugin zarządczy, przez plugins.governance w konfiguracji obszaru roboczego (zob. Podłączanie polityki), i oba są wymienione wśród pluginów osadzonych. Podłączenia na tej stronie podają 0.9.0, wersję encji Plugin każdego pluginu w katalogu biblioteki standardowej; build używa pluginu wkompilowanego w CLI.

Co mają wspólnego

Obsługują rolę label-transform i żadnej innej. Każdy zgłasza zmiany etykiet w roli kształtowania etykiet, po zbudowaniu grafu builda, a przed jego oceną (zob. role transformacji). Podłączony do jakiejkolwiek innej roli, każdy z nich jest odrzucany przed uruchomieniem, ponieważ nie deklaruje eksportu dla tej roli. W ir-verdict build zatrzymuje się z komunikatem:

[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

W render-verdict i annotation-transform odmowa to ten sam E0085, wskazujący zamiast tego odpowiednio verdict_render i transform_annotations.

Czytają etykiety węzła i jego encję Component, i nic więcej. Etykiety węzła to te, które ma on w chwili uruchomienia pluginu: własne etykiety jego encji Component oraz te zapisane przez transformacje wymienione wcześniej. Jego encja Component to nazwa, którą nadaje mu type: encji Aggregate, np. core/datastore/mariadb. Żaden z pluginów nie czyta wartości węzła, encji Release ani jej środowiska: to, co którykolwiek z nich zapisuje na węźle, wynika wyłącznie z etykiet i encji Component tego węzła.

Zapisują etykiety i tylko etykiety. Każda zmiana zgłaszana przez którykolwiek z pluginów wskazuje jedną etykietę na jednym węźle builda, z wartością tekstową. Zapisanie etykiety, którą węzeł już ma, zastępuje jej wartość — dotyczy to także własnej etykiety encji Component. Żaden nie usuwa etykiet i żaden nie może zmienić wartości, encji Component ani wersji węzła, ani zbioru węzłów: rola kształtowania etykiet nie oferuje zmian tego rodzaju (zob. Kształtowanie etykiet).

Ich ustawienia nie są sprawdzane przed uruchomieniem. Żaden nie deklaruje schematu dla swoich settings, więc build przekazuje je pluginowi w postaci, w jakiej zostały zapisane. Klucz, którego plugin nie czyta, jest ignorowany — błędnie zapisane rules niczego nie ustawia, a build się kończy — natomiast klucz, który plugin czyta, z wartością innego typu zatrzymuje build z komunikatem wskazującym plugin, a następnie decode settings: i przyczynę.

Czytają pliki z sources jako YAML, w kolejności nazw plików. Plugin otrzymuje pliki posortowane według nazwy, niezależnie od kolejności, w jakiej wymienia je podłączenie. Plik, który nie jest poprawnym YAML, zatrzymuje build z komunikatem wskazującym plugin, a następnie parse source "<file>": i przyczynę podaną przez parser; plik, którego treść nie ma kształtu odczytywanego przez plugin, zatrzymuje go z decode source "<file>": i przyczyną.

Dane wejściowe stosowane przez build przechowuje plik blokady. Pull rozwiązujący plik blokady encji Release — aggrega pull lub build z --auto-pull — zapisuje ustawienia każdego podłączenia i treść każdego z jego plików, a build stosuje to, co zostało zapisane. Po edycji ustawień podłączenia lub jednego z jego plików należy ponownie rozwiązać plik blokady; build, który tego nie robi, nadal zapisuje etykiety wynikające z zapisanych danych wejściowych.

Podłączony bez bloku with: żaden z nich niczego nie zapisuje, a build się kończy.

Kilka podłączeń w label-transform działa w kolejności, w jakiej je wymieniono, a każde czyta etykiety zapisane przez poprzednie, więc reguła może dopasować etykietę ustawioną przez wcześniejsze podłączenie. examples/policy-label-transform/ podłącza oba pluginy po polityce Rego oraz werdykt, który czyta to, co zapisały wszystkie trzy.

governance/label-injector

Wstrzykiwacz etykiet dodaje etykiety do każdego węzła, którego etykiety pasują do reguły.

Ustawienia wstrzykiwacza etykiet

UstawienieTypDomyślnieSkutek
ruleslista regułbrakreguły stosowane do każdego węzła; bez reguł plugin niczego nie zapisuje

Każda reguła zawiera dwie mapy kluczy etykiet na wartości tekstowe:

KluczDomyślnieSkutek
matchbrak parwęzeł pasuje, gdy ma każdą wymienioną parę, każdą z tą wartością; reguła bez par pasuje do każdego węzła
setbrak parkażda para jest zapisywana na każdym węźle, do którego pasuje reguła

Etykieta, której węzeł nie ma, jest porównywana jako pusty ciąg, więc para w match o wartości "" pasuje także do węzła, który nie ma tego klucza.

Reguły są stosowane do każdego węzła w kolejności, w jakiej je wymieniono, a etykieta zapisana przez późniejszą regułę zastępuje wartość zapisaną dla tego samego klucza przez wcześniejszą regułę.

Skąd pochodzą reguły

Plugin czyta rules ze swoich ustawień, gdy zawierają one co najmniej jedną regułę. Gdy nie zawierają żadnej, czyta pliki z sources w kolejności nazw plików i przyjmuje reguły pierwszego pliku, którego lista rules najwyższego poziomu zawiera co najmniej jedną regułę, w tym samym kształcie:

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

Reguły żadnego późniejszego pliku nie są czytane. Plik przed nim, którego nie da się sparsować, zatrzymuje build.

Podłączony wstrzykiwacz etykiet i zapisane przez niego etykiety

To podłączenie ustawia właściciela na każdym węźle, a następnie harmonogram kopii zapasowych i innego właściciela na węzłach w kategorii 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

Podłączony samodzielnie do encji Aggregate z examples/policy-label-transform/ — db to core/datastore/mariadb, cache to core/datastore/redis, web to core/devtool/adminer — aggrega build --release release-production.yaml --auto-pull --ir-graph wypisuje graf builda, którego węzły mają:

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

Każdy węzeł pasował do pierwszej reguły i otrzymał shop-team; db i cache, w kategorii datastore, pasowały także do drugiej, która zastąpiła wartość przez data-team. Każda inna etykieta jest własną etykietą encji Component.

governance/selector-tagger

Tagger selektorowy zapisuje na każdym węźle etykietę tag, której wartość jest wyszukiwana według encji Component węzła.

Mapa i ustawienia taggera selektorowego

Zawsze zapisuje klucz tag; klucza nie można konfigurować.

Mapa pochodzi z plików w sources. Każdy plik to mapa YAML z nazwy encji Component na tag, który otrzymują jej węzły:

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

Czytany jest każdy plik, w kolejności nazw plików, a wpis w późniejszym pliku zastępuje wpis tej samej encji Component we wcześniejszym. Każdy tag jest ciągiem znaków: wartość, którą YAML odczytuje jako inny typ, np. 3, zatrzymuje build, więc należy ująć ją w cudzysłów — "3".

UstawienieTypDomyślnieSkutek
defaultstringpustytag, który otrzymuje węzeł, gdy mapa nie wymienia jego encji Component; gdy pusty, taki węzeł pozostaje bez tag

Bez sources każdy węzeł otrzymuje default.

Podłączony tagger selektorowy i zapisane przez niego etykiety

To podłączenie taguje bazę danych i pamięć podręczną na podstawie tags.yaml, czyli mapy powyżej, a każdy inny węzeł jako untagged:

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

Podłączony samodzielnie do tej samej encji Aggregate, aggrega build --release release-production.yaml --auto-pull --ir-graph wypisuje graf builda, którego węzły mają:

"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 nie ma w mapie, więc web otrzymał default. Bez ustawienia default węzeł web nie ma tag, a pozostałe dwa są otagowane jak powyżej.

Gdzie kompilator nie interpretuje

Ani plugin, ani kompilator nie wie, co oznacza właściciel, harmonogram kopii zapasowych czy tag. Klucze i wartości etykiet to ciągi znaków dostarczane przez podłączenie; kompilator przekazuje każdemu pluginowi węzły, stosuje zgłoszone przez niego etykiety i przenosi je w grafie builda, gdzie znaczenie nadaje im polityka, która je czyta.