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

Aggrega Core (Plugin) スキーマ

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

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

Wasm プラグイン: OCI レジストリに公開される WebAssembly モジュールで、metadata.pluginType(実装するソケット)と素の metadata.name によって識別され、対象とする ABI バージョン、任意の署名ポインタ、任意のランタイムブロックを宣言します。エンティティとその .wasm は、metadata.version でタグ付けされた 1 つの OCI マニフェストとして公開されます。エンティティの YAML はマニフェストの config blob、.wasm はインラインレイヤーとなり、署名は 1 回だけ行われます。識別子は metadata.pluginType/metadata.name の座標とエンティティの metadata.version の組です。.wasm の場所はその座標と設定されたレジストリから導出され、解決されたコンテンツダイジェストはエンティティではなくロックファイルに保持されます。ロックファイルがダイジェストを記録し、レジストリごとのトラストポリシーがプル時にアーティファクトの署名を検証します。コンパイラはプラグインの動作を解釈しません。コンパイラは参照をルーティングし、WebAssembly ランタイムがバイト列を実行します。

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

トップレベルの型: object

プロパティ

プロパティ種類必須説明
apiVersionconst “aggrega.ai/v1beta1”はい定数: "aggrega.ai/v1beta1"
kindconst “Plugin”はい定数: "Plugin"
metadataobjectはい
specobjectはいプラグインが対象とする ABI バージョン、任意の署名ポインタ、および任意のランタイムブロックです。プラグインの .wasm の場所は、プラグインの識別情報(その metadata.pluginType(ソケット)と素の metadata.name)と設定済みのレジストリから導出されます。spec には含まれません。

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

plugin.metadata

プロパティ種類必須説明
namestringはい1 文字以上。
versionstringはいPlugin エンティティの厳密なセマンティックバージョニング(例: 1.0.0)です。パターン: ^(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-]+)*))?$。
pluginTypestring (enum)はいこのプラグインが実装するソケットの種類です。プラグインはランタイムが認識するプラグイン種別の分類から、ちょうど 1 つのソケットの種類を実装します: provider(IR ノードを provider ネイティブのアーティファクトにレンダリングします)、linter(作成されたコンテンツを検査し、診断を発行します)、pipeline-step(FeatureRecipe または Recipe の pipeline: 内のステップで、レンダリングされたドキュメントセットにパッチを適用します)、governance(ビルドパイプラインのガバナンスロールを担います。トポロジー構築時にノードのラベルを変換するか、静的解析時に IR グラフに対して、またはレンダリング時にレンダリング済みアーティファクトに対して受理・拒否の判定を下します。何を出力できるかは、その種類ではなく、アタッチされたロールによって決まります)、cli(オペレーターがコマンドラインで呼び出すランタイムの aggrega <cmd> サブコマンドを提供します。コンパイル時のレンダリングおよびパイプラインのソケットとは異なる、ランタイムのソケットです)、parser(外部のソーステキストを正規の構造化ツリーに変換し、利用側が独自の言語パーサーを持たずにツリーを読めるようにします。扱うフォーマットを parse:<format> ケイパビリティとして公開します)、importer(外部のインフラストラクチャまたはエージェント定義のソースを Aggrega の作成ファイルの下書きに変換し、扱うフォーマットを import:<format> ケイパビリティとして公開します)。許可される値: "provider"、"linter"、"pipeline-step"、"governance"、"cli"、"parser"、"importer"
descriptionstringいいえこのエンティティが何であり、何のためのものかを、使用するかどうかを判断する人に向けて記述します。まずそのものを名指しする一文で始め、次に読み手がそれを選択し正しく使うために必要なこと、つまりそれを実行するビルドに何を期待するか、その動作で意外な点は何かを加えます。通常は短い段落程度の長さです。
maintainersobject[]いいえこのエンティティを所有するメンテナーの一覧です。
licensestringいいえこのエンティティが記述するソフトウェアのライセンスの SPDX 識別子です(MIT や AGPL-3.0 など)。記録するのはそのソフトウェアの条件であり、このファイルの条件ではありません。
repositorystringいいえソースファイルが置かれている Git リポジトリの URL です。
homestringいいえこのエンティティのホームページ、wiki、またはドキュメントの URL です。
keywordsstring[]いいえUI での発見性を高めるための説明的なキーワードの一覧です。

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

plugin.metadata.maintainers[]
プロパティ種類必須説明
namestringはい
emailstringいいえ
urlstringいいえ

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

plugin.spec

プラグインが対象とする ABI バージョン、任意の署名ポインタ、および任意のランタイムブロックです。プラグインの .wasm の場所は、プラグインの識別情報(その metadata.pluginType(ソケット)と素の metadata.name)と設定済みのレジストリから導出されます。spec には含まれません。

