Schemat Aggrega Catalog (ArtifactLibrary)
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/artifactlibrary-v1beta1.schema.json
Kolekcja nazwanych pakietów artefaktów wielokrotnego użytku, które encje Recipes i FeatureRecipes wykorzystują podczas renderowania za pomocą artifacts.<name>: { $import: ... }. Każdy pakiet to zestaw plików wyjściowych importowanych jako jedna całość. Poziom 3 — opcjonalny, dla katalogów, które potrzebują ponownego użycia artefaktów w wielu encjach Recipe. Jeden tryb tworzenia: wyłącznie szablony Go.
Wskazówki opisowe dotyczące tworzenia encji ArtifactLibrary zawiera dokumentacja tworzenia encji ArtifactLibrary; ta strona dokumentuje schemat strukturalny, który ta dokumentacja opisuje.
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 “ArtifactLibrary” | tak | Stała: "ArtifactLibrary" |
metadata | object | tak | |
spec | object | tak | Zawartość encji ArtifactLibrary. spec.artifacts jest wymagane i musi deklarować co najmniej jeden pakiet. spec ma additionalProperties: false — na poziomie koperty nie są akceptowane równoległe tryby tworzenia. Jeden tryb tworzenia zapewnia jednolite renderowanie (wszędzie szablony Go) i sprawia, że autorzy nie muszą zmieniać modelu ewaluacji w trakcie renderowania, gdy korzystają z zaimportowanych pakietów. |
Dodatkowe właściwości są niedozwolone.
artifactlibrary.metadata
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
name | string | tak | Identyfikator biblioteki w notacji PascalCase. Jest to nazwa ^[A-Z][A-Za-z0-9]*$. |
version | string | tak | Wersja biblioteki w ścisłym formacie Semantic Versioning (np. 1.0.0). Konsument może wymagać jej jako opcjonalnej minimalnej wersji :<version> w odwołaniu przez samą nazwę (^(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 | Zwięzłe podsumowanie zakresu biblioteki. |
labels | mapa string | nie | Etykiety deklarowane przez autora. Kompilator jest neutralny wobec treści i nie interpretuje wartości etykiet: są to nieprzezroczyste metadane, przenoszone po to, by cokolwiek odczytuje bibliotekę, mogło według nich dopasowywać. |
annotations | mapa string | nie | Adnotacje deklarowane przez autora. Takie samo podejście nieprzezroczystych metadanych jak w przypadku etykiet. |
Dodatkowe właściwości są niedozwolone.
artifactlibrary.spec
Zawartość encji ArtifactLibrary. spec.artifacts jest wymagane i musi deklarować co najmniej jeden pakiet. spec ma additionalProperties: false — na poziomie koperty nie są akceptowane równoległe tryby tworzenia. Jeden tryb tworzenia zapewnia jednolite renderowanie (wszędzie szablony Go) i sprawia, że autorzy nie muszą zmieniać modelu ewaluacji w trakcie renderowania, gdy korzystają z zaimportowanych pakietów.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
artifacts | mapa map typu string | tak | Nazwana mapa pakietów artefaktów wielokrotnego użytku. Każdy pakiet grupuje pliki wyjściowe, które należą do siebie (na przykład CRD, jego RBAC i ConfigMap). Treść każdego pliku jest nieprzezroczysta dla walidacji koperty — semantyką treści zajmuje się parser szablonów Go w momencie wykorzystania. Klucze: identyfikator w notacji PascalCase. Klucze wpisów występują w kanonicznych adresach URL odwołań (#/artifacts/<name>); ograniczenie na poziomie koperty zapobiega rozprzestrzenianiu się kluczy niezgodnych z PascalCase w ekosystemie katalogów. ^[A-Z][A-Za-z0-9]*$. Co najmniej 1 wpis. |
Dodatkowe właściwości są niedozwolone.