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

Aggrega Per-Release Lockfile スキーマ

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

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

将来のビルドを決定的にするため、Release から解決されたすべての URI を固定する、機械生成のロックファイルです。<release-stem>.yaml の隣の <release-stem>.lock に置かれ、aggrega pull --release <release> によって生成され、aggrega build --release <release> によって使用されます。2 つの来歴の形が、依存関係グラフ内の 2 つの異なる関係を記録します。referenced_from(文字列のリスト)は entities に現れ、ドット区切りのオーサリング箇所のパスとして、各 URI が Release / Aggregate / Manifest / .aggrega-config.yaml のどこから取り込まれたかを記録します。また plugins にも現れ、アーティファクトに到達する経由となった各 Plugin エンティティの参照を記録します。consumers({consumer_uri, fragments} レコードのリスト)は schema_libraries、mapping_libraries、workload_libraries、artifact_libraries に現れ、どのカタログエンティティがライブラリのどの <entry-name> フラグメントを参照しているかを記録します。この構造化された形により、ライブラリの更新がどのコンシューマーに影響するかの差分を、Release を再度解決せずに追跡できます。スキーマの進化に関する方針: 新しいトップレベルセクションの追加は SemVer-MINOR(追加的)、既存セクション内への新しいフィールドの追加は SemVer-MINOR、キーの削除や制約の強化は SemVer-MAJOR です。

トップレベルの型: object

プロパティ

