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 kontekstu szablonów Aggrega

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

Widok, który kompilator składa i przekazuje do szablonów encji Recipe i FeatureRecipe podczas renderowania. Podczas renderowania dołączanej encji FeatureRecipe kompilator dodatkowo wypełnia .attachment_name i .inject kontekstem o zasięgu dołączenia, .context.render_facts tym, co dostawca hosta zgłosił o renderowaniu hosta, a w szablonach generujących własne zasoby dołączenia także .context.used_by komponentami, które korzystają z jego hosta. W przypadku encji FeatureRecipe o zasięgu granicy (spec.executionScope: boundary) szablony, które uruchamia ona raz dla granicy — wśród nich jej locals, provides, source, valuesMapping, artifacts i kroki pipeline — zastają filary .context, .workload, .attachment_name, .inject i .inject_raw nieobecne, a zamiast nich wypełniony filar .boundary.* — zob. blok boundary na końcu właściwości; jej injectMapping jest uruchamiany raz dla każdego komponentu, do którego sięga dołączenie, w kontekście tego komponentu, więc odczytuje .context.* i .attachment_name, a .boundary nie jest tam ustawiony. Ten widok NIE jest zapisywany na dysku; istnieje wyłącznie w pamięci kompilatora podczas renderowania. Ten schemat dokumentuje kontrakt między kompilatorem a autorami szablonów Ops.

Dostępność na etapach renderowania bazowego, w kolejności wykonywania etapów:

  • Provides evaluation (preambuła locals, następnie provides): tylko filary lokalne dla węzła. Wpis locals odczytuje wpisy znajdujące się nad nim we własnym bloku; szablon provides odczytuje całe rozwiązane .locals węzła. Odwołanie do samego siebie jest zabronione (żaden wpis provides nie odczytuje innego).
  • Source resolution (publikacja locals + ewaluacja source): wszystkie filary; brak .source i .workload. Te locals są w tym miejscu publikowane w .locals, a następnie source: jest ewaluowane względem nich.
  • Values mapping (valuesMapping): wszystkie filary + .source; brak .workload.
  • Workload synthesis (ewaluacja workload): wszystkie filary + .source; .workload jest właśnie ewaluowane (niedostępne dla odwołania do samego siebie).
  • Artifact evaluation (artifacts): wszystkie filary + .source + .workload (najpełniejszy kontekst).

Typ najwyższego poziomu: object

Właściwości