プロパティ種類必須説明
abiVersionstring (enum)はいプラグインが対象とするホスト/ゲスト ABI バージョンです。受け付けられる値は v1beta1 のみです。このコンパイラがもはや対応していない ABI バージョンを宣言する Plugin は拒否され、プラグインを再ビルドすべき対象のバージョンが示されます。許可される値: "v1beta1"
signatureobjectいいえプラグインに添付された署名を指す、任意の記述用ポインタです。このブロックはドキュメント専用であり、カタログの読者のために署名の場所と作成方法を記録します。このブロック自体がプラグインを制限したり受け入れたりすることはありません。強制力のあるチェックは、プル時に適用されるレジストリごとの信頼ポリシーです。署名は OCI リファラーとして取得され、レジストリの信頼済みアイデンティティまたは固定された鍵に対して検証され、検証済みの事実としてロックファイルに記録されます。署名を必須とするレジストリでは、必須の署名が欠落している、信頼されていない、または無効な場合にプルが停止します。
runtimeobjectいいえプラグインの読み込みと実行時にホストが適用する、任意の実行制約です。外向きのネットワークアクセスは作成用のフィールドではありません。プラグインはビルド時にネットワークに到達することがない(事前コンパイルの境界)ため、ここで作成するホスト許可リストのフィールドはありません。
exportsobject[]いいえこのプラグインが提供するエクスポートで、それぞれが宣言されたケイパビリティを持ちます。エクスポートとは、ホストがディスパッチする名前付きのエントリーポイント 1 つです(例: render_node、lint_naming、step)。エクスポートごとのケイパビリティブロックは、そのエクスポートが何を行うかについての作成者の主張であり、ホストは公開時と読み込み時にプラグインの自己申告と照合します。エントリーは作成者の記述順を保持します。省略した場合、作成されたエクスポートは宣言されません。
commandsobject[]いいえ機械が管理するため、作成しないでください。プラグインの自己申告から aggrega plugin sync(または aggrega plugin gen-catalog)によって記録されます。CLI プラグインが提供するトップレベルの aggrega <command> 動詞は、プラグインの自己申告から読み取られ、自己申告で宣言された順にここへ記録されます。そのため、CLI プラグインがインストールするコマンドは、プラグインを読み込まずにエンティティから読み取れます。CLI 以外のプラグインはコマンドを提供せず、空のリストを記録します。ホストはちょうどこの集合をインストールします。記録された集合がプラグインの自己申告と異なる場合は読み込み時に停止し、公開時にはバイナリと同期していない集合を拒否して、作成者に再記録を促します。
providerobjectいいえpluginType: provider プラグイン用の provider ソケットブロックです。提供するケイパビリティ、aggrega.ai/v1beta1 の Workload kind の変換方法、読み取るプラットフォームネイティブのアノテーション、およびレンダリング動作の契約を記述します。provider のレンダリングを行うプラグインにのみ存在し、その他のプラグイン種別には存在しません。
pipelineStepobjectいいえpluginType: pipeline-step プラグイン用の pipeline-step ブロックです。そのステップと互換性のある provider ケイパビリティを記述します。pipeline-step プラグインにのみ存在し、その他のプラグイン種別には存在しません。
parserobjectいいえpluginType: parser プラグイン用の parser ブロックです。正規の構造化ツリーに変換するソースフォーマットを記述します。parser プラグインにのみ存在し、その他のプラグイン種別には存在しません。
importerobjectいいえpluginType: importer プラグイン用の importer ブロックです。Aggrega の作成ファイルの下書きに変換する外部のソースフォーマットと、それらのフォーマットのソースを識別するためのシグネチャを記述します。importer プラグインにのみ存在し、その他のプラグイン種別には存在しません。

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

plugin.spec.signature

プラグインに添付された署名を指す、任意の記述用ポインタです。このブロックはドキュメント専用であり、カタログの読者のために署名の場所と作成方法を記録します。このブロック自体がプラグインを制限したり受け入れたりすることはありません。強制力のあるチェックは、プル時に適用されるレジストリごとの信頼ポリシーです。署名は OCI リファラーとして取得され、レジストリの信頼済みアイデンティティまたは固定された鍵に対して検証され、検証済みの事実としてロックファイルに記録されます。署名を必須とするレジストリでは、必須の署名が欠落している、信頼されていない、または無効な場合にプルが停止します。

プロパティ種類必須説明
typeconst “sigstore-cosign”はい署名方式です。サポートされている方式は sigstore-cosign です。定数: "sigstore-cosign"
signatureRefstringいいえ添付された署名バンドルの OCI リファラー参照で、ドキュメントと検出のために使われます。署名をここで固定せず、プル時のリファラー列挙で検出する場合は省略します。
publicKeyRefstringいいえ鍵付き署名の場合に、署名の作成に使われた公開鍵を指すポインタです。省略した場合はキーレス(OIDC アイデンティティ)署名を示し、レジストリの信頼済みアイデンティティに対して検証されます。

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

plugin.spec.runtime

プラグインの読み込みと実行時にホストが適用する、任意の実行制約です。外向きのネットワークアクセスは作成用のフィールドではありません。プラグインはビルド時にネットワークに到達することがない(事前コンパイルの境界)ため、ここで作成するホスト許可リストのフィールドはありません。