プロパティ種類必須説明
entitiesobject[]いいえこの Release から到達可能なカタログエンティティです。Component、Feature、Recipe、FeatureRecipe、Plugin、Aggregate、Release 自身の Aggregate と Manifest、およびその Manifest が拡張する Manifest を含みます。各エントリは kind と正規 URI の組み合わせで識別されるため、名前を共有する種類の異なる 2 つのエンティティ(たとえば、どちらも imported/flow という名前の Aggregate と Manifest)は 2 つのエントリとなり、それぞれ自身のダイジェストに照らして検証されます。各エントリは、解決されたバージョン、エンティティが持つ内容のダイジェスト、およびその URI を Release の依存関係クロージャに取り込んだオーサリング箇所の起点(referenced_from)を記録します。エントリに kind がないロックファイルは古くなっています。aggrega pull --release <release> で書き直されます。デフォルト: []
external_inputsExternalInput[]いいえ取得時にコンテンツアドレス指定の入力ストアに固定されるリモート入力です。プロバイダープラグインのレンダリングがワークスペース外から消費するコンテンツで、リモートのスキーマドキュメントやベンダリングされていないチャート依存関係などが該当します。各エントリは 1 つの URL を、ストア内でそのバイト列を指すダイジェストに固定します。ビルドは固定された入力をストアから提供し、このセクションをネットワークアクセスなしで読み取ります。デフォルト: []
generated_atstringはいこのロックファイルを生成した pull の RFC 3339 タイムスタンプです。ロックファイルの読み込み時に、パターンによって値がその形式に制約されます。診断用の来歴情報であり、解決が行われた実時刻を記録します。pull ごとに意図的に変化し、ロックファイルのバイト同一性の保証には含まれません。パターン: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$。
mapping_librariesLibraryEntry[]いいえRelease の依存関係クロージャが Recipe / FeatureRecipe の valuesMapping: { $import: ... } 箇所を通じて到達する MappingLibrary エントリです。各エントリの consumers リストは、どのカタログエンティティがライブラリのどの <entry-name> フラグメントを参照しているかを記録します。これは構造化された記録であり、Release を再度解決せずにライブラリのバージョン更新による影響の差分を追跡できるようにします。デフォルト: []
mutatorsobject[]いいえ解決済みの transform ロールのガバナンスアタッチメントで、記述された順序で並びます。transform ロールのプラグイン(ノードラベルを書き換える label-transform、または展開前にアノテーションを注入する annotation-transform)はレンダリング出力のバイト列を形作るため、アタッチメントの集合(順序付きリストと、アタッチメントごとのロール、プラグイン座標、エクスポート関数)はバイト列を決定する入力としてここに固定されます。ビルドは集合、順序、ロール、エクスポート関数を再構築するためにこのセクションを読み取り、.aggrega-config.yaml は決して読み取りません。そのため、pull 後に行われた plugins.governance の変更(次の pull でのみ採用されます)に対してビルド出力は不変です。順序は意味を持ちます。各 transform ランナーは自身のロールのアタッチメントをリスト順に適用するため、URI でソートされる plugins / providers セクションとは異なり、このリストが並べ替えられることはありません。プラグインのコンテンツダイジェストはここには重複して記録されません。ダイジェストは plugins および entities セクションにのみ記録され、この記録は識別子によってそれらを参照します。デフォルト: []
pluginsobject[]いいえバイト列がレンダリング出力を形作る Wasm プラグインで、それぞれ .wasm のコンテンツダイジェストで固定されます。.aggrega-config.yaml の plugins.governance で transform ロール(label-transform、annotation-transform)としてアタッチされた governance プラグインと、参照される Recipes / FeatureRecipes / Providers に埋め込まれたプラグイン URI が該当します。verdict ロール(ir-verdict、render-verdict)としてアタッチされた governance プラグインと plugins.linter のアタッチメントは verdict を返すだけで出力バイトを形作らないため、どちらも固定されません。どちらもここにも entities にも現れず、verdict アタッチメントが読み取るルールファイルは verdict_inputs に記録されます。デフォルト: []
providersobject[]いいえ解決済みのケイパビリティごとのプロバイダー選択です。各エントリは 1 つのケイパビリティ(例: helm)を、それをレンダリングするプロバイダーレンダリングプラグインのダイジェストを含まない OCI 識別子に固定します。この識別子は pull 時に、.aggrega-config.yaml の plugins.providers リスト(ケイパビリティを提供するプラグインが曖昧な場合)、または唯一の提供プラグイン(曖昧でない場合)から解決されます。ビルドはプロバイダーを選択するためにこのセクションを読み取り、.aggrega-config.yaml は決して読み取りません。そのため、pull 後に行われたワークスペース設定の変更に対してビルド出力は不変です。プラグインのコンテンツダイジェストはここには重複して記録されません。ダイジェストは plugins および entities セクションにのみ記録され、この記録は識別子によってそれらを参照します。バージョンの共存は維持されます。この記録はケイパビリティごとにプラグインリポジトリを選択し、具体的なバージョンは entities(解決されたプラグインバージョンごとに 1 エントリ)に記録され、各 Recipe の spec.capability のバージョン固定がレンダリング時にそれらの中から選択します。デフォルト: []
releasestringはいこのロックファイルが対応する Release へのパスで、ロックファイル自身のディレクトリからの相対パスとして解決されます(例: ./release-prod.yaml)。Release ごとの命名の慣例により、<release-stem>.lock は <release-stem>.yaml の隣に置かれます。相対パスにより、マシン固有の絶対パスなしでロックファイルが自己記述的になります。これは Release を指すものであり、解決時に Release が保持していた内容は release_documents に記録されます。
release_documentsobject[]いいえ解決時に読み取られた Release ファイルで、それぞれそのバイト列のコンテンツダイジェストによって記録されます。まずこのロックファイルが属する Release、次にそれが拡張する各 Release が、extends チェーンをたどる順に並びます。Release が要求するものはすべてその内容から解決されるため、pull 後に編集された Release は記録されたダイジェストと一致しなくなり、ビルド、または aggrega pull --verify は、何かがレンダリングされる前に、そのファイルを示し、対処方法として aggrega pull --release <release> を挙げて停止します。ダイジェストはバイト列をそのまま対象とし、正規化によって取り除かれるものはありません。これは Aggregate と Manifest の固定と同じ規則であり、コメントや空白の編集も変更とみなされます。このセクションを持たないロックファイルは Release ファイルを記録しておらず、そのようなロックファイルを持つビルドは Release が記録されていないと報告します。Release が parameters を通じてインポートするファイルはここには記録されません。
schema_librariesLibraryEntry[]いいえRelease の依存関係クロージャがエンティティの schema: / usesSchema: / featuresSchema: コンテンツ内の $ref および $import: 箇所を通じて到達する SchemaLibrary エントリです。各エントリの consumers リストは、どのカタログエンティティがライブラリのどの <entry-name> フラグメントを参照しているかを記録します。これは構造化された記録であり、Release を再度解決せずにライブラリのバージョン更新による影響の差分を追跡できるようにします。デフォルト: []
source_artifactsSourceArtifactEntry[]いいえpull 時に Recipe / FeatureRecipe の spec.source フィールドから取得されたソースアーティファクトです。各エントリは一意の {kind, url, chart, pinned_version} 識別子を、コンテンツダイジェスト、メディアタイプ、およびこのアーティファクトに解決されたすべてのカタログエンティティを示す構造化された referenced_by: 逆参照とともに特定します。url は記述された識別用 URL であり、リポジトリルートの helm ソースについて解決されたアーティファクトの場所は、来歴として resolved_url: に別途記録されます。同じチャートを同じバージョンに固定する複数の Recipes は、複数の referenced_by: 記録を持つ単一のエントリに重複排除されます。kind の列挙型は、解決される 4 つのソース種別と、どのソースアダプターも提供しない terraform-module-oci を対象とします。これを指定する Recipe または FeatureRecipe は読み込み時に拒否されるため、その種別のエントリを記録する pull はありません。デフォルト: []
toolchainobjectいいえこのロックファイルを生成したツールチェーンのバージョンです。コンパイラ自身のバージョンと、コンパイラが同梱する各コアプラグインのバージョンを含みます。ビルドをどのコンパイラとどのコアプラグインが解決・レンダリングしたかを事後にロックファイルから確認できるように記録されます。固定されたセクションだけでは常に答えられるとは限りません。コンパイラバイナリ内から提供されるコアプロバイダープラグインは固定されないままであり、そのため自身の記録されたバージョンを持たないからです。記録するのはバージョンのみです。このスタンプはプラグインのバイト列の取得元を決して記録しないため、同じコンパイラで同じ依存関係クロージャを固定した 2 台のマシンは同じスタンプを書き込みます。このセクションを比較したり、警告したり、これを理由にビルドを拒否したりするものはなく、ロックファイルにこのセクションがなくても何も通知されません。ツールチェーンはロックファイルが固定する依存関係クロージャの一部ではありません。同じ理由で、このセクションは同じ入力に対する 2 回の pull 間のバイト同一性の比較から、generated_at と同じ扱いで除外されます。
verdict_inputsobject[]いいえverdict ロールの governance アタッチメント(ir-verdict / render-verdict)がコンパイル時に読み取る外部ルール入力です。アタッチメントの with.sources を通じて供給される Kyverno / Rego ルールファイルが該当します。監査と pull 間のドリフトの可視化のため、ソースごとにコンテンツダイジェストとして記録されます。verdict を形作ったダイジェストは pull 間で差分を取れるため、変更されたルールファイルは lockfile の差分として現れます。このセクションは来歴(PROVENANCE)であり、ビルド入力ではありません。mutators.sources とは異なり content を持たず、ビルドはこれを読み取りません(NOT)。verdict プラグインは固定されずにキャッシュされ、ルール入力をその場で読み取ります(verdict は出力バイトを形作らないため、lockfile が決定的出力のために固定するものには含まれません)。verdict プラグインは固定されないため、entities / plugins セクションには存在しません。そのためこのレコードは、それらのセクションを指すのではなく単独で成り立つものとして、記述された URI によってアタッチメントを識別します。ダイジェストを記録することで、受理/拒否の判断を決定した入力を、ビルドに pin することなく監査可能かつ再現可能にします。デフォルト: []
versionconst 1はいlockfile スキーマのバージョンで、1 です。スキーマに SemVer-MAJOR の変更があるとこの値が増加します。定数: 1
workload_librariesLibraryEntry[]いいえRelease の依存関係クロージャが Recipe の workload: { $import: ... } 箇所を介して到達する WorkloadLibrary エントリです。各エントリの consumers リストは、どのカタログエンティティがライブラリのどの <entry-name> フラグメントを参照しているかを記録します。これは構造化されたレコードで、Release を再度解決せずにライブラリのバージョンアップによる影響の差分を追跡可能にします。デフォルト: []
artifact_librariesLibraryEntry[]いいえRelease の依存関係クロージャが Recipe / FeatureRecipe の artifacts.<name>: { $import: ... } 箇所を介して到達する ArtifactLibrary エントリです。各エントリの consumers リストは、どのカタログエンティティがライブラリのどの <entry-name> バンドルを参照しているかを記録します。これは構造化されたレコードで、Release を再度解決せずにライブラリのバージョンアップによる影響の差分を追跡可能にします。デフォルト: []

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

