Schemat kontekstu szablonów ścieżek 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/path-template-context-v1beta1.schema.json
Lista dozwolonych zmiennych używana przez szablony Go obliczane względem Release.spec.boundaries[].directory i Release.spec.boundaries[].subDirectory (oraz nadpisania subDirectory dla poszczególnych komponentów), gdy Aggrega buduje encję Release. Szablony ścieżek używają missingkey=error (w odróżnieniu od globalnego trybu missingkey=zero dla szablonów wartości) oraz walidacji w czasie parsowania: każde odwołanie do pola w szablonie ścieżki musi występować na tej liście dozwolonych zmiennych dla danego kontekstu (directory: lub subDirectory:); nieznane pola powodują błąd Loud Guardrail w czasie parsowania, nigdy w czasie renderowania. Różnicę względem szablonów wartości wyjaśnia strona „Zmienne szablonów ścieżek” w dokumentacji języka.
Typ najwyższego poziomu: object
Właściwości
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
capability | string | nie | Dostępne w directory: ORAZ subDirectory:. Możliwość renderowania, którą Recipe komponentu wnoszącego deklaruje w spec.capability, z usuniętym ewentualnym przypięciem wersji — na przykład ‘helm’, ‘helm-chart’ lub ‘compose’. subDirectory: domyślnie przyjmuje {{ .capability }}, dzięki czemu artefakty każdej możliwości trafiają do własnego podfolderu w katalogu granicy. W szablonie directory: wartość jest rozwiązywana dla każdego komponentu osobno, więc granica, której poddrzewo wnosi więcej niż jedną możliwość, daje jeden katalog na każdą możliwość; osobne przejście po granicach, które publikuje .parent_boundary.directory, odbywa się przed powiązaniem jakiegokolwiek komponentu i pozostawia tę wartość pustą. |
boundary_name | string | nie | Dostępne w directory: ORAZ subDirectory:. Klucz mapy w release.spec.boundaries. |
parameters | object | nie | Dostępne w directory: ORAZ subDirectory:. Typowana mapa parametrów z encji Release. Szablony ścieżek otrzymują dostęp do .parameters jako celowy wyjątek od jednoprzebiegowego cyklu życia parametrów — szablony wartości NIE otrzymują .parameters; wartości zależne od środowiska trafiają do szablonów wartości poprzez już zinterpolowany YAML encji Aggregate. |
component_id | string | nie | Dostępne TYLKO w subDirectory:. Tożsamość umieszczanego współtwórcy. Dla komponentu jego spłaszczony identyfikator instancji komponentu (np. ‘backend’ lub ‘data-layer.main-db’). Dla encji Feature dołączonej na granicy, której encja FeatureRecipe działa raz dla granicy (executionScope: boundary), złożona tożsamość komponentu, którą każdy zasób emitowany przez to dołączenie niesie w etykiecie aggrega.ai/component-id (np. ‘bfr—app—shared’ dla dołączenia ‘shared’ na granicy ‘app’), skrócona tam, gdzie plugin renderujący dołączenia ogranicza nazwy, tak aby katalog, który wskazuje, odpowiadał tej etykiecie. Bez znaczenia na poziomie granicy i odrzucane przez walidację podczas parsowania w szablonach directory:. |
parent_boundary | object | nie | Dostępne w directory: ORAZ subDirectory:. Już rozwiązane wartości granicy nadrzędnej. Wypełniane przez przejście w głąb, które oblicza szablony każdej granicy z rozwiązanymi wartościami jej rodzica; elementy podrzędne nigdy nie widzą tu własnych wartości. Granica najwyższego poziomu nie ma rodzica, więc odczyt klucza pod parent_boundary w takiej granicy zatrzymuje build ze wskazaniem granicy, pola szablonu i brakującego klucza. |
manifest | object | nie | Dostępne w directory: ORAZ subDirectory:. Zawiera rozwiązane metadane encji Recipe obliczone dla każdego komponentu. |
Dodatkowe właściwości są niedozwolone.
path-template-context.parent_boundary
Dostępne w directory: ORAZ subDirectory:. Już rozwiązane wartości granicy nadrzędnej. Wypełniane przez przejście w głąb, które oblicza szablony każdej granicy z rozwiązanymi wartościami jej rodzica; elementy podrzędne nigdy nie widzą tu własnych wartości. Granica najwyższego poziomu nie ma rodzica, więc odczyt klucza pod parent_boundary w takiej granicy zatrzymuje build ze wskazaniem granicy, pola szablonu i brakującego klucza.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
directory | string | nie | Obliczony ciąg directory rodzica. |
boundary_name | string | nie | Nazwa rodzica (klucz mapy w release.spec.boundaries). |
parameters | object | nie | Mapa parametrów encji Release — ta sama mapa, którą niesie .parameters. |
annotations | mapa string | nie | Adnotacje granicy nadrzędnej po rozwiązaniu kaskady. |
Dodatkowe właściwości są niedozwolone.
path-template-context.manifest
Dostępne w directory: ORAZ subDirectory:. Zawiera rozwiązane metadane encji Recipe obliczone dla każdego komponentu.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
recipe_name | string | nie | Nazwa rozwiązanej encji Recipe z wyszukiwania dla danego komponentu. |
Dodatkowe właściwości są niedozwolone.