プロパティ種類必須説明
maxMemoryPagesintegerいいえプラグインの線形メモリを Wasm ページ単位(1 ページあたり 64 KiB)で制限します。0 または省略した場合はプラットフォームのデフォルト上限が適用されるため、読み込みが無制限になることはありません。より多くのメモリを必要とするアタッチメントでは、この値を引き上げます。最小値: 0。
timeoutMsintegerいいえ1 回の呼び出しの間にプラグイン自身のコードが実行できる時間をミリ秒単位で制限します。プラグインが呼び出すホスト関数の内部で費やされた時間は含みません。Linux ではプロセッサ時間で計測するため、負荷の高いマシンでプロセッサを待つ時間は含まれません。その他のシステムでは経過時間で計測します。新たに読み込まれたプラグインへの最初の呼び出しでは、プラグイン自身の起動時間も含まれます。0 または省略した場合はプラットフォームのデフォルト上限が適用されるため、呼び出しがキャンセル不能になることはありません。より長く実行されるアタッチメントでは、この値を引き上げます。最小値: 0。
hostFunctionsstring[]いいえ機械が管理するため、記述しないでください。プラグインがインポートするホスト関数で、aggrega plugin sync(または aggrega plugin gen-catalog)によって .wasm のインポートセクションから読み取られ、正規化された形式(ソート済み、重複除去済み)でここに記録されます。公開時にはバイナリから再導出され、記録が異なるエンティティは拒否されます。プル時には再び導出されて検証されます。ホストはこの導出されたセットのみを登録し、各エントリを精選された許可リストに照らして検証します。
configKVstring のマップいいえランタイムが開始時にプラグインへ渡す Plugin 固有の設定で、文字列から文字列へのキーと値のペアとして指定します。エントリは作成者が記述した順序を保持するため、出力されるレコードは実行間でバイト単位で同一になります。省略した場合は、ランタイムのデフォルトである空の設定が有効なままになります。

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

plugin.spec.exports[]
プロパティ種類必須説明
namestringはいエクスポートの ABI 名です。ホストがディスパッチする名前です(例: render_node、lint_naming、step)。1 文字以上である必要があります。
operatesstring (enum)いいえこのエクスポートが実行するパイプライン操作です: patch(既存のレンダリング済みドキュメントを変更する)または emit(新しいドキュメントを追加する)。省略した場合、操作の宣言はありません。許可される値: "patch"、"emit"
scopestring (enum)いいえこのエクスポートが操作するドキュメントルートです: own(ノード自身のレンダリング済みドキュメント)または host(コンポーネントスコープの FeatureRecipe がアタッチされているコンポーネントのドキュメント)。省略した場合、スコープの宣言はありません。許可される値: "own"、"host"
selectorstringいいえエクスポートが作用する対象を説明する、人間が読める自由形式の記述です(例: workloads carrying a pod template)。カタログの読者向けのドキュメントであり、コンパイラはこれを解釈しません。

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

plugin.spec.commands[]
プロパティ種類必須説明
namestringはいホストが登録するコマンドの動詞です。オペレーターが実行する aggrega <name> トークンであり、ホストが呼び出し時にプラグインへ渡す識別子でもあるため、複数のコマンドを担う単一のプラグインは、どのコマンドが呼び出されたかに基づいて処理を振り分けます。1 文字以上である必要があります。
descriptionstringいいえコマンドの 1 行の短いヘルプテキストで、コマンド一覧とヘルプ出力に表示されます。ドキュメント専用であり、ホストはこれに基づいて動作しません。
flagsobject[]いいえコマンドのフラグで、宣言順に並びます。各エントリは、ホストがコマンドに登録するフラグを 1 つ追加し、aggrega help がそれをコアコマンドのフラグと同様に表示します。フラグを持たないコマンドでは空のままにします。1 つのコマンド内で各フラグ名と各短縮形は 1 回だけ現れ、すべての aggrega コマンドが既に持つフラグ(--help、-h、およびグローバルフラグ)を再利用することはできません。ホストはプラグインのコマンドを追加する際にこれを確認し、宣言が条件を満たさないプラグインは警告とともに追加されません。

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

plugin.spec.commands[].flags[]
プロパティ種類必須説明
namestringはいフラグの長い名前です。オペレーターがコマンドラインで渡す —name トークンです。宣言されるすべてのフラグはこれを指定する必要があります。1 文字以上である必要があります。
shorthandstringいいえフラグの任意の短い別名です。オペレーターが長い名前の代わりに渡せる -x 形式で、ASCII の英字または数字 1 文字で指定します。省略した場合、フラグには短い別名がありません。パターン: ^[A-Za-z0-9]$。
descriptionstringいいえフラグの 1 行のヘルプテキストで、コマンドのヘルプ出力に表示されます。任意のドキュメントであり、ホストはこれを検証も使用もしません。
typestring (enum)いいえフラグの値の型(string、bool または int)であり、ヘルプがどの種類のフラグとして表示するかを決めます。省略した場合、文字列フラグとして表示されます。許可される値: "string"、"bool"、"int"
defaultstringいいえオペレーターがフラグを渡さない場合の既定値で、文字列として記述します。bool または int のフラグでは、その型の値です。省略した場合、フラグは既定値を宣言しません。

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

plugin.spec.provider

