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

Aggrega テンプレートコンテキストのスキーマ

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

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

コンパイラがレンダリング中に組み立て、Recipe および FeatureRecipe のテンプレートに渡すビューです。アタッチメントの FeatureRecipe をレンダリングする場合、コンパイラはさらに、.attachment_name と .inject にアタッチメントスコープのコンテキストを、.context.render_facts にホストのプロバイダーがホストのレンダリングについて報告した内容を設定し、アタッチメント自身のリソースを生成するテンプレートでは、.context.used_by にそのホストを使用するコンポーネントを設定します。境界スコープの FeatureRecipe(spec.executionScope: boundary)では、境界に対して 1 回実行されるテンプレート(locals、provides、source、valuesMapping、artifacts、pipeline のステップなど)において、.context、.workload、.attachment_name、.inject、.inject_raw の各ピラーは存在せず、代わりに .boundary.* ピラーが設定されます。プロパティの末尾にある boundary ブロックを参照してください。その injectMapping は、アタッチメントが到達する各コンポーネントについて、そのコンポーネントのコンテキストで 1 回ずつ実行されるため、.context.* と .attachment_name を読み取り、そこでは .boundary は設定されません。これはディスクには永続化されず、レンダリング中のコンパイラのメモリ内にのみ存在します。このスキーマは、コンパイラと Ops のテンプレート作成者との間の契約を記述します。

ベースレンダリングの各ステージで利用できるものを、ステージの実行順に示します。

  • Provides の評価(locals プリアンブル、次に provides): ノードローカルのピラーのみ。locals のエントリは、同じブロック内でそれより上にあるエントリを読み取ります。provides テンプレートは、ノードの解決済みの .locals 全体を読み取ります。自己参照は禁止されています(provides のエントリが別のエントリを読み取ることはありません)。
  • ソースの解決(locals の公開 + source の評価): すべてのピラー。.source と .workload は存在しません。ここでそれらの locals が .locals に公開され、次に source: がそれに対して評価されます。
  • 値のマッピング(valuesMapping): すべてのピラー + .source。.workload は存在しません。
  • Workload の合成(workload の評価): すべてのピラー + .source。.workload は評価中です(自己参照には存在しません)。
  • アーティファクトの評価(artifacts): すべてのピラー + .source + .workload(最も完全なコンテキスト)。

トップレベルの型: object

プロパティ