lockfile.entities[]

プロパティ種類必須説明
kindstring (enum)はいカタログエンティティの種類で、Release、その Aggregate、またはその Manifest がそれを指定している箇所から読み取られます。component と feature は Aggregate、Release、または Manifest のマッピングが指定する Component 型または Feature 型、recipe と feature_recipe は Manifest のマッピングがバインドする実現、plugin は Plugin エンティティ、aggregate は Release 自身の Aggregate とそれがインクルードするすべての Aggregate、manifest は Release 自身の Manifest とそれが拡張する Manifest を表します。uri と組み合わせてエントリを識別します。ビルドは各エントリを同じ種類と URI のエンティティと比較するため、種類の異なる同名の 2 つのエンティティのどちらへの編集も検出されます。許可される値: "aggregate"、"component"、"feature"、"feature_recipe"、"manifest"、"plugin"、"recipe"
uristringはいカタログエンティティの正規 URI です(例: hub.aggrega.ai/component/core/compute/api-server)。
resolved_versionstringはいpull 時にリゾルバーが選択した具体的なバージョンです。カタログエンティティ自身のバージョン(例: 1.2.3)、またはバージョンではなくパスで解決されたトップレベルエンティティの場合は空です。1 つのパスセグメントを指すため単一のパスセグメントとして記録され、/、\、.. を含みません。この値はビルドがこのエンティティを読み戻すキャッシュスロットを構成するため、キャッシュディレクトリの外に出る値はその外側の場所を指してしまいます。パターン: ^([^/\\.]|\.[^/\\.])*\.?$。
digeststringはいエンティティの公開物が持つ内容のダイジェストで、sha256: の後に 64 文字の小文字 16 進数が続く形式です。エンティティのドキュメントと、その横に宣言されたすべてのファイルをパス順に並べ、それぞれのパスとバイトの SHA-256 を寄与させた SHA-256 です。ファイルを宣言しないエンティティは、その 1 つのドキュメントとして数えられます。それ以外は何も含まれません。アーカイブの圧縮方法、タイムスタンプ、実行ビットを含むいかなるパーミッションビットも含まれないため、エンティティはカタログディレクトリから読み取った場合もレジストリから取得した場合も、またどのシステム上の同じファイルのどのチェックアウトでも、同じダイジェストを記録します。パターン: ^sha256:[a-f0-9]{64}$。
manifest_digeststringいいえ解決されたアーティファクトの OCI マニフェストダイジェストで、sha256: の後に 64 文字の小文字 16 進数が続く形式です。署名はこのダイジェストにコミットし、マニフェストは公開されたバイトのダイジェストを示します。取得およびキャッシュからの読み取りは、エンティティが上記の digest と照合される前に、このダイジェストと照合されます。レジストリで解決されたエンティティの場合にのみ存在します。パターン: ^sha256:[a-f0-9]{64}$。
referenced_fromstring[]いいえ記述箇所の起点です。Release / Aggregate / Manifest の YAML へのドット区切りパス(例: aggregate.spec.components.api.type)で、この URI が Release の依存関係クロージャに含まれる理由を記録します。デフォルト: []
signatureVerifiedSignatureいいえpull 時に、解決元レジストリのトラストポリシーに照らしてこのエンティティの署名が検証されたときに記録される、検証済み署名の事実です。
deprecationDeprecationRecordいいえpull 時に、署名され信頼された非推奨マーカーがこのアーティファクト上で見つかったときに記録される、検証済みの遡及的な非推奨マーカーです。マーカーは、非推奨とするアーティファクトの署名付き OCI referrer であり、アーティファクトを再公開することなく公開後に付加されます。マーカーの重大度とメッセージ、およびそれを作成した検証済みの署名者を記録します。ビルドはこの事実を読み取り、lockfile のみに基づいて非推奨ポリシーを適用します。マーカーを再発見したり再検証したりすることはありません。

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