pluginType: provider プラグイン用の provider ソケットブロックです。提供するケイパビリティ、aggrega.ai/v1beta1 の Workload kind の変換方法、読み取るプラットフォームネイティブのアノテーション、およびレンダリング動作の契約を記述します。provider のレンダリングを行うプラグインにのみ存在し、その他のプラグイン種別には存在しません。

プロパティ種類必須説明
capabilitiesstring[]いいえaggrega plugin gen-catalog によってプラグインの .wasm の自己申告から記録されるため、このリストの出所はプラグインです。作成者は公開前にこのリストを絞り込み、このエンティティが提供すべきでないエントリを削除できますが、自己申告にないものを追加することはできません。公開時、および --plugin でプラグインの .wasm を指定した aggrega validate は、自己申告にないケイパビリティを含むリストを拒否します。公開は記述されたとおりにエンティティを送信し、このリストを書き換えることはなく、自己申告にあってリストから除かれた各ケイパビリティを通知します。この provider が提供するケイパビリティ(helm や compose などのケイパビリティ名)で、provider はその出力形式をレンダリングします。provider は、あるケイパビリティの出力形式を共有するアーティファクト全体に対して汎用的ですが、すべてのケイパビリティに対して汎用的なわけではありません。そのため、このリストは願望ではなく、明示的でテスト済みの互換性の主張です。エントリは記述順を保持します。Recipe が要求する provider ターゲットは、そのターゲットをリストに含む provider プラグインに解決されます。複数の provider プラグインがリストに含むターゲットは、ワークスペース設定の plugins.providers の選択で使用するプラグインを指定しない限り、曖昧として停止します。リストが空または未指定の場合はケイパビリティの主張を宣言しないため、プラグインはどのターゲットも提供しません。
workloadSchemastringいいえこの provider が aggrega.ai/v1beta1 の Workload kind を provider ネイティブのマニフェストにどのように変換するかを記述する JSON Schema 2020-12 です。指定されている場合、provider は workload: ブロックを宣言する Recipes(合成モード)をサポートします。provider は、ドキュメント/契約としてのこのスキーマを参考に、Workload を provider ネイティブのマニフェストに変換します。workload: Recipe がサポートされるかどうかは、このフィールドの有無ではなく、バインドされた provider の合成ケイパビリティによって決まります。合成できない provider にバインドされた合成モードの Recipe は、レンダリング時に明示的に停止します。標準ライブラリのカタログは、合成を行う provider に、文書化された契約として workloadSchema を宣言し、そのケイパビリティと同期させています。このフィールドは文書化された契約です。本体は読み込み時に JSON Schema 2020-12 にコンパイルされて整形式かどうかが検査され、それ以外にこれを読み取るものはありません。
wellKnownAnnotationsobject[]いいえprovider のサポートの主張です。この provider が読み取るプラットフォームネイティブの既知のアノテーションキー(aggrega.ai/ 名前空間)を、読み取られるスコープと、未指定時に適用される動作とともに列挙します。キーは provider が実際に読み取る場合にのみ宣言してください。公開されるサポートマトリクスはこれらの宣言からレンダリングされるため、ここに記載されたキーは、作成者が指定したスコープでレンダリング出力を変更することを期待できるキーです。コンパイラはこの宣言を 2 つの方法で読み取ります。provider 自身の contract.inputKinds が主張していない入力の種類を指定する scope は、同じエンティティ内の隣接する主張と矛盾するため、ビルドはそのキーと矛盾を示して停止します。また、aggrega.ai/ アノテーションがこの provider を通じてレンダーに到達し、そのレンダーが宣言するどの入力の種類でもそれを対象とするエントリがない場合、ビルドは警告します。これは、予約済みの aggrega.ai/ プレフィックスの下で値をバインドすることを規定するルールとは別のものです。未指定の場合はサポートの主張を宣言せず、この provider についてそのような警告は出されません。これらのキーをいずれも読み取らない provider は、このリストの代わりに readsNoWellKnownAnnotations を宣言します。エントリは順序付きリストであり、記述順を保持します。
readsNoWellKnownAnnotations定数 trueいいえこの provider が aggrega.ai/ 名前空間のプラットフォームネイティブのアノテーションキー、すなわち本来なら wellKnownAnnotations に列挙されるキーをいずれも読み取らないことを宣言します。これはどのキーも対象としないサポートの主張であり、明示的な表明です。これに対し、このフィールドと wellKnownAnnotations の両方を省略することは沈黙を意味します。この場合ビルドは、この provider を通じてレンダーに到達するすべての aggrega.ai/ アノテーションについて、キー、provider、そのレンダーが宣言する入力の種類を示して警告します。値は変更されずにそのまま通過し、ビルドは停止しません。記述できるのは true のみであるため、フィールドを省略することが引き続き何も表明しない唯一の方法です。wellKnownAnnotations と同時に記述することはできません。キーの一部を読み取る provider は、代わりにそれらをそちらに列挙します。定数:true
contractobjectいいえprovider が自己宣言するレンダリング動作の契約です。レンダリングする入力の種類、ディスパッチグループのノードごとの出力をどのように組み立て、その出力をどのディレクトリの下に配置するか、インポートされたアーティファクトファイルに適用するテンプレート区切り文字のペア、読み込まれた 1 つのインスタンスがすべてのクロッシングを処理できるかどうか、境界をまたぐエッジを配線するかどうか、omit エントリを尊重するかどうか、Recipe が境界の共有出力に提供するファイルを受け入れるかどうか、そのエコシステムがソースの横に決して同梱しないファイルを示します。これは provider プラグインの自己報告を公開時に記録したもので、ホストは公開時と読み込み時にその自己報告と照合します。未指定の場合はレンダリング動作の契約を宣言せず、照合ではエクスポートごとの主張のみを比較します。

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

