Zum Inhalt springen
AggregaAggrega
Sprache wählen: Deutsch
Diese Seite wurde maschinell übersetzt. Das englische Original lesen.

Aggrega-Schema für den Katalog (ArtifactLibrary)

Generierte Referenz. Nicht von Hand bearbeiten — aus dem veröffentlichten JSON Schema neu generieren.

Schema-ID: https://aggrega.ai/schemas/artifactlibrary-v1beta1.schema.json

Eine wiederverwendbare Sammlung benannter Artefakt-Bundles, die Recipes und FeatureRecipes zur Renderzeit über artifacts.<name>: { $import: ... } konsumieren. Jedes Bundle ist eine Menge von Ausgabedateien, die als eine Einheit importiert werden. Stufe 3 — optional für Kataloge, die Artefakte Recipe-übergreifend wiederverwenden müssen. Einziger Authoring-Modus: nur Go-Templates.

Siehe die Authoring-Referenz zur ArtifactLibrary für Anleitungen in Prosaform zum Verfassen von ArtifactLibrary-Entitäten; diese Seite dokumentiert das strukturelle Schema, das diese Referenz beschreibt.

Typ der obersten Ebene: object

Eigenschaften

EigenschaftTypErforderlichBeschreibung
apiVersionconst “aggrega.ai/v1beta1”jaKonstante: "aggrega.ai/v1beta1"
kindconst “ArtifactLibrary”jaKonstante: "ArtifactLibrary"
metadataobjectja
specobjectjaDer Inhalt der ArtifactLibrary. spec.artifacts ist erforderlich und muss mindestens ein Bundle deklarieren. spec trägt additionalProperties: false — auf Ebene der Hülle werden keine parallelen Authoring-Modi akzeptiert. Die Festlegung auf einen einzigen Authoring-Modus hält das Rendering einheitlich (durchgehend Go-Templates) und erspart es Autoren, beim Konsumieren importierter Bundles mitten im Rendering das Auswertungsmodell zu wechseln.

Zusätzliche Eigenschaften sind nicht zulässig.

artifactlibrary.metadata

EigenschaftTypErforderlichBeschreibung
namestringjaPascalCase-Bezeichner der Bibliothek. Er ist der Name in der Identitätsreferenz per bloßem Namen #/artifacts/; die Version liefert das Lockfile pro Release, und kein Registry-Host geht in die Referenz oder einen abgeleiteten Bezeichner ein. Muster: ^[A-Z][A-Za-z0-9]*$.
versionstringjaStrikte semantische Versionierung der Bibliothek (z. B. 1.0.0). Ein Konsument kann sie als optionale Mindestversion :<version> in einer Referenz per bloßem Namen angeben (:#/artifacts/); das Lockfile pro Release bestimmt die aufgelöste Version. Muster: ^(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-]+)*))?$.
descriptionstringneinEine knappe Zusammenfassung dessen, was die Bibliothek abdeckt.
labelsMap von stringneinVom Autor deklarierte Labels. Der Compiler ist inhaltsneutral und interpretiert Label-Werte nicht: Sie sind opake Metadaten, mitgeführt für alles, was die Bibliothek liest und darauf abgleichen will.
annotationsMap von stringneinVom Autor deklarierte Annotationen. Dieselbe Haltung opaker Metadaten wie bei Labels.

Zusätzliche Eigenschaften sind nicht zulässig.

artifactlibrary.spec

Der Inhalt der ArtifactLibrary. spec.artifacts ist erforderlich und muss mindestens ein Bundle deklarieren. spec trägt additionalProperties: false — auf Ebene der Hülle werden keine parallelen Authoring-Modi akzeptiert. Die Festlegung auf einen einzigen Authoring-Modus hält das Rendering einheitlich (durchgehend Go-Templates) und erspart es Autoren, beim Konsumieren importierter Bundles mitten im Rendering das Auswertungsmodell zu wechseln.

EigenschaftTypErforderlichBeschreibung
artifactsMap von Maps von stringjaBenannte Map wiederverwendbarer Artefakt-Bundles. Jedes Bundle gruppiert die Ausgabedateien, die zusammengehören (zum Beispiel eine CRD, ihr RBAC und eine ConfigMap). Der Inhalt jeder Datei ist für die Validierung der Hülle opak — die Inhaltssemantik übernimmt der Go-Template-Parser zum Zeitpunkt des Konsums. Schlüssel: PascalCase-Bezeichner. Eintragsschlüssel erscheinen in kanonischen Referenz-URLs (#/artifacts/<name>); die Einschränkung auf Ebene der Hülle verhindert, dass Schlüssel, die nicht PascalCase sind, sich durch das Katalog-Ökosystem verbreiten. Der adressiert das gesamte Bundle, nie eine einzelne Datei darin. Muster: ^[A-Z][A-Za-z0-9]*$. Mindestens 1 Eintrag.

Zusätzliche Eigenschaften sind nicht zulässig.