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

Aggrega Entity Lock スキーマ

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

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

entity.lock ファイルはエンティティの横に置かれ、そのエンティティが自身のドキュメントの外に求める入力のコンテンツピンを記録します。対象は、そのアーティファクトがインポートするファイル、ローカルソースのファイル、そしてエンティティが識別情報を完全に書き出しているリモートソースです。さらに、ディレクトリであるローカルソースについては、そのファイルのうちどれがエンティティに属するかを決定したルールも記録します。このファイルを書き込むのは 1 つのステップ、aggrega pin です。これはエンティティの作成者が実行するもので、Release を必要としません。aggrega pull と aggrega push も、指示された場合、つまり --pin-sources を指定した場合、またはワークスペースの pin_sources_at_pull もしくは pin_sources_at_push が設定されている場合には同じステップを実行し、同じバイト列を書き込みます。ピン留めを指示されていない pull はここに何も書き込みません。ワークスペース自身のカタログディレクトリにあるエンティティに対しては、このステップが記録する内容とファイルが保持する内容を比較し、ピンが欠けている場合や入力と一致しなくなっている場合には、aggrega pin を示して停止します。ローカルソースの場合、ピン留め以降に追加、変更、削除されたファイルは、他の古いピンと同様に pull を停止させます。aggrega build はこのファイルを読み戻し、ディスク上の内容のダイジェストが記録された値と一致しなくなっている場合に停止します。このファイルのスコープは、置かれているディレクトリによって決まります。つまり、そのディレクトリにあるエンティティの入力をピン留めします。そのため、種類ごとに独自の名前を持たせるのではなく、1 つのファイル名がすべての種類に共通して使われます。このステップは、そのような入力を読み込まないエンティティのロックを、空のロックとして残すのではなく削除します。エンティティドキュメント自体が機械によって書き込まれることはありません。作成者が入力した内容は入力したとおりに保たれ、機械が導出した内容はここに置かれます。この分離により、ロックは安全にコミットでき、差分として読みやすくなります。各行が 1 つの入力を示し、変化したダイジェストは変化した入力を示すからです。タイムスタンプや解決メタデータを持たないため、変更のない入力に対してステップを再実行しても、ファイルはバイト単位で同一のまま保たれます。ピンを記録できるすべての種類に 1 つの行の形が共通して使われるため、ピンはどの種類に属していても同じように読めます。ワイヤー形式は閉じています (additionalProperties: false)。スキーマ進化の方針: 新しい任意フィールドの追加は SemVer-MINOR (追加的) であり、フィールドの削除や制約の厳格化は SemVer-MAJOR です。

トップレベルの型: object

プロパティ

プロパティ種類必須説明
versionconst 1はいエンティティロックのスキーマバージョン: 1。スキーマに SemVer-MAJOR の変更が入るとこの値が増えます。定数: 1
sourceDigestsobject[]いいえこのエンティティが参照するリモートソースのうち、エンティティがその識別情報を完全に書き出しているもののコンテンツピンです。解決時に取得したバイトから固定され、ビルド時に読み戻されて、キャッシュされたソースがずれていないことを検証します。各エントリは解決済みソースの識別情報 {kind, url, chart, moduleSubdir, version} とコンテンツダイジェスト(OCI で配布されるソースの場合はマニフェストダイジェストも)を反映します。識別情報がテンプレートから埋められるソース(たとえば Release のインフラストラクチャ値から読み取られるバージョン)はここにエントリを持ちません。どのアーティファクトを指すかはそのエンティティを使う各 Release が決めるため、解決先の各識別情報は代わりにその Release のロックファイルでピン留めされます。ローカル(ファイルシステム相対)のソースもここにエントリを持ちません。取得されるものではなくパスを指すため、ピン留めすべき取得済みアーカイブがなく、そのファイルは代わりに localSourceDigests で 1 つずつピン留めされます。
artifactDigestsobject[]いいえこのエンティティのアーティファクトが $import でインポートするファイル(Recipe の場合は boundary.artifacts のエントリがインポートするものも含む)のコンテンツピンです。解決時に固定され、ビルド時に読み戻されて、インポートされたファイルがずれていないことを検証します。値がファイルインポートであるアーティファクトごとに 1 エントリです。インライン(リテラル)のアーティファクトはすでにエンティティの一部であり個別のピンを持たず、ライブラリから取得したアーティファクトはそのライブラリが解決されたバージョンによってピン留めされます。ビルドはどちらのブロックのエントリも同じ方法でピンと比較し、同じ条件のもとでピンと一致しなくなったファイルを拒否します。
localSourceDigestsobject[]いいえこのエンティティのローカルソース(取得されるのではなく、エンティティの隣のパスとして書かれたソース)のファイルのコンテンツピンです。エンティティのピン留め時に固定され、ビルド時に読み戻されて、ファイルがずれていないことを検証します。ソースがエンティティの公開物に含めるファイルごとに 1 エントリです。つまり、ソースが指すディレクトリ配下のファイルのうち ignore に記録されたルールが残すすべてのファイル、またはソースが指す 1 つのファイルです。テンプレートとして書かれたローカルソースは Release がテンプレートを埋めて初めてディレクトリを指すため、エンティティ自身のディレクトリ内で記録済みルールが残すすべてのファイルを含め、その各ファイルがピン留めされます。エンティティドキュメント、その隣にある作成者の .aggregaignore、およびこのファイルはエントリになりません。ドキュメントはエンティティそのものであり、ignore ファイルのルールは ignore に記録され、ロックは自身のダイジェストを記録できないためです。ロックがここにいずれかのエントリを記録すると、ビルドは、エントリのないファイルを含むソース、内容がエントリのダイジェストと一致しなくなったファイルを含むソース、またはエントリが指すファイルが欠けているソースを拒否します。
ignoreobjectいいえこのエンティティのローカルソースディレクトリ配下のどのファイルがエンティティに属するかを決めるルールで、エンティティのピン留め時に記録されます。そのディレクトリの以降の読み取りはすべて、これらのルールのみを適用します。対象は、エンティティの公開、pull または公開がロックと照合する比較、作成者のエンティティ行、ビルドの比較とレンダリング、そして検証を行う pull です。そのため、作成者の .aggregaignore、ワークスペースの provider バインディング、または aggrega バイナリを変更しても、エンティティを再度ピン留めするまでダイジェストは変わらず、再度ピン留めするとその変更がここに差分として現れます。エンティティがディレクトリであるローカルソース、またはテンプレートとして書かれたローカルソースを宣言している場合にのみ存在します。ルールを記録していないロックは、そのディレクトリ配下のすべてのファイルを残します。配下のどこにあるシンボリックリンクも、たどられずに拒否されます。

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