lockfile.mutators[]

プロパティ種類必須説明
pluginstringはいtransform ロールのプラグインの解決済みプラグイン座標です。Plugin エンティティの <pluginType>/<name> 識別子(例: governance/tag-injector)です。pin されたダイジェストとバージョンセットを得るため、識別子によって plugins および entities セクションと結合します。
rolestring (enum)はいこのアタッチメントが紐づく transform ロールで、記述された plugins.governance エントリからそのまま記録されるため、ビルドはロールを推測するのではなく、まさにそのロールでアタッチメントを実行します。label-transform はトポロジー構築時にノードラベルを書き換え、annotation-transform は解決中、展開の前にアノテーションを注入します。許可される値: "label-transform"、"annotation-transform"
functionstringいいえアタッチメントが指定するエクスポートの上書きです。省略した場合は、ロールのデフォルトのエクスポート(label-transform では mutate、annotation-transform では transform_annotations)が選択されます。
settingsobjectいいえアタッチメントが宣言した自由形式の設定オブジェクトで、記述されたとおりに pin され、そのままプラグインに渡されます。ビルドは設定をその場の config からではなくここから読み取るため、pull 後に設定を変更してもビルド出力は変わりません。アタッチメントが何も宣言しない場合は存在しません。
sourcesobject[]いいえアタッチメントが宣言したソースファイルのコンテンツアドレス指定の pin で、ベース名の順に並びます。ビルドは、ホストからその場で読み取るのではなく、各 pin に記録された内容からプラグインが読み取るソースを再構築するため、pull 後にソースファイルが変更されてもビルド出力は変わりません。アタッチメントが何も宣言しない場合は存在しません。

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

lockfile.mutators[].sources[]
プロパティ種類必須説明
contentstringはいソースファイルの内容で、ビルドが lockfile からプラグインのソース入力を再構築できるよう、そのまま保持されます。
digeststringはい記録された内容のコンテンツアドレスで、sha256: の後に 64 文字の小文字 16 進数が続く形式です。再 pull では、元のファイルをこのダイジェストと比較してドリフトを検出します。パターン: ^sha256:[a-f0-9]{64}$。
pathstringはいソースファイルのベース名です。ホストの絶対パスになることはないため、pin は移植可能かつ決定的です。

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

lockfile.plugins[]

プロパティ種類必須説明
uristringはいWasm プラグインの .wasm アーティファクトの素のアイデンティティで、<pluginType>/<name> パスです(例: governance/aggrega-security-baseline)。最初のセグメントはプラグインの型(provider、linter、pipeline-step、governance、cli、parser、importer)で、その後のセグメントがプラグインの名前です。型と名前の組み合わせがプラグインのアイデンティティとなり、2 つの型の下にある同じ名前は 2 つのプラグインです。物理的な取得場所はこのアイデンティティと設定されたレジストリから導出され、ロックファイルには記録されません。
resolved_versionstringはいWasm アーティファクトが解決されたコンテンツダイジェストで、sha256: に続く 64 文字の小文字 16 進数で表します。プラグインアーティファクトはバージョン名ではなくコンテンツアドレスで識別されます。.wasm はプラグインマニフェストにインラインで含まれ、そのバイトのダイジェストで固定されるため、このフィールドはそのダイジェストを記録し、これは下記の digest とも同じです。この値はビルドがアーティファクトを読み戻すキャッシュスロットを構成するため、/、\、.. を含みません。これらは sha256: 形式によってすでに除外されています。パターン: ^sha256:[a-f0-9]{64}$。
digeststringはい解決された Wasm アーティファクトのコンテンツダイジェストで、sha256: に続く 64 文字の小文字 16 進数で表します。これは、コンテンツアドレスが比較されるすべての場所で書かれる形式です。パターン: ^sha256:[a-f0-9]{64}$。
manifest_digeststringいいえ解決された Wasm アーティファクトの OCI マニフェストダイジェストで、sha256: に続く 64 文字の小文字 16 進数で表します。署名はこのダイジェストに対してコミットし、上記のコンテンツ digest はキャッシュの固定と整合性チェックに使われるポータブルなアイデンティティです。レジストリから解決されたアーティファクトの場合にのみ存在します。パターン: ^sha256:[a-f0-9]{64}$。
referenced_fromstring[]いいえこのアーティファクトが Release の依存関係クロージャに含まれる理由で、到達する経由となった各 Plugin エンティティの参照を、entities セクションがそのエンティティを記録する形で示します(例: governance/label-injector:1.0.0)。デフォルト: []
signatureVerifiedSignatureいいえプル時にこのプラグインの署名が、カタログエンティティと同じレジストリごとの信頼ポリシーに照らして検証されたときに記録される、検証済み署名の事実です。
deprecationDeprecationRecordいいえpull 時に、署名され信頼された非推奨マーカーがこのアーティファクト上で見つかったときに記録される、検証済みの遡及的な非推奨マーカーです。マーカーは、非推奨とするアーティファクトの署名付き OCI referrer であり、アーティファクトを再公開することなく公開後に付加されます。マーカーの重大度とメッセージ、およびそれを作成した検証済みの署名者を記録します。ビルドはこの事実を読み取り、lockfile のみに基づいて非推奨ポリシーを適用します。マーカーを再発見したり再検証したりすることはありません。

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

