Aggrega 依存関係ロックファイル (Manifest) スキーマ
自動生成されたリファレンスです。手動で編集しないでください。公開されている JSON Schema から再生成してください。
スキーマ ID: https://aggrega.ai/schemas/manifest-v1beta1.schema.json
抽象的な component と Feature の型を、型ごとに具体的な Recipe と FeatureRecipe の実装にマッピングする、単一のグローバルなロックファイルです。名前によるインスタンスごとの上書きもできます。
Manifest エンティティの記述に関する解説は Manifest 記述リファレンスを参照してください。このページでは、そのリファレンスが説明する構造スキーマを記載します。
トップレベルの型: object
プロパティ
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
apiVersion | const “aggrega.ai/v1beta1” | はい | 定数: "aggrega.ai/v1beta1" |
kind | const “Manifest” | はい | 定数: "Manifest" |
metadata | object | はい | |
defs | string[] | いいえ | 標準の YAML アンカー (& と *) 用の任意のブロックです。コンパイラ向けにフラットな O(1) の辞書を保ちつつ、Manifest を DRY に保ちます。 |
spec | object | はい | Manifest のマッピング宣言と、任意のベース継承です。mappings は抽象的な component 型と feature 型を具体的な Recipe 実装と FeatureRecipe 実装に結び付けます。extends はベースの Manifest からマッピングを継承します。 |
追加のプロパティは許可されません。
manifest.metadata
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
name | string | はい | 1 文字以上。 |
version | string | はい | manifest ロックファイルの厳密なセマンティックバージョニング(例: 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-]+)*))?$。 |
description | string | いいえ | このエンティティが何であり、何のためのものかを、使用するかどうかを判断する人に向けて記述します。まずそのものを名指しする一文で始め、次に読み手がそれを選択し正しく使うために必要なこと、つまりそれを使用する Release に何を期待するか、その動作で意外な点は何かを加えます。通常は短い段落程度の長さです。 |
maintainers | object[] | いいえ | このエンティティを所有するメンテナーの一覧です。 |
license | string | いいえ | このエンティティが記述するソフトウェアのライセンスの SPDX 識別子です(MIT や AGPL-3.0 など)。記録するのはそのソフトウェアの条件であり、このファイルの条件ではありません。 |
repository | string | いいえ | ソースファイルが置かれている Git リポジトリの URL です。 |
home | string | いいえ | このエンティティのホームページ、wiki、またはドキュメントの URL です。 |
keywords | string[] | いいえ | UI での発見性を高めるための説明的なキーワードの一覧です。 |
追加のプロパティは許可されません。
manifest.metadata.maintainers[]
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
name | string | はい | |
email | string | いいえ | |
url | string | いいえ |
追加のプロパティは許可されません。
manifest.spec
Manifest のマッピング宣言と、任意のベース継承です。mappings は抽象的な component 型と feature 型を具体的な Recipe 実装と FeatureRecipe 実装に結び付けます。extends はベースの Manifest からマッピングを継承します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
extends | string | いいえ | マッピングの継承元となるベース Manifest の URI です。同じキーについては、子のマッピングがベースのマッピングを置き換えます。 |
mappings | object | はい | 抽象インターフェースを具体的な実装にマッピングします。マッピングはトップレベルのキー「components」と「features」の下に宣言し、それぞれが component 型 / feature 型の URI を Recipe / FeatureRecipe の URI に直接マッピングします。この 2 つのキーがすべてであり、ここでは他のキーは受け付けません。Manifest の層ではマッピングは capability に依存しません。capability の決定は、Aggrega が Release をビルドするときに、解決された各 Recipe の spec.capability から導かれます。キー: "components"、"features" のいずれか。 |
追加のプロパティは許可されません。
manifest.spec.mappings
抽象インターフェースを具体的な実装にマッピングします。マッピングはトップレベルのキー「components」と「features」の下に宣言し、それぞれが component 型 / feature 型の URI を Recipe / FeatureRecipe の URI に直接マッピングします。この 2 つのキーがすべてであり、ここでは他のキーは受け付けません。Manifest の層ではマッピングは capability に依存しません。capability の決定は、Aggrega が Release をビルドするときに、解決された各 Recipe の spec.capability から導かれます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
components | mapping_tier | いいえ | Component-type から Recipe URI へのマッピングです。Recipe URI は最大 2 つのセグメント(省略可能な先頭の capability、続いて recipe 名)と、省略可能なバージョンを持ちます。3 つ目のセグメントを持つ参照はどの recipe にも一致しません。バージョンの形式は、完全一致(‘postgres-bitnami:1.2.0’)、範囲(‘postgres-bitnami:^1.2.0’)、またはバージョンなし(‘postgres-bitnami’)です。リゾルバは最初の解決時に、解決されたバージョンを lockfile に固定します。参照はさらに capability で修飾することもできます(‘terraform/mariadb-rds:1.0.0’。最初の ’/’ の前のセグメントが recipe の spec.capability を示します)。これは、同じ名前を持つ recipe が複数ある場合に必須です。曖昧な修飾なしの参照は、黙っていずれかを選ぶのではなく、明示的に解決を停止します。 |
features | mapping_tier | いいえ | Feature-type から FeatureRecipe URI へのマッピングです。運用上の Features と認証情報の Features(feature.aggrega.ai/kind: secret のラベルが付いたもの)の両方を含みます。 |
キー: "components"、"features" のいずれか。
追加のプロパティは許可されません。
定義
mapping_tier
2 層の解決: ‘type’ はカタログの型でマッピングし (DRY な一括指定)、‘name’ はインスタンス名でマッピングします (細かな上書き)。どちらも任意ですが、少なくとも一方が必要です。解決時は name が type より優先されます。バージョン付きの type キーはバージョンなしのキーより優先されます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
type | string のマップ | いいえ | カタログの型 URI を Recipe URI にマッピングします。完全一致のためのバージョン付きキー (‘core/api-server:1.0.0’)、メジャー互換一致のための範囲キー (‘core/api-server:^1.0.0’)、任意のバージョンに一致するバージョンなしキー (‘core/api-server’) をサポートします。 |
name | string のマップ | いいえ | 特定のインスタンス名を Recipe URI にマッピングします。型に基づくマッピングより優先されます。 |
annotations | object のマップ | いいえ | アノテーション駆動の Feature ショートカットです。アノテーションキーを、Feature URI と、ドット区切りパスのサブキーから Feature の pillar (values または infra) への pillar ごとにまとめたルーティングテーブルにマッピングします。検証は対象 Feature の spec.schema. |
追加のプロパティは許可されません。