プロパティ種類必須説明
contextobjectはいコンパイラが組み立てる実行コンテキストで、アイデンティティ、トポロジー、配信のデータを提供します。
valuesobjectはいこのノードの不透明なコグニティブペイロードで、解決時にスキーマバリデーターによって検証済みです。変更されずにそのまま渡されます。
infraobjectはいこのノードのために Release から注入される物理的なサイジングペイロードです。Developer を完全に経由しません。
localsstring のマップはいRecipe 自身のプライベートな状態です(例: primary_compute、volumes_path)。locals プリアンブルで、そのノードの provides より先に評価され、ソース解決の段階でこのピラーに公開されます。各エントリは Go テンプレートで、同じブロック内でそれまでに解決されたエントリを持つ自己完結したノードローカルのコンテキストに対して評価されます。そのため、エントリは自分より上で定義された兄弟エントリを読むことができ(MAY)、その兄弟の解決済みの値を受け取ります。あるエントリが別のエントリを読む箇所では、記述順序が契約の一部です。定義をそれを読むエントリより下に移動するとビルドが壊れます。後続のエントリ、またはブロックが宣言していないキーへの ‘.locals.’ 参照は停止します。このチェックはキー入力ではなく参照が解決されるパスを読むため、直接の形式、’{{ with .locals }}’ ブロック内での読み取り、‘.locals’ に直接バインドされた変数を通じた読み取り、括弧で囲んだブロックから読むキー(‘(.locals).’ や ’($.locals).’)のいずれも対象になります。対象にならない書き方が 1 つあります。テンプレートのテキストからパスが決まらない参照で、‘index .locals’ や ‘(default dict .locals).’ のような関数を通じて到達するもの、または関数を適用するパイプラインを持つ ‘with’ ブロックや変数バインディングを通じて到達するものです。これは解析されず、その方法で到達した存在しないキーは停止しません。何も出力しないのではなく、リテラルテキスト '' をレンダリングします。唯一の例外は ‘index’ 自体です。どのテンプレートでも、読み取るマップが要求されたキーを持たない場合はキーを示して停止するため、‘index .locals’ を通じて到達した存在しないキーは停止します。locals エントリは ‘.provides’ を読めません。provides(プリアンブルの後の provides 評価時)、source、valuesMapping、workload、artifacts、assertions で利用でき、pipeline[].with(および pipeline[].when)を介して下流の Wasm プラグインでも利用できます。呼び出し側には公開されません。
providesstring のマップいいえRecipe の公開 API 契約です。provides 評価から設定されます。ベースレンダリングの valuesMapping で自己参照に利用できます(例: {{ .provides.host }})。provides テンプレート自体の中では利用できません(provides の自己完結性の不変条件)。呼び出し側は inject キーをこれらの値に対して解決します。
featurestemplate_attachment のマップいいえこのノード上のすべてのアタッチメントで、作成者が付けたインスタンス名をキーとします。運用の Feature、認証情報の Feature、アイデンティティの Feature など、何を生成するかにかかわらず、1 つのピラーがすべてを保持します。アタッチメント間で異なるのは生成するものであり、テンプレートがそれを読む方法ではないためです。Recipe はこれを読んで、アタッチされた機能にレンダリングを適応させ、アタッチメントが公開するものを利用します。ノードの接続の 1 つに書かれたアタッチメントはここに含まれません。それはその接続の下、.context.uses..features. で読まれるため、このピラーを range するテンプレートはノード自身のアタッチメントだけを扱います。
metadataobjectいいえ決定的な命名のためのグローバルなアイデンティティを提供する、Release とコンパイルのメタデータです。すべてのテンプレートブロック(valuesMapping、injectMapping、pipeline with)で利用できます。
attachment_namestringいいえアタッチメントの FeatureRecipe をレンダリングする場合にのみ設定されます。アタッチメントのインスタンス名を含みます。これは所有エンティティの featuresSchema で埋めるスロット、または作成者が付けた自由な名前です(例: ‘admin_password’、‘db_credentials’)。アタッチメントごとに異なる決定的なリソース名を、ホストのコンポーネント名の後に組み立てるために使います。ホストのプロバイダーが helm のようにレンダリング名を報告する場合は ’{{ .context.rendered_name }}-{{ .attachment_name | replace ”_” ”-” }}‘(Kubernetes の名前で許される文字で書かれたホストの名前に、アンダースコアをハイフンに置き換えたアタッチメント名を続けたもの)、ホストのプロバイダーが何も報告しない場合は ’{{ .context.instance_id }}-{{ .attachment_name }}’ です。
injectobjectいいえ作成された inject ブロックを持つアタッチメントの FeatureRecipe をレンダリングする場合にのみ設定されます(例: { env: [ { in: ‘OPENAI_API_KEY’, from: ‘api_token’ } ] })。uses エッジから得られるベースコンポーネントの事前ハイドレート済み配信パイプである .context.inject とは別物です。作成された inject を持たないアタッチメントおよびベースの Recipes では null/不在として評価されます。
inject_rawobject or nullいいえinject ブロックに対する、変更されていない不変の Developer の意図です。ブロックが指定する各メカニズム(env、file、arg、または ssm_param のようなカスタムのもの)はそれぞれ自身の名前の下にあり、書かれたとおりのエントリ(in と、from または value)を書かれた順序で保持します。そのため、.inject_raw.ssm_param は .inject_raw.env がコアのメカニズムを読むのと同じ方法でカスタムのメカニズムを読みます。Developer が inject ブロックを完全に省略した場合は null になります。Ops が inject マッピングによる変更の前に省略を検出する論理チェック(例: {{ if not .inject_raw }})に使います。各エントリがコンポーネント自身のどの values または provides を配信するかは、エントリのテキストからではなく .context.self_inject で読み取ります。
stepsobject のマップいいえパイプラインのステップ間通信です。Wasm パイプラインの ‘with:’ ブロック内でのみ利用できます。各キーはパイプラインのステップ ID で、そのステップがエクスポートした出力を含みます。
sourcestring または object または nullいいえ解決済みの source フィールドの内容です。Recipe のテンプレートでは、ソース解決の段階で Go テンプレート評価後の Recipe の source: フィールドから設定され、values マッピング以降(valuesMapping、workload、artifacts)で利用でき、Recipe に source: がない場合は null になります。FeatureRecipe のテンプレートでは、Go テンプレート評価後の FeatureRecipe 自身の source: フィールドであり、その valuesMapping の前に評価され、valuesMapping とそれ以降に評価されるすべてのテンプレート(omits、workload、artifacts、pipeline ステップ)で読まれます。ホストコンポーネントのものになることはなく、FeatureRecipe に source: がない場合は null です。FeatureRecipe の injectMapping はその source より前に評価され、ホストコンポーネントのものを読みます。文字列形式は URI パス、オブジェクト形式は構造化されたソースです(例: 解決済みバージョンを持つ OCI ディスクリプター)。
workloadworkload-v1beta1.schema.json または nullいいえこのノードのパース済みの Workload spec です。Workload 合成の段階で、Go テンプレート評価と Workload の JSON Schema 検証(workload-v1beta1.schema.json に対する)を経た Recipe の workload: フィールドから設定されます。artifact 評価以降(artifacts)で利用できるため、artifacts は重複なしに workload のフィールドを参照できます(例: .workload.services.metrics.ports.prom を読む ServiceMonitor)。Recipe に workload: ブロックがない場合は null になります。null の値に対して .workload.* を参照しようとするテンプレートは、テンプレート評価時に明確なエラーで失敗します。
boundaryobjectいいえ境界スコープのコンテキスト。spec.executionScope が ‘boundary’ である FeatureRecipe が境界に対して 1 回実行するテンプレートを評価する場合にのみ設定されます。Component スコープの FeatureRecipes はこのピラーを受け取らず、代わりにその context.instance_id、context.inject、context.uses、および .workload ピラーがコンポーネントごとのデータを運びます。境界スコープの FeatureRecipe が境界に対して実行するテンプレートは、それらのコンポーネントごとのピラーの代わりに .boundary.* を受け取ります。その injectMapping は、アタッチメントが到達する各コンポーネントのコンテキストで実行され、それらのコンポーネントごとのピラーを読み取り、このピラーは受け取りません。

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

