Aggrega パステンプレートコンテキストのスキーマ
自動生成されたリファレンスです。手動で編集しないでください。公開されている JSON Schema から再生成してください。
スキーマ ID: https://aggrega.ai/schemas/path-template-context-v1beta1.schema.json
Aggrega が Release をビルドする際に Release.spec.boundaries[].directory と Release.spec.boundaries[].subDirectory(および component ごとの subDirectory の上書き)に対して評価される Go テンプレートが使用する変数の許可リストです。パステンプレートは missingkey=error(値テンプレートに適用されるグローバルな missingkey=zero とは異なります)に加えて、パース時の検証を使用します。パステンプレート内のすべてのフィールド参照は、該当するコンテキスト(directory: か subDirectory: か)についてこの許可リストに含まれている必要があります。未知のフィールドはレンダリング時ではなく、必ずパース時に Loud Guardrail エラーを発生させます。値テンプレートとの違いについては、言語リファレンスの「パステンプレート変数」ページで説明しています。
トップレベルの型: object
プロパティ
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
capability | string | いいえ | directory: と subDirectory: の両方で使用できます。寄与する component の Recipe が spec.capability で宣言するレンダリング機能から、バージョン指定を取り除いたものです。たとえば ‘helm’、‘helm-chart’、‘compose’ などです。subDirectory: のデフォルトは {{ .capability }} で、これにより各機能の成果物が boundary の directory の下にある専用のサブフォルダーに配置されます。directory: テンプレートでは値は component ごとに解決されるため、サブツリーが複数の機能を寄与する boundary は、機能ごとに 1 つのディレクトリに評価されます。.parent_boundary.directory を公開する boundary ごとの別個の走査は、component がバインドされる前に実行されるため、この値は空のままです。 |
boundary_name | string | いいえ | directory: と subDirectory: の両方で使用できます。release.spec.boundaries. |
parameters | object | いいえ | directory: と subDirectory: の両方で使用できます。Release からの型付きパラメーターマップです。パステンプレートは、parameters の単一パスのライフサイクルからの意図的な例外として .parameters へのアクセスを受け取ります。値テンプレートは .parameters を受け取りません。環境に応じた値は、補間済みの Aggregate YAML を介して値テンプレートに渡されます。 |
component_id | string | いいえ | subDirectory: でのみ利用できます。配置されるコントリビューターの識別子です。コンポーネントの場合は、フラット化されたコンポーネントごとのインスタンス ID です(例: ‘backend’ や ‘data-layer.main-db’)。FeatureRecipe が境界に対して 1 回だけ実行される(executionScope: boundary)境界にアタッチされた Feature の場合は、そのアタッチメントが出力するすべてのリソースが aggrega.ai/component-id ラベルに持つ合成されたコンポーネント識別子です(例: 境界 ‘app’ のアタッチメント ‘shared’ なら ‘bfr—app—shared’)。アタッチメントのレンダリングプラグインが名前を制限する場合は短縮され、それが示すディレクトリがそのラベルと一致するようになります。境界レベルでは意味を持たず、directory: テンプレートではパース時の検証で拒否されます。 |
parent_boundary | object | いいえ | directory: と subDirectory: の両方で使用できます。親境界の解決済みの値です。深さ優先の走査によって設定され、各境界のテンプレートはその親の解決済みの値を使って評価されます。子はここで自身の値を参照することはありません。最上位の境界には親がないため、そこで parent_boundary の下のキーを読み取るとビルドが停止し、その境界、テンプレートフィールド、欠落しているキーが示されます。 |
manifest | object | いいえ | directory: と subDirectory: の両方で使用できます。component ごとに評価された、解決済みの Recipe メタデータを保持します。 |
追加のプロパティは許可されません。
path-template-context.parent_boundary
directory: と subDirectory: の両方で使用できます。親境界の解決済みの値です。深さ優先の走査によって設定され、各境界のテンプレートはその親の解決済みの値を使って評価されます。子はここで自身の値を参照することはありません。最上位の境界には親がないため、そこで parent_boundary の下のキーを読み取るとビルドが停止し、その境界、テンプレートフィールド、欠落しているキーが示されます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
directory | string | いいえ | 親の評価済みの directory 文字列です。 |
boundary_name | string | いいえ | 親の名前です(release.spec.boundaries のマップキー)。 |
parameters | object | いいえ | Release のパラメーターマップで、.parameters が持つものと同じマップです。 |
annotations | string のマップ | いいえ | カスケードの解決後の、親境界のアノテーションです。 |
追加のプロパティは許可されません。
path-template-context.manifest
directory: と subDirectory: の両方で使用できます。component ごとに評価された、解決済みの Recipe メタデータを保持します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
recipe_name | string | いいえ | component ごとの検索で得られた、解決済みの Recipe の名前です。 |
追加のプロパティは許可されません。