コンテンツにスキップ
AggregaAggrega
言語の選択: 日本語
このページは機械翻訳されています。英語の原文を読む。

Aggrega Catalog (ArtifactLibrary) スキーマ

自動生成されたリファレンスです。手動で編集しないでください。公開されている JSON Schema から再生成してください。

スキーマ ID: https://aggrega.ai/schemas/artifactlibrary-v1beta1.schema.json

Recipes と FeatureRecipes がレンダリング時に artifacts.<name>: { $import: ... } を介して利用する、名前付きアーティファクトバンドルの再利用可能なコレクションです。各バンドルは、1 つの単位としてインポートされる出力ファイルの集合です。Tier 3 — Recipe をまたいだアーティファクトの再利用を必要とするカタログ向けのオプトイン機能です。オーサリングモードは 1 つのみで、Go テンプレートだけを使用します。

ArtifactLibrary エンティティのオーサリングに関する解説は ArtifactLibrary オーサリングリファレンス を参照してください。このページでは、そのリファレンスが説明する構造スキーマを記載します。

トップレベルの型: object

プロパティ

プロパティ種類必須説明
apiVersionconst “aggrega.ai/v1beta1”はい定数: "aggrega.ai/v1beta1"
kindconst “ArtifactLibrary”はい定数: "ArtifactLibrary"
metadataobjectはい
specobjectはいArtifactLibrary の内容です。spec.artifacts は必須で、少なくとも 1 つのバンドルを宣言する必要があります。spec には additionalProperties: false が指定されており、エンベロープレベルでは並行するオーサリングモードは受け付けられません。オーサリングモードを 1 つに限定することで、レンダリングが一様に保たれ(全体を通して Go テンプレート)、インポートしたバンドルを利用する際に作成者がレンダリングの途中で評価モデルを切り替える必要がなくなります。

追加のプロパティは許可されません。

artifactlibrary.metadata

プロパティ種類必須説明
namestringはいライブラリの PascalCase 識別子です。ベア名の識別参照 #/artifacts/ における 名に当たります。バージョンは Release ごとのロックファイルによって提供され、レジストリホストは参照にも派生する識別子にも含まれません。パターン: ^[A-Z][A-Za-z0-9]*$。
versionstringはいライブラリの厳密なセマンティックバージョニング(例: 1.0.0)です。利用側は、ベア名参照(:#/artifacts/)において、これを任意の :<version> 最小バージョン下限として指定できます。解決されたバージョンは Release ごとのロックファイルが管理します。パターン: ^(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-]+)*))?$。
descriptionstringいいえライブラリが扱う内容の簡潔な概要です。
labelsstring のマップいいえ作成者が宣言するラベルです。コンパイラは内容に対して中立であり、ラベルの値を解釈しません。ラベルは不透明なメタデータであり、ライブラリを読むものが照合に使うために運ばれます。
annotationsstring のマップいいえ作成者が宣言するアノテーションです。ラベルと同様に、不透明なメタデータとして扱われます。

追加のプロパティは許可されません。

artifactlibrary.spec

ArtifactLibrary の内容です。spec.artifacts は必須で、少なくとも 1 つのバンドルを宣言する必要があります。spec には additionalProperties: false が指定されており、エンベロープレベルでは並行するオーサリングモードは受け付けられません。オーサリングモードを 1 つに限定することで、レンダリングが一様に保たれ(全体を通して Go テンプレート)、インポートしたバンドルを利用する際に作成者がレンダリングの途中で評価モデルを切り替える必要がなくなります。

プロパティ種類必須説明
artifactsstring のマップのマップはい再利用可能なアーティファクトバンドルの名前付きマップです。各バンドルは、まとまって機能する出力ファイル(たとえば CRD、その RBAC、および ConfigMap)をグループ化します。各ファイル本体はエンベロープの検証では不透明として扱われ、内容のセマンティクスは利用時に Go テンプレートパーサーが処理します。キー: PascalCase 識別子。エントリキーは正規の参照 URL(#/artifacts/<name>)に現れるため、エンベロープレベルの制約により、PascalCase でないキーがカタログのエコシステム全体に広がることを防ぎます。 はバンドル全体を指し、その中の個々のファイルを指すことはありません。パターン: ^[A-Z][A-Za-z0-9]*$。1 エントリ以上。

追加のプロパティは許可されません。