lockfile.providers[]

プロパティ種類必須説明
capabilitystringはいこのバインディングがプロバイダーを選択する対象のケイパビリティで、Recipe が spec.capability を通じてバインドする素のケイパビリティ名です(例: helm、compose)。
pluginstringはい解決されたプロバイダーレンダリングプラグインの素のアイデンティティです(Plugin エンティティのアイデンティティで、metadata.pluginType と metadata.name をスラッシュで連結したもの。例: provider/helm)。固定されたダイジェストとバージョンセットを得るため、アイデンティティによって plugins セクションおよび entities セクションと結合されます。

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

lockfile.release_documents[]

プロパティ種類必須説明
digeststringはい解決処理が読み取った時点の Release ファイルのバイトのコンテンツダイジェストで、sha256: に続く 64 文字の小文字 16 進数で表します。パターン: ^sha256:[a-f0-9]{64}$。
pathstringはいこのロックファイルが属する Release を含むディレクトリからの、スラッシュ区切りの Release ファイルの相対パスです(例: release-prod.yaml、../shared/base-release.yaml)。ホストの絶対パスにはならないため、この記録はポータブルかつ決定的です。

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

lockfile.toolchain

このロックファイルを生成したツールチェーンのバージョンです。コンパイラ自身のバージョンと、コンパイラが同梱する各コアプラグインのバージョンを含みます。ビルドをどのコンパイラとどのコアプラグインが解決・レンダリングしたかを事後にロックファイルから確認できるように記録されます。固定されたセクションだけでは常に答えられるとは限りません。コンパイラバイナリ内から提供されるコアプロバイダープラグインは固定されないままであり、そのため自身の記録されたバージョンを持たないからです。記録するのはバージョンのみです。このスタンプはプラグインのバイト列の取得元を決して記録しないため、同じコンパイラで同じ依存関係クロージャを固定した 2 台のマシンは同じスタンプを書き込みます。このセクションを比較したり、警告したり、これを理由にビルドを拒否したりするものはなく、ロックファイルにこのセクションがなくても何も通知されません。ツールチェーンはロックファイルが固定する依存関係クロージャの一部ではありません。同じ理由で、このセクションは同じ入力に対する 2 回の pull 間のバイト同一性の比較から、generated_at と同じ扱いで除外されます。

プロパティ種類必須説明
compiler_versionstringはいこのロックファイルを書き出したコンパイラのバージョンで、Aggrega のすべてのインターフェースが報告する v なしの形式で表します(v1.2.0 ではなく 1.2.0)。バージョンがスタンプされたビルドはそのバージョンを記録し(タグ付きのリリースビルドはそのタグ)、バージョンスタンプを持たないビルドは (devel) マーカーを記録するため、スタンプのないコンパイラが生成したロックファイルがリリースの出力と取り違えられることはありません。単一のパスセグメントとして記録されるため、/、\、.. を含みません。パターン: ^([^/\\.]|\.[^/\\.])*\.?$。
core_pluginsobject[]はいコンパイラが同梱する各コアプラグインのバージョンで、プラグインごとに 1 エントリ、プラグイン座標の順に並びます。コアプラグインはコンパイラ自身のタグで同じバージョンとして公開されるため、コンパイラがプラグインを内部から提供した場合もレジストリから取得した場合も、これらのバージョンは同じになります。これにより、スタンプにマシン固有の情報が含まれません。コアプラグインを同梱しないビルドでは空です。デフォルト: []

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

lockfile.toolchain.core_plugins[]
プロパティ種類必須説明
pluginstringはいコアプラグインの座標で、Plugin エンティティの <pluginType>/<name> アイデンティティです(例: provider/helm)。providers セクションと mutators セクションがプラグインを指すのと同じアイデンティティです。
versionstringはいこのコアプラグインのバージョンで、Aggrega のすべてのインターフェースが報告する v なしの形式で表します。単一のパスセグメントとして記録されるため、/、\、.. を含みません。パターン: ^([^/\\.]|\.[^/\\.])*\.?$。

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

lockfile.verdict_inputs[]

プロパティ種類必須説明
pluginstringはい判定アタッチメントの記述されたプラグイン URI で、.aggrega-config.yaml の plugins.governance に書かれたとおりのものです(例: governance/aggrega-security-baseline:1.0.0)。記録されたルール入力がどのアタッチメントに属するかを識別します。判定プラグインは固定されずにキャッシュされるため、結合先となる plugins / entities セクションのエントリを持ちません。
rolestring (enum)はいこのアタッチメントがバインドされている判定ロールで、ir-verdict(静的解析時に IR グラフに対して)または render-verdict(レンダリング時にレンダリングされたアーティファクトに対して)です。両方の判定段階にアタッチされ、それぞれ独自のルール入力を持ちうる同じプラグインを区別します。許可される値: "ir-verdict"、"render-verdict"
sourcesobject[]いいえアタッチメントが宣言したルール入力ファイルのコンテンツダイジェストで、ベース名の順に並びます。アタッチメントがソースを宣言しない場合は存在しません。

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