entity-lock.sourceDigests[]

プロパティ種類必須説明
kindenumはい解決済みソースの種類です。閉じた集合のいずれかで、ロックファイルのソースアーティファクトの kind およびキャッシュメタデータの kind と同じ集合です。3 つとも同じ解決済みソースの識別情報を記録し、ビルドはこの種類を読んでローダーを選ぶためです。terraform-module-oci はこの集合に含まれますが、これを扱うソースアダプターはありません。これを指定する Recipe または FeatureRecipe は読み込み時に拒否されます。許可される値: "helm-oci-chart"、"helm-https-chart"、"compose-https-fragment"、"git-repository"、"terraform-module-oci"
urlstringはいダイジェストがピン留めする、作成者が記述したソース URL です。spec.source.url に書かれた識別用 URL(リポジトリルート、または helm-https-chart の場合は直接の .tgz)です。ビルドはこの同じ URL をオフラインで再構成するため、これは解決済みのアーティファクトの場所ではなく、ピンのキーとなる安定した識別情報です。
chartstringいいえリポジトリルートを指す helm ソースのチャート名(spec.source.chart)です。解決済みソースの識別情報の一部であり、1 つのリポジトリルートから同じバージョンで提供される 2 つのチャートが別々にピン留めされます。直接の .tgz、OCI、compose、git のソースでは存在しません。これらはいずれも URL 内でチャートを選択しないためです。
moduleSubdirstringいいえgit をソースとするリポジトリ内で、アーティファクトとなるディレクトリ(spec.source.module_subdir)です。解決済みソースの識別情報の一部であり、1 つのリポジトリの同じコミットにある 2 つのディレクトリが別々にピン留めされます。リポジトリ全体がアーティファクトである場合、およびクローン内に降りるのではなく URL でアーティファクトに到達するすべての種類では存在しません。
versionstringはいソースが解決された具体的なピン留めバージョンです。helm-* の種類ではチャートバージョン、git-repository の参照では解決先のコミットです。ビルドがソースを読み戻すキャッシュスロットを構成するため、単一のパスセグメントとして記録され、/、\、.. を含みません。パターン: ^([^/\\.]|\.[^/\\.])*\.?$。
digeststringはい取得したソースアーカイブのコンテンツダイジェストで、sha256: の後に 64 文字の小文字の 16 進数が続く形式です。ビルド時にキャッシュされたバイトと照合して検証されます。パターン: ^sha256:[a-f0-9]{64}$。
manifestDigeststringいいえOCI で配布されるソースの OCI マニフェストダイジェスト(独立した信頼の起点)で、sha256: の後に 64 文字の小文字の 16 進数が続く形式です。OCI ソース(helm-oci-chart)の場合にのみ存在し、https や git のソースでは存在しません。これらは構造上マニフェストを持たないためです。パターン: ^sha256:[a-f0-9]{64}$。

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

entity-lock.artifactDigests[]

プロパティ種類必須説明
namestringはいこのエントリがどのアーティファクトの $import ファイルをピン留めするかを示します。artifacts のエントリでは artifacts: マップのキー、Recipe の boundary.artifacts のエントリでは boundary/ の後にキーが続くものです。そのため、同じキーで書かれた各ブロックのエントリは別々にピン留めされます。
digeststringはいインポートされたファイルのバイトのコンテンツダイジェストで、sha256: の後に 64 文字の小文字の 16 進数が続く形式です。ビルド時に検証されます。パターン: ^sha256:[a-f0-9]{64}$。

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

