Schemat pliku blokady zależności Aggrega (Manifest)
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/manifest-v1beta1.schema.json
Pojedynczy, globalny plik blokady, który odwzorowuje abstrakcyjne typy komponentów i typy Feature na konkretne implementacje Recipe i FeatureRecipe według typu, z nadpisaniem dla poszczególnych instancji według nazwy.
Wskazówki dotyczące tworzenia encji Manifest zawiera dokumentacja tworzenia encji Manifest; ta strona dokumentuje schemat strukturalny opisywany w tamtej dokumentacji.
Typ najwyższego poziomu: object
Właściwości
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
apiVersion | const “aggrega.ai/v1beta1” | tak | Stała: "aggrega.ai/v1beta1" |
kind | const “Manifest” | tak | Stała: "Manifest" |
metadata | object | tak | |
defs | string[] | nie | Opcjonalny blok na standardowe kotwice YAML (& i *), pozwalający uniknąć powtórzeń w encji Manifest przy zachowaniu płaskiego słownika O(1) dla kompilatora. |
spec | object | tak | Deklaracje odwzorowań encji Manifest wraz z opcjonalnym dziedziczeniem z bazy: mappings łączy abstrakcyjne typy komponentów i funkcji z konkretnymi implementacjami Recipe i FeatureRecipe; extends dziedziczy odwzorowania z bazowej encji Manifest. |
Dodatkowe właściwości są niedozwolone.
manifest.metadata
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
name | string | tak | Co najmniej 1 znak. |
version | string | tak | Wersja pliku blokady manifestu zgodna ze ścisłym Semantic Versioning (np. 1.0.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-]+)*))?$. |
description | string | nie | Czym jest ta encja i do czego służy, napisane dla osoby decydującej, 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 jej użyć — czego oczekuje od encji Release, która jej używa, i co w jej zachowaniu może zaskoczyć. Zwykle wystarcza krótki akapit. |
maintainers | object[] | nie | Lista opiekunów, do których należy ta encja. |
license | string | nie | Identyfikator SPDX licencji oprogramowania opisywanego przez tę encję, np. MIT lub AGPL-3.0. Określa warunki tego oprogramowania, a nie warunki tego pliku. |
repository | string | nie | URL repozytorium Git, w którym znajdują się pliki źródłowe. |
home | string | nie | URL strony domowej, wiki lub dokumentacji tej encji. |
keywords | string[] | nie | Lista opisowych słów kluczowych ułatwiających wyszukiwanie w interfejsie użytkownika. |
Dodatkowe właściwości są niedozwolone.
manifest.metadata.maintainers[]
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
name | string | tak | |
email | string | nie | |
url | string | nie |
Dodatkowe właściwości są niedozwolone.
manifest.spec
Deklaracje odwzorowań encji Manifest wraz z opcjonalnym dziedziczeniem z bazy: mappings łączy abstrakcyjne typy komponentów i funkcji z konkretnymi implementacjami Recipe i FeatureRecipe; extends dziedziczy odwzorowania z bazowej encji Manifest.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
extends | string | nie | URI bazowej encji Manifest, z której dziedziczone są odwzorowania. Odwzorowanie potomne zastępuje odwzorowanie bazowe dla tego samego klucza. |
mappings | object | tak | Odwzorowuje abstrakcyjne interfejsy na konkretne implementacje. Odwzorowania deklaruje się pod kluczami najwyższego poziomu ‘components’ i ‘features’, z których każdy odwzorowuje URI typów komponentów / typów funkcji bezpośrednio na URI encji Recipe / FeatureRecipe. Te dwa klucze stanowią całą powierzchnię; żaden inny klucz nie jest tu akceptowany. Na warstwie encji Manifest odwzorowanie jest agnostyczne wobec możliwości — o możliwości decyduje spec.capability każdej rozwiązanej encji Recipe, gdy Aggrega buduje encję Release. Klucze: jeden z "components", "features". |
Dodatkowe właściwości są niedozwolone.
manifest.spec.mappings
Odwzorowuje abstrakcyjne interfejsy na konkretne implementacje. Odwzorowania deklaruje się pod kluczami najwyższego poziomu ‘components’ i ‘features’, z których każdy odwzorowuje URI typów komponentów / typów funkcji bezpośrednio na URI encji Recipe / FeatureRecipe. Te dwa klucze stanowią całą powierzchnię; żaden inny klucz nie jest tu akceptowany. Na warstwie encji Manifest odwzorowanie jest agnostyczne wobec możliwości — o możliwości decyduje spec.capability każdej rozwiązanej encji Recipe, gdy Aggrega buduje encję Release.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
components | mapping_tier | nie | Mapowanie typu Component na URI encji Recipe. URI encji Recipe ma co najwyżej dwa segmenty — opcjonalną początkową zdolność, a następnie nazwę recepty — oraz opcjonalną wersję; odwołanie z trzecim segmentem nie pasuje do żadnej recepty. Formy wersji: dokładna (‘postgres-bitnami:1.2.0’), zakres (‘postgres-bitnami:^1.2.0’) lub bez wersji (‘postgres-bitnami’); resolver przypina rozwiązaną wersję w pliku blokady przy pierwszym rozwiązaniu. Odwołanie może dodatkowo być kwalifikowane zdolnością (‘terraform/mariadb-rds:1.0.0’, gdzie segment przed pierwszym ’/’ wskazuje spec.capability recepty) — jest to wymagane, gdy więcej niż jedna recepta ma tę samą nazwę; niejednoznaczne gołe odwołanie głośno przerywa rozwiązywanie zamiast po cichu wybierać jedną z nich. |
features | mapping_tier | nie | Odwzorowanie typu funkcji na URI encji FeatureRecipe. Obejmuje zarówno operacyjne encje Features, jak i encje Features z poświadczeniami (oznaczone etykietą feature.aggrega.ai/kind: secret). |
Klucze: jeden z "components", "features".
Dodatkowe właściwości są niedozwolone.
Definicje
mapping_tier
Dwupoziomowe rozwiązywanie: ‘type’ odwzorowuje według typu z katalogu (zbiorczo, bez powtórzeń), ‘name’ odwzorowuje według nazwy instancji (szczegółowe nadpisanie). Oba są opcjonalne, ale co najmniej jeden musi być obecny. Podczas rozwiązywania nazwa ma pierwszeństwo przed typem. Klucze typów z wersją mają pierwszeństwo przed kluczami bez wersji.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
type | mapa string | nie | Odwzorowuje URI typów z katalogu na URI encji Recipe. Obsługuje klucze z wersją (‘core/api-server:1.0.0’) dla dokładnego dopasowania, klucze z zakresem (‘core/api-server:^1.0.0’) dla dopasowania zgodnego w obrębie wersji głównej lub klucze bez wersji (‘core/api-server’) dla dopasowania dowolnej wersji. |
name | mapa string | nie | Odwzorowuje konkretne nazwy instancji na URI encji Recipe. Ma pierwszeństwo przed odwzorowaniem opartym na typie. |
annotations | mapa object | nie | Skróty encji Feature sterowane adnotacjami. Mapuje klucze adnotacji na URI encji Feature wraz z pogrupowaną według filarów tabelą routingu z podklucza w postaci ścieżki kropkowej na filar encji Feature (values lub infra). Walidacja wynika z deklaracji spec.schema. |
Dodatkowe właściwości są niedozwolone.