lockfile.verdict_inputs[].sources[]
プロパティ種類必須説明
digeststringはいプル時のルール入力ファイルのバイトのコンテンツアドレスで、sha256: に続く 64 文字の小文字 16 進数で表します。再プルで再計算されるため、変更されたルールファイルはロックファイルの差分として現れます。パターン: ^sha256:[a-f0-9]{64}$。
pathstringはいルール入力ファイルのベース名です。ホストの絶対パスにはならないため、この記録はポータブルかつ決定的です。

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

定義

DeprecationRecord

pull 時に、署名され信頼された非推奨マーカーがこのアーティファクト上で見つかったときに記録される、検証済みの遡及的な非推奨マーカーです。マーカーは、非推奨とするアーティファクトの署名付き OCI referrer であり、アーティファクトを再公開することなく公開後に付加されます。マーカーの重大度とメッセージ、およびそれを作成した検証済みの署名者を記録します。ビルドはこの事実を読み取り、lockfile のみに基づいて非推奨ポリシーを適用します。マーカーを再発見したり再検証したりすることはありません。

プロパティ種類必須説明
messagestringはいマーカーが持つ、人間が読める非推奨メッセージです。通常は移行先への案内です。
severitystring (enum)はいマーカーの重大度で、warning < error < retracted の順に並びます。この重大度が設定された停止しきい値以上の場合、ビルドは停止し、それ以外の場合は勧告を出力します。許可される値: "warning", "error", "retracted"
signerVerifiedSignatureいいえマーカーの検証済み署名者で、アーティファクト署名の署名者と同じ方法で記録されます。キーレスの場合は証明書の subject/issuer、キー付きの場合は固定された鍵のフィンガープリントです。マーカーはそれ自体が署名済みアーティファクトであるため、その署名者はアーティファクト署名と同じ形を持ちます。ここでの bundle_digest は、非推奨となったアーティファクトのものではなく、マーカー自身の署名バンドルを指します。

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

ExternalInput

固定された単一の外部入力です。レンダリングが要求した URL、コンテンツアドレス方式の入力ストア内でそのバイト列を指す SHA-256 ピン (sha256/<digest>)、ペイロードサイズ、およびそれを必要とした利用者の来歴から成ります。ピンは正本です。固定された URL は常にストアから提供され、ストアの再充填は、バイト列がレンダリングに届く前にこのダイジェストに対して検証されます。

プロパティ種類必須説明
required_bystring[]はい来歴、すなわちこの入力を要求したレンダリング箇所です。lockfile の書き込み側によってソートされ、重複が除去されます。
sha256stringはい小文字 16 進数の SHA-256 ピンです。https 入力の場合はペイロードのバイト列のダイジェスト、oci 入力の場合は参照が解決されたマニフェストダイジェストです。sha256/<digest> にあるストアの blob を指します。パターン: ^[0-9a-f]{64}$。
sizeintegerはい固定されたペイロードのバイト単位のサイズです。バイト数が負になることはありません。最小値: 0。
urlstringはいレンダリング箇所で記述された入力 URL です。レンダリング時の要求をそのピンに対応付ける検索キーです。

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

LibraryEntry

schema_libraries、mapping_libraries、workload_libraries、artifact_libraries の各エントリが共有する共通の形です。consumers リストはカタロググラフの関係、つまりどのカタログエンティティがこのライブラリのどの <entry-name> フラグメントを参照しているかを記録し、ライブラリのダイジェストが変わったときの構造化された影響差分を支えます。ライブラリは他と同じく OCI アーティファクトであるため、カタログエンティティと同じ検証済みの事実を記録します。すなわち、署名が対象とするマニフェストダイジェスト、検証済みの署名そのもの、および pull 時に発見された検証済みの遡及的な非推奨マーカーです。

プロパティ種類必須説明
uristringはいライブラリエンティティの正規 URI です。
resolved_versionstringはいpull 時に解決された具体的なバージョン (ライブラリ依存グラフに対する最小バージョン選択) で、ライブラリ自身のバージョンです。ビルドがライブラリを読み戻すキャッシュスロットを構成するため、単一のパスセグメントとして記録され、/、\、.. を含みません。キャッシュディレクトリの外へ出る値は、その外部の場所を指してしまうためです。パターン: ^([^/\\.]|\.[^/\\.])*\.?$。
digeststringはい解決されたライブラリアーティファクトのコンテンツダイジェストで、sha256: の後に小文字の 16 進数 64 文字が続く形式です。これは、コンテンツアドレスが比較されるすべての箇所で記述される形式です。パターン: ^sha256:[a-f0-9]{64}$。
manifest_digeststringいいえ解決されたライブラリアーティファクトの OCI マニフェストダイジェストで、sha256: の後に小文字の 16 進数 64 文字が続く形式です。署名はこのダイジェストを対象とします。上記のコンテンツ digest は、キャッシュピンと整合性チェックに使われる可搬な識別子です。レジストリから解決されたライブラリの場合にのみ存在します。パターン: ^sha256:[a-f0-9]{64}$。
signatureVerifiedSignatureいいえこのライブラリの署名が pull 時に、カタログエンティティと同じレジストリごとの信頼ポリシーに対して検証されたときに記録される、検証済み署名の事実です。
deprecationDeprecationRecordいいえpull 時にこのライブラリで発見された、検証済みの遡及的な非推奨マーカーです。ビルドはこれを報告し、記録された重大度が満たす停止しきい値をワークスペースが設定している場合は停止します。これにより、バージョンが固定された後に撤回されたライブラリは、明示的に固定されたバージョンでは迂回されるバージョン選択時だけでなく、すべてのビルドで通知されます。
consumersobject[]いいえどのカタログエンティティがこのライブラリを、どの <entry-name> フラグメントで参照しているかの記録です。ファンインを表します。ライブラリごとに多数の利用者があり、それぞれが多数のフラグメントを参照し得ます。各記録は、利用者の URI と、その利用者が取り込むフラグメントの集合を持ちます。デフォルト: []

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