plugin.spec.provider.wellKnownAnnotations[]
プロパティ種類必須説明
keystringはいprovider が読み取るプラットフォームネイティブの既知のアノテーションキー(例: aggrega.ai/namespace)です。プラットフォームが予約する aggrega.ai/ アノテーション名前空間、つまり provider が読み取るプラットフォームディレクティブの下に位置します。パターン: ^aggrega\.ai/.+。
purposestringはいアノテーションが制御する内容、つまり指定されている場合に影響を与えるレンダリング動作です。
defaultBehaviorstringいいえこのアノテーションが未指定の場合に provider が適用する動作です。
scopestring (enum)[]いいえこの provider がキーを読み取る場所です。最初の 3 つの値は Recipe の入力の種類であり、キーが読み取られるレンダリングパスを示します。sourced はベンダリングされたファイルセット、synthesized は provider が具体化する Workload、artifactsStandalone は出力全体がインポートされたアーティファクトドキュメントであるノードです。これらはいずれも、この provider の contract.inputKinds が主張する入力の種類でなければなりません。主張していない種類を指定するとビルドが停止します。boundary は、ノードごとではなく境界ごとに 1 回解決されるキー(組み立てられたアーティファクトの名前や、境界をまたぐ参照の形成元となる配置コンテキスト)のためのもので、入力の種類は意味のある軸ではないため、contract.inputKinds とは照合されません。複数のパスで読み取られるキーは、そのすべてを列挙します。未指定の場合はパスごとの主張を行いません。何も検査されず、キーは provider がどこかでそれを読み取ることのみを示します。エントリは 1 つ以上必要です。同じエントリを 2 回指定することはできません。各エントリに許可される値: "sourced"、"synthesized"、"artifactsStandalone"、"boundary"。

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

plugin.spec.provider.contract

provider が自己宣言するレンダリング動作の契約です。レンダリングする入力の種類、ディスパッチグループのノードごとの出力をどのように組み立て、その出力をどのディレクトリの下に配置するか、インポートされたアーティファクトファイルに適用するテンプレート区切り文字のペア、読み込まれた 1 つのインスタンスがすべてのクロッシングを処理できるかどうか、境界をまたぐエッジを配線するかどうか、omit エントリを尊重するかどうか、Recipe が境界の共有出力に提供するファイルを受け入れるかどうか、そのエコシステムがソースの横に決して同梱しないファイルを示します。これは provider プラグインの自己報告を公開時に記録したもので、ホストは公開時と読み込み時にその自己報告と照合します。未指定の場合はレンダリング動作の契約を宣言せず、照合ではエクスポートごとの主張のみを比較します。

