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 Aggrega Infrastructure Base (FeatureRecipe)

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

Definicje tworzone przez zespół Ops, odwzorowujące abstrakcyjną encję Feature z katalogu na konkretną, wersjonowaną implementację dla jednej zdolności providera. Ściśle 1:1 z fizycznym dostawcą i funkcją z katalogu.

Wskazówki dotyczące tworzenia encji FeatureRecipe zawiera dokumentacja tworzenia encji FeatureRecipe; ta strona dokumentuje schemat strukturalny, który opisuje ta dokumentacja.

Typ najwyższego poziomu: object

Właściwości

WłaściwośćTypWymaganaOpis
apiVersionconst “aggrega.ai/v1beta1”takStała: "aggrega.ai/v1beta1"
kindconst “FeatureRecipe”takStała: "FeatureRecipe"
metadataobjecttak
specobjecttakPowiązanie z możliwością providera, mapowanie, potok i mapowanie wstrzyknięć dla encji FeatureRecipe. Zawiera te same trzy rodzaje wejść co Recipe (sourced, synthesized, artifacts) oraz dostępne tylko w FeatureRecipe injectMapping; FeatureRecipe służąca wyłącznie do powiązań, deklarująca tylko capability i implements, jest poprawna i niczego nie renderuje.

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

featurerecipe.metadata

WłaściwośćTypWymaganaOpis
namestringtakCo najmniej 1 znak.
versionstringtakWersja encji FeatureRecipe w ścisłym formacie Semantic Versioning (np. 1.2.5). Wzorzec: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$.
descriptionstringnieCzym jest ta encja i do czego służy, napisane dla kogoś, kto decyduje, czy jej użyć. Należy zacząć od zdania nazywającego rzecz, a następnie dodać to, czego czytelnik potrzebuje, aby ją wybrać i poprawnie użyć — czego oczekuje od encji Release, która ją wdraża, oraz wszystko, co zaskakuje w jej zachowaniu. Zwykle wystarcza krótki akapit.
maintainersobject[]nieLista opiekunów, do których należy ta encja.
licensestringnieIdentyfikator SPDX licencji oprogramowania opisywanego przez tę encję, np. MIT lub AGPL-3.0. Określa warunki tego oprogramowania, a nie warunki tego pliku.
repositorystringnieURL repozytorium Git, w którym znajdują się pliki źródłowe.
homestringnieURL strony domowej, wiki lub dokumentacji tej encji.
keywordsstring[]nieLista opisowych słów kluczowych ułatwiających wyszukiwanie w interfejsie użytkownika.

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

featurerecipe.metadata.maintainers[]
WłaściwośćTypWymaganaOpis
namestringtak
emailstringnie
urlstringnie

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

featurerecipe.spec

Powiązanie z możliwością providera, mapowanie, potok i mapowanie wstrzyknięć dla encji FeatureRecipe. Zawiera te same trzy rodzaje wejść co Recipe (sourced, synthesized, artifacts) oraz dostępne tylko w FeatureRecipe injectMapping; FeatureRecipe służąca wyłącznie do powiązań, deklarująca tylko capability i implements, jest poprawna i niczego nie renderuje.

WłaściwośćTypWymaganaOpis
capabilitystringtakJawna możliwość providera, z którą wiąże się ta receptura (np. ‘helm’, ‘terraform’, ‘compose’) — rodzaj providera, który ją renderuje.
implementsstringtakDeklaruje, który typ encji Feature z katalogu ta receptura może implementować (w tym encje Features z danymi uwierzytelniającymi oznaczone feature.aggrega.ai/kind: secret; dokładna wersja, zakres zgodny z wersją główną ’^’ lub bez wersji). Kompilator używa tego do weryfikacji mapowań w encji Manifest oraz do podpowiadania kandydatów w diagnostyce i uzupełnianiu w edytorze; nigdy nie rozstrzyga na tej podstawie kompilacji. Mapowanie w encji Manifest jest jawnym wyborem implementacji dokonanym przez użytkownika, przypiętym w pliku blokady encji Release.
localsmapa stringniePrywatny stan Ops. Wewnętrzne wyniki obliczeń dostępne wyłącznie w szablonach tej encji FeatureRecipe jako ‘.locals.*’. Każdy wpis sam jest szablonem Go, ewaluowanym względem samodzielnego kontekstu: ‘.context.instance_id’ (KOMPONENT HOSTA, dla którego rozstrzygane jest to dołączenie — to właśnie oznacza ta referencja na każdej powierzchni szablonów), ‘.attachment_name’ (rozstrzygana instancja dołączenia i jedyna droga do tej nazwy z wpisu lokalnego), własne ‘.values’ i ‘.infra’ dołączenia oraz dotychczas rozstrzygnięte wpisy tego samego bloku. Wpisy są rozstrzygane w kolejności, w jakiej zostały zapisane, a wpis MOŻE odczytać wpis sąsiedni zdefiniowany POWYŻEJ, otrzymując jego rozstrzygniętą wartość, a nie tekst szablonu. Kolejność autorska jest częścią kontraktu wszędzie tam, gdzie jeden wpis odczytuje inny: przeniesienie definicji poniżej wpisu, który ją odczytuje, psuje kompilację, a blok nigdy nie jest przestawiany, aby referencja dała się rozstrzygnąć. Referencja ‘.locals.’ do wpisu, który ten blok definiuje PÓŹNIEJ, zatrzymuje kompilację ze wskazaniem błędu kolejności; referencja do klucza, którego blok w ogóle nie deklaruje, zatrzymuje ją ze wskazaniem klucza. Obie kontrole odczytują ścieżkę, do której referencja SIĘ ROZSTRZYGA, a nie wpisane znaki, więc obejmują jednakowo formę bezpośrednią, odczyt wewnątrz bloku ’{{ with .locals }}’, odczyt przez zmienną powiązaną bezpośrednio z ‘.locals’ oraz klucz odczytany z bloku w nawiasach, ‘(.locals).’ lub ’($.locals).’. Jednego zapisu nie obejmują: referencji, której ścieżki nie określa tekst szablonu — osiągniętej przez funkcję, taką jak ‘index .locals’ lub ‘(default dict .locals).’, albo przez blok ‘with’ lub powiązanie zmiennej, których potok stosuje funkcję, ponieważ wynik takiego potoku jest ustalany podczas ewaluacji, a nie przez jego tekst. Nie jest ona analizowana, a nieobecny klucz osiągnięty w ten sposób nie zatrzymuje kompilacji: renderuje dosłowny tekst '' zamiast niczego. Jedynym wyjątkiem jest samo ‘index’: na każdej powierzchni szablonów zatrzymuje kompilację ze wskazaniem klucza, gdy odczytywana mapa nie zawiera żądanego klucza, więc nieobecny klucz osiągnięty przez ‘index .locals’ zatrzymuje kompilację. Wpisy locals tej encji FeatureRecipe są rozstrzygane PRZED jej provides, więc szablon provides może odczytywać ‘.locals’ i otrzymuje rozstrzygnięte wartości, natomiast szablon provides wskazujący klucz, którego ten blok nie deklaruje, zatrzymuje kompilację. Reguły są takie same, jak te, których przestrzega blok locals encji Recipe. Gdy executionScope ma wartość boundary, blok jest ewaluowany jeden raz dla dołączenia granicy, względem kontekstu szablonu w zakresie granicy zamiast kontekstu komponentu, a każdy komponent, do którego sięga dołączenie, odczytuje te rozstrzygnięte wpisy, łącznie z ‘.locals’ odczytywanymi przez jego injectMapping. Służy do eksportowania fizycznych realiów (np. docelowych kontenerów, ścieżek JSON) dla dalszych pluginów Wasm. Nigdy nie jest udostępniany wywołującym — do publicznego API służy provides.
providesmapa stringniePubliczne API dewelopera. Kontraktowe zmienne wyjściowe dostępne do rozstrzygania inject przez wywołującego w dalszej kolejności. Gdy executionScope ma wartość boundary, provides są ewaluowane jeden raz dla dołączenia granicy, względem kontekstu szablonu w zakresie granicy, a każdy komponent, do którego sięga dołączenie, odczytuje tę jedną ewaluację pod ‘.features..provides’, podobnie jak połączenie niesione przez dołączenie; kontrakt provides deklarowany przez implementowaną encję Feature jest sprawdzany jeden raz, na tej ewaluacji, ze wskazaniem dołączenia granicy.
sourcestring lub objectnieOpcjonalna ścieżka do kodu infrastruktury. Przyjmuje ciąg URI lub otwarty obiekt strukturalny. Jeśli podano ją razem z valuesMapping, kompilator ją renderuje, a wyrenderowane dokumenty dołączają do wyjścia encji FeatureRecipe przed uruchomieniem jej kroków potoku.
valuesMappingstring lub objectnieTreść mapowania wartości z trzema trybami tworzenia, wybieranymi na podstawie kształtu treści. Tryb 1 (inline): skalarny ciąg szablonu Go tworzący format wartości oczekiwany przez providera. Tryb 2 (import pliku): mapa YAML z dokładnie jednym kluczem, $import: ./relative/path.tmpl, wskazująca lokalny plik szablonu Go. Tryb 3 (import z biblioteki): mapa YAML z dokładnie jednym kluczem, $import: <Library>#/mappings/<entry>, odwołująca się do wpisu encji MappingLibrary przez samą nazwę (wersję dostarcza plik blokady danej encji Release; w referencji nie występuje host rejestru). W formie obiektowej $import nie może pasować do ^oci://; wartość, która pasuje, jest odrzucana.
workloadstring lub objectnieGenerator YAML encji Workload z trzema trybami tworzenia, wybieranymi na podstawie kształtu treści. Tryb 1 (inline): skalarny ciąg szablonu Go, którego wynik jest parsowany jako ‘aggrega.ai/v1beta1 Workload’. Tryb 2 (import pliku): mapa YAML z dokładnie jednym kluczem, $import: ./relative/path.yaml, wskazująca lokalny plik szablonu Go. Tryb 3 (import z biblioteki): mapa YAML z dokładnie jednym kluczem, $import: <Library>#/workloads/<entry>, odwołująca się do wpisu encji WorkloadLibrary przez samą nazwę (wersję dostarcza plik blokady danej encji Release; w referencji nie występuje host rejestru). Docelowa encja Provider musi obsługiwać syntezę obciążeń; katalog biblioteki standardowej deklaruje workloadSchema dla takich providerów jako udokumentowany kontrakt. Encja workload: FeatureRecipe powiązana z providerem, który nie potrafi syntezować, zatrzymuje się z wyraźnym błędem podczas renderowania. Syntezowane obciążenie encji FeatureRecipe emituje natywne manifesty providera w katalogu wyjściowym funkcji. W formie obiektowej $import nie może pasować do ^oci://; wartość, która pasuje, jest odrzucana.
artifactsmapa string lub objectnieMapa z nazwy wpisu na definicję treści artefaktu. Wartość każdego wpisu przyjmuje jeden z trzech trybów, rozpoznawanych po kształcie treści. Tryb 1 (inline): skalar typu string z szablonem Go, którego wynikiem jest treść artefaktu. Tryb 2 (import pliku): mapa YAML z dokładnie jednym kluczem, $import: ./relative/path.yaml, wskazującym lokalny plik z szablonem Go. Tryb 3 (import z biblioteki): mapa YAML z dokładnie jednym kluczem, $import: <Library>#/artifacts/<entry>, odwołującym się do pakietu ArtifactLibrary po samej nazwie (wersję dostarcza plik blokady danej encji Release; w odwołaniu nie występuje host rejestru). Pakiet rozwija się w jedno wyjście na plik, każde zagnieżdżone pod kluczem wpisu jako <key>/<filename>. Klucz nazywa wyjście wpisu: klucz wpisu w trybie 1 lub 2 jest nazwą pliku wyjściowego, użytą tak, jak ją zapisano, a zaimportowany plik wpisu w trybie 2 dostarcza treść, nie nazywając wyjścia, więc dwa wpisy importujące różne pliki o tej samej nazwie dają dwa odrębne wyjścia. Zasoby pomocnicze emitowane przez encję FeatureRecipe generującą zasoby (ConfigMap, ServiceMonitor, NetworkPolicy, CRD ExternalSecret itp.) mają kształt artefaktów; artifacts: jest podstawowym mechanizmem generowania zasobów. Kolizje między wpisami artefaktów, plikami pakietów, wyjściem źródła i syntezą obciążenia zatrzymują kompilację podczas renderowania węzła. Blok artifacts definiuje się identycznie w encji Recipe i w encji FeatureRecipe — te same trzy tryby, ta sama reguła klucz–wyjście i to samo zachowanie przy kolizjach — dlatego ta część opisu brzmi tak samo dla obu rodzajów; przykład napisany dla jednego przenosi się na drugi bez zmian. W formie obiektowej $import nie może pasować do ^oci://; wartość, która pasuje, jest odrzucana. Klucze: klucz nazywa wyjście wpisu, więc jest ograniczony do pojedynczej nazwy pliku: zaczyna się literą lub cyfrą, a dalej zawiera litery, cyfry, kropki, łączniki lub podkreślenia. Kropki po pierwszym znaku zachowują rozszerzenia, jakie noszą klucze artefaktów (main.tf, template.yaml, serviceaccount.yaml). Znak / sprawiłby, że klucz nazywałby ścieżkę, a nie plik, a początkowa . dopuściłaby .., co wskazuje lokalizację poza katalogiem wyjściowym — klasa pierwszego znaku odrzuca oba przypadki. Przy imporcie z biblioteki klucz nazywa katalog, w którym zagnieżdżone są pliki pakietu, więc obowiązuje to samo ograniczenie. Wzorzec: ^[A-Za-z0-9][A-Za-z0-9._-]*$.
omitsobject[]nieCo pominąć z tego, co renderuje źródło tej encji FeatureRecipe — dla źródła przyjętego takim, jakie jest, które renderuje coś, czego Release nie może dostarczyć: dokument renderowany przez pobrany chart, na przykład Secret z kluczem, który chart generuje na nowo przy każdym renderowaniu, usługę, wolumen lub konfigurację dołączoną do pobranego pliku compose albo zasób zadeklarowany w pobranym szablonie CloudFormation. Większość FeatureRecipes nigdy tego nie potrzebuje. Każdy wpis wskazuje jedną jednostkę renderowaną przez źródło po jej rodzaju, nazwie oraz, jeśli wpis je podaje, przestrzeni nazw i subcharcie, z którego pochodzi, każde w słownictwie dostawcy renderującego źródło — dla chartu dokument po jego własnym kind i metadata.name; dla pliku compose service, volume lub config po kluczu pod services:, volumes: lub configs:; dla szablonu CloudFormation zasób po jego Type i identyfikatorze logicznym. Ten dostawca pomija każdą jednostkę dopasowaną przez wpis, a to, co wpis dopasowuje i co dostawca odrzuca z powodu wpisu, jest własnym udokumentowanym kontraktem tego dostawcy. Dostawca, który nie potrafi niczego pominąć, odrzuca encję FeatureRecipe deklarującą ten klucz, zanim cokolwiek zostanie wyrenderowane. Filtrowane jest tylko to, co renderuje source: — wpis workload: ani artifacts: nigdy — dlatego klucz wymaga source. Każda wartość jest szablonem, ewaluowanym w tym samym kontekście co valuesMapping. Najpierw ewaluowane jest when wpisu, a wpis, którego when renderuje wartość fałszywą, jest pomijany. Każdy pozostały aktywny wpis musi coś pominąć: aktywny wpis, który nie dopasowuje niczego z wyrenderowanego źródła, zatrzymuje kompilację, wskazując ten wpis. Źródło nadal renderuje się w całości — każdy szablon chartu nadal się wykonuje, więc szablon, który zawodzi, nadal przerywa kompilację — a pomijane jest tylko jego wyjście. Klucz definiuje się identycznie w encji Recipe i w encji FeatureRecipe. Co najmniej 1 wpis.
injectMappingstringnieOpcjonalny szablon Go inline ewaluowany w fazie przechwytywania przed renderowaniem (Pre-Render Interception), raz dla każdego komponentu, do którego sięga dołączenie, w kontekście szablonu tego komponentu: odczytuje ‘.context’ i ‘.features’ komponentu oraz ‘.attachment_name’, ‘.values’, ‘.infra’ i ‘.locals’ dołączenia, niezależnie od executionScope, a odwołanie do ‘.boundary’, którego nie zawiera kontekst żadnego komponentu, zatrzymuje kompilację. Zwraca słownik JSON/YAML, który kompilator Go natywnie głęboko scala z kanałem pamięci ‘.context.inject’ wywołującego. Służy do modyfikacji zmiennych środowiskowych i kontraktów dostarczania po stronie wywołującego bez Wasm.
pipelineobject[]nieSekwencyjna lista kroków potoku Wasm uruchamianych po renderowaniu na zbiorze wyrenderowanych dokumentów; każdy krok zwraca łatki RFC 6902 i efekty uboczne.
executionScopestring (enum)nieOkreśla, czy generowanie zasobów tej encji FeatureRecipe działa dla każdego komponentu (domyślnie), czy raz na dołączenie do granicy. FeatureRecipes o zasięgu granicy są deduplikowane według (boundary_path, instancja FeatureRecipe), a każdy szablon poza injectMapping odczytuje kontekst szablonu o zasięgu granicy: filary .boundary.* zamiast filarów .context.* dla każdego komponentu, a odwołanie do tych ostatnich zatrzymuje kompilację. injectMapping jest wykonywane raz dla każdego komponentu, do którego sięga dołączenie, niezależnie od executionScope, więc odczytuje kontekst tego komponentu i nigdy .boundary. Dozwolone wartości: "component", "boundary" Domyślnie: "component"
readsCallerRenderFactslogicznanieDeklaruje, że szablony tej encji FeatureRecipe odczytują to, co wyrenderowały Components łączące się z tym, do którego jest dołączona: fakty renderowania, które dostawca każdego z tych wywołujących zgłasza o własnym wyjściu. Gdy ma wartość true, a FeatureRecipe renderuje się dla każdego komponentu, każde jej dołączenie renderuje się po wyrenderowaniu wszystkich encji Component w kompilacji, a nie zaraz po encji Component, do której jest dołączone, dzięki czemu renderowanie każdego wywołującego jest ukończone przed ewaluacją dołączenia. Gdy ma wartość false lub jest nieobecny, żaden wpis wywołującego w ‘.context.used_by’ nie zawiera faktów renderowania, dołączenie renderuje się zaraz po swojej encji Component, chyba że readsTargetRenderFacts ma wartość true, a kompilacja zatrzymuje się na szablonie zapisanym inline w tej encji FeatureRecipe, który odczytuje fakty renderowania wywołującego pod ‘.context.used_by’. Domyślnie: false
readsTargetRenderFactslogicznanieDeklaruje, że szablony tej encji FeatureRecipe odczytują to, co wyrenderowały Components, z którymi połączony jest ten, do którego jest dołączona: fakty renderowania, które dostawca każdego z tych celów zgłasza o własnym wyjściu, w każdym wpisie ‘.context.uses’. Gdy ma wartość true, a FeatureRecipe renderuje się dla każdego komponentu, każde jej dołączenie renderuje się po wyrenderowaniu wszystkich encji Component w kompilacji, a nie zaraz po encji Component, do której jest dołączone, dzięki czemu renderowanie każdego celu jest ukończone przed ewaluacją dołączenia. To to samo późniejsze renderowanie, które powoduje readsCallerRenderFacts, więc ustawienie któregokolwiek klucza lub obu sprawia, że dołączenie renderuje się wtedy. Gdy ma wartość false lub jest nieobecny, żaden wpis w ‘.context.uses’ nie zawiera faktów renderowania, dołączenie renderuje się zaraz po swojej encji Component, chyba że readsCallerRenderFacts ma wartość true, a kompilacja zatrzymuje się na szablonie zapisanym inline w tej encji FeatureRecipe, który odczytuje fakty renderowania celu pod ‘.context.uses’. Domyślnie: false
assertionsmapa stringnieWalidacja krzyżowa pól w czasie kompilacji. Każdy wpis jest nazwaną asercją: klucz to stabilny identyfikator reguły pokazywany w komunikatach o błędach; wartość to string z szablonem Go o semantyce zatrzymania {{ fail "message" }}. Wiele nazwanych asercji na encję jest ewaluowanych dla każdej instancji w kolejności zadeklarowanej przez autora; pierwsza niespełniona asercja zatrzymuje kompilację. Asercje FeatureRecipe są ewaluowane po powiązaniu z recepturą i po ewaluacji provides, przed renderowaniem, i wyrażają niezmienniki implementacyjne konkretnego chartu lub modułu, który FeatureRecipe pobiera jako źródło. Kontekst szablonu: .values / .infra / .uses / .features / .metadata oraz .provides / .locals / .recipe. Ewaluator używa missingkey=error: odwołania do niezdefiniowanych kluczy zatrzymują kompilację z diagnostyką braku klucza. Ponieważ samo odwołanie zatrzymuje kompilację, zanim zadziała jakakolwiek wartość zastępcza, zwykłe default nie zapewnia na tej powierzchni wartości zastępczej dla pola opcjonalnego — należy poprzedzić odwołanie sprawdzeniem hasKey albo użyć funkcji pomocniczej optional, która bezpośrednio sprawdza obecność. Odczyt klucza przez index również jej nie zapewnia: index zatrzymuje kompilację na kluczu, którego mapa nie zawiera, wskazując ten klucz.

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

featurerecipe.spec.omits[]
WłaściwośćTypWymaganaOpis
kindstringtakRodzaj jednostki do pominięcia, w słownictwie providera renderującego źródło: dla chartu własny kind wyrenderowanego dokumentu, np. Secret; dla pliku compose service, volume lub config; dla szablonu CloudFormation Type zasobu, np. AWS::S3::Bucket. Wskazuje rodzaj renderowany przez źródło i nie ma związku z kind:, który zawiera ustrukturyzowane source:. Szablon.
namestringtakNazwa jednostki do pominięcia, w słownictwie providera renderującego źródło: dla chartu własne metadata.name wyrenderowanego dokumentu; dla pliku compose klucz jednostki pod services:, volumes: lub configs:; dla szablonu CloudFormation logiczny identyfikator zasobu, czyli jego klucz pod Resources. Szablon.
namespacestringniePrzestrzeń nazw, w której znajduje się jednostka do pominięcia, gdy wpis ma dopasować tylko jednostkę w tej przestrzeni nazw — dla providera, którego wynik ma przestrzenie nazw, tak jak wyrenderowane dokumenty chartu. Gdy pole jest nieobecne lub renderuje się do pustego ciągu, wpis dopasowuje jednostkę o danym rodzaju i nazwie niezależnie od przestrzeni nazw. Plik compose i szablon CloudFormation nie mają przestrzeni nazw, a ich providery odrzucają wpis, który ją wskazuje. Szablon.
subchartstringnieSubchart, z którego pochodzi pomijana jednostka, gdy wpis ma dopasować tylko kopię renderowaną przez jeden subchart — dla źródła złożonego z zagnieżdżonych źródeł, tak jak chart jest złożony ze swoich subchartów. Dla chartu jest to własna nazwa subchartu albo alias nadany mu przez zależność rodzica, przy czym nazwy zagnieżdżonego subchartu łączy się znakiem /, zaczynając od najbardziej zewnętrznego: operator lub operator/webhooks. Wpis dopasowuje wtedy dokument wyrenderowany z własnych templates/ lub crds/ tego subchartu, a nie dokument renderowany przez sam chart ani przez subchart zagnieżdżony w tamtym. Gdy pole jest nieobecne lub renderuje się do pustego stringu, wpis dopasowuje jednostkę swojego rodzaju i nazwy niezależnie od jej pochodzenia. Chart, który nie renderuje subchartu o tej nazwie, zatrzymuje kompilację, wskazując wpis. Plik compose i szablon CloudFormation nie mają subchartów, a ich dostawcy odrzucają wpis, który go wskazuje. Szablon.
whenstringnieWbudowany szablon Go ewaluowany przed pozostałymi polami wpisu. Gdy renderuje wartość fałszywą, wpis jest odrzucany: jego pozostałe pola nie są ewaluowane, nic nie jest pomijane z jego powodu i nie musi on niczego dopasować. Pusty lub nieobecny when zachowuje wpis. Prawdziwość wynika ze standardowej konwencji dla wyniku szablonu przypominającego wartość logiczną: ciągi true/True/TRUE, dowolna liczba niezerowa i każdy inny niepusty ciąg są prawdziwe, natomiast false/False/FALSE, pusty ciąg i zero są fałszywe. when, którego nie da się wyrenderować, zatrzymuje kompilację.

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

featurerecipe.spec.pipeline[]
WłaściwośćTypWymaganaOpis
idstringtakProgramowy identyfikator tego kroku, unikalny wśród kroków tego potoku: dokument deklarujący jeden identyfikator w dwóch swoich krokach jest odrzucany przy odczycie. Późniejszy krok tego samego potoku odczytuje wyniki tego kroku jako .steps.<id>.outputs. Wzorzec: ^[a-zA-Z0-9_]+$.
pluginstringtakOdwołanie do encji Plugin uruchamianej przez ten krok, zawsze zawężone typem gniazda pluginu: <pluginType>/<name> z opcjonalną wersją, np. parser/yaml lub parser/yaml:1.0.0. Zawężenie jest obowiązkowe, a nie jedną z kilku form — niezawężone name:version jest odrzucane, ponieważ dwa gniazda mogą zawierać plugin o tej samej nazwie, a to zawężenie sprawia, że encję da się rozwiązać. Kompilacja rozwiązuje encję do jej adresowanego treścią artefaktu .wasm — lokalizowanego na podstawie tożsamości pluginu i skonfigurowanego rejestru, z skrótem przypiętym w pliku blokady — i ładuje bajty. Samo odwołanie do .wasm lub artefaktu nie jest tu akceptowane.
functionstringtakEksportowana funkcja Wasm do wywołania.
withstringnieWbudowany szablon Go ewaluowany do mapy JSON/YAML, która ściśle spełnia jawny schemat wejściowy tego pluginu.
optionallogicznanieGdy ma wartość true, niepowodzenie tego kroku (pułapka gościa, poprawka wskazująca dokument nieobecny w zbiorze, niepoprawna poprawka lub diagnostyka o ważności zatrzymującej) zostaje obniżone do głośnego ostrzeżenia: zbiór dokumentów sprzed kroku jest przywracany, wynik tego kroku jest odrzucany, a potok działa dalej. Gdy ma wartość false lub jest nieobecne, każde niepowodzenie kroku zatrzymuje kompilację po przywróceniu zbioru dokumentów sprzed kroku.
whenstringnieWbudowany szablon Go ewaluowany podczas przechodzenia potoku. Gdy renderuje wartość fałszywą, krok jest pomijany — działa jako przejście: zbiór dokumentów trafia do następnego kroku bez zmian, nie wnosząc poprawek, efektów ubocznych ani rekordu kroku. Pusty lub nieobecny when zawsze uruchamia krok. Prawdziwość wynika ze standardowej konwencji dla wyniku szablonu przypominającego wartość logiczną: ciągi true/True/TRUE, dowolna liczba niezerowa i każdy inny niepusty ciąg są prawdziwe, natomiast false/False/FALSE, pusty ciąg i zero są fałszywe. when i optional są niezależne: krok może zadeklarować oba.

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