LibraryEntry.consumers[]

プロパティ種類必須説明
consumer_uristringはいこのライブラリを参照するカタログエンティティの正規 URI です。スキーマライブラリの場合は Component または Feature、マッピング、ワークロード、アーティファクトライブラリの場合は Recipe または FeatureRecipe、あるいはエントリがこのライブラリを参照する同じ種類の別のライブラリです。
fragmentsstring[]はいこの利用者がライブラリ内で参照する <entry-name> フラグメントの集合です (例: ["#/schemas/PortSpec", "#/schemas/EndpointSpec"])。順序は書き込み側によって辞書順に正規化されます。

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

SourceArtifactEntry

単一のソースアーティファクトのピンです。{kind, url, chart, module_subdir, pinned_version} の識別子、pull を検証するコンテンツダイジェスト、正規のメディアタイプ、およびこのアーティファクトに解決されたすべてのカタログエンティティへの構造化された逆参照を含みます。chart と module_subdir は 2 つのセレクタ項目であり、それを必要とする種類について、URL だけでは特定できないものをそれぞれ指定します。

プロパティ種類必須説明
kindenumはいソースの種類です。どのアダプタがアーティファクトを解決したか、およびどのメディアタイプが想定されるかを決定します。terraform-module-oci はこの集合に含まれますが、どのソースアダプタも扱いません。これを指定する Recipe や FeatureRecipe は読み込み時に拒否されます。許可される値: "helm-oci-chart"、"helm-https-chart"、"compose-https-fragment"、"git-repository"、"terraform-module-oci"
urlstringはい記述された URL、すなわち Recipe の spec.source.url に書かれた識別 URL です。helm-https-chart の場合、これは記述どおりのリポジトリルート(repo-root 形式)または直接の .tgz(direct 形式)です。ビルドはこれと同じ URL をオフラインで再構築するため、ピンのキーとなる安定した識別子になります。git-repository の場合はクローン可能なリポジトリ URL、helm-oci-chart の場合はレジストリ参照、compose-https-fragment の場合はフラグメントの HTTPS URL です。repo-root 形式の helm ソースについて解決されたアーティファクトの場所は、来歴として resolved_url: に別途記録されます。
chartstringいいえrepo-root 形式の helm ソースのチャート名(Recipe の spec.source.chart)です。{kind, url, chart, module_subdir, pinned_version} の識別子の一部であり、1 つのリポジトリルートから同じバージョンで提供される 2 つのチャートが別々のエントリにピン留めされるようにします。直接の .tgz、OCI、compose、git のソースでは存在しません。これらはいずれも URL 内でチャートを選択しないためです。
module_subdirstringいいえgit から取得したリポジトリ内でアーティファクトとなるディレクトリ(Recipe の spec.source.module_subdir)です。{kind, url, chart, module_subdir, pinned_version} の識別子の一部であり、1 つのリポジトリの同じコミットにある 2 つのディレクトリが別々のエントリにピン留めされるようにします。リポジトリ全体がアーティファクトである場合、およびクローン内を辿るのではなく URL でアーティファクトに到達するすべての種類では存在しません。
pinned_versionstringはいpull 時にピン留めされた具体的なバージョンです。helm-* の種類ではチャートのバージョンです。git-repository では、記述された参照が解決されたコミットです(元のタグ/ブランチ参照ではありません。それは、Recipe が spec.source.ref: を記述している場合に、各 referenced_by: エントリの requested_ref: に記録されます)。ビルドは Recipe に書かれた内容によってこのエントリを見つけます。記述された ref: があればそれを記録済みの requested_ref: と照合し、なければこのピン留めされた値を使います。そのため、タグを指定する Recipe は、コミットが Recipe に一度も現れることなく、そのタグがピン留めされたコミットに解決されます。ビルドがアーティファクトを読み戻すキャッシュスロットを構成するため、単一のパスセグメントとして記録され、/、\、.. を含みません。パターン: ^([^/\\.]|\.[^/\\.])*\.?$。
resolved_urlstringいいえ来歴専用です。記述された URL が pull 時に解決された具体的なアーティファクトの場所です。repo-root 形式の helm ソースでは、リポジトリインデックスがチャートとバージョンを解決した直接の .tgz URL です。診断のために記録されるもので、アーティファクトの識別子の一部ではありません。解決された場所が記述された URL と等しい場合(直接の .tgz、OCI、compose、git のソース)は存在しません。
digeststringはい解決された .tar.gz アーカイブのコンテンツダイジェストで、sha256: に続く 64 文字の小文字 16 進数の形式です。ビルド時の検証ではキャッシュスロットのバイト列を読み取り、ダイジェストを再計算してこのフィールドと比較します。不一致の場合はビルドが停止し、コンテンツダイジェストの不一致が報告されます。パターン: ^sha256:[a-f0-9]{64}$。
manifest_digeststringいいえ解決されたアーティファクトの OCI マニフェストダイジェストで、sha256: に続く 64 文字の小文字 16 進数の形式です。マニフェストは、キャッシュされたアーカイブの検証基準となる独立した信頼の起点です。上記のコンテンツ digest は、キャッシュのピンと整合性チェックに使われるポータブルな識別子です。OCI で配布されるソース(helm-oci-chart)でのみ存在します。パターン: ^sha256:[a-f0-9]{64}$。
mediatypestringはいレジストリが提示した正規のメディアタイプです (レジストリメタデータを持たない kind の場合はその kind のデフォルト)。診断用の来歴のために記録されます。
referenced_bySourceArtifactReference[]はいこのアーティファクトに解決されたカタログエンティティで、決定的な出力のため (uri, field) でソートされます。エントリは Recipe または FeatureRecipe がそれを pull したからこそ存在するため、リストが空になることはありません。少なくとも 1 エントリです。

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