プロパティ種類必須説明
inputKindsobjectいいえこのプラグインが描画する、3 種類の Recipe 入力種別のうちのどれか。ソースのファイルセット、合成されたワークロード、スタンドアロンのアーティファクトのみのノードです。各フィールドは独立した宣言です。
boundaryAssemblystring (enum)いいえプラグインがディスパッチグループのノードごとの描画出力をどのように結合するかを示します。none は各ノードの出力をディスパッチパスに直接書き込みます。merge はノードごとの断片を 1 つのドキュメントに畳み込みます。nest は各ノードの出力を包括構造内のそれぞれの位置に配置します。省略した場合、アセンブリに関する宣言はありません。許可される値: "none"、"merge"、"nest"
artifactDelimitersobjectいいえプラグインがインポートされたアーティファクトファイルに適用する Go テンプレートの区切り文字のペア。省略した場合はデフォルトの {{/}} のペアを意味します。ターゲットの構文がこのペアと衝突するプラグインは、ここで別のペアを宣言します。
assemblyNameAnnotationobjectいいえ解決された値が、プラグインがディスパッチグループから組み立てるアーティファクトの名前となる境界アノテーション。グループに寄与する境界を 1 つの名前付きアセンブリに畳み込むプラグインは、読み取るアノテーションキーと、寄与するすべての境界がそのアノテーションの解決値で一致しなければならないかどうかを宣言します。省略した場合、プラグインはディスパッチパスのみからアセンブリの名前を付けます。
reusableInstance真偽値いいえクロッシングごとに新しいインスタンスを使うのではなく、ロードされた 1 つのプラグインインスタンスがビルドのすべての描画、アセンブル、検証のクロッシングを担ってよいかどうか。プラグインがクロッシングをまたいで状態を保持しない場合、つまりクロッシングごとの入力の純粋関数である場合にのみ true を宣言します。これにより、単一のインスタンスは再利用されても新たにロードされてもバイト単位で同一の出力を生成します。省略した場合 (false) はクロッシングごとに新しいインスタンスをロードし、構造上状態を持つプラグインを分離します。
crossBoundaryLinking真偽値いいえプラグインが、ペアになった link_publish/link_resolve のエクスポート契約を通じてプロバイダネイティブの相互参照の配線を出力することで、境界をまたぐ uses エッジ (消費側と被消費側の端が異なるディスパッチグループに組み立てられる uses エッジ) を配線するかどうか。プラグインが両方をエクスポートする場合にのみ true を宣言します。エクスポートのペアと一致しない宣言はロード時に停止します。省略した場合 (false) は境界をまたぐリンクを宣言せず、ホストはリンクのクロッシングをプラグインに回しません。
omits真偽値いいえプロバイダが omit エントリ (ノードの出力から除外する描画単位を指定するエントリ) に従うかどうか。従う場合、エントリが一致するすべての単位を描画結果から除外し、各エントリが一致した単位の数を報告します。これはプロバイダの自己申告が行う omits の宣言の公開時の記録であり、その申告と異なる値はロード時に停止します。省略した場合 (false) はそのようなサポートを宣言しません。
boundaryArtifacts真偽値いいえプロバイダが、Recipe の spec.boundary.artifacts の下で、描画する境界の共有出力に Recipe が寄与するファイルを受け入れるかどうか。コンパイラはそのような各ファイルを、境界の組み立てられた出力を保持するディレクトリに 1 回だけ書き込み、プロバイダのターゲットはそれをその出力の一部として扱います。これはプロバイダの自己申告が行う boundary_artifacts の宣言の公開時の記録であり、その申告と異なる値はロード時に停止します。省略した場合 (false) はそのようなサポートを宣言せず、このプロバイダに対してこのブロックを宣言する Recipe は、何かが描画される前に拒否されます。
nestSegmentstringいいえboundaryAssembly が nest であるプロバイダについて、このプロバイダのターゲットが各寄与者自身のサブディレクトリを配置するディレクトリ。チャートの包括構造では charts、ルートモジュールでは modules です。コンパイラは、このディレクトリ、寄与者の名前、各ファイル自身のパスを結合します。ネストするプロバイダでのみ読み取られます。省略した場合、各寄与者のサブディレクトリは境界自身のディレクトリに直接配置されます。値は 1 つのディレクトリを指定し、パスを指定することはありません。
sourceIgnoreobjectいいえこのプロバイダのエコシステムが、描画するソースの横に決して同梱しないファイルを、gitignore 構文の無視ルールとして示したもの。自己申告が宣言する source_ignore ルールの公開時の記録です。作成者が、このプロバイダがその作成者のために機能を提供する Recipe または FeatureRecipe を固定すると、これらのルールは作成者自身の .aggregaignore と合成され、このプラグインの名前とともにエンティティの横の entity.lock に記録されます。以降、エンティティのローカルソースの公開、比較、描画のすべてで、記録されたルールが適用されます。指定する場合は自己申告が宣言する内容と一致しなければならず、申告が異なるプラグインはロード時に拒否されます。省略した場合は宣言を行わず、比較もされません。

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

plugin.spec.provider.contract.inputKinds

このプラグインが描画する、3 種類の Recipe 入力種別のうちのどれか。ソースのファイルセット、合成されたワークロード、スタンドアロンのアーティファクトのみのノードです。各フィールドは独立した宣言です。

プロパティ種類必須説明
sourced真偽値いいえ取り込まれたファイルセット(チャート、モジュール、compose ファイル)をレンダリングします。
synthesized真偽値いいえ合成されたワークロードを provider ネイティブのアーティファクトにレンダリングします。
artifactsStandalone真偽値いいえアーティファクトのみのスタンドアロンノード、つまりインポートされたアーティファクトドキュメントを持ち、source もワークロードも持たないノードをレンダリングします。

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

plugin.spec.provider.contract.artifactDelimiters

プラグインがインポートされたアーティファクトファイルに適用する Go テンプレートの区切り文字のペア。省略した場合はデフォルトの {{/}} のペアを意味します。ターゲットの構文がこのペアと衝突するプラグインは、ここで別のペアを宣言します。

プロパティ種類必須説明
leftstringはい開始区切り文字です。
rightstringはい終了区切り文字です。

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

plugin.spec.provider.contract.assemblyNameAnnotation

解決された値が、プラグインがディスパッチグループから組み立てるアーティファクトの名前となる境界アノテーション。グループに寄与する境界を 1 つの名前付きアセンブリに畳み込むプラグインは、読み取るアノテーションキーと、寄与するすべての境界がそのアノテーションの解決値で一致しなければならないかどうかを宣言します。省略した場合、プラグインはディスパッチパスのみからアセンブリの名前を付けます。

プロパティ種類必須説明
annotationstringはいプラグインが組み立てられたアーティファクトの名前を読み取る境界アノテーションのキーです。
requireUnique真偽値いいえ1 つのディスパッチグループに寄与するすべての境界が、アノテーションの解決された値で一致しなければならないかどうかです。true の場合、寄与する境界がアノテーションを異なる値に解決するグループはビルドを停止させます。false の場合、プラグインは最初に解決された値を受け入れます。

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

