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

Schemat gniazda Aggrega Wasm Mutator

Dokumentacja wygenerowana automatycznie. Nie należy jej edytować ręcznie — należy ją wygenerować ponownie z opublikowanego JSON Schema.

Identyfikator schematu: https://aggrega.ai/schemas/wasm-mutator-v1beta1.schema.json

Kształty komunikatów, które plugin zarządczy podłączony w roli label-transform przyjmuje (MutatorInput) i emituje (MutatorOutput). Rola ta działa podczas budowania topologii, po zbudowaniu grafu i przed jego oceną: plugin zwraca dokumenty JSON Patch, a host stosuje je do etykiet węzłów i do niczego innego, zatrzymując kompilację na poprawce, która sięga jakiejkolwiek innej części grafu. Typy ładunków dla Go, Rust i TypeScript są generowane z tego schematu do pakietów plugin-ABI, więc trzy języki odczytują i zapisują jeden format komunikatów; gość importuje je z tych pakietów albo przez swój zestaw narzędzi dla pluginów, jeśli zestaw je reeksportuje.

Jeden z następujących kształtów

  • MutatorInput
  • MutatorOutput

Definicje

MutatorInput

Ładunek, który host przekazuje pluginowi mutatora przy każdym wywołaniu: kontekst kompilacji na poziomie wydania oraz projekcja grafu topologii zawierająca etykiety każdego węzła i wartości deklarowane przez jego instancję.

WłaściwośćTypWymaganaOpis
compilation_contextCompilationContexttakMetadane na poziomie encji Release, które mutator odczytuje, decydując, które reguły zgodności, FinOps lub ładu korporacyjnego mają zastosowanie do kompilacji.
graphMutatorGraphtakProjekcja grafu topologii udostępniana pluginowi mutatora: encja Component każdego węzła, jej rozwiązana wersja, etykiety węzła i wartości deklarowane przez jego instancję. Celowo węższa niż pełny wynik topologii: krawędzie i ładunki funkcji nie są udostępniane, ponieważ zadaniem mutatora jest etykietowanie, a nie przekształcanie topologii. Wartości są dostępne do odczytu, aby konfiguracja zadeklarowana przez dewelopera mogła decydować o etykiecie; poprawka sięga etykiet i niczego innego, więc plugin nie może ich zmienić.
sourcesMutatorSource[]niePliki definicji, które host odczytuje i przekazuje pluginowi bez zmian, jako uporządkowaną listę posortowaną według ścieżki. Host odczytuje bajty jako nieprzezroczystą treść i ich nie parsuje. Nieobecne, gdy dołączenie nie deklaruje źródeł.
settingsobjectnieObiekt ustawień o dowolnej postaci, który host przekazuje pluginowi bez zmian. Host nie parsuje jego treści ani na nią nie reaguje. Nieobecny, gdy dołączenie nie deklaruje ustawień.

Dodatkowe właściwości są niedozwolone.

MutatorOutput

Kształt odpowiedzi emitowanej przez plugin mutatora: lista nieprzezroczystych dokumentów JSON Patch, które host stosuje do grafu topologii. Poprawki pozostają nieprzezroczyste na warstwie schematu, aby host nie musiał powielać parsera JSON Patch, który gość już implementuje.

WłaściwośćTypWymaganaOpis
patchesany[]takNieprzezroczyste dokumenty JSON Patch do zastosowania do grafu topologii, w kolejności.
errorstringnieKomunikat o niepowodzeniu ustawiany, gdy gość został uruchomiony, ale nie mógł ukończyć operacji; nieobecny w razie powodzenia. Host przedstawia obecny błąd jako nieudane wywołanie pluginu.

Dodatkowe właściwości są niedozwolone.

CompilationContext

Metadane na poziomie encji Release, które mutator odczytuje, decydując, które reguły zgodności, FinOps lub ładu korporacyjnego mają zastosowanie do kompilacji.

WłaściwośćTypWymaganaOpis
release_namestringtakWartość metadata.name encji Release.
environmentstringtakEtykieta środowiska, w którym działa encja Release (np. dev, staging, prod).

Dodatkowe właściwości są niedozwolone.

MutatorGraph

Projekcja grafu topologii udostępniana pluginowi mutatora: encja Component każdego węzła, jej rozwiązana wersja, etykiety węzła i wartości deklarowane przez jego instancję. Celowo węższa niż pełny wynik topologii: krawędzie i ładunki funkcji nie są udostępniane, ponieważ zadaniem mutatora jest etykietowanie, a nie przekształcanie topologii. Wartości są dostępne do odczytu, aby konfiguracja zadeklarowana przez dewelopera mogła decydować o etykiecie; poprawka sięga etykiet i niczego innego, więc plugin nie może ich zmienić.

WłaściwośćTypWymaganaOpis
nodesmapa MutatorNodetakWęzły indeksowane bezwzględnym identyfikatorem węzła.

Dodatkowe właściwości są niedozwolone.

MutatorNode

Projekcja pojedynczego węzła, względem której plugin mutatora ocenia swoje reguły: którą encję Component węzeł implementuje, która wersja tej encji Component została rozwiązana, jakie etykiety węzeł posiada i jakie wartości deklaruje jego instancja.

WłaściwośćTypWymaganaOpis
componentstringtakNazwa bazowej encji Component, którą węzeł instancjonuje.
resolved_versionstringtakDokładna wersja semantyczna (Semantic Version) encji Component, którą resolver przypiął dla tego węzła.
labelsmapa stringtakEtykiety duck typing i ontologii węzła.
valuesobjectnieWartości, które instancja komponentu węzła deklaruje w encji Aggregate, z kluczami w postaci zapisanej przez autora i w kolejności autora. Każdy szablon w encji Aggregate został już obliczony względem jej parametrów, więc wartość przeniesiona do parametru dociera jako wartość dostarczona przez encję Release albo jako wartość domyślna parametru. Są tu tylko własne wartości instancji: wartość domyślna zadeklarowana przez schemat encji Component ani nic, co wnosi encja Recipe lub Feature, się tu nie znajdują. Wartość, którą encja Component deklaruje jako wrażliwą, dociera ukryta, dokładnie tak, jak otrzymuje ją werdykt zarządczy dla całego grafu: w jej miejscu znajduje się ten sam jednokluczowy obiekt znacznika ukrycia, który przenosi ten werdykt, ze wskazaniem zadeklarowanego powodu, a wartość siostrzana, do której nie sięga żadna deklaracja, dociera w zapisanej postaci. Plugin odczytuje je, aby zdecydować, jakie etykiety dodać; poprawka nie może do nich sięgnąć. Nieobecne, gdy instancja nie deklaruje żadnych wartości.

Dodatkowe właściwości są niedozwolone.

MutatorSource

Jeden plik definicji przekazany pluginowi: jego ścieżka w postaci nazwy bazowej oraz treść pliku. Oba są przenoszone bez zmian; host nie parsuje treści.

WłaściwośćTypWymaganaOpis
pathstringtakNazwa bazowa pliku źródłowego. Host dostarcza wyłącznie nazwę bazową, nigdy bezwzględnej ścieżki hosta, dzięki czemu komunikat jest przenośny i deterministyczny.
contentstringtakTreść pliku źródłowego, przenoszona bez zmian jako nieprzezroczysty ciąg znaków.

Dodatkowe właściwości są niedozwolone.