SourceArtifactReference

単一のカタログエンティティ → ソースアーティファクトの逆参照です。entity と uri の組でカタログエンティティを識別し、field はアーティファクトが宣言されたエンティティの spec 内のソース側パスを示します。省略可能な requested_ref: は Recipe に記述された spec.source.ref: を保持し、Recipe がそれを記述している場合は常に書き込まれます(git-repository のタグ/ブランチ → コミット SHA)。

プロパティ種類必須説明
entityenumはいこの逆参照を保持するカタログエンティティの種類です。許可される値: "recipe"、"feature_recipe"
uristringはいRecipe または FeatureRecipe の正規 URI です(例: hub.aggrega.ai/recipe/helm/mariadb-bitnami:1.0.0)。
fieldstringはいアーティファクトが宣言されたエンティティの spec 内のソース側パスです。値は spec.source です。
requested_refstringいいえ省略可能です。Recipe に記述された spec.source.ref: で、Recipe がそれを記述している場合は常に書き込まれます。ref: v1.0.0 を記述する git-repository の Recipe では、これは "v1.0.0" を保持し、pinned_version: はその参照が解決されたコミットを保持します。Recipe が ref: を記述しない場合は存在しません。これは、リゾルバが記述されたバージョンをそのままピン留めするすべての種類(helm-、compose-)に該当します。これは 2 つの役割を同時に担い、無条件に記録することで両者が互いを排除しないようにしています。ビルドは、コミットではなく参照を指定する Recipe からこのエントリを見つけるために、これで結合します。また、アップグレードではない pull は、記録された各参照をそのピン留めされたバージョンに固定します。リモートで移動した参照は、採用されるのではなく実行を停止させます。

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

VerifiedSignature

pull 時に、解決元レジストリの信頼ポリシーに照らしてアーティファクトの署名が検証されたときに記録される、検証済み署名の事実です。署名可能なアーティファクトはすべて、カタログエンティティ、ライブラリ、Wasm プラグインのいずれであっても、同じ方法でこれを記録します。これは、種類ごとに別の経路ではなく、すべてが 1 つの経路で検証されるためです。検証モード、一致したキーレスの ID と発行者 (キーレスの場合)、およびコンテンツキャッシュ内の署名バンドルのコンテンツアドレス指定ダイジェストを記録します。ビルドは検証を再実行しません。何かをレンダリングする前に、ビルドはすべてのセクションで、ビルド元とするすべてのエントリについてこの事実を読み取ります。キャッシュされたバンドルを再ハッシュして結果を bundle_digest と比較し、blob が存在しないか異なる場合は停止します。また、コンテンツキャッシュから提供されたエントリについては、署名がどのアーティファクトに対して作成されたかをそのバンドルから読み取り、ビルドがそのエントリについて読み取ったものとは異なるアーティファクトに対して作成されていた場合は停止します。そのため、あるエントリから別のエントリにコピーされた signature は、署名の要件がどうであれ拒否されます。ビルドは署名を検証しないため、エントリ自身のアーティファクト向けに作成され、手作業でキャッシュに書き込まれたバンドルは、pull が検証したものと区別されません。また、ワークスペースの信頼設定が、コンテンツキャッシュから提供されたエントリに署名を要求している場合 (これは pull がアーティファクトを取得するときに適用する要件であり、pull が署名のないアーティファクトを受け入れることを許すスキップや advisory レジストリは、ビルドがそのエントリを受け入れることも許します)、事実を持たないエントリはビルドを停止させます。カタログディレクトリ、コンパイラバイナリ内のコピー、または Release の隣から読み取られたエントリには、この要件は決して課されません。

プロパティ種類必須説明
bundle_digeststringはいキャッシュされた署名バンドル blob の SHA-256 ダイジェストで、sha256: の後に 64 文字の小文字の 16 進数が続く形式です。キャッシュ blob を指すため、パスを構成し、/、\、.. を含みません (sha256: 形式によってすでに除外されています)。また、どのセクションのエントリにおいても、ビルドがその blob を再ハッシュして照合する対象となります。パターン: ^sha256:[a-f0-9]{64}$。
identitystringいいえ署名の検証済み署名者です。キーレス署名の場合は署名証明書のサブジェクト、キー付き署名の場合は keyed:sha256: の後に固定された公開鍵の PEM テキストの SHA-256 が続くものです。
issuerstringいいえキーレス署名の検証済み OIDC 発行者です。キー付き署名の場合は空です。
modestring (enum)はい署名を受け入れた検証モードです。許可される値: "keyless"、"keyed"

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