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

エンティティリファレンスの概要

Aggrega のオーサリング語彙は、Aggregate、Component、Feature、Recipe、FeatureRecipe、Plugin、Manifest、Release、SchemaLibrary、MappingLibrary、WorkloadLibrary、ArtifactLibrary で構成され、さらに Recipe の合成された入力の中に埋め込まれる、プラットフォームが所有する Workload kind があります。すべてのエンティティは JSON Schema に準拠する YAML ドキュメントです。このリファレンスが説明するすべてのフィールド、キーワード、エンティティ間の参照は、そのオーサリング契約の一部です。

この章群はオーサリングの対象範囲を扱います。各エンティティがどのフィールドを受け付けるか、各フィールドが作成者にとって何を意味するか、フィールドがエンティティ間でどのように相互作用するか(Recipe の implements: が実装する Component を指定すること、Release の manifest: による Manifest へのポインタ、Component の featuresSchema で宣言されたスロットを参照する Workload の containers.<name>.attachments)です。各エンティティの概念上の役割、つまり分類体系がなぜその形をしているのか、どのドメインがどのエンティティを所有するのか、4 つのドメインがオーサリング上の関心事をどのように分離するのかは、../architecture/04-entity-taxonomy.md で説明しています。3 つの Recipe 入力種別の 1 つとしての Workload kind のアーキテクチャ上の役割は、../architecture/16-recipe-input-composition.md で説明しています。

このリファレンスの構成

オーサリング語彙は 2 つの資料で説明されており、それぞれ異なる疑問に答えます。

上に挙げたすべての kind には、生成されたスキーマリファレンスがあります。 これらのページはコンパイラ自身が公開するスキーマから生成されており、schema/README.md がエンティティ kind、プラグインのワイヤ形式、ワークスペースファイルを含む全体の索引になっています。「このドキュメントに何を含められるか」を知るにはスキーマリファレンスを参照してください。すべてのフィールド、その型、必須かどうか、エンベロープが強制する制約がわかります。

以下のページはオーサリングガイドです。 スキーマでは伝えられないことを説明するために手作業で書かれています。kind が何のためにあるのか、そのフィールドが他の kind とどのように相互作用するのか、どの状況にどのオーサリング形式が適しているのか、標準ライブラリのカタログが従う慣例は何か、です。「どのように書くのか、なぜこの形なのか」を知るにはオーサリングガイドを参照してください。

エンティティ別リファレンス

  • Aggregate — 開発者の宣言的な意図を表す成果物です。コンポーネント、uses によるそのトポロジー、環境ごとの差異のためのパラメーター契約、Feature のアタッチメントを宣言します。
  • Component — Platform Architect が作成するカタログエンティティで、再利用可能なコンポーネントの種類を定義します。values と infra のスキーマ(それぞれ簡潔形式または完全形式の JSON Schema 2020-12 宣言)、provides 出力契約、usesSchema 受信エッジ契約、featuresSchema による認証情報スロットを宣言します。
  • Feature — Platform Architect が作成するカタログエンティティで、横断的な関心事(監視サイドカー、データマスキング、ルーティングポリシー)を表します。values と infra のスキーマ(それぞれ JSON Schema 2020-12 宣言)、appliesTo アタッチメントセレクター、相互運用性の制約を宣言します。
  • Recipe — Ops が作成する、Component から特定のプロバイダーへの変換です。3 つの入力種別(source: + valuesMapping:、workload:、artifacts:。いずれも統一されたファイルインポート語彙に従い、インラインの内容または $import: を受け付けます)と、呼び出し側注入の契約を構成する provides ブロックを組み合わせます。
  • FeatureRecipe — Ops が作成する、Feature から特定のプロバイダーへの変換です。Recipe と同じ 3 つの入力種別の契約に加えて、呼び出し側の変数を書き換えるために inject パイプに割り込む injectMapping を使用します。
  • Plugin — コンテンツアドレス指定される WebAssembly プラグインです。実装する 1 つのソケット型(provider、linter、pipeline-step、governance、cli、parser、importer のいずれか)、ABI バージョン、そのソケット型が提供する機能を宣言します。プロバイダーのレンダリングを行う Plugin(pluginType: provider)は、提供するプロバイダー名を spec.provider.capabilities で宣言し、プロバイダーソケットのメタデータである workloadSchema と wellKnownAnnotations を同じ spec.provider ブロックに持ちます。
  • Manifest — プロジェクトごとのマッピング表です。抽象的な Component と Feature の型を、components と features の下で具体的な Recipe と FeatureRecipe の URI にバインドします。検索順序は name > バージョン付き type > バージョンなし type です。
  • Release — 環境ごとのデプロイメントルーターです。Aggregate を Manifest にバインドし、コンポーネントを物理的な境界にマッピングし、環境ごとのパラメーター値を与え、Ops が管理する Features をアタッチします。

ライブラリエンティティ

4 つのライブラリ kind は Tier 3、つまりオプトインの再利用エンティティです。カタログは、同じ内容がエンティティ間で繰り返される場合にライブラリを宣言し、そうでなければライブラリなしで提供されます。各ライブラリは 1 種類の内容を保持し、参照内のフラグメント(#/schemas/、#/mappings/、#/workloads/、#/artifacts/)が、その参照がどのライブラリを指すかを示します。

  • SchemaLibrary — 再利用可能な JSON Schema 2020-12 の定義と、任意のパラメーター化されたヘルパーです。Component または Feature のスキーマから $ref: <Library>#/schemas/<name> で参照されます。
  • MappingLibrary — 再利用可能な Go テンプレートの断片です。Recipe または FeatureRecipe の valuesMapping: に $import: <Library>#/mappings/<name> でインポートされます。
  • WorkloadLibrary — 再利用可能な Workload の内容です。Recipe または FeatureRecipe の workload: に $import: <Library>#/workloads/<name> でインポートされます。
  • ArtifactLibrary — 補助的な出力ファイルの再利用可能なバンドルです。Recipe または FeatureRecipe の artifacts: に $import: <Library>#/artifacts/<name> でインポートされます。バンドルが再利用の単位であり、1 回のインポートはバンドル内のファイルごとに 1 つの出力に展開されます。

プラットフォームが所有する kind

  • Workload — プラットフォームが所有するコンパイラの kind です(ユーザーが作成するカタログエンティティではありません)。Recipe の workload: フィールドに(インラインまたは $import: 経由で)埋め込まれ、プロバイダーがプロバイダーネイティブのマニフェストに合成するデプロイメントの形を記述します。