Aggrega Wasm Importer Socket スキーマ
自動生成されたリファレンスです。手動で編集しないでください。公開されている JSON Schema から再生成してください。
スキーマ ID: https://aggrega.ai/schemas/wasm-import-v1beta1.schema.json
インポーター プラグインのソケットが受け取るワイヤー形式 (ImportInput) と出力するワイヤー形式 (ImportOutput) です。インポーターは外部のインフラストラクチャ記述を Aggrega のエンティティに変換します。指定された形式のソースのバイト列を読み取り、ソースの各ノードをカタログのエンティティにマッピングし、出力したエンティティ、行ったマッピングの判断、発生させた診断、生成したスキャフォールド ファイルを返します。インポーターは、扱う形式をディスクリプタ内で import:
次のいずれかの形
ImportInputImportOutput
定義
ImportInput
インポーターのゲストが受け取るペイロードです。バイト列の読み取り方法を選択するソース形式、主ソースのバイト列とその読み取り元ファイルの名前、複数ファイルのインポートにおける名前付きソース、インポーター固有の動作のためにコンシューマーが提供する任意の不透明なオプションドキュメント、ワークスペースのカタログが保持する Components のビュー、およびインポートが下書きの対象とするターゲットを含みます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
format | string | はい | インポートするソース形式の名前で、インポーターが公開する import: |
bytes | string | はい | インポートする主ソースのバイト列で、インポーターは指定された形式として読み取ります。インポートのソースが 1 つのファイルの場合はファイル全体、ディレクトリの場合は空となり、そのファイルは代わりに名前付きソースとして渡されます。各キットはこれを独自のフィールド型で保持します。その型がバイト型であれば生のまま、文字列であれば base64 エンコードされ、インポーターがデコードして復元します。生成されたエンコーダーが、フィールドとワイヤ上でバイト列を運ぶ形式との間を変換します。 |
name | string | いいえ | インポートのソースの名前で、前にディレクトリを含みません。これにより、インポーターは報告する内容と作成する内容の中でソースを示せます。ソースが 1 つのファイルの場合は、そのファイルのベース名です。主バイト列は名前付きソースとしては届かないため、これが主バイト列の持つ唯一の名前です。ソースがディレクトリの場合は、そのディレクトリのベース名で、ディレクトリのファイルは引き続きそれぞれ独自の名前で名前付きソースとして届き、主バイト列は空になります。ソースに与える名前がない場合は存在しません。 |
sources | ImportSource[] | いいえ | 名前付きソースで、それぞれが独自のバイト列を持ち、名前順にソートされた 1 つのリストにまとめられます。インポートのソースがディレクトリの場合、インポーターが宣言したファイルパターンで選択されたファイルごとに 1 つ存在し、ディレクトリ内のスラッシュ区切りのパスで命名されます。インポーターを設定するアタッチメントが with.sources に宣言したファイルもここに含まれ、それぞれベース名で命名されます。ディレクトリから読み取ったファイルとこれらのファイルが同じ名前を持つインポートは、ホストが拒否します。どちらも何も提供しない場合は存在しません。 |
settings | any | いいえ | インポーター固有の動作のためにコンシューマーが提供する不透明なインポートオプションドキュメントです。ホストはこれを解釈せずにそのまま渡し、インポーターは自身が文書化した形で読み取ります。コンシューマーがオプションを提供しない場合は存在しません。 |
catalog | CatalogProjection | いいえ | ワークスペース自身のカタログ(インポーター自体が選択されたカタログ)が保持する Components のビューで、インポーターがソースノードをカタログエンティティにマッピングする際に候補として評価できるようにします。ホストはそのローカルカタログのみから構築し、名前、バージョン、ラベル、宣言された構造だけを含みます。値、デフォルト、シークレットは決して含みません。順序は固定されているため、1 つのカタログからは 1 つのバイト列が得られます。カタログが Component を保持しない場合は存在しません。 |
target | string | いいえ | インポートが下書きの対象とするプロバイダー機能で、compose や helm などです。インポートに指定されたターゲット、またはターゲットを指定せずに以前のインポートを更新するインポートの場合は、その以前のインポートが記録したターゲットです。インポーターは、そのターゲットだけが必要とするものを宣言として下書きに書き込み、別のターゲットだけが必要とするものは省きます。ホストは、ワークスペースのカタログの Recipe がそれにバインドされることを確認したうえで、指定されたとおりに受け渡します。インポートがターゲットを指定しない場合は存在しません。 |
追加のプロパティは許可されません。
CatalogProjection
インポーターから見たワークスペースのカタログです。カタログが保持する Component ごとに 1 つのエントリがあり、それぞれインポーターが候補をスコアリングする際に評価するメタデータを含みます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
components | CatalogComponent[] | はい | カタログが保持する Component 名ごとに 1 つのエントリで、名前順にソートされます。カタログが 1 つの Component の複数バージョンを保持する場合、そのエントリは、バージョンを指定せずに Component を指定する参照が解決されるバージョンを記述します。 |
追加のプロパティは許可されません。
CatalogComponent
ワークスペースのカタログの 1 つの Component です。名前とバージョン、ラベル、values と provides が宣言するキー名、および依存関係のために宣言するソケットを含みます。別の Component を拡張する Component は、自身が宣言するものに加えて継承したものも含みます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
name | string | はい | metadata.name で宣言された Component の名前です。Aggregate がこの Component を参照する際に使う名前です。 |
version | string | はい | metadata.version で宣言された Component のバージョンです。 |
labels | string のマップ | いいえ | 文字列から文字列へのマップとしての Component のラベルです。ラベルを持たない場合は存在しません。 |
values | string[] | いいえ | Component の values が宣言するトップレベルのキー名で、ソートされています。名前のみのリストであり、値やデフォルトは決して含みません。values がキーを宣言しない場合は存在しません。 |
provides | string[] | いいえ | Component の provides が宣言するトップレベルのキー名で、ソートされています。名前のみのリストであり、値は決して含みません。provides がキーを宣言しない場合は存在しません。 |
sockets | CatalogSocket[] | いいえ | Component が依存関係のために宣言するソケットで、宣言順に並びます。別の Component を拡張する Component では、継承したソケットが拡張元の Component の宣言順で先に来て、その後に追加したソケットが続きます。何も宣言しない場合は存在しません。 |
追加のプロパティは許可されません。
CatalogSocket
カタログの Component が依存関係のために宣言する 1 つのソケットです。ソケットの名前と、そのソケットを通じて接続される依存関係が満たす必要のあるラベルセレクターを含みます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
name | string | はい | Component の usesSchema で宣言されたソケットの名前です。 |
selector | string | はい | ソケットのラベルセレクターで、Component が記述した Kubernetes 形式の文法のまま、そのまま保持されます。このソケットを通じて接続される依存関係が持つ必要のあるラベルです。 |
追加のプロパティは許可されません。
ImportSource
複数ファイルまたはディレクトリのインポートにおける 1 つの名前付きソースです。ソースの位置を示す名前と、そのバイト列を含みます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
name | string | はい | インポート内でのこのソースの名前で、相対ファイルパスなどです。 |
bytes | string | はい | このソースのバイト列です。各キットはこれを独自のフィールド型で保持します。その型がバイト型であれば生のまま、文字列であれば base64 エンコードされ、インポーターがデコードして復元します。生成されたエンコーダーが、フィールドとワイヤ上でバイト列を運ぶ形式との間を変換します。 |
追加のプロパティは許可されません。
ImportOutput
インポーターのゲストが返すペイロードです。インポートが生成したエンティティ、その背後にあるマッピングの判断、インポートが発生させた診断、および生成したスキャフォールドファイルを含みます。すべてのフィールドは任意であるため、何も解決しなかったインポートは診断のみを返すことができます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
entities | EmittedEntity[] | いいえ | インポートが生成したエンティティで、それぞれ既存のカタログエンティティへの参照、または下書きされたエンティティ本体のいずれかです。インポートがエンティティを出力しなかった場合は存在しません。 |
decisions | ImportDecision[] | いいえ | インポートが行ったマッピングの判断で、解決したソースノードごとに 1 つあり、評価した候補と行った選択を記録します。インポートが判断を記録しなかった場合は存在しません。 |
diagnostics | Diagnostic[] | いいえ | インポートが発生させた診断です。たとえば未解決のソースノードや曖昧なマッピングなどです。インポートが何も生成しなかった場合は存在しません。 |
files | ScaffoldFile[] | いいえ | インポートがエンティティとともに生成したスキャフォールドファイルで、スターター aggregate や readme などです。インポートがファイルを生成しなかった場合は存在しません。 |
error | string | いいえ | ゲストは実行されたものの操作を完了できなかった場合に設定される失敗メッセージです。成功時には存在しません。出力に含まれる診断とは別のものです。診断は結果を生成した実行中に見つかった問題を報告し、error は操作自体が完了しなかったことを報告します。ホストは error が存在する場合、プラグイン呼び出しの失敗として扱います。 |
追加のプロパティは許可されません。
EmittedEntity
インポートが生成した 1 つのエンティティです。その種類、名前、および出力方法(既存のカタログエンティティへの参照、または新たに下書きされたエンティティ本体)を含みます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
kind | string | はい | 出力されたエンティティの種類です。コアインポーターは Component、Aggregate、Release を出力します。読み取り側はそれ以外の種類も許容します。 |
name | string | はい | 出力されたエンティティの名前です。 |
mode | string (enum) | はい | エンティティの出力方法です。reference は既存のカタログエンティティを名前で指し、draft は新たに下書きされたエンティティ本体を含みます。許可される値: "reference"、"draft" |
body | string | いいえ | 下書きされたエンティティの生の YAML 本体です。純粋な参照の場合は空で、参照はエンティティを下書きするのではなく既存のエンティティを指定します。 |
labels | string のマップ | いいえ | 出力されたエンティティに付与するラベルで、文字列から文字列へのマップです。コアインポーターはこれを空のままにします。 |
annotations | string のマップ | いいえ | 出力されたエンティティに付与するアノテーションで、文字列から文字列へのマップです。コアインポーターはこれを空のままにします。 |
sourceRef | string | いいえ | このエンティティの出力元となったソースノードへの参照で、読み取り側がエンティティをインポートされたソース内の起点までたどれるようにします。 |
decisionRef | string | いいえ | このエンティティを生成したマッピングの判断への参照で、評価された候補と行われた選択にエンティティを結び付けます。 |
追加のプロパティは許可されません。
ImportDecision
1 つのマッピング決定です。インポーターが解決したソースノード、検討した候補のカタログエンティティ、選択した候補、およびその選択の根拠を含みます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
sourceNode | DecisionSourceNode | はい | この決定が解決したソースノードです。インポーターがソースから読み取り、カタログエンティティにマッピングしたノードです。 |
candidates | ImportCandidate[] | いいえ | インポーターがこのソースノードに対して検討した候補のカタログエンティティです。それぞれにスコアと、そのスコアの根拠となるシグナルごとの内訳が含まれます。インポーターが候補を検討しなかった場合は存在しません。 |
chosen | DecisionChoice | いいえ | インポーターがこのソースノードに対して選択した候補と、その出力方法です。インポーターが選択を行わなかった場合は存在しません。 |
rationale | string | いいえ | インポーターがこの選択を行った理由を人が読める形で説明したものです。 |
swapHint | string | いいえ | 選択されたマッピングを別の候補に置き換える方法を示すヒントです。これにより、読み手は決定を修正できます。 |
追加のプロパティは許可されません。
DecisionSourceNode
マッピング決定が解決したソースノードです。識別子、ソースが付けている型、およびそのパラメーターの人が読める形の要約を含みます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
id | string | はい | インポートされたソース内でのソースノードの識別子です。 |
type | string | はい | ソースが付けているとおりのソースノードの型です。 |
paramsSummary | string | はい | ソースノードのパラメーターを人が読める形で要約したもので、決定とあわせて表示するためのものです。 |
追加のプロパティは許可されません。
ImportCandidate
インポーターがソースノードに対して検討した 1 つの候補カタログエンティティです。候補のコンポーネント、その総合スコア、スコアが属するマッチティア、およびスコアの根拠となるシグナルごとの内訳を含みます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
componentName | string | はい | 候補のカタログコンポーネントの名前です。 |
score | 数値 | はい | 候補の総合マッチスコアで、シグナルごとの内訳を集計したものです。 |
tier | string | はい | 候補が属するマッチティアで、スコアを大まかに区分した帯です。 |
signals | CandidateSignals | はい | 候補のスコアの根拠となるシグナルごとの内訳です。 |
追加のプロパティは許可されません。
CandidateSignals
候補のスコアの根拠となるシグナルごとの内訳で、一致するシグナルごとに 1 つの寄与を含みます。固定フィールドのオブジェクトであるため、シグナルの集合は安定しており、ワイヤ上の表現は決定的です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
table | 数値 | はい | マッピングテーブルシグナルによるスコアへの寄与です。 |
category | 数値 | はい | カテゴリシグナルによるスコアへの寄与です。 |
domainLabels | 数値 | はい | ドメインラベルシグナルによるスコアへの寄与です。 |
shape | 数値 | はい | 形状シグナルによるスコアへの寄与です。 |
name | 数値 | はい | 名前シグナルによるスコアへの寄与です。 |
追加のプロパティは許可されません。
DecisionChoice
マッピング決定が選択した候補です。対象のカタログエンティティ、その出力方法、および選択のマッチティアを含みます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
target | string | はい | 選択された対象カタログエンティティの名前です。 |
mode | string | はい | 選択された対象の出力方法で、出力エンティティのモードと対応します。既存エンティティへの参照か、新たに起草された本体のいずれかです。 |
tier | string | はい | 選択された対象のマッチティアです。 |
追加のプロパティは許可されません。
ScaffoldFile
インポートが生成した 1 つのスキャフォールドファイルです。インポート出力ルートからの相対パスと、ファイルの内容を含みます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
path | string | はい | スキャフォールドファイルのパスで、インポート出力ルートからの相対パスです。 |
content | string | はい | スキャフォールドファイルの内容です。 |
追加のプロパティは許可されません。