template-context.context

コンパイラが組み立てる実行コンテキストで、アイデンティティ、トポロジー、配信のデータを提供します。

プロパティ種類必須説明
instance_idstringはい現在のノードの、フラット化された絶対 ID です(例: ‘backend’、またはモジュールインスタンス data-layer の component main-db であれば ‘data-layer-zdmain-db’)。作成されたすべての component 名が満たすアルファベットで書かれます。同じ Aggregate に対しては決定的で、コンパイル間で安定しています。これは、このノードのために構築されるリソースのうち、どの provider も名前を導出しないもの(Recipe から配置される artifact セット、および ID にちなんで名前を付ける provider が合成する workload)の名前であり、それらのいずれかについて公開されるアドレスはこの値から構築されます。
rendered_namestringいいえこのノードにバインドされた provider が、ノードのためにレンダリングするリソースに付ける名前です。作成者が供給した source については、供給されたテンプレート自体がレンダリングに用いる名前(chart が読む release 名など)です。provider が合成する workload については、ノードの ID を書く代わりに名前を導出する場合に、その workload のリソースに付ける名前です(helm provider が同じ release 名で行うように)。この Recipe が、供給された chart や module が宣言したリソース、またはそのような provider が合成したリソースに名前で言及する箇所では、provides エントリ、valuesMapping、workload、artifacts エントリ、pipeline ステップの with や when のいずれであっても、この値を読んでください。provider はその名前を、作成された component 名よりも制限の多いアルファベットで綴ることがあり、その場合は両者が異なるためです。バインドされた provider がそのような名前を導出しない場合は空です。配置された artifact セットのリソース、および ID にちなんで名前を付ける provider が合成した workload のリソースはノードの ID を持つため、それらには ’{{ .context.instance_id }}’ を読んでください。また、独自のリソース名を書いた Recipe はそれらをすでに知っています。バインドされた provider が名前を報告しない箇所でこのキーを読むとビルドが停止し、代わりに何を書くべきかが示されます。この拒否は Recipe がインラインで書くテンプレートが対象です。‘$import’ を通じて供給される valuesMapping、workload、artifacts エントリは、レンダリングがそこに到達したときに初めて解決されるため、それらの内部の参照は停止せずに空の値としてレンダリングされます。component の attachment にバインドされた FeatureRecipe のテンプレートでは、これはホスト側 provider が報告するホスト component の名前です。ホスト自身の Recipe が読む値であり、そこでの instance_id がホストの ID であるのと同様です。そのため attachment はこの値からホストにちなんだリソース名を付け、ホストのプラットフォームが受け入れる名前を得られます。ホストの provider が名前を報告しない場合は空であり、attachment の injectMapping 以外のインラインテンプレートからこれを読むとビルドが停止します。その場合は代わりに ’{{ .context.instance_id }}’ を読んでください。
labelsstring のマップいいえ現在のノードのダックタイピングおよびオントロジーのラベルです。トポロジー構築時に label-transform ロールでアタッチされたガバナンスプラグインが加えた変更も含みます。
annotationsobjectいいえ現在のノードの、カスケードする 3 つのアノテーションバケットです。由来ごとに分けられています。
injectobjectはい事前にハイドレートされ、インターセプトされた配信パイプです。最初は、Developer の inject キーを Target の provides の値に解決する、コンパイラ生成のマップです。injectMapping のディープマージによってその場で変更されます。Base Recipe がレンダリングされる時点では、完全に解決された物理的な文字列を含みます。
usesenriched_edge のマップはい拡張されたトポロジーのエッジマップです。Developer のエイリアス(例: ‘my_db’、‘my_api’)をキーとします。各エントリは、ターゲットノードの ID、解決済みの provides、インジェクションのマッピング、カスケードされたアノテーション、およびその接続に書かれた attachment をコンパイラが組み立てたビューであり、readsTargetRenderFacts を宣言する FeatureRecipe の場合は、ターゲットのレンダリングが報告した内容も含みます。これは生の IR エッジではありません。テンプレートで利用するためにコンパイラが特別に構築した拡張された射影です。このマップを走査するテンプレートは、接続を書かれた順ではなく、キーの順(エイリアスでソートされた順)で参照します。
self_injectobjectはいコンポーネント自身の values と provides のうち、開発者がすでに配信名を与えたものです。コンポーネント自体に書かれた inject: ブロック(.inject_raw が書かれたとおりに保持し、.context.inject が解決済みの形で保持するブロック)から読み取られます。ブロックが指定する各メカニズム(env、file、arg、または ssm_param のようなカスタムのもの)は、開発者が書いた各名前を、そのエントリが配信する自身のキーに対応付けます。これは .context.uses..inject が接続の名前をそれらが読み取るキーに対応付けるのと同じ方法です。from: で書かれたエントリには ‘provides.’、value: テンプレートがコンポーネント自身の values のうちちょうど 1 つだけを読み取り、それ以外は何も読み取らないエントリには ‘values.’ が対応します。 はその値の最上位キーであり、読み取りを囲むテキストや関数が何であっても、値の中をどれだけ深く読み取っても同じです。’{{ .values.config.port }}’、’{{ index .values.config “port” }}’、’{{ (default dict .values.config).port }}’ はいずれも ‘values.config’ に対応します。それ以外のすべてのエントリには空文字列が対応します。リテラル、2 つの値を読み取るテンプレート、values 以外のものを読み取るテンプレート、または values の読み取りをテキストが 1 つの最上位キーに帰属させないテンプレート(’{{ index .values “role” }}‘、values 全体の読み取り、コンテキスト全体を関数に渡すものなど)がこれに当たります。したがって、自身の値をデフォルト名で配信する Recipe は、いずれかのエントリがすでに ‘values.’ に対応しているかを確認し、対応していればデフォルトをスキップします。例: {{ range $name, $key := .context.self_inject.env }}{{ if eq $key “values.role” }}…{{ end }}{{ end }}。開発者がブロックを書いていない場合も存在し、空になります。メカニズムはブロックがそれを指定している場合にのみ現れ、テンプレートがどのように読み取っても名前はソートされた順で現れます。開発者が書いたテキストから読み取られ、解決済みの値から読み取られることはありません。
used_byinbound_edge[]いいえこの component を使用する component です。別の component がこれに対して行う uses 接続ごとに 1 つのエントリがあり、接続元の component が書かれた順、次にそれぞれの uses エントリの順に並びます。2 回接続する component は 2 回現れます。component に attach された FeatureRecipe だけが、attachment 自身のリソースを生成するテンプレート(その valuesMapping、workload、artifacts)でのみ読みます。component 自身の Recipe テンプレート、injectMapping、pipeline ステップの with と when には存在しません。それらの出力はいずれも component 自身のレンダリング出力に入る可能性があり、その出力は誰が接続しても同じままであるためです。各エントリはキーではなくリスト項目であるため、これを走査するテンプレートは呼び出し元をその順で参照します。
render_factsrender_factsいいえこの component をレンダリングした provider が、出力した内容について報告したもの(provider が報告する render facts)で、fact 名をキーとします。provider がどの名前を報告し、各エントリが何を保持するかは、その provider 自身が文書化した契約です。すべての値はエントリが 1 つでもリストであるため、テンプレートは常にそれを走査します。component のレンダリングで複数回の provider 呼び出しが行われ、1 つの名前が複数の呼び出しから報告された場合、そのリストは呼び出しが実行された順に 1 つに結合されます。component がレンダリングされた後、その component に attach された FeatureRecipe のすべてのテンプレート(valuesMapping、workload、artifacts、pipeline ステップの with と when)に存在し、provider が何も報告しない場合は空であるため、誰も報告していない名前は空のリストとして読まれます。component がレンダリングされる前に実行される、component 自身の Recipe テンプレートと injectMapping には存在しません。

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

template-context.context.annotations

現在のノードの、カスケードする 3 つのアノテーションバケットです。由来ごとに分けられています。

プロパティ種類必須説明
releasestring のマップいいえRelease の境界からカスケードする物理的なトポロジーの文字列です。
catalogstring のマップいいえDomain 2 で Platform Architect が作成した、変更不可の固有の特性です。
aggregatestring のマップいいえAggregate のサブシステムからカスケードする認知的なメタデータです。

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

template-context.context.inject

事前にハイドレートされ、インターセプトされた配信パイプです。最初は、Developer の inject キーを Target の provides の値に解決する、コンパイラ生成のマップです。injectMapping のディープマージによってその場で変更されます。Base Recipe がレンダリングされる時点では、完全に解決された物理的な文字列を含みます。

プロパティ種類必須説明
envstring のマップいいえ環境変数による配信です。キーは Developer のローカル変数名、値は解決されたターゲットの文字列です。
filestring のマップいいえファイルマウントによる配信です。キーはローカルのファイルパス、値は解決されたターゲットの文字列です。
argstring のマップいいえコマンドライン引数による配信です。キーはフラグのプレフィックス、値は解決されたターゲットの文字列です。
allstring のマップいいえenv + file + arg + カスタムのメカニズムを事前に計算してフラットにマージしたものです。uses-inject の解決後に設定され、inject マッピングの後に再計算されます。テンプレートは汎用的なシリアライズのために {{ toJson .context.inject.all }} を使用します。
template-context.context.self_inject

コンポーネント自身の values と provides のうち、開発者がすでに配信名を与えたものです。コンポーネント自体に書かれた inject: ブロック(.inject_raw が書かれたとおりに保持し、.context.inject が解決済みの形で保持するブロック)から読み取られます。ブロックが指定する各メカニズム(env、file、arg、または ssm_param のようなカスタムのもの)は、開発者が書いた各名前を、そのエントリが配信する自身のキーに対応付けます。これは .context.uses..inject が接続の名前をそれらが読み取るキーに対応付けるのと同じ方法です。from: で書かれたエントリには ‘provides.’、value: テンプレートがコンポーネント自身の values のうちちょうど 1 つだけを読み取り、それ以外は何も読み取らないエントリには ‘values.’ が対応します。 はその値の最上位キーであり、読み取りを囲むテキストや関数が何であっても、値の中をどれだけ深く読み取っても同じです。’{{ .values.config.port }}’、’{{ index .values.config “port” }}’、’{{ (default dict .values.config).port }}’ はいずれも ‘values.config’ に対応します。それ以外のすべてのエントリには空文字列が対応します。リテラル、2 つの値を読み取るテンプレート、values 以外のものを読み取るテンプレート、または values の読み取りをテキストが 1 つの最上位キーに帰属させないテンプレート(’{{ index .values “role” }}‘、values 全体の読み取り、コンテキスト全体を関数に渡すものなど)がこれに当たります。したがって、自身の値をデフォルト名で配信する Recipe は、いずれかのエントリがすでに ‘values.’ に対応しているかを確認し、対応していればデフォルトをスキップします。例: {{ range $name, $key := .context.self_inject.env }}{{ if eq $key “values.role” }}…{{ end }}{{ end }}。開発者がブロックを書いていない場合も存在し、空になります。メカニズムはブロックがそれを指定している場合にのみ現れ、テンプレートがどのように読み取っても名前はソートされた順で現れます。開発者が書いたテキストから読み取られ、解決済みの値から読み取られることはありません。

プロパティ種類必須説明
envstring のマップいいえ環境変数による配信: キーは開発者の変数名、値は各エントリが配信する自身のキーです。
filestring のマップいいえファイルマウントによる配信: キーは開発者のファイルパス、値は各エントリが配信する自身のキーです。
argstring のマップいいえコマンドライン引数による配信: キーは開発者のフラグプレフィックス、値は各エントリが配信する自身のキーです。

template-context.metadata

決定的な命名のためのグローバルなアイデンティティを提供する、Release とコンパイルのメタデータです。すべてのテンプレートブロック(valuesMapping、injectMapping、pipeline with)で利用できます。

プロパティ種類必須説明
release_namestringいいえビルド対象の Release の名前です(例: ‘prod-billing’)。Ops がグローバルに一意なクラウドリソース名(S3 バケット、IAM ロール)を構築するために使用します。.context.instance_id と組み合わせて、環境間での一意性を保証します。
release_versionstringいいえRelease のセマンティックバージョンです。
environmentstringいいえRelease のメタデータにある環境の文字列です(例: ‘production’、‘local’)。
aggregate_namestringいいえコンパイル対象のルート Aggregate の名前です。

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

template-context.inject

作成された inject ブロックを持つアタッチメントの FeatureRecipe をレンダリングする場合にのみ設定されます(例: { env: [ { in: ‘OPENAI_API_KEY’, from: ‘api_token’ } ] })。uses エッジから得られるベースコンポーネントの事前ハイドレート済み配信パイプである .context.inject とは別物です。作成された inject を持たないアタッチメントおよびベースの Recipes では null/不在として評価されます。

プロパティ種類必須説明
envstring のマップいいえアタッチメントのスコープでの環境変数による受け渡し。
filestring のマップいいえアタッチメントのスコープでのファイルマウントによる受け渡し。
argstring のマップいいえアタッチメントのスコープでの引数による受け渡し。
allstring のマップいいえアタッチメントのすべての inject 方式をコンパイラが生成して統合した、利便用のマージです。

template-context.boundary

境界スコープのコンテキスト。spec.executionScope が ‘boundary’ である FeatureRecipe が境界に対して 1 回実行するテンプレートを評価する場合にのみ設定されます。Component スコープの FeatureRecipes はこのピラーを受け取らず、代わりにその context.instance_id、context.inject、context.uses、および .workload ピラーがコンポーネントごとのデータを運びます。境界スコープの FeatureRecipe が境界に対して実行するテンプレートは、それらのコンポーネントごとのピラーの代わりに .boundary.* を受け取ります。その injectMapping は、アタッチメントが到達する各コンポーネントのコンテキストで実行され、それらのコンポーネントごとのピラーを読み取り、このピラーは受け取りません。

プロパティ種類必須説明
pathstringいいえFeatureRecipe がアタッチされている Release 境界のパスです。最も外側から内側への境界名を ’/’ で連結したものです(例: ‘bridge’、‘bridge/frontend’)。これは境界を指すものであり、その出力が書き込まれるディレクトリではありません。そのディレクトリは境界の directory: が設定します。
assembly_pathstringいいえこのアタッチメント自身の出力が組み立てられるディレクトリで、ビルドの出力ディレクトリからの相対パスです。境界の評価済みの directory: と subDirectory: であり、ビルドがその出力を振り分けるディレクトリです(例: ‘bridge/compose’)。接続のエンドポイントが同じ組み立て済みファイルにレンダリングされる場合に限り、そのエンドポイントの source_assembly_path または target_assembly_path と完全に一致します。そのため FeatureRecipe はそれらを比較して、自身のファイル内の接続と別のファイル内の接続を区別します。不透明なデータであり、コアはこれを解釈しません。
boundary_namestringいいえ境界の名前(release.spec.boundaries のマップキー)。
componentsobjectいいえ境界のサブツリー内のすべての component について、instance_id からエントリへのマップです(再帰的で、ネストされた境界の component も含みます)。各エントリは、その component の解決済みの型 URI、インスタンス ID、および component ごとの provides の評価で得られた提供値を持ちます。
internal_uses_edgesobject[]いいえsource と target がどちらもこの境界のサブツリー内にある uses エッジ。
outgoing_cross_boundary_uses_edgesobject[]いいえソースがこの境界のサブツリー内にあり、ターゲットがその外にある uses エッジです。
incoming_cross_boundary_uses_edgesobject[]いいえtarget がサブツリー内にあり、source が外にある uses エッジ。誰が内向きに呼び出しているかを知る必要がある、ingress 型のアグリゲーターが使います。
cross_boundary_uses_edgesobject[]いいえ境界をまたぐ外向きと内向きのエッジを合わせた、利便用の和集合です。
labelsstring のマップいいえサブツリー内の component のラベルの和集合で、記述された順序が保たれます。
annotationsstring のマップいいえカスケードの解決後の、境界自身の annotations。
feature_attachmentstemplate_attachment[]いいえこの境界に直接アタッチされたアタッチメント(境界スコープ内でのアタッチメント間の参照用)で、.features が持つものと同じアタッチメントの形をとります。

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

定義

inbound_edge

別の component が、アタッチされた FeatureRecipe のレンダリング対象である component に対して行う 1 つの接続です。誰が接続するか、どのソケットを通じて接続するか、接続元の component が何を公開するか、そして接続元が配置される namespace と boundary を表します。すべての値は、コンパイラが解釈せずに運ぶ文字列です。

プロパティ種類必須説明
component_idstringはい接続元の component のフラット化されたインスタンス ID(例: ‘frontend’ や ‘data-layer.etl’)です。subDirectory のパステンプレートが .component_id として読み取る値であり、.context.uses..target が接続のもう一方の端を表記するのと同じ表記です。
socketstringはい接続元の component がこの接続を引き出す usesSchema のカテゴリです(例: ‘databases’、‘apis’)。
providesstring のマップはい接続元の component の解決済み provides で、その Component が宣言するキーに絞り込まれたものです。その component の利用側が .context.uses..provides で読み取るのと同じ値です。何も公開しない場合は空です。
source_namespacestringいいえ接続元の component が配置される namespace です。その component 自身のレンダリングが受け取る aggrega.ai/namespace アノテーションであり、その boundary のアノテーションに、その component 自身の Release エントリのアノテーションを最後に適用したものです。そのため、エントリで namespace を設定またはクリアする component は、boundary の設定ではなく自身の設定を持ちます。これは、boundary スコープの FeatureRecipe が .boundary の uses エッジのリストにある同じ接続のエントリで source_namespace として読み取る値です。接続元の component に namespace が適用されない場合は存在しません。出力する前に if または with でガードしてください。
source_boundary_pathstringいいえ接続元の component を保持する Release boundary のスラッシュ区切りのパスです(例: ‘edge’ や ‘aws-prod/payments’)。boundary スコープの FeatureRecipe が .boundary の uses エッジのリストにある同じ接続のエントリで source_boundary_path として読み取る値です。
render_factsrender_factsいいえ接続元の component のレンダリングが、出力した内容について報告したもので、ファクト名をキーとします。まずその component 自身の provider 呼び出しが報告したファクト、次にその component にアタッチされ、一緒にレンダリングされた各 Feature のファクトがレンダリング順に並び、1 つの名前が複数から得たリストはその順序で 1 つに結合されます。すべての値は、エントリが 1 つであってもリストなので、テンプレートは常にそれを range で走査します。readsCallerRenderFacts を宣言する FeatureRecipe に対してのみ存在します。そのアタッチメントはすべての component のレンダリングが終わってからレンダリングされるため、すべての呼び出し元のレンダリングは完了しています。その場合はすべてのエントリに存在し、provider が何も報告しない呼び出し元では空です。それ以外の FeatureRecipe では存在しません。

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

render_facts

名前をキーとするレンダーファクトです。component をレンダリングした provider が、出力した内容について報告したものです。provider がどの名前を報告し、各エントリが何を保持するかは、その provider 自身が文書化した契約です。コンパイラは、各値がリストであること以外、どちらについても何も知りません。リストはエントリの順序を保持します。オブジェクトのエントリは provider が書いた順序のキーで運ばれ、それを range で走査するテンプレートは、このコンテキスト上のすべてのキー付きマップと同様に、キー順でキーを受け取ります。

自由形式のオブジェクトです。値は any[] です。

template_attachment

テンプレートが読み取る 1 つのアタッチメントで、アタッチされた Feature のインスタンスごとのビューです。すべてのアタッチメントは、何を生成するかにかかわらず同じフィールドを公開するため、.features. は、その名前がエンティティの宣言したスロットであっても自由なアタッチメントであっても、同じように読み取れます。

プロパティ種類必須説明
typestringいいえアタッチされた Feature の Catalog Feature URI です。
resolved_versionstringいいえManifest の解決後の、アタッチされた Feature のバージョンです。このビルドで実際にバインドされたバージョンで、.features..resolved_version として読み取ります。.context.uses..resolved_version と対応しているため、アタッチメントとエッジはバインドされたバージョンを同じ方法で報告します。アタッチメントの型がどの Catalog エンティティにも解決されない場合は空です。
labelsstring のマップいいえアタッチされた Feature の Catalog ラベルで、Feature が宣言した順序のままそのまま運ばれます。フィルタリング、名前の変更、プレフィックスの除去は一切行われないため、テンプレートは Feature の作者が書いたものをそのまま読み取ります。テンプレートは、アタッチされた Feature の名前や URI ではなく、それが何であるかに基づいて分岐できます。.context.uses..labels と対応しています。Feature がラベルを宣言しない場合や、アタッチメントの型がどの Catalog エンティティにも解決されない場合はキー自体が存在しないため、個々のラベルを参照する前に if でガードするか、マップを range で走査してください。
valuesobjectいいえアタッチメント自身の開発者意図のピラーで、アタッチメントの宣言からそのまま運ばれます。
infraobjectいいえアタッチメント自身の運用サイジングのピラーで、アタッチメントの宣言からそのまま運ばれます。
providesstring のマップいいえこのアタッチメントにバインドされた FeatureRecipe の解決済みの公開契約です。出力されたリソースの名前、そのキー、ID、および追加で生成されたキーを含み、利用側には .features..provides. として公開されます。利用側は、アタッチメントの物理的な ID を再導出する代わりにこれらの値を読み取ります。バインドされた FeatureRecipe が何も公開しないアタッチメントは、空のマップではなく provides キー自体を持たないため、テンプレートは個々のキーを参照する前にガードします。

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

enriched_edge

コンパイラが組み立てる、エンリッチされた単一のトポロジーエッジです。ターゲットの解決済みアイデンティティ、provides、およびカスケードされたアノテーションを含みます。

プロパティ種類必須説明
targetstringはいターゲットノードの絶対フラット化 ID(例: ‘data-layer.main-db’)。
socketstringはいこのエッジが属する usesSchema カテゴリ(例: ‘databases’、‘apis’)。
sourcestringいいえソース(コンシューマ)ノードの絶対フラット化 ID。コンシューマごとの出力をコンシューマノードでキー付けする boundary スコープのビューで設定されます。
source_namespacestringいいえソースエンドポイントの生の aggrega.ai/namespace アノテーション(存在しない場合は空)。source と同様に boundary スコープのビューでのみ設定され、component 自身の .context.uses エントリでは空になります。provider のネットワークアイデンティティ解決のための不透明なデータであり、コアはこれを解釈しません。
source_boundary_pathstringいいえソースエンドポイントの boundary パス。それを含む Release 境界の、スラッシュ区切りのパスです(例: ‘bridge/frontend’)。source と同様に boundary スコープのビューでのみ設定され、component 自身の .context.uses エントリでは空になります。
source_assembly_pathstringいいえソースエンドポイントのアセンブリパス。その出力が組み立てられるディレクトリで、ビルドの出力ディレクトリからの相対パスであり、境界の評価済みの directory: と subDirectory: から構成されます(例: ‘bridge/compose’)。アセンブリパスが同じ 2 つのエンドポイントは 1 つの組み立て済みファイルにレンダリングされ、アセンブリパスが .boundary.assembly_path と等しいエンドポイントは、それを読み取る FeatureRecipe 自身の出力が組み立てられるファイルにレンダリングされます。エンドポイントをネットワークに配置する境界スコープの FeatureRecipe は、aggrega.ai/namespace が適用されない場合、これをソースエンドポイントのネットワークとして読み取れます。source と同様に boundary スコープのビューでのみ設定され、component 自身の .context.uses エントリでは空になります。不透明なデータであり、コアはこれを解釈しません。
target_namespacestringいいえターゲットエンドポイントの生の aggrega.ai/namespace アノテーション(存在しない場合は空)。source と同様に boundary スコープのビューでのみ設定され、component 自身の .context.uses エントリでは空になります。provider のネットワークアイデンティティ解決のための不透明なデータです。
target_boundary_pathstringいいえターゲットエンドポイントの boundary パス。それを含む Release 境界の、スラッシュ区切りのパスです(例: ‘bridge/backend’)。source と同様に boundary スコープのビューでのみ設定され、component 自身の .context.uses エントリでは空になります。
target_assembly_pathstringいいえターゲットエンドポイントのアセンブリパス。その出力が組み立てられるディレクトリで、ビルドの出力ディレクトリからの相対パスであり、境界の評価済みの directory: と subDirectory: から構成されます(例: ‘bridge/compose’)。アセンブリパスが .boundary.assembly_path と等しいエンドポイントは、それを読み取る FeatureRecipe 自身の出力が組み立てられるファイルにレンダリングされます。エンドポイントをネットワークに配置する境界スコープの FeatureRecipe は、aggrega.ai/namespace が適用されない場合、これをターゲットエンドポイントのネットワークとして読み取れます。source と同様に boundary スコープのビューでのみ設定され、component 自身の .context.uses エントリでは空になります。不透明なデータであり、コアはこれを解釈しません。
providesstring のマップはいターゲットノードの完全に解決された provides 辞書。provides の評価時、inject のハイドレーションより前に評価されます。
injectobjectはいこのエッジに対する Developer の元の inject マッピング(キー = ローカル変数名、値 = ターゲットの provides キー)。これは生(RAW)のマッピングであり、解決済みの値ではありません。
labelsstring のマップいいえターゲットノードのダックタイピングおよびオントロジーのラベル(トポロジー構築による変更後)。
annotationsobjectいいえターゲットノードの 3 つのカスケードするアノテーションバケット。
componentstringいいえターゲットノードの Catalog component タイプ URI(例: ‘core/postgres’)。
resolved_versionstringいいえターゲットノードの解決済み SemVer。
boundary_pathstringいいえRelease に由来するターゲットノードの物理的な空間階層(例: ‘aws-eks-cluster/backend-ns’)。
origin_featurestringいいえこのエッジが Feature によって自律的に宣言された場合(feature.aggrega.ai/kind: secret のラベルが付いた認証情報 Features を含む)、その Feature のインスタンス名。Developer が宣言したエッジでは null または存在しません。
origin_release真偽値いいえAggregate が宣言したのではなく Release がこの接続を配線した場合に true になります。Aggregate が宣言する接続では存在しません。
valuesobjectいいえこの接続について Aggregate の uses エントリに記述された接続ごとの開発者設定で、そのまま引き継がれます。接続に何もない場合は存在しません。消費側ノードのコンテキストにのみ届き、ターゲットのコンテキストには届きません。
infraobjectいいえこの接続について Release の uses エントリに記述された接続ごとの運用設定で、そのまま引き継がれます。接続に何もない場合は存在しません。消費側ノードのコンテキストにのみ届き、ターゲットのコンテキストには届きません。
featurestemplate_attachment のマップいいえこの接続に記述されたアタッチメント。接続のソケットがそれぞれに宣言するスロット名でキー付けされ、各アタッチメントは .features が持つアタッチメントの形をとります: その type、解決済みバージョン、labels、values、infra、およびそれにバインドされた FeatureRecipe の解決済み provides です。Recipe は接続の認証情報を .context.uses..features..provides. として読むため、複数のターゲットに到達するコンシューマは各ターゲット自身の認証情報を読みます。これらのアタッチメントは消費側ノード自身の .features には決して含まれないため、.features を range してノードのアタッチメントを type で探すテンプレートが接続のアタッチメントに出会うことはありません。テンプレートで range すると、スロットはキー順に並びます。接続に何もない場合は存在しません。
render_factsrender_factsいいえターゲットのレンダーが出力について報告した内容で、ファクト名でキー付けされ、.context.used_by 上の呼び出し元エントリと同じ形をとります: まずターゲット自身の provider 呼び出しが報告したファクト、次にそれにアタッチされ一緒にレンダーされた各 Feature のファクトがレンダー順に並び、1 つの名前が複数から得たリストはその順で 1 つに結合されます。値はエントリが 1 つでも常にリストなので、テンプレートは常にそれを range します。readsTargetRenderFacts を宣言する FeatureRecipe(そのアタッチメントはすべての component のレンダー後にレンダーされるため、すべてのターゲットのレンダーは完了しています)に対する .context.uses にのみ存在し、その場合はすべてのエントリに存在し、provider が何も報告しないターゲットでは空になります。それ以外のすべての FeatureRecipe、パイプラインステップの with と when、component 自身の Recipe テンプレート、および boundary スコープの FeatureRecipe が読むエッジリストには存在しません。

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

enriched_edge.inject

このエッジに対する Developer の元の inject マッピング(キー = ローカル変数名、値 = ターゲットの provides キー)。これは生(RAW)のマッピングであり、解決済みの値ではありません。

プロパティ種類必須説明
envstring のマップいいえ環境変数による配信です。キーはコンシューマーのローカル変数名、値はターゲットの provides キーです。
filestring のマップいいえファイルマウントによる配信です。キーはコンシューマーのローカルファイルパス、値はターゲットの provides キーです。
argstring のマップいいえコマンドライン引数による配信です。キーはコンシューマーのフラグプレフィックス、値はターゲットの provides キーです。

enriched_edge.annotations

ターゲットノードの 3 つのカスケードするアノテーションバケット。

プロパティ種類必須説明
releasestring のマップいいえターゲットノードの Release boundary に由来する物理トポロジー文字列。
catalogstring のマップいいえターゲットノードの Catalog エンティティに由来する不変の特性。
aggregatestring のマップいいえターゲットノードの Aggregate サブシステムに由来する認知メタデータ。

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