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 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śćTypWymaganaOpis
apiVersionconst “aggrega.ai/v1beta1”takStała: "aggrega.ai/v1beta1"
kindconst “ArtifactLibrary”takStała: "ArtifactLibrary"
metadataobjecttak
specobjecttakZawartość 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śćTypWymaganaOpis
namestringtakIdentyfikator biblioteki w notacji PascalCase. Jest to nazwa w odwołaniu tożsamościowym przez samą nazwę #/artifacts/; wersję dostarcza plik blokady danej encji Release, a żaden host rejestru nie wchodzi do odwołania ani do żadnego identyfikatora pochodnego. Wzorzec: ^[A-Z][A-Za-z0-9]*$.
versionstringtakWersja 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ę (:#/artifacts/); rozstrzygniętą wersję określa plik blokady danej encji Release. 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-]+)*))?$.
descriptionstringnieZwięzłe podsumowanie zakresu biblioteki.
labelsmapa stringnieEtykiety 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ć.
annotationsmapa stringnieAdnotacje 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śćTypWymaganaOpis
artifactsmapa map typu stringtakNazwana 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. wskazuje cały pakiet, nigdy pojedynczy plik w nim. Wzorzec: ^[A-Z][A-Za-z0-9]*$. Co najmniej 1 wpis.

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