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 Policy

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-policy-v1beta1.schema.json

Kształty komunikatów, które plugin zarządczy podłączony w roli werdyktu przyjmuje — PolicyInput w roli ir-verdict, RenderPolicyInput w roli render-verdict — i emituje (PolicyOutput). Werdykt o ważności halt zatrzymuje budowanie z diagnostyką czasu budowania; werdykt warn lub info jest zgłaszany, a budowanie trwa dalej. Graf wejściowy etapu IR to pełny graf IR agnostyczny wobec możliwości, do którego odwołuje się ir-v1beta1.schema.json zamiast deklarować go tutaj ponownie, dzięki czemu plugin polityki widzi te same szczegóły węzłów, krawędzi i dołączeń co kompilator; autorzy pluginów śledzą wersję schematu IR. Wejście etapu renderowania przenosi wyrenderowane pliki wyjściowe zamiast 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

  • PolicyInput
  • RenderPolicyInput
  • PolicyOutput

Definicje

PolicyInput

Ładunek, który analiza statyczna przekazuje gniazdu polityki: pełny graf IR (ten sam kształt, który emituje Topology Builder) oraz wstępnie obliczone ścieżki routingu, które analizator wylicza równolegle.

WłaściwośćTypWymaganaOpis
graphIRGraphtakPełny graf IR agnostyczny wobec możliwości, pochodzący z jednego źródła: ir-v1beta1.schema.json. Plugin polityki analizuje pełne szczegóły węzłów, krawędzi i dołączeń zamiast wąskiej projekcji.
precalculated_pathsPrecalculatedPath[]takŚcieżki routingu wstępnie wyliczone przez analizator, dzięki czemu polityki mogą wnioskować o osiągalności bez ponownego przechodzenia grafu.
sourcesPolicySource[]niePliki definicji, które host odczytuje w czasie kompilacji 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.

PolicyOutput

Kształt odpowiedzi emitowanej przez plugin polityki: werdykty, które zostały wyzwolone podczas ewaluacji, po jednej diagnostyce na każdy wyzwolony werdykt. Reguła zezwalająca niczego nie emituje, więc pusta tablica wyników oznacza, że nie wyzwolono żadnego werdyktu.

WłaściwośćTypWymaganaOpis
resultsDiagnostic[]takWyzwolone werdykty, po jednej diagnostyce każdy, w kolejności, w jakiej emituje je plugin. Pusta, gdy nie wyzwolono żadnego werdyktu.
errorstringnieKomunikat o niepowodzeniu ustawiany, gdy gość został uruchomiony, ale nie mógł ukończyć operacji; nieobecny w razie powodzenia. Różni się od diagnostyki przenoszonej przez wynik: diagnostyka zgłasza problemy wykryte podczas przebiegu, który mimo to dał wynik, natomiast błąd zgłasza, że sama operacja nie została ukończona. Host traktuje obecny błąd jako nieudane wywołanie pluginu.

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

RenderPolicyInput

Ładunek, który otrzymuje plugin zarządczy podłączony w roli render-verdict: wyrenderowane pliki wyjściowe, które analizuje polityka, zamiast grafu IR.

WłaściwośćTypWymaganaOpis
artifactsRenderedArtifact[]takWyrenderowane pliki wyjściowe, które analizuje polityka, jako uporządkowana lista posortowana według ścieżki, dzięki czemu komunikat jest identyczny bajt po bajcie między przebiegami dla identycznego wejścia.
sourcesPolicySource[]niePliki definicji, które host odczytuje w czasie kompilacji 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.

RenderedArtifact

Jeden wyrenderowany plik wyjściowy: jego ścieżka i wyrenderowana treść pod tą ścieżką.

WłaściwośćTypWymaganaOpis
pathstringtakŚcieżka wyjściowa wyrenderowanego pliku, względem katalogu głównego renderowania.
contentstringtakWyrenderowana treść pod tą ścieżką.
treeanynieSparsowane, ustrukturyzowane drzewo tego artefaktu, obecne, gdy host sparsował treść przed przekazaniem jej pluginowi — kanoniczny widok JSON formatu źródłowego, którego plugin nie odczytuje natywnie (na przykład artefakt HCL sparsowany do JSON). Najwyższy poziom może być obiektem, tablicą lub skalarem, zgodnie z kształtem samego sparsowanego dokumentu. Nieobecne, gdy host nie sparsował artefaktu; wówczas plugin odczytuje bezpośrednio natywną treść. Host przekazuje drzewo w sposób nieprzezroczysty, przenosząc je bez zmian i nie interpretując jego treści.
formatstringnieFormat, w jakim artefakt został wyrenderowany, obecny, gdy dostawca, który go wytworzył, go zadeklarował. Nieobecny, gdy dostawca, który wytworzył artefakt, nie zadeklarował formatu.

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

PolicySource

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.

PrecalculatedPath

Jedna wstępnie wyliczona ścieżka routingu, którą materializuje analizator, dzięki czemu reguły polityk mogą wnioskować o osiągalności bez ponownego przechodzenia grafu.

WłaściwośćTypWymaganaOpis
path_idstringtakStabilny identyfikator tej ścieżki; deterministyczny między przebiegami dla identycznego wejścia.
nodesstring[]takUporządkowana sekwencja identyfikatorów węzłów, przez które przechodzi ścieżka, od źródła do węzła końcowego.
attached_featuresstring[]takPosortowana alfabetycznie suma identyfikatorów URI typów encji Feature dołączonych do dowolnego węzła na ścieżce. Semantyka przynależności do zbioru: encja Feature występuje raz, nawet jeśli przenosi ją wiele węzłów. Pusta, gdy żaden węzeł na ścieżce nie przenosi żadnego dołączenia encji Feature.

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