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

Aggrega カタログ(WorkloadLibrary)スキーマ

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

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

Recipes がレンダリング時に workload: { $import: ... } を介して利用する、再利用可能な Workload テンプレート断片のコレクションです。Tier 3 — Recipe をまたいだワークロードの再利用を必要とするカタログ向けのオプトイン機能です。オーサリングモードは 1 つのみで、Go テンプレートだけを使用します。

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

トップレベルの型: object

プロパティ

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

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

workloadlibrary.metadata

プロパティ種類必須説明
namestringはいライブラリの PascalCase 識別子です。ベア名による識別参照 #/workloads/ における 名にあたります。バージョンは Release ごとのロックファイルによって提供され、レジストリホストは参照にも、そこから派生するいかなる識別子にも含まれません。パターン: ^[A-Z][A-Za-z0-9]*$。
versionstringはいライブラリの厳密なセマンティックバージョニング(例: 1.0.0)です。利用側は、ベア名参照(:#/workloads/)の中で、任意の :<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 のマップいいえ作成者が宣言するアノテーションです。ラベルと同様に、不透明なメタデータとして扱われます。

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

workloadlibrary.spec

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

プロパティ種類必須説明
workloadsstring のマップはい再利用可能な Workload テンプレート断片の名前付きマップです。各エントリの本体はエンベロープの検証からは不透明であり、内容のセマンティクスは利用時に Go テンプレートパーサーによって処理されます。キー: PascalCase 識別子。エントリのキーは正規の参照 URL(#/workloads/<name>)に現れるため、エンベロープレベルの制約により、PascalCase でないキーがカタログエコシステム全体に広がることを防ぎます。パターン: ^[A-Z][A-Za-z0-9]*$。1 エントリ以上です。

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