plugin.spec.provider.contract.sourceIgnore

このプロバイダのエコシステムが、描画するソースの横に決して同梱しないファイルを、gitignore 構文の無視ルールとして示したもの。自己申告が宣言する source_ignore ルールの公開時の記録です。作成者が、このプロバイダがその作成者のために機能を提供する Recipe または FeatureRecipe を固定すると、これらのルールは作成者自身の .aggregaignore と合成され、このプラグインの名前とともにエンティティの横の entity.lock に記録されます。以降、エンティティのローカルソースの公開、比較、描画のすべてで、記録されたルールが適用されます。指定する場合は自己申告が宣言する内容と一致しなければならず、申告が異なるプラグインはロード時に拒否されます。省略した場合は宣言を行わず、比較もされません。

プロパティ種類必須説明
patternsstring[]いいえエコシステム独自の無視パターンです。それぞれローカルのソースディレクトリのルートを基準とし、適用される順に並びます。
filesstring[]いいえエコシステムがソース内で尊重する無視ファイルの名前です (チャートでは .helmignore)。そのような各ファイルの各行はさらなるパターンであり、そのファイルを含むディレクトリを基準とします。

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

plugin.spec.pipelineStep

pluginType: pipeline-step プラグイン用の pipeline-step ブロックです。そのステップと互換性のある provider ケイパビリティを記述します。pipeline-step プラグインにのみ存在し、その他のプラグイン種別には存在しません。

プロパティ種類必須説明
capabilitiesstring[]いいえaggrega plugin gen-catalog によってプラグインの .wasm の自己報告から記録されるため、このリストの出どころはプラグインです。作成者は公開前にこのリストを絞り込み、このエンティティが提供すべきでないエントリを削除できますが、自己報告に含まれないエントリを追加することはできません。公開と、--plugin でプラグインの .wasm を渡した aggrega validate は、自己報告に含まれない機能を挙げるリストを拒否します。公開はエンティティを記述どおりに送信してこのリストを書き換えることはなく、自己報告に含まれるもののリストから除かれている各機能を通知します。このプラグインのパイプラインステップが互換性を持つプロバイダの機能。helm や compose などのプロバイダ機能名で、ステップがその描画出力の変換方法を知っているものです。ステップは一度に 1 つのプロバイダの出力形状に対して書かれるため、このリストは願望ではなく、明示的でテスト済みの互換性の宣言です。エントリは作成者の順序を保持します。これはその宣言のカタログで読み取り可能な記録です。ビルドは、ステップがスコープに触れるときに同じ宣言をプラグインから読み取り、そのスコープのドキュメントを描画するプロバイダが含まれていない場合は停止します。空または省略されたリストは互換性の宣言を行わないため、どのスコープもそのステップを受け入れません。

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

plugin.spec.parser

pluginType: parser プラグイン用の parser ブロックです。正規の構造化ツリーに変換するソースフォーマットを記述します。parser プラグインにのみ存在し、その他のプラグイン種別には存在しません。

プロパティ種類必須説明
capabilitiesstring[]いいえaggrega plugin gen-catalog によってプラグインの .wasm の自己報告から記録されるため、このリストの出どころはプラグインです。作成者は公開前にこのリストを絞り込み、このエンティティが提供すべきでないエントリを削除できますが、自己報告に含まれないエントリを追加することはできません。公開と、--plugin でプラグインの .wasm を渡した aggrega validate は、自己報告に含まれない機能を挙げるリストを拒否します。公開はエンティティを記述どおりに送信してこのリストを書き換えることはなく、自己報告に含まれるもののリストから除かれている各機能を通知します。このパーサーが正規の構造化ツリーに変換するソース形式。それぞれ parse:<format> として記述します (例: parse:yaml)。接頭辞はエントリの一部であるため、複数の形式を公開する 1 つのプラグインは、形式ごとに 1 つのエントリを列挙します。エントリは作成者の順序を保持します。要求された形式は、リストに一致するエントリを含むパーサーに解決されます。どのパーサーも公開していない形式はビルドを停止し、複数のパーサープラグインが公開している形式は曖昧として停止します。空または省略されたリストは形式の宣言を行わないため、プラグインは何も解析しません。

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

plugin.spec.importer

pluginType: importer プラグイン用の importer ブロックです。Aggrega の作成ファイルの下書きに変換する外部のソースフォーマットと、それらのフォーマットのソースを識別するためのシグネチャを記述します。importer プラグインにのみ存在し、その他のプラグイン種別には存在しません。