entity-lock.localSourceDigests[]

プロパティ種類必須説明
pathstringはいエンティティドキュメントを含むディレクトリからの相対パスで、スラッシュで区切って記述します(例: charts/app/templates/deployment.yaml)。
digeststringはいファイルのバイトのコンテンツダイジェストで、sha256: の後に 64 文字の小文字の 16 進数が続く形式です。ビルド時に検証されます。パターン: ^sha256:[a-f0-9]{64}$。

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

entity-lock.ignore

このエンティティのローカルソースディレクトリ配下のどのファイルがエンティティに属するかを決めるルールで、エンティティのピン留め時に記録されます。そのディレクトリの以降の読み取りはすべて、これらのルールのみを適用します。対象は、エンティティの公開、pull または公開がロックと照合する比較、作成者のエンティティ行、ビルドの比較とレンダリング、そして検証を行う pull です。そのため、作成者の .aggregaignore、ワークスペースの provider バインディング、または aggrega バイナリを変更しても、エンティティを再度ピン留めするまでダイジェストは変わらず、再度ピン留めするとその変更がここに差分として現れます。エンティティがディレクトリであるローカルソース、またはテンプレートとして書かれたローカルソースを宣言している場合にのみ存在します。ルールを記録していないロックは、そのディレクトリ配下のすべてのファイルを残します。配下のどこにあるシンボリックリンクも、たどられずに拒否されます。

プロパティ種類必須説明
pluginobjectいいえエンティティがピン留めされた時点で、作成者のワークスペースにおいてエンティティの機能を提供していたプラグイン(その機能に対するワークスペースの provider バインディング、それがなければ aggrega バイナリに組み込まれたプラグイン)をバージョンなしで示した名前と、そのプラグインが宣言した ignore ルールです。プラグインのバージョンもダイジェストも記録されません。どの読み取りでも適用されるのはルールであるため、同じプラグインの別のリリースで再びピン留めしても、ルールが変わらない限りロックは変わりません。その機能に対する自身のプラグインが異なるルールを宣言している pull は、両方のプラグインと差分を挙げてアドバイザリでその旨を伝え、それによって停止することはありません。どのプラグインもその機能を提供していなかった場合は存在しません。
rulesobject[]いいえ適用される順序で並べた、合成済みのルールそのものです。まずプラグインのパターン、次にプラグインが指定する ignore ファイルのうち走査で見つかったものすべての行(ディレクトリ自身のファイルがその配下のファイルより先)、最後にエンティティの隣にある作成者の .aggregaignore の行です。後のマッチが前のマッチを上書きするため、作成者のファイルはそこに記されたパスについて最終的な決定権を持ち、! で始まる行は前のルールが除外したものを復帰させます。ルールが除外したディレクトリには入らないため、その配下のファイルはディレクトリが復帰した場合にのみ復帰します。

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

entity-lock.ignore.plugin

エンティティがピン留めされた時点で、作成者のワークスペースにおいてエンティティの機能を提供していたプラグイン(その機能に対するワークスペースの provider バインディング、それがなければ aggrega バイナリに組み込まれたプラグイン)をバージョンなしで示した名前と、そのプラグインが宣言した ignore ルールです。プラグインのバージョンもダイジェストも記録されません。どの読み取りでも適用されるのはルールであるため、同じプラグインの別のリリースで再びピン留めしても、ルールが変わらない限りロックは変わりません。その機能に対する自身のプラグインが異なるルールを宣言している pull は、両方のプラグインと差分を挙げてアドバイザリでその旨を伝え、それによって停止することはありません。どのプラグインもその機能を提供していなかった場合は存在しません。

プロパティ種類必須説明
namestringはいエンティティがピン留めされた時点でその機能を提供していたプラグインで、バージョンなしの <pluginType>/<name> として記述されます。読み取り時に適用されるのは以下のルールであり、この名前はそれが誰のルールだったかを示します。1 文字以上です。
patternsstring[]いいえプラグインが宣言した ignore パターンを、宣言されたとおりに記録したものです。
filesstring[]いいえプラグインが、そのエコシステムがソース内で尊重すると宣言した ignore ファイルの名前です。

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

entity-lock.ignore.rules[]
プロパティ種類必須説明
patternstringはいgitignore 構文による 1 つの ignore パターンです。
withinstringはいパターンのスコープとなるディレクトリで、エンティティドキュメントを含むディレクトリからの相対パスをスラッシュ区切りで記述します。. はそのディレクトリ自体を表します。プラグインが宣言したパターンはローカルソースのディレクトリに、ignore ファイルの行はそのファイルを含むディレクトリに、作成者の .aggregaignore の行はエンティティのディレクトリにスコープされます。
fromstringはいパターンが宣言された場所です。プラグインが宣言したものは plugin、それ以外は読み込み元の ignore ファイルのパス(エンティティドキュメントを含むディレクトリからの相対パス)です。

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