WłaściwośćTypWymaganaOpis
contextobjecttakKontekst wykonania złożony przez kompilator, dostarczający dane o tożsamości, topologii i dostarczaniu.
valuesobjecttakNieprzezroczysty ładunek kognitywny dla tego węzła, już zwalidowany przez walidator schematu podczas rozwiązywania. Przekazywany bez zmian.
infraobjecttakŁadunek fizycznego wymiarowania wstrzykiwany z encji Release dla tego węzła. Całkowicie omija Developera.
localsmapa stringtakPrywatny stan encji Recipe (np. primary_compute, volumes_path). Obliczany w preambule locals — przed provides danego węzła — i publikowany w tym filarze podczas rozwiązywania source. Każdy wpis jest szablonem Go obliczanym względem samodzielnego, lokalnego dla węzła kontekstu zawierającego dotychczas rozwiązane wpisy tego samego bloku, więc wpis MOŻE odczytać wpis siostrzany zdefiniowany POWYŻEJ niego i otrzymuje jego rozwiązaną wartość. Kolejność autora jest częścią kontraktu wszędzie tam, gdzie jeden wpis odczytuje inny: przeniesienie definicji poniżej wpisu, który ją odczytuje, psuje kompilację. Odwołanie ‘.locals.’ do późniejszego wpisu lub do klucza, którego blok nie deklaruje, zatrzymuje kompilację. Kontrola sprawdza ścieżkę, do której odwołanie SIĘ ROZWIĄZUJE, a nie wpisane znaki, więc obejmuje zarówno formę bezpośrednią, odczyt wewnątrz bloku ’{{ with .locals }}’ i odczyt przez zmienną powiązaną bezpośrednio z ‘.locals’, jak i klucz odczytywany z bloku w nawiasach, ‘(.locals).’ lub ’($.locals).’. Nie obejmuje jednego zapisu: odwołania, którego ścieżki nie rozstrzyga tekst szablonu — osiągniętego przez funkcję, np. ‘index .locals’ lub ‘(default dict .locals).’, albo przez blok ‘with’ lub powiązanie zmiennej, którego potok stosuje taką funkcję. Takie odwołanie nie jest analizowane, 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 szablonu zatrzymuje kompilację, podając nazwę klucza, gdy odczytywana mapa nie zawiera żądanego klucza, więc nieobecny klucz osiągnięty przez ‘index .locals’ zatrzymuje kompilację. Wpis locals nie może odczytać ‘.provides’. Dostępne w provides (podczas obliczania provides, po preambule), source, valuesMapping, workload, artifacts, assertions oraz dla dalszych wtyczek Wasm przez pipeline[].with (i pipeline[].when). Nigdy nie jest udostępniane wywołującym.
providesmapa stringniePubliczny kontrakt API encji Recipe. Wypełniany na podstawie obliczenia provides. Dostępny w valuesMapping renderowania bazowego do odwołań do samego siebie (np. {{ .provides.host }}). NIEDOSTĘPNY w samym szablonie provides (niezmiennik samodzielności provides). Wywołujący rozwiązują klucze inject względem tych wartości.
featuresmapa template_attachmentnieKażde dołączenie tego węzła, z kluczem w postaci nazwy instancji nadanej przez autora. Jeden filar przenosi je wszystkie, niezależnie od tego, co wytwarzają — operacyjną encję Feature, encję Feature poświadczeń, encję Feature tożsamości — ponieważ dołączenia różnią się tym, co wytwarzają, a nie tym, jak szablon je odczytuje. Encja Recipe odczytuje je, aby dostosować renderowanie do dołączonych możliwości i korzystać z tego, co publikuje dołączenie. Dołączenie zapisane na jednym z połączeń węzła nie należy do nich: odczytuje się je w ramach tego połączenia, pod .context.uses..features., więc szablon iterujący po tym filarze napotyka tylko własne dołączenia węzła.
metadataobjectnieMetadane encji Release i kompilacji, zapewniające globalną tożsamość na potrzeby deterministycznego nazewnictwa. Dostępne we wszystkich blokach szablonów (valuesMapping, injectMapping, pipeline with).
attachment_namestringnieWypełniane tylko podczas renderowania dołączenia FeatureRecipe. Zawiera nazwę instancji dołączenia — slot, który wypełnia w featuresSchema encji nadrzędnej, albo dowolną nazwę nadaną przez autora (np. ‘admin_password’, ‘db_credentials’). Służy do tworzenia deterministycznych nazw zasobów, różnych dla każdego dołączenia, złożonych po nazwie komponentu hosta: ’{{ .context.rendered_name }}-{{ .attachment_name | replace ”_” ”-” }}’, gdy provider hosta zgłasza nazwę renderowaną, jak robi to helm — nazwę hosta zapisaną znakami dozwolonymi w nazwie Kubernetes, z podkreśleniami nazwy dołączenia zamienionymi na łączniki — oraz ’{{ .context.instance_id }}-{{ .attachment_name }}’, gdy provider hosta nie zgłasza żadnej.
injectobjectnieWypełniane tylko podczas renderowania dołączenia FeatureRecipe, które ma napisany przez autora blok inject (np. { env: [ { in: ‘OPENAI_API_KEY’, from: ‘api_token’ } ] }). Różni się od .context.inject, który jest wstępnie nawodnionym kanałem dostarczania komponentu bazowego z krawędzi uses. Przyjmuje wartość null/jest nieobecne dla dołączeń bez napisanego inject oraz dla bazowych Recipes.
inject_rawobiekt lub nullnieNiezmienna, niezmodyfikowana intencja Developera dla bloku inject. Każdy mechanizm wskazany w bloku — env, file, arg lub niestandardowy, taki jak ssm_param — znajduje się pod własną nazwą i zawiera wpisy dokładnie w zapisanej postaci (in, z from lub value), w zapisanej kolejności, więc .inject_raw.ssm_param odczytuje mechanizm niestandardowy tak samo, jak .inject_raw.env odczytuje mechanizm podstawowy. Przyjmuje wartość null, jeśli Developer całkowicie pominął blok inject. Używana przez Ops do kontroli logicznych (np. {{ if not .inject_raw }}), aby wykryć pominięcie przed modyfikacjami mapowania inject. To, które własne values lub provides komponentu dostarcza każdy wpis, odczytuje się w .context.self_inject, a nie z tekstu wpisów.
stepsmapa objectnieKomunikacja między krokami potoku. Dostępna tylko wewnątrz bloków ‘with:’ potoku Wasm. Każdy klucz to identyfikator kroku potoku, zawierający wyjścia eksportowane przez ten krok.
sourcestring lub object lub nullnieRozwiązana zawartość pola source. W szablonach encji Recipe: wypełniana podczas rozwiązywania source z pola source: encji Recipe po obliczeniu szablonu Go, dostępna od mapowania wartości (valuesMapping, workload, artifacts) i równa null, gdy Recipe nie ma source:. W szablonach encji FeatureRecipe: własne pole source: encji FeatureRecipe po obliczeniu szablonu Go, obliczane przed jej valuesMapping i odczytywane tam oraz w każdym szablonie obliczanym po nim (omits, workload, artifacts, kroki potoku), nigdy pole komponentu hosta; null, gdy FeatureRecipe nie ma source:. Pole injectMapping encji FeatureRecipe jest obliczane przed jej źródłem i odczytuje źródło komponentu hosta. Forma string = ścieżka URI; forma object = ustrukturyzowane źródło (np. deskryptor OCI z rozwiązaną wersją).
workloadworkload-v1beta1.schema.json lub nullnieSparsowana specyfikacja encji Workload dla tego węzła. Wypełniana podczas syntezy workload z pola workload: encji Recipe po obliczeniu szablonu Go + walidacji JSON Schema encji Workload (względem workload-v1beta1.schema.json). Dostępna od obliczania artefaktów (artifacts), dzięki czemu artefakty mogą odwoływać się do pól workload bez duplikacji (np. ServiceMonitor odczytujący .workload.services.metrics.ports.prom). Przyjmuje wartość null, gdy Recipe nie ma bloku workload:. Próby dereferencji .workload.* na wartości null w szablonie kończą się czytelnym błędem w czasie obliczania szablonu.
boundaryobjectnieKontekst zakresu granicy — wypełniany tylko podczas ewaluacji szablonu, który encja FeatureRecipe, której spec.executionScope ma wartość ‘boundary’, uruchamia raz dla granicy. Encje FeatureRecipes o zakresie Component nie otrzymują tego filaru; zamiast tego ich context.instance_id, context.inject, context.uses oraz filar .workload niosą dane poszczególnych komponentów. Szablony encji FeatureRecipe o zakresie granicy uruchamiane dla granicy otrzymują .boundary.* w miejsce tych filarów dotyczących poszczególnych komponentów; jej injectMapping jest uruchamiany w kontekście każdego komponentu, do którego sięga dołączenie, odczytuje te filary dotyczące poszczególnych komponentów i nie otrzymuje tego filaru.

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

template-context.context