プロパティ種類必須説明
capabilitiesstring[]いいえaggrega plugin gen-catalog によってプラグインの .wasm の自己報告から記録されるため、このリストの出どころはプラグインです。作成者は公開前にこのリストを絞り込み、このエンティティが提供すべきでないエントリを削除できますが、自己報告に含まれないエントリを追加することはできません。公開と、--plugin でプラグインの .wasm を渡した aggrega validate は、自己報告に含まれない機能を挙げるリストを拒否します。公開はエンティティを記述どおりに送信してこのリストを書き換えることはなく、自己報告に含まれるもののリストから除かれている各機能を通知します。このインポーターが下書きの Aggrega オーサリングファイルに変換する外部ソース形式で、それぞれ import:<format> の形で書きます(例: import:terraform)。プレフィックスはエントリの一部であるため、複数の形式を公開する 1 つのプラグインは形式ごとに 1 エントリを列挙します。エントリは記述された順序を保持します。要求されたインポート形式は、一致するエントリをリストに含むインポーターに解決されます。どのインポーターも公開していない形式はインポートを停止させ、複数のインポータープラグインが公開している形式は、ワークスペース設定の plugins.importer エントリがそのうちの 1 つをアタッチしない限り曖昧として停止します。アタッチされた場合はそのインポーターが実行されます。リストが空または存在しない場合は形式の主張を宣言しないため、プラグインは何もインポートしません。
detectobject[]いいえ機械が所有するため、手で記述しないでください。エンティティの生成時にプラグインの .wasm の自己申告から導出され、自己申告が宣言した順序でここに記録されます。インポートが形式を指定しないときに、このインポーターの形式のソースを認識するためのシグネチャです。aggrega import は、ワークスペースのカタログが保持するすべてのインポーター(すべてのバージョンを含む)とコンパイラのコアインポーターのシグネチャを読み取り、どの形式が何であるかを知らないままそれらをソースと照合し、シグネチャが一致した 1 つのインポーターの形式としてソースを読み取ります。どのシグネチャにも一致しないソースは形式の指定を求めて拒否され、複数の形式のシグネチャに一致するソースはそれらの形式を挙げて拒否されます。ソースを認識したインポーターは、それを自身が公開するすべての形式として認識するため、複数の形式を公開するインポーターでは一致がすべて曖昧として拒否されます。存在する場合、リストはプラグインの自己申告が宣言する内容とエントリごとに順序も含めて等しくなければならず、ロードと公開は報告が異なるプラグインをこのフィールドを挙げて拒否します。存在しない場合は何も主張せず、比較もされません。その場合、インポーターの形式には名前を指定したときにのみ到達します。

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

plugin.spec.importer.detect[]
プロパティ種類必須説明
syntaxstringはいソースを解析する構文形式です(例: json や yaml)。これはパーサープラグインが parse:<syntax> として公開する形式です。ソースは、ワークスペースのカタログがその構文に対して提供するパーサーで解析されます。カタログが何も提供しない構文の場合は、コンパイラが内蔵するパーサーで解析されます。その構文を指定するシグネチャがいくつあっても、解析は最大 1 回です。その構文で解析できないソースは、その構文を指定するどのシグネチャにも一致しません。どちらもパーサーを提供しない構文は、そのパーサーがないことを示して認識を停止させます。1 文字以上です。
filesstring[]いいえシグネチャが適用されるファイル名パターンです。区切り文字をスラッシュとして読んだソース名の末尾と照合されます。1 セグメントのパターンはファイル自体の名前と、スラッシュで区切られた複数セグメントのパターンはパスの末尾の同数のセグメントと照合されるため、.vscode/mcp.json は .vscode という名前のディレクトリにある mcp.json という名前のファイルに一致します。セグメント内では、* は任意の文字の並びに、? は 1 文字に、[...] はクラスに属する 1 文字に一致します。いずれかのパターンが一致すると、シグネチャが適用されます。存在しないか空の場合は、名前にかかわらず 1 つのファイルであるソースに適用され、ディレクトリ内のファイルには適用されません。インポーターのシグネチャのパターンは、aggrega import がディレクトリ内のどのファイルをそのインポーターに渡すかも決定します。
matchobject[]いいえ解析されたツリーが、宣言された順序ですべて満たさなければならない述語です。存在しないか空の場合は、その構文で解析できること以外にツリーに何も求めません。

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

plugin.spec.importer.detect[].match[]
プロパティ種類必須説明
pathstringはい述語がツリーのどこを参照するかで、ツリーの最上位からドットでつないだキーとして書きます。data.nodes は最上位の data オブジェクトの nodes メンバーを指します。0 以上の整数として書いたセグメントは、0 から数えた配列のその位置を選択するため、nodes.0.type は最初のノードの type を指します。それ以外のセグメントはオブジェクトのメンバーを選択します。1 文字以上です。
isstring (enum)はいパスが到達しなければならないもの: present は、null を含む任意の種類の値に到達したときに成立します。absent は、何にも到達しないときに成立します。object、array、string、number、boolean は、それぞれその種類の値に到達したときに成立します。許容値: "present", "absent", "object", "array", "string", "number", "boolean"
equalsstringいいえパスが到達する値が完全に一致しなければならない文字列です。文字列でない値は決して一致しません。1 つの述語には equals と prefix のうち最大 1 つを宣言します。1 文字以上です。
prefixstringいいえパスが到達する値がその文字列で始まらなければならない文字列です。文字列でない値は決してその文字列で始まりません。1 つの述語には equals と prefix のうち最大 1 つを宣言します。1 文字以上です。

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