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 katalogu Aggrega (WorkloadLibrary)

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

Kolekcja fragmentów szablonów Workload wielokrotnego użytku, z których encje Recipes korzystają w czasie renderowania za pomocą workload: { $import: ... }. Poziom 3 — opcjonalny, dla katalogów potrzebujących ponownego użycia obciążeń między encjami Recipe. Jeden tryb tworzenia: wyłącznie szablony Go.

Wskazówki dotyczące tworzenia encji WorkloadLibrary zawiera dokumentacja tworzenia encji WorkloadLibrary; ta strona opisuje schemat strukturalny, który opisuje tamta dokumentacja.

Typ najwyższego poziomu: object

Właściwości

WłaściwośćTypWymaganaOpis
apiVersionconst “aggrega.ai/v1beta1”takStała: "aggrega.ai/v1beta1"
kindconst “WorkloadLibrary”takStała: "WorkloadLibrary"
metadataobjecttak
specobjecttakZawartość encji WorkloadLibrary. spec.workloads jest wymagane i musi deklarować co najmniej jeden wpis. spec ma additionalProperties: false — na poziomie koperty nie są akceptowane równoległe tryby tworzenia. Jeden tryb tworzenia zapewnia jednolite renderowanie encji Recipe (wszędzie szablony Go) i sprawia, że autorzy nie muszą zmieniać modelu ewaluacji w trakcie renderowania, korzystając z importowanych fragmentów.

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

workloadlibrary.metadata

WłaściwośćTypWymaganaOpis
namestringtakIdentyfikator biblioteki w notacji PascalCase. Jest to nazwa w referencji tożsamości po samej nazwie #/workloads/; wersję dostarcza plik blokady danej encji Release, a żaden host rejestru nie trafia do referencji 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 ją wskazać jako opcjonalną minimalną wersję :<version> w referencji po samej nazwie (:#/workloads/); rozwiązaną wersją zarządza 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.

workloadlibrary.spec

Zawartość encji WorkloadLibrary. spec.workloads jest wymagane i musi deklarować co najmniej jeden wpis. spec ma additionalProperties: false — na poziomie koperty nie są akceptowane równoległe tryby tworzenia. Jeden tryb tworzenia zapewnia jednolite renderowanie encji Recipe (wszędzie szablony Go) i sprawia, że autorzy nie muszą zmieniać modelu ewaluacji w trakcie renderowania, korzystając z importowanych fragmentów.

WłaściwośćTypWymaganaOpis
workloadsmapa stringtakNazwana mapa fragmentów szablonów Workload wielokrotnego użytku. Treść każdego wpisu jest nieprzezroczysta dla walidacji koperty — semantyką zawartości zajmuje się parser szablonów Go w momencie użycia. Klucze: identyfikator w notacji PascalCase. Klucze wpisów pojawiają się w kanonicznych adresach URL referencji (#/workloads/<name>); ograniczenie na poziomie koperty zapobiega rozprzestrzenianiu się kluczy niezgodnych z PascalCase w ekosystemie katalogów. Wzorzec: ^[A-Z][A-Za-z0-9]*$. Co najmniej 1 wpis.

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