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 (Recipe)

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

Tworzona przez zespół Ops warstwa wskazań i mapowań, łącząca intencję zespołu Dev z konkretnym dostawcą infrastruktury. Ściśle 1:1 z fizycznym dostawcą i komponentem katalogu.

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

Typ najwyższego poziomu: object

Właściwości

WłaściwośćTypWymaganaOpis
apiVersionconst “aggrega.ai/v1beta1”takStała: "aggrega.ai/v1beta1"
kindconst “Recipe”takStała: "Recipe"
metadataobjecttak
specobjecttakPowiązanie z dostawcą, źródło, mapowanie wartości i potok dla encji Recipe. Obsługuje trzy rodzaje wejścia składane przez dodawanie: źródłowe (source wraz z nakładką valuesMapping), syntetyzowane (workload) i artefakty (nazwane pliki wyjściowe). Niezależnie od nich encja Recipe może dodawać pliki do wspólnego wyjścia granicy, w której jest renderowana, w ramach klucza ‘boundary’.

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

recipe.metadata

WłaściwośćTypWymaganaOpis
namestringtakCo najmniej 1 znak.
versionstringtakWersja implementującej receptury w ścisłym formacie Semantic Versioning (np. 2.1.0). 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.

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

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

recipe.spec

Powiązanie z dostawcą, źródło, mapowanie wartości i potok dla encji Recipe. Obsługuje trzy rodzaje wejścia składane przez dodawanie: źródłowe (source wraz z nakładką valuesMapping), syntetyzowane (workload) i artefakty (nazwane pliki wyjściowe). Niezależnie od nich encja Recipe może dodawać pliki do wspólnego wyjścia granicy, w której jest renderowana, w ramach klucza ‘boundary’.

WłaściwośćTypWymaganaOpis
capabilitystringtakJawna zdolność dostawcy, z którą wiąże się ta receptura (np. ‘helm’, ‘terraform’, ‘compose’) — rodzaj dostawcy, który ją renderuje. Przyjmuje opcjonalne przypięcie wersji w tych samych trzech formach co ‘implements’: bez wersji (‘helm’), dokładna (‘helm:1.0.0’) lub zakres zgodny z wersją główną (‘helm:^1.0.0’). Sama nazwa wybiera rodzaj dostawcy; przypięcie, jeśli jest obecne, wybiera, która wersja wtyczki renderującej dostawcy obsługującej tę zdolność renderuje tę recepturę — najwyższa dostępna bez przypięcia, dokładna przy przypięciu dokładnym, najwyższa w zakresie przy daszku. Przypięcie, którego nie spełnia żadna wersja obsługującej wtyczki, jawnie zatrzymuje kompilację. Wszystko, co następuje po wyborze dostawcy — grupowanie wyjścia, segmenty ścieżek, zgodność potoku i wybór kodeka — opiera się na samej zdolności, więc dwie receptury przypinające różne wersje wtyczki tej samej zdolności współistnieją w jednej kompilacji.
implementsstringtakDeklaruje, który typ komponentu katalogu ta receptura może implementować (dokładna wersja ‘core/api-server:1.0.0’, zakres zgodny z wersją główną ‘core/api-server:^1.0.0’ lub bez wersji ‘core/api-server’). Kompilator używa go do weryfikacji mapowań w encji Manifest oraz do podpowiadania kandydatów w diagnostyce i uzupełnianiu w edytorze; nigdy nie rozstrzyga on kompilacji. aggrega lint również go odczytuje, aby odnaleźć encję Component, z której zadeklarowanym kontraktem provides porównywane są klucze opublikowane przez encję Recipe. Mapowanie w encji Manifest jest jawnym wyborem implementacji dokonanym przez użytkownika, przypiętym w pliku blokady encji Release.
sourcestring lub objectnieLokalizacja kodu infrastruktury. Przyjmuje ciąg URI albo otwarty obiekt strukturalny, którego klucze zdefiniowane przez dostawcę są udostępniane szablonom encji Recipe jako ‘.source.*’.
localsmapa stringniePrywatny stan Ops. Wewnętrzne wyniki obliczeń dostępne w szablonach tej encji Recipe jako ‘.locals.*’. Każdy wpis jest sam szablonem Go, ewaluowanym względem samodzielnego kontekstu lokalnego dla węzła: ‘.context.instance_id’, ‘.values’, ‘.infra’ oraz wpisów tego samego bloku rozwiązanych do tej pory. Wpisy są rozwiązywane w kolejności zapisu, a wpis MOŻE odczytać wpis siostrzany zdefiniowany POWYŻEJ, otrzymując jego rozwiązaną wartość, a nie tekst szablonu. Kolejność autora jest częścią kontraktu wszędzie tam, gdzie jeden wpis odczytuje inny: przeniesienie definicji poniżej odczytującego ją wpisu psuje kompilację, a blok nigdy nie jest przestawiany, aby odwołanie dało się rozwiązać. Odwołanie ‘.locals.’ do wpisu, który ten blok definiuje PÓŹNIEJ, zatrzymuje kompilację ze wskazaniem błędu kolejności; odwołanie do klucza, którego blok w ogóle nie deklaruje, zatrzymuje ją ze wskazaniem klucza. Obie kontrole odczytują ścieżkę, do której odwołanie SIĘ ROZWIĄZUJE, a nie wpisane znaki, więc obejmują w równym stopniu formę bezpośrednią, odczyt wewnątrz bloku ’{{ with .locals }}’, odczyt przez zmienną powiązaną bezpośrednio z ‘.locals’ oraz klucz odczytywany z bloku w nawiasach, ‘(.locals).’ lub ’($.locals).’. Jednego zapisu nie obejmują: odwołania, którego ścieżki nie rozstrzyga tekst szablonu — osiąganego przez funkcję, np. ‘index .locals’ lub ‘(default dict .locals).’, albo przez blok ‘with’ lub powiązanie zmiennej, których potok ją stosuje, gdyż to, co zwraca taki potok, rozstrzyga się podczas ewaluacji, a nie na podstawie tekstu. Nie jest ono analizowane, a nieobecny klucz osiągnięty w ten sposób nie zatrzymuje kompilacji: renderuje się jako dosłowny tekst '', a nie jako nic. Jedynym wyjątkiem jest samo ‘index’: na każdej powierzchni szablonów zatrzymuje kompilację, wskazując klucz, gdy odczytywana mapa nie zawiera żądanego klucza, więc nieobecny klucz osiągnięty przez ‘index .locals’ zatrzymuje kompilację. Wpis lokalny nie może odczytać ‘.provides’: ten filar nie należy do tego kontekstu, a wpis, który po niego sięga, zatrzymuje kompilację. Rozwiązane wartości trafiają do provides, source, valuesMapping, workload, artifacts, assertions oraz pipeline[].with (i pipeline[].when) — wpisy locals tej encji Recipe są rozwiązywane PRZED jej provides, więc szablon provides może odczytać ‘.locals’ i otrzymuje rozwiązane wartości, natomiast szablon provides wskazujący klucz, którego ten blok nie deklaruje, zatrzymuje kompilację. Służy do eksportowania fizycznych realiów (np. docelowych kontenerów, ścieżek JSON) dla dalszych wtyczek Wasm. Nigdy nie jest udostępniany wywołującym — do publicznego API służy provides.
providesmapa wartości string, number lub booleanniePubliczne API dla programistów. Kontraktowe zmienne wyjściowe dostępne dla rozwiązywania inject przez dalszych wywołujących. Kompilator ewaluuje szablony provides względem samodzielnego kontekstu, w dowolnej kolejności między sobą — żaden wpis provides nie odczytuje innego. Wpisy locals węzła są rozwiązywane w preambule locals, przed jego provides, więc szablon provides może odczytać ‘.locals’ i otrzymuje rozwiązane wartości; wskazanie klucza, którego blok locals nie deklaruje, zatrzymuje kompilację. Wywołujący rozwiązują klucze inject względem tych wartości podczas hydratacji inject. Wartości są skalarami — potok przenosi je dosłownie i deterministycznie zamienia na ciągi znaków na granicy wstrzykiwania.
valuesMappingstring lub objectnieTreść mapowania wartości z trzema trybami tworzenia wybieranymi na podstawie kształtu treści. Tryb 1 (wbudowany): skalar ciągu szablonu Go (zwykle skalar blokowy YAML |) generujący format wartości oczekiwany przez dostawcę z kontekstu Aggrega (.values, .features, .infra). 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 MappingLibrary przez tożsamość samej nazwy (wersję dostarcza plik blokady danej encji Release; w odwołaniu nie pojawia się host rejestru). W formie obiektowej $import nie może pasować do ^oci://; wartość, która pasuje, jest odrzucana.
workloadstring lub objectnieGenerator YAML obiektu Workload z trzema trybami tworzenia, wybieranymi na podstawie kształtu treści. Tryb 1 (inline): skalar łańcuchowy z szablonem Go, którego wynik parsuje się 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 biblioteki): mapa YAML z dokładnie jednym kluczem, $import: <Library>#/workloads/<entry>, odwołująca się do wpisu WorkloadLibrary przez tożsamość samej nazwy (wersję dostarcza plik blokady danej encji Release; w odwołaniu nie pojawia się host rejestru). Docelowy Provider musi obsługiwać syntezę obiektów workload; katalog biblioteki standardowej deklaruje workloadSchema w takich providerach jako udokumentowany kontrakt. Encja Recipe z workload: powiązana z providerem, który nie potrafi syntetyzować, głośno zatrzymuje się w czasie renderowania. W postaci obiektowej $import nie może pasować do ^oci://; wartość, która pasuje, jest odrzucana.
artifactsmapa string lub objectnieMapa nazw wpisów na treść artefaktów. Wartość każdego wpisu przyjmuje jeden z trzech trybów, wybierany na podstawie kształtu treści. Tryb 1 (inline): skalar łańcuchowy 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ąca lokalny plik szablonu Go. Tryb 3 (import biblioteki): mapa YAML z dokładnie jednym kluczem, $import: <Library>#/artifacts/<entry>, odwołująca się do pakietu ArtifactLibrary przez tożsamość samej nazwy (wersję dostarcza plik blokady danej encji Release; w odwołaniu nie pojawia się host rejestru). Pakiet rozwija się w jeden wynik na plik, każdy zagnieżdżony pod kluczem wpisu jako <key>/<filename>. Klucz nazywa wynik wpisu: klucz wpisu w trybie 1 lub 2 jest nazwą pliku wynikowego, użytą tak, jak ją zapisano, a zaimportowany plik wpisu w trybie 2 dostarcza treść, nie nazywając wyniku, więc dwa wpisy importujące różne pliki o tej samej nazwie to dwa odrębne wyniki. Kolizje między wpisami artefaktów, plikami pakietów, wynikiem źródła i syntezą obiektu workload zatrzymują kompilację podczas renderowania węzła. Blok artifacts tworzy się identycznie w encji Recipe i w encji FeatureRecipe — te same trzy tryby, ta sama reguła klucz–wynik i to samo zachowanie przy kolizjach — dlatego ta część opisu brzmi tak samo dla obu rodzajów; przykład napisany dla jednego przenosi się bez zmian na drugi. W postaci obiektowej $import nie może pasować do ^oci://; wartość, która pasuje, jest odrzucana. Klucze: klucz nazywa wynik wpisu, więc jest ograniczony do pojedynczej nazwy pliku: zaczyna się literą lub cyfrą i ciągnie się dalej literami, cyframi, kropkami, łącznikami lub podkreśleniami. Kropki po pierwszym znaku zachowują rozszerzenia, które 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 wynikowym — klasa pierwszego znaku odrzuca oba przypadki. Przy imporcie biblioteki klucz nazywa katalog, pod którym zagnieżdżane są pliki pakietu, więc obowiązuje to samo ograniczenie. Wzorzec: ^[A-Za-z0-9][A-Za-z0-9._-]*$.
omitsobject[]nieCo pominąć w tym, co renderuje źródło tej encji Recipe — dla źródła przyjętego takim, jakie jest, które renderuje coś, czego encja Release nie może dostarczyć: dokument renderowany przez pobrany chart, na przykład Secret z kluczem, który chart generuje od nowa przy każdym renderowaniu, usługę, wolumin lub konfigurację dołączoną do pobranego pliku compose albo zasób zadeklarowany w pobranym szablonie CloudFormation. Większość encji Recipes nigdy tego nie potrzebuje. Każdy wpis wskazuje jedną jednostkę renderowaną przez źródło po jej rodzaju, nazwie i — jeśli wpis je podaje — przestrzeni nazw oraz subcharcie, z którego pochodzi, każde w słownictwie providera 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 provider pomija każdą jednostkę, do której pasuje wpis, a to, do czego wpis pasuje i co provider odrzuca z powodu wpisu, jest jego własnym udokumentowanym kontraktem. Provider, który nie potrafi niczego pominąć, odrzuca encję Recipe deklarującą ten klucz, zanim cokolwiek zostanie wyrenderowane. Filtrowane jest tylko to, co renderuje source: — wpis workload: ani artifacts: nigdy nie jest — więc klucz wymaga source. Każda wartość jest szablonem, ewaluowanym względem tego samego kontekstu co valuesMapping. Najpierw ewaluowane jest when wpisu, a wpis, którego when renderuje wartość fałszywą, jest odrzucany. Każdy pozostały aktywny wpis musi coś pominąć: aktywny wpis, który nie pasuje do niczego, co wyrenderowało źródło, 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ę — i pomijany jest tylko jego wynik. Co najmniej 1 wpis.
boundaryobjectnieCo ta encja Recipe wnosi do wspólnego wyniku granicy, w której się renderuje, zamiast do wyniku własnego komponentu. Większość encji Recipes nigdy tego nie potrzebuje: służy to plikowi, który cel odczytuje raz dla całej granicy — na przykład konfiguracji providera Terraform, którą Terraform akceptuje tylko w konfiguracji głównej granicy, a nigdy w module jednego komponentu. Provider akceptuje takie pliki tylko tam, gdzie jego kontrakt deklaruje boundaryArtifacts, a encja Recipe deklarująca ten blok dla providera, który tego nie robi, jest odrzucana, zanim cokolwiek zostanie wyrenderowane. Encja FeatureRecipe nie ma takiego bloku.
outputLabelsmapa stringnieEtykiety zadeklarowane przez autora encji Recipe, nanoszone na każdy obiekt, który tworzy wyrenderowane wyjście tej receptury, i tłumaczone przez dostawcę na powierzchnię etykiet każdego dostawcy (Kubernetes metadata.labels dla syntezy helm, source-render i artefaktów; etykiety usług Compose; tagi poszczególnych zasobów w treściach artefaktów Terraform .tf.json). Biegną tym samym torem co stałe etykiety pochodzenia, ale należą do autora, a nie do kompilatora. Przestrzenie nazw aggrega.ai/ i app.kubernetes.io/ są zarezerwowane dla natywnych etykiet pochodzenia platformy i są odrzucane podczas ładowania. Za klucz lub wartość, które nie są prawidłową etykietą dla docelowego dostawcy, odpowiada autor receptury; rdzeń nie kontroluje zestawu znaków etykiet poza regułą zarezerwowanych przestrzeni nazw.
outputComponentLabelsstring[]nieKlucze etykiet tożsamości encji Component, które ta receptura przenosi na swoje wyrenderowane wyjście. Każdy wpis wskazuje klucz etykiety; wartość jest pobierana z etykiet instancji komponentu renderowanej przez tę recepturę, więc naniesiona etykieta niesie wartość zadeklarowaną przez ten komponent, a nie powtórzoną tutaj. Przeniesione etykiety trafiają na tę samą powierzchnię etykiet co outputLabels, które zamiast tego niosą dosłowne pary klucz-wartość zapisane na miejscu. Klucz zadeklarowany w obu blokach jest odrzucany podczas ładowania, więc każdy naniesiony klucz ma jedno źródło. Przestrzenie nazw aggrega.ai/ i app.kubernetes.io/ są zarezerwowane dla natywnych etykiet pochodzenia platformy i są odrzucane podczas ładowania; klucz z zakresem, taki jak component.aggrega.ai/hosting, leży poza tymi zarezerwowanymi korzeniami i może zostać przeniesiony.
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.
assertionsmapa stringnieWalidacja krzyżowa pól w czasie budowania. Każdy wpis jest nazwaną asercją: klucz to stabilny identyfikator reguły podawany w komunikatach o błędach; wartość to ciąg szablonu Go z semantyką 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 budowanie. Asercje encji Recipe są ewaluowane po powiązaniu recipe i po ewaluacji provides, przed renderowaniem, i wyrażają niezmienniki implementacyjne konkretnego chartu lub modułu, z którego korzysta encja Recipe. Kontekst szablonu: .values / .infra / .uses / .features / .metadata oraz .provides / .locals / .recipe. Ewaluator używa missingkey=error: odwołania do niezdefiniowanych kluczy zatrzymują przetwarzanie z diagnostyką no-such-key. Ponieważ samo odwołanie zatrzymuje przetwarzanie, zanim zdąży zadziałać jakakolwiek wartość zastępcza, zwykłe default nie zapewnia w tym miejscu wartości zastępczej dla pola opcjonalnego — należy zabezpieczyć odwołanie za pomocą hasKey albo użyć funkcji pomocniczej optional, która bezpośrednio sprawdza obecność klucza. Odczyt klucza przez index również jej nie zapewnia: index zatrzymuje przetwarzanie na kluczu, którego mapa nie zawiera, podając ten klucz.

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

recipe.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.

recipe.spec.boundary

Co ta encja Recipe wnosi do wspólnego wyniku granicy, w której się renderuje, zamiast do wyniku własnego komponentu. Większość encji Recipes nigdy tego nie potrzebuje: służy to plikowi, który cel odczytuje raz dla całej granicy — na przykład konfiguracji providera Terraform, którą Terraform akceptuje tylko w konfiguracji głównej granicy, a nigdy w module jednego komponentu. Provider akceptuje takie pliki tylko tam, gdzie jego kontrakt deklaruje boundaryArtifacts, a encja Recipe deklarująca ten blok dla providera, który tego nie robi, jest odrzucana, zanim cokolwiek zostanie wyrenderowane. Encja FeatureRecipe nie ma takiego bloku.

WłaściwośćTypWymaganaOpis
artifactsmapa string lub objecttakMapa nazw plików na definicje zawartości plików, o kształcie dokładnie takim jak własne artifacts tej encji Recipe: te same trzy tryby — wbudowany ciąg szablonu Go, $import: lokalnego pliku szablonu Go albo $import: pakietu ArtifactLibrary, którego pliki są zagnieżdżane pod kluczem wpisu jako <key>/<filename> — ta sama reguła przypisania klucza do nazwy pliku i ten sam kontekst szablonu, więc wpis może odczytywać .values, .infra, .locals i pozostałe pola dokładnie tak jak wpis artifacts. Różni się miejsce zapisu każdego pliku: jednokrotnie, w katalogu zawierającym złożone wyjście granicy, obok plików zapisywanych tam przez własny proces składania providera, a nie we własnym katalogu tego komponentu. Każdy wpis jest ewaluowany dla każdego komponentu, który ta encja Recipe renderuje w granicy, a pliki powstałe z tych ewaluacji są scalane według nazwy: jedna nazwa ewaluowana do identycznych bajtów przez kilka komponentów lub kilka encji Recipe to jeden plik, natomiast jedna nazwa ewaluowana do różnych bajtów zatrzymuje budowanie z podaniem pliku i wszystkich jego współtwórców — podobnie jak nazwa, którą własny proces składania providera już zapisuje. Do takiego pliku nie jest wpisywana informacja, który komponent go zapisał, ponieważ należy on do każdego komponentu, który go zadeklarował. Wpis, którego szablon renderuje się do pustej treści, nie zapisuje żadnego pliku. Wpisy nie są przekazywane providerowi, który zapisuje resztę wyjścia granicy bez ich odczytywania. W formie obiektowej $import nie może pasować do ^oci://; wartość, która pasuje, jest odrzucana. Klucze: klucz nazywa plik, więc jest ograniczony do pojedynczej nazwy pliku, zgodnie z regułą, której podlega klucz artifacts: zaczyna się literą lub cyfrą, a dalej zawiera litery, cyfry, kropki, łączniki lub podkreślenia. 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 granicy — klasa pierwszego znaku wyklucza oba przypadki. W przypadku importu z biblioteki klucz nazywa katalog, pod którym zagnieżdżane są pliki pakietu, więc obowiązuje to samo ograniczenie. Wzorzec: ^[A-Za-z0-9][A-Za-z0-9._-]*$. Co najmniej 1 wpis.

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

recipe.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.