Kontekst wykonania złożony przez kompilator, dostarczający dane o tożsamości, topologii i dostarczaniu.

WłaściwośćTypWymaganaOpis
instance_idstringtakBezwzględny, spłaszczony identyfikator bieżącego węzła (np. ‘backend’ lub ‘data-layer-zdmain-db’ dla komponentu main-db instancji modułu data-layer), zapisany w alfabecie, który spełnia każda nazwa komponentu nadana przez autora. Deterministyczny i stabilny między kompilacjami dla tego samego Aggregate. Jest to nazwa zasobów budowanych dla tego węzła, dla których żaden dostawca nie wyprowadza nazwy — zestawu artefaktów umieszczonego z Recipe oraz workloadu syntetyzowanego przez dostawcę, który nazywa go według tożsamości — dlatego adres publikowany dla jednego z nich jest budowany z tej wartości.
rendered_namestringnieNazwa, którą dostawca powiązany z tym węzłem nadaje zasobom renderowanym dla węzła — dla źródła dostarczonego przez autora jest to nazwa, względem której renderują się same dostarczone szablony, np. nazwa wydania odczytywana przez chart; dla syntetyzowanego workloadu jest to nazwa nadawana zasobom tego workloadu, jeśli dostawca ją wyprowadza, zamiast zapisywać tożsamość węzła, jak robi to dostawca helm z tą samą nazwą wydania. Należy ją odczytywać wszędzie tam, gdzie ten Recipe nazywa zasób zadeklarowany przez dostarczony chart lub moduł albo syntetyzowany przez takiego dostawcę, czy to we wpisie provides, w valuesMapping, w workload, we wpisie artifacts, czy w with lub when kroku pipeline’u, ponieważ dostawca może zapisać tę nazwę w uboższym alfabecie niż ten, w którym zapisana jest nazwa komponentu nadana przez autora, i wtedy obie się różnią. Pusta, gdy powiązany dostawca nie wyprowadza takiej nazwy: zasoby umieszczonego zestawu artefaktów oraz workloadu syntetyzowanego przez dostawcę, który nazywa go według tożsamości, noszą tożsamość węzła, więc dla nich należy odczytywać ’{{ .context.instance_id }}’, a Recipe, który sam zapisał nazwy swoich zasobów, już je zna. Odczyt tego klucza tam, gdzie powiązany dostawca nie zgłasza nazwy, zatrzymuje budowanie i wskazuje, co zapisać zamiast tego. Odmowa obejmuje szablony zapisane przez Recipe inline; valuesMapping, workload lub wpis artifacts dostarczony przez ‘$import’ jest rozwiązywany dopiero wtedy, gdy dotrze do niego renderowanie, więc odwołanie w jednym z nich renderuje się jako pusta wartość zamiast zatrzymać budowanie. W szablonach FeatureRecipe powiązanego z dołączeniem komponentu jest to nazwa komponentu-GOSPODARZA w postaci zgłaszanej przez własnego dostawcę gospodarza — wartość, którą odczytuje własny Recipe gospodarza, tak jak instance_id jest tam tożsamością gospodarza — dzięki czemu dołączenie nazywa zasób według swojego gospodarza i otrzymuje nazwę akceptowaną przez platformę gospodarza. Gdy dostawca gospodarza nie zgłasza nazwy, jest ona pusta, a odczyt jej z szablonu inline dołączenia innego niż jego injectMapping zatrzymuje budowanie; należy tam zamiast tego odczytywać ’{{ .context.instance_id }}’.
labelsmapa stringnieEtykiety duck typingu i ontologii bieżącego węzła, łącznie z wszelkimi zmianami wprowadzonymi podczas budowania topologii przez wtyczkę zarządzania dołączoną w roli label-transform.
annotationsobjectnieTrzy kaskadowe kubełki adnotacji bieżącego węzła, rozdzielone według pochodzenia.
injectobjecttakWstępnie nawodniony i przechwycony kanał dostarczania. Na początku jest to mapa generowana przez kompilator, która rozwiązuje klucze inject dewelopera na wartości provides celu. Modyfikowany w miejscu przez głębokie scalenia injectMapping. W chwili renderowania bazowego Recipe zawiera w pełni rozwiązane fizyczne ciągi znaków.
usesmapa enriched_edgetakWzbogacona mapa krawędzi topologicznych. Kluczem jest alias dewelopera (np. ‘my_db’, ‘my_api’). Każdy wpis to złożony przez kompilator widok tożsamości węzła docelowego, rozwiązanych provides, mapowania wstrzykiwania i kaskadowych adnotacji oraz dołączeń zapisanych na tym połączeniu — a w przypadku FeatureRecipe deklarującego readsTargetRenderFacts także tego, co zgłosiły renderowania celu. NIE jest to surowa krawędź IR — to wzbogacona projekcja zbudowana przez kompilator specjalnie na potrzeby szablonów. Szablon iterujący po tej mapie widzi połączenia w kolejności kluczy — posortowane według aliasu — a nie w kolejności zapisu.
self_injectobjecttakKtóre z własnych values i provides komponentu deweloper już opatrzył nazwą dostarczania, odczytywane z bloku inject: zapisanego w samym komponencie — bloku, który .inject_raw przechowuje w zapisanej postaci, a .context.inject w postaci rozwiązanej. Każdy mechanizm wskazany w bloku (env, file, arg lub niestandardowy, taki jak ssm_param) mapuje każdą nazwę zapisaną przez dewelopera na własny klucz, który dostarcza dany wpis, tak jak .context.uses..inject mapuje nazwy połączenia na klucze, które one odczytują: ‘provides.’ dla wpisu zapisanego z from: ; ‘values.’ dla wpisu, którego szablon value: odczytuje dokładnie jedną z własnych values komponentu i nic poza nią, przy czym jest kluczem najwyższego poziomu tej wartości, niezależnie od tego, jaki tekst lub jakie funkcje otaczają odczyt i jak głęboko sięga on w wartość — ’{{ .values.config.port }}’, ’{{ index .values.config “port” }}’ i ’{{ (default dict .values.config).port }}’ są wszystkie mapowane na ‘values.config’; oraz pusty ciąg znaków dla każdego innego wpisu — literału, szablonu odczytującego dwie wartości, szablonu odczytującego cokolwiek poza values lub szablonu, którego odczytu values tekst nie przypisuje do jednego klucza najwyższego poziomu, jak ’{{ index .values “role” }}’, values odczytywane w całości lub cały kontekst przekazany do funkcji. Encja Recipe, która dostarcza własną wartość pod nazwą domyślną, sprawdza więc, czy jakiś wpis jest już mapowany na ‘values.’, i jeśli tak, pomija swoją nazwę domyślną, np. {{ range $name, $key := .context.self_inject.env }}{{ if eq $key “values.role” }}…{{ end }}{{ end }}. Obecne i puste, gdy deweloper nie zapisał żadnego bloku; mechanizm pojawia się tylko wtedy, gdy blok go wskazuje, a szablon napotyka nazwy posortowane, niezależnie od sposobu ich odczytu. Odczytywane z tekstu zapisanego przez dewelopera, nigdy z rozwiązanej wartości.
used_byinbound_edge[]nieKomponenty, które używają tego komponentu: jeden wpis na każde połączenie uses, które inny komponent do niego tworzy, w kolejności zapisu łączących się komponentów, a następnie w kolejności własnych wpisów uses każdego z nich. Komponent łączący się dwukrotnie pojawia się dwukrotnie. Odczytywane wyłącznie przez FeatureRecipe dołączony do komponentu i tylko w szablonach tworzących własne zasoby dołączenia — jego valuesMapping, workload i artifacts. Nie występuje we własnych szablonach Recipe komponentu, w injectMapping ani w with i when kroku pipeline’u, ponieważ wynik każdego z nich może trafić do własnego renderowanego wyniku komponentu, który pozostaje taki sam niezależnie od tego, kto się z nim łączy. Każdy wpis jest elementem listy, a nie kluczem, więc szablon iterujący po nim napotyka wywołujących w tej kolejności.
render_factsrender_factsnieTo, co dostawca, który wyrenderował ten komponent, zgłosił o emitowanym wyniku — zgłaszane przez niego fakty renderowania — z kluczem w postaci nazwy faktu. To, jakie nazwy zgłasza dostawca i co zawiera każdy wpis, określa własny udokumentowany kontrakt tego dostawcy. Każda wartość jest listą, nawet z jednym wpisem, więc szablon zawsze po niej iteruje; gdy renderowanie komponentu wymagało więcej niż jednego wywołania dostawcy, a jedną nazwę zgłosiło kilka z nich, ich listy są łączone w jedną w kolejności wykonania wywołań. Dostępne w każdym szablonie FeatureRecipe dołączonego do komponentu — jego valuesMapping, workload, artifacts oraz with i when kroków pipeline’u — po wyrenderowaniu komponentu, i puste, gdy jego dostawca niczego nie zgłasza, więc nazwa, której nikt nie zgłosił, odczytuje się jako pusta lista. Nie występuje we własnych szablonach Recipe komponentu ani w injectMapping, które są wykonywane przed wyrenderowaniem komponentu.

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

template-context.context.annotations

Trzy kaskadowe kubełki adnotacji bieżącego węzła, rozdzielone według pochodzenia.

WłaściwośćTypWymaganaOpis
releasemapa stringnieFizyczne ciągi topologii kaskadowo przekazywane z granic Release.
catalogmapa stringnieNiezmienne cechy wewnętrzne zdefiniowane przez architekta platformy w domenie 2.
aggregatemapa stringnieMetadane kognitywne kaskadowo przekazywane z podsystemów Aggregate.

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

template-context.context.inject

Wstępnie nawodniony i przechwycony kanał dostarczania. Na początku jest to mapa generowana przez kompilator, która rozwiązuje klucze inject dewelopera na wartości provides celu. Modyfikowany w miejscu przez głębokie scalenia injectMapping. W chwili renderowania bazowego Recipe zawiera w pełni rozwiązane fizyczne ciągi znaków.

WłaściwośćTypWymaganaOpis
envmapa stringnieDostarczanie przez zmienne środowiskowe. Klucze to lokalne nazwy zmiennych dewelopera, wartości to rozwiązane ciągi docelowe.
filemapa stringnieDostarczanie przez montowanie plików. Klucze to lokalne ścieżki plików, wartości to rozwiązane ciągi docelowe.
argmapa stringnieDostarczanie przez argumenty wiersza poleceń. Klucze to prefiksy flag, wartości to rozwiązane ciągi docelowe.
allmapa stringnieWstępnie obliczone płaskie scalenie mechanizmów env + file + arg + niestandardowych. Wypełniane po rozwiązaniu uses-inject i przeliczane ponownie po mapowaniu inject. Szablony używają {{ toJson .context.inject.all }} do uniwersalnej serializacji.
template-context.context.self_inject

Które z własnych values i provides komponentu deweloper już opatrzył nazwą dostarczania, odczytywane z bloku inject: zapisanego w samym komponencie — bloku, który .inject_raw przechowuje w zapisanej postaci, a .context.inject w postaci rozwiązanej. Każdy mechanizm wskazany w bloku (env, file, arg lub niestandardowy, taki jak ssm_param) mapuje każdą nazwę zapisaną przez dewelopera na własny klucz, który dostarcza dany wpis, tak jak .context.uses..inject mapuje nazwy połączenia na klucze, które one odczytują: ‘provides.’ dla wpisu zapisanego z from: ; ‘values.’ dla wpisu, którego szablon value: odczytuje dokładnie jedną z własnych values komponentu i nic poza nią, przy czym jest kluczem najwyższego poziomu tej wartości, niezależnie od tego, jaki tekst lub jakie funkcje otaczają odczyt i jak głęboko sięga on w wartość — ’{{ .values.config.port }}’, ’{{ index .values.config “port” }}’ i ’{{ (default dict .values.config).port }}’ są wszystkie mapowane na ‘values.config’; oraz pusty ciąg znaków dla każdego innego wpisu — literału, szablonu odczytującego dwie wartości, szablonu odczytującego cokolwiek poza values lub szablonu, którego odczytu values tekst nie przypisuje do jednego klucza najwyższego poziomu, jak ’{{ index .values “role” }}’, values odczytywane w całości lub cały kontekst przekazany do funkcji. Encja Recipe, która dostarcza własną wartość pod nazwą domyślną, sprawdza więc, czy jakiś wpis jest już mapowany na ‘values.’, i jeśli tak, pomija swoją nazwę domyślną, np. {{ range $name, $key := .context.self_inject.env }}{{ if eq $key “values.role” }}…{{ end }}{{ end }}. Obecne i puste, gdy deweloper nie zapisał żadnego bloku; mechanizm pojawia się tylko wtedy, gdy blok go wskazuje, a szablon napotyka nazwy posortowane, niezależnie od sposobu ich odczytu. Odczytywane z tekstu zapisanego przez dewelopera, nigdy z rozwiązanej wartości.

WłaściwośćTypWymaganaOpis
envmapa stringnieDostarczanie przez zmienne środowiskowe: klucze to nazwy zmiennych dewelopera, wartości to własny klucz, który dostarcza każdy wpis.
filemapa stringnieDostarczanie przez montowanie plików: klucze to ścieżki plików dewelopera, wartości to własny klucz, który dostarcza każdy wpis.
argmapa stringnieDostarczanie przez argumenty wiersza poleceń: klucze to prefiksy flag dewelopera, wartości to własny klucz, który dostarcza każdy wpis.

template-context.metadata

Metadane encji Release i kompilacji, zapewniające globalną tożsamość na potrzeby deterministycznego nazewnictwa. Dostępne we wszystkich blokach szablonów (valuesMapping, injectMapping, pipeline with).

WłaściwośćTypWymaganaOpis
release_namestringnieNazwa budowanej encji Release (np. ‘prod-billing’). Używana przez zespół Ops do tworzenia globalnie unikalnych nazw zasobów chmurowych (kubełki S3, role IAM). W połączeniu z .context.instance_id gwarantuje unikalność między środowiskami.
release_versionstringnieWersja semantyczna Release.
environmentstringnieCiąg środowiska z metadanych Release (np. ‘production’, ‘local’).
aggregate_namestringnieNazwa kompilowanego głównego Aggregate.

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

template-context.inject

Wypełniane tylko podczas renderowania dołączenia FeatureRecipe, które ma napisany przez autora blok inject (np. { env: [ { in: ‘OPENAI_API_KEY’, from: ‘api_token’ } ] }). Różni się od .context.inject, który jest wstępnie nawodnionym kanałem dostarczania komponentu bazowego z krawędzi uses. Przyjmuje wartość null/jest nieobecne dla dołączeń bez napisanego inject oraz dla bazowych Recipes.

WłaściwośćTypWymaganaOpis
envmapa stringnieDostarczanie zmiennych środowiskowych w zakresie dołączenia.
filemapa stringnieDostarczanie montowanych plików w zakresie dołączenia.
argmapa stringnieDostarczanie argumentów w zakresie dołączenia.
allmapa stringnieGenerowane przez kompilator pomocnicze scalenie wszystkich mechanizmów inject dołączenia.

template-context.boundary

Kontekst zakresu granicy — wypełniany tylko podczas ewaluacji szablonu, który encja FeatureRecipe, której spec.executionScope ma wartość ‘boundary’, uruchamia raz dla granicy. Encje FeatureRecipes o zakresie Component nie otrzymują tego filaru; zamiast tego ich context.instance_id, context.inject, context.uses oraz filar .workload niosą dane poszczególnych komponentów. Szablony encji FeatureRecipe o zakresie granicy uruchamiane dla granicy otrzymują .boundary.* w miejsce tych filarów dotyczących poszczególnych komponentów; jej injectMapping jest uruchamiany w kontekście każdego komponentu, do którego sięga dołączenie, odczytuje te filary dotyczące poszczególnych komponentów i nie otrzymuje tego filaru.

WłaściwośćTypWymaganaOpis
pathstringnieŚcieżka granicy encji Release, do której dołączona jest encja FeatureRecipe: nazwy granic od najbardziej zewnętrznej do wewnątrz, połączone znakiem ’/’ (np. ‘bridge’, ‘bridge/frontend’). Wskazuje granicę, a nie katalog, do którego zapisywane są jej dane wyjściowe; ten katalog ustawia directory: granicy.
assembly_pathstringnieKatalog, względny wobec katalogu wyjściowego kompilacji, w którym składane są własne dane wyjściowe tego dołączenia: ewaluowane directory: i subDirectory: jego granicy, czyli katalog, do którego kompilacja kieruje te dane (np. ‘bridge/compose’). Jest dokładnie równy source_assembly_path lub target_assembly_path punktu końcowego połączenia wtedy i tylko wtedy, gdy ten punkt końcowy renderuje się do tego samego złożonego pliku, więc encja FeatureRecipe porównuje je, aby odróżnić połączenie wewnątrz własnego pliku od połączenia w innym pliku. Dane nieprzezroczyste; rdzeń ich nie interpretuje.
boundary_namestringnieNazwa granicy (klucz mapy w release.spec.boundaries).
componentsobjectnieMapa instance_id na wpis dla każdego komponentu w poddrzewie granicy (rekurencyjnie, łącznie z komponentami zagnieżdżonych granic). Każdy wpis zawiera rozwiązany URI typu komponentu, identyfikator instancji oraz udostępniane wartości z ewaluacji provides poszczególnych komponentów.
internal_uses_edgesobject[]nieKrawędzie uses, których źródło ORAZ cel znajdują się w poddrzewie tej granicy.
outgoing_cross_boundary_uses_edgesobject[]nieKrawędzie uses, których źródło znajduje się w poddrzewie tej granicy, a cel poza nim.
incoming_cross_boundary_uses_edgesobject[]nieKrawędzie uses, których cel jest w poddrzewie, a źródło poza nim. Używane przez agregatory w stylu ingress, które muszą wiedzieć, kto się do nich odwołuje.
cross_boundary_uses_edgesobject[]niePomocnicza suma wychodzących i przychodzących krawędzi przekraczających granicę.
labelsmapa stringnieSuma etykiet komponentów w poddrzewie, z zachowaniem kolejności nadanej przez autora.
annotationsmapa stringnieWłasne adnotacje granicy po rozwiązaniu kaskady.
feature_attachmentstemplate_attachment[]nieDołączenia przyłączone bezpośrednio do tej granicy (do wzajemnych odwołań między dołączeniami w zakresie granicy), w tym samym kształcie dołączenia, jaki ma .features.

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

Definicje

inbound_edge

Jedno połączenie, które inny komponent nawiązuje z komponentem, dla którego renderuje dołączona encja FeatureRecipe: kto się łączy, przez które gniazdo, co publikuje łączący się komponent oraz w jakiej przestrzeni nazw i granicy jest umieszczony. Każda wartość jest ciągiem znaków, który kompilator przenosi bez interpretowania.

WłaściwośćTypWymaganaOpis
component_idstringtakSpłaszczony identyfikator instancji łączącego się komponentu (np. ‘frontend’ lub ‘data-layer.etl’) — wartość, którą szablon ścieżki subDirectory odczytuje jako .component_id, zapisana tak, jak .context.uses..target zapisuje drugi koniec połączenia.
socketstringtakKategoria usesSchema, przez którą łączący się komponent nawiązuje to połączenie (np. ‘databases’, ‘apis’).
providesmapa stringtakRozwiązane provides łączącego się komponentu, zawężone do kluczy deklarowanych przez jego encję Component — te same wartości, które konsument tego komponentu odczytuje w .context.uses..provides. Puste, gdy komponent niczego nie publikuje.
source_namespacestringniePrzestrzeń nazw, w której umieszczony jest łączący się komponent: adnotacja aggrega.ai/namespace, którą otrzymuje jego własne renderowanie — adnotacje jego granic, z adnotacjami jego własnego wpisu w encji Release zastosowanymi na końcu, tak że komponent, którego wpis ustawia lub czyści przestrzeń nazw, ma własne ustawienie zamiast ustawienia swojej granicy. Jest to wartość, którą encja FeatureRecipe o zakresie granicy odczytuje jako source_namespace we wpisie tego samego połączenia na listach krawędzi uses w .boundary. Nieobecna, gdy do łączącego się komponentu nie ma zastosowania żadna przestrzeń nazw; przed wypisaniem należy ją zabezpieczyć za pomocą if lub with.
source_boundary_pathstringnieRozdzielona ukośnikami ścieżka granicy w encji Release, która zawiera łączący się komponent (np. ‘edge’ lub ‘aws-prod/payments’) — wartość, którą encja FeatureRecipe o zakresie granicy odczytuje jako source_boundary_path we wpisie tego samego połączenia na listach krawędzi uses w .boundary.
render_factsrender_factsnieTo, co renderowania łączącego się komponentu zgłosiły o wygenerowanym wyniku, z kluczami będącymi nazwami faktów: najpierw fakty zgłoszone przez wywołania jego własnego providera, następnie fakty każdej dołączonej do niego encji Feature, która renderowała razem z nim, w kolejności renderowania; listy, które jedna nazwa otrzymuje od kilku z nich, są łączone w jedną w tej kolejności. Każda wartość jest listą, nawet z jednym wpisem, więc szablon zawsze iteruje po niej. Obecne tylko dla encji FeatureRecipe deklarującej readsCallerRenderFacts — której dołączenia renderują się, gdy każdy komponent już się wyrenderował, więc renderowanie każdego wywołującego jest kompletne — i wtedy w każdym wpisie, puste dla wywołującego, którego providery niczego nie zgłaszają. Nieobecne dla każdej innej encji FeatureRecipe.

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

render_facts

Fakty renderowania z kluczami będącymi nazwami: to, co providery, które wyrenderowały komponent, zgłosiły o wygenerowanym wyniku. Jakie nazwy zgłasza provider i co zawiera każdy wpis, określa udokumentowany kontrakt tego providera; kompilator nie dowiaduje się o żadnym z nich niczego poza tym, że każda wartość jest listą. Lista zachowuje kolejność swoich wpisów. Wpis będący obiektem jest przenoszony z kluczami w kolejności, w jakiej zapisał je provider, a szablon iterujący po nim napotyka je w kolejności kluczy, tak jak w przypadku każdej mapy z kluczami w tym kontekście.

Obiekt o dowolnej postaci; wartości są typu any[].

template_attachment

Pojedynczy załącznik w postaci, w jakiej odczytuje go szablon: widok dołączonej encji Feature dla danej instancji. Każdy załącznik udostępnia te same pola niezależnie od tego, co produkuje, więc .features. odczytuje się tak samo bez względu na to, czy ta nazwa jest slotem zadeklarowanym przez encję, czy swobodnym załącznikiem.

WłaściwośćTypWymaganaOpis
typestringnieURI Feature w katalogu dla dołączonej encji Feature.
resolved_versionstringnieWersja dołączonej encji Feature po rozwiązaniu encji Manifest — wersja faktycznie powiązana w tej kompilacji, odczytywana jako .features..resolved_version. Odpowiada .context.uses..resolved_version, dzięki czemu załącznik i krawędź podają powiązaną wersję w ten sam sposób. Pusta, gdy typ załącznika nie wskazuje żadnej encji katalogu.
labelsmapa stringnieEtykiety katalogowe dołączonej encji Feature, przenoszone dosłownie w kolejności, w jakiej deklaruje je encja Feature — nic nie jest filtrowane, przemianowywane ani pozbawiane prefiksu, więc szablon odczytuje dokładnie to, co zapisał autor encji Feature. Pozwala szablonowi rozgałęziać się według tego, czym jest dołączona encja Feature, a nie według jej nazwy czy URI. Odpowiada .context.uses..labels. Klucza w ogóle nie ma, gdy encja Feature nie deklaruje żadnych etykiet oraz gdy typ załącznika nie wskazuje żadnej encji katalogu, dlatego przed odwołaniem się do pojedynczej etykiety należy użyć if lub iterować po mapie.
valuesobjectnieWłasny filar intencji dewelopera dołączenia, przenoszony dosłownie z deklaracji dołączenia.
infraobjectnieWłasny filar wymiarowania operacyjnego dołączenia, przenoszony dosłownie z deklaracji dołączenia.
providesmapa stringnieRozwiązany publiczny kontrakt encji FeatureRecipe powiązanej z tym załącznikiem — nazwa emitowanego zasobu, jego klucz, tożsamość i wszelkie dodatkowe produkowane klucze — udostępniany konsumentowi jako .features..provides.. Konsument odczytuje te wartości zamiast ponownie wyprowadzać fizyczną tożsamość załącznika. Załącznik, którego powiązana encja FeatureRecipe niczego nie publikuje, w ogóle nie ma klucza provides zamiast pustej mapy, dlatego szablon powinien to sprawdzić przed odwołaniem się do pojedynczego klucza.

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

enriched_edge

Pojedyncza wzbogacona krawędź topologiczna złożona przez kompilator. Zawiera rozwiązaną tożsamość celu, jego provides oraz kaskadowe adnotacje.

WłaściwośćTypWymaganaOpis
targetstringtakBezwzględny spłaszczony identyfikator węzła docelowego (np. ‘data-layer.main-db’).
socketstringtakKategoria usesSchema, do której należy ta krawędź (np. ‘databases’, ‘apis’).
sourcestringnieBezwzględny spłaszczony identyfikator węzła źródłowego (konsumenta). Wypełniany dla widoków o zakresie granicy, które kluczują wyjścia poszczególnych konsumentów według węzła konsumenta.
source_namespacestringnieSurowa adnotacja aggrega.ai/namespace punktu końcowego źródła (pusta, gdy jej brak). Wypełniana tylko dla widoków o zakresie granicy, tak jak source; własny wpis .context.uses komponentu zawiera ją pustą. Nieprzezroczyste dane dla rozwiązywania tożsamości sieciowej przez dostawcę; rdzeń ich nie interpretuje.
source_boundary_pathstringnieŚcieżka granicy punktu końcowego źródła: rozdzielana ukośnikami ścieżka granicy encji Release, która go zawiera (np. ‘bridge/frontend’). Wypełniana tylko dla widoków o zakresie granicy, tak jak source; własny wpis .context.uses komponentu zawiera ją pustą.
source_assembly_pathstringnieŚcieżka składania punktu końcowego źródła: katalog, względny wobec katalogu wyjściowego kompilacji, w którym składane są jego dane wyjściowe, utworzony z ewaluowanych directory: i subDirectory: jego granicy (np. ‘bridge/compose’). Dwa punkty końcowe z tą samą ścieżką składania renderują się do jednego złożonego pliku, a punkt końcowy, którego ścieżka składania jest równa .boundary.assembly_path, renderuje się do pliku, w którym składane są własne dane wyjściowe odczytującej encji FeatureRecipe. Encja FeatureRecipe o zakresie granicy, która umieszcza punkty końcowe w sieciach, może odczytać ją jako sieć punktu końcowego źródła, gdy nie ma zastosowania żadne aggrega.ai/namespace. Wypełniana tylko dla widoków o zakresie granicy, tak jak source; własny wpis .context.uses komponentu zawiera ją pustą. Dane nieprzezroczyste; rdzeń ich nie interpretuje.
target_namespacestringnieSurowa adnotacja aggrega.ai/namespace punktu końcowego celu (pusta, gdy jej brak). Wypełniana tylko dla widoków o zakresie granicy, tak jak source; własny wpis .context.uses komponentu zawiera ją pustą. Nieprzezroczyste dane dla rozwiązywania tożsamości sieciowej przez dostawcę.
target_boundary_pathstringnieŚcieżka granicy punktu końcowego celu: rozdzielana ukośnikami ścieżka granicy encji Release, która go zawiera (np. ‘bridge/backend’). Wypełniana tylko dla widoków o zakresie granicy, tak jak source; własny wpis .context.uses komponentu zawiera ją pustą.
target_assembly_pathstringnieŚcieżka składania punktu końcowego celu: katalog, względny wobec katalogu wyjściowego kompilacji, w którym składane są jego dane wyjściowe, utworzony z ewaluowanych directory: i subDirectory: jego granicy (np. ‘bridge/compose’). Punkt końcowy, którego ścieżka składania jest równa .boundary.assembly_path, renderuje się do pliku, w którym składane są własne dane wyjściowe odczytującej encji FeatureRecipe. Encja FeatureRecipe o zakresie granicy, która umieszcza punkty końcowe w sieciach, może odczytać ją jako sieć punktu końcowego celu, gdy nie ma zastosowania żadne aggrega.ai/namespace. Wypełniana tylko dla widoków o zakresie granicy, tak jak source; własny wpis .context.uses komponentu zawiera ją pustą. Dane nieprzezroczyste; rdzeń ich nie interpretuje.
providesmapa stringtakW pełni rozwiązany słownik provides węzła docelowego. Obliczany podczas ewaluacji provides, przed hydratacją inject.
injectobjecttakOryginalne mapowanie inject dewelopera dla tej krawędzi (klucze = nazwy zmiennych lokalnych, wartości = klucze provides celu). Jest to SUROWE mapowanie, a nie rozwiązane wartości.
labelsmapa stringnieEtykiety duck typingu i ontologii węzła docelowego (po mutacji podczas budowy topologii).
annotationsobjectnieTrzy kaskadowe zbiory adnotacji węzła docelowego.
componentstringnieURI typu komponentu węzła docelowego w katalogu (np. ‘core/postgres’).
resolved_versionstringnieRozwiązana wersja SemVer węzła docelowego.
boundary_pathstringnieFizyczna hierarchia przestrzenna węzła docelowego z encji Release (np. ‘aws-eks-cluster/backend-ns’).
origin_featurestringnieJeśli tę krawędź zadeklarowała autonomicznie encja Feature (w tym Features z poświadczeniami oznaczone etykietą feature.aggrega.ai/kind: secret), nazwa instancji Feature. Null lub brak dla krawędzi zadeklarowanych przez dewelopera.
origin_releaselogicznanieTrue, gdy to połączenie podłączyła encja Release, a nie zadeklarowała go encja Aggregate. Brak dla połączenia, które deklaruje Aggregate.
valuesobjectnieKonfiguracja deweloperska dla połączenia, zapisana we wpisie uses encji Aggregate dla tego połączenia, przenoszona dosłownie. Brak, gdy połączenie jej nie zawiera. Trafia wyłącznie do kontekstu węzła konsumującego, nigdy do kontekstu celu.
infraobjectnieKonfiguracja operacyjna dla połączenia, zapisana we wpisie uses encji Release dla tego połączenia, przenoszona dosłownie. Brak, gdy połączenie jej nie zawiera. Trafia wyłącznie do kontekstu węzła konsumującego, nigdy do kontekstu celu.
featuresmapa template_attachmentnieZałączniki zapisane na tym połączeniu, kluczowane nazwą slotu, którą gniazdo połączenia deklaruje dla każdego z nich, każdy w kształcie załącznika, jaki niesie .features: jego typ, rozwiązana wersja, etykiety, values, infra oraz rozwiązane provides encji FeatureRecipe z nim powiązanej. Encja Recipe odczytuje poświadczenie połączenia jako .context.uses..features..provides., dzięki czemu konsument sięgający do kilku celów odczytuje własne poświadczenie każdego celu. Te załączniki nigdy nie należą do własnego .features węzła konsumującego, więc szablon iterujący po .features w celu znalezienia załączników węzła według typu nie napotka załączników połączenia. Przy iteracji w szablonie sloty pojawiają się w kolejności kluczy. Nieobecne, gdy połączenie żadnych nie niesie.
render_factsrender_factsnieCo renderowania celu zgłosiły o wyemitowanym wyjściu, kluczowane nazwą faktu, w kształcie, jaki ma wpis wywołującego w .context.used_by: najpierw fakty zgłoszone przez wywołania jego własnego dostawcy, potem fakty każdej dołączonej do niego encji Feature, która renderowała się razem z nim, w kolejności renderowania; listy, które jedna nazwa otrzymuje od kilku z nich, są łączone w jedną w tej kolejności. Każda wartość jest listą, nawet z jednym wpisem, więc szablon zawsze po niej iteruje. Obecne tylko w .context.uses dla encji FeatureRecipe, która deklaruje readsTargetRenderFacts — której załączniki renderują się, gdy wyrenderują się już wszystkie komponenty, więc renderowanie każdego celu jest kompletne — i wtedy w każdym wpisie, puste dla celu, którego dostawcy nic nie zgłaszają. Brak dla każdej innej encji FeatureRecipe, w with i when kroku potoku, we własnych szablonach Recipe komponentu oraz w listach krawędzi, które odczytuje FeatureRecipe o zakresie granicy.

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

enriched_edge.inject

Oryginalne mapowanie inject dewelopera dla tej krawędzi (klucze = nazwy zmiennych lokalnych, wartości = klucze provides celu). Jest to SUROWE mapowanie, a nie rozwiązane wartości.

WłaściwośćTypWymaganaOpis
envmapa stringnieDostarczanie przez zmienne środowiskowe: klucze to nazwy lokalnych zmiennych konsumenta, wartości to klucze provides celu.
filemapa stringnieDostarczanie przez montowanie plików: klucze to lokalne ścieżki plików konsumenta, wartości to klucze provides celu.
argmapa stringnieDostarczanie przez argumenty wiersza poleceń: klucze to prefiksy flag konsumenta, wartości to klucze provides celu.

enriched_edge.annotations

Trzy kaskadowe zbiory adnotacji węzła docelowego.

WłaściwośćTypWymaganaOpis
releasemapa stringnieCiągi topologii fizycznej z granic encji Release węzła docelowego.
catalogmapa stringnieNiezmienne cechy z encji katalogowej węzła docelowego.
aggregatemapa stringnieMetadane poznawcze z podsystemów encji Aggregate węzła docelowego.

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