Aggrega カタログ(Feature)スキーマ
自動生成されたリファレンスです。手動で編集しないでください。公開されている JSON Schema から再生成してください。
スキーマ ID: https://aggrega.ai/schemas/feature-v1beta1.schema.json
コンポーネントに動的にバインドされる、モジュール式の運用機能です。
Feature エンティティのオーサリングに関する解説は Feature オーサリングリファレンスを参照してください。このページでは、そのリファレンスが説明する構造スキーマを記載します。
トップレベルの型: object
プロパティ
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
apiVersion | const “aggrega.ai/v1beta1” | はい | 定数: "aggrega.ai/v1beta1" |
kind | const “Feature” | はい | 定数: "Feature" |
metadata | object | はい | |
spec | object | はい | カタログの Feature に対する検証、ターゲティング、相互運用性の契約です。スキーマで記述する自由形式の柱(values、infra、provides)、固定形状の柱(usesSchema の依存ソケット、featuresSchema のアタッチメントスロット)、コンポーネントのターゲティング(appliesTo と appliesToAnyOf)、および相互運用性の制御から構成されます。 |
追加のプロパティは許可されません。
feature.metadata
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
name | string | はい | 1 文字以上。 |
version | string | はい | feature の厳密なセマンティックバージョニング(例: 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 での発見性を高めるための説明的なキーワードの一覧です。 |
labels | object | いいえ | Feature のダックタイピング用ラベルです。予約ラベル ‘feature.aggrega.ai/kind’ に値 ‘secret’ を指定すると、作成者とそれを表示するツールに対して、この Feature が認証情報の Feature であることを示します。認証情報の Feature と通常の Feature は、同じアタッチメント面の下で同じ方法でアタッチされます。アタッチメントが何を生成するかは、ラベルではなく、Manifest がその型を対応付ける FeatureRecipe によって決まります。 |
annotations | string のマップ | いいえ | Domain 2 で Platform Architect が記述する、不変で固有のフィーチャー特性です。.context.annotations.catalog バケットへ継承されます。 |
追加のプロパティは許可されません。
feature.metadata.maintainers[]
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
name | string | はい | |
email | string | いいえ | |
url | string | いいえ |
追加のプロパティは許可されません。
feature.metadata.labels
Feature のダックタイピング用ラベルです。予約ラベル ‘feature.aggrega.ai/kind’ に値 ‘secret’ を指定すると、作成者とそれを表示するツールに対して、この Feature が認証情報の Feature であることを示します。認証情報の Feature と通常の Feature は、同じアタッチメント面の下で同じ方法でアタッチされます。アタッチメントが何を生成するかは、ラベルではなく、Manifest がその型を対応付ける FeatureRecipe によって決まります。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
feature.aggrega.ai/kind | string (enum) | いいえ | Feature の種類ラベルです。値 ‘secret’ は、この Feature が認証情報の Feature であることを示します。使用できる値: "secret" |
feature.spec
カタログの Feature に対する検証、ターゲティング、相互運用性の契約です。スキーマで記述する自由形式の柱(values、infra、provides)、固定形状の柱(usesSchema の依存ソケット、featuresSchema のアタッチメントスロット)、コンポーネントのターゲティング(appliesTo と appliesToAnyOf)、および相互運用性の制御から構成されます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
extends | string | いいえ | この Feature が継承する基底 Feature への参照です。基底は、Feature が公開されるレジストリ座標ではなく metadata.name で指定し、すべてのカタログ参照と同じ 3 つのバージョン形式を取ります。最も高い利用可能なリリースを指す無修飾形式(core/queue)、完全一致(core/queue:1.0.0)、またはキャレット範囲(core/queue:^1.0.0)です。継承されるのはメタデータだけではありません。基底の metadata.labels と metadata.annotations、appliesTo と appliesToAnyOf のセレクタ、interoperability ブロック、usesSchema と featuresSchema はすべて下方へマージされ、schema 上の JSON Schema 2020-12 の宣言は自動的にマージされます。共有されるキーでは子自身の値が優先され、識別フィールドは決して継承されません。 |
featuresSchema | object のマップ | いいえ | 宣言的なアタッチメントスロットの定義です。この Feature が、さらに別の Feature のアタッチを想定する名前付きのバインディングポイントを表します。スロットは、どのフィルがそれにバインドできるか(selector)と、フィルの素材をどのように渡せるか(inject)を制約します。フィル自身の Feature が、その values と infra の契約を所有します。スロットを宣言してもアタッチメントブロックが閉じられることはなく、作成者はどのスロットも宣言していない名前で Feature をアタッチできます。スロットはバインディングポイントであり、依存ソケットではありません。別のトポロジーサーフェスは usesSchema が宣言します。 |
appliesTo | string | いいえ | Components に一致する Kubernetes 形式のラベルセレクタ文字列です。カンマ区切りの要件はすべて満たされる必要があります(AND)。サポートされる形式は key=value、key!=value、key in (v1, v2)、key notin (v1, v2)、無修飾の key(ラベルが存在する)、!key(ラベルが存在しない)です。例:“tier in (critical, production), !legacy”。空または存在しないセレクタは制約を宣言しません。セレクタはこの Feature のアタッチメントが評価されるたびにこれらの形式に照らして読み取られ、形式外の要件があるとそれを示してビルドが停止します。対象は、空の要件(先頭、末尾、または重複したカンマ)や、空白または = ! ( ) とカンマのいずれかを含むキーです。そのため “!tier=frontend” は拒否され、値を除外するには tier!=frontend と書きます。値は演算子の後のテキストであり、どのような文字を含んでいてもかまいません。このフィールドのパターンは、アタッチメントが評価される前に、いくつかの不正な形のみを拒否します。パターン: ^(?:[^()]*[()][\s\S]*|[ \t]*(?:![ \t]*[^,]*[^ \t,][^,]*|[^ \t,!][^,]*)?(?:,[ \t]*(?:![ \t]*[^,]*[^ \t,][^,]*|[^ \t,!][^,]*)?)*)$。 |
appliesToAnyOf | string または string[] の map | いいえ | セレクタのリストです。いずれか(ANY)の項目が一致すれば Feature が適用されます(OR ロジック)。各項目は、ラベルセレクタ文字列(appliesTo と同じ文法。文字列内の要件は AND で結合されます)か、すべてのペアが一致する必要があるフラットなキーと値の map(等価比較のみ)のいずれかです。 |
interoperability | object | いいえ | 高度な運用上の安全性と相互運用性の制御です。 |
usesSchema | object のマップ | いいえ | このエンティティが宣言する依存ソケットで、ソケット名をキーとします。ソケットを通じて張られる各接続は、そのソケットの宣言(セレクタと、許可する inject メカニズム)に照らしてチェックされます。キー: 1 文字以上の英字、数字、アンダースコア、ハイフン。ドットは使用できません。パターン: ^[a-zA-Z0-9_-]+$。 |
schema | object | いいえ | 自由形式の柱を扱う JSON Schema 2020-12 のコンテンツです。values(Developer の領域。Developer が Aggregate 内の Feature アタッチメントごとに設定する、アプリケーションの形を表すパラメータ)、infra(Operator の領域。Release が提供する物理的なサイジングの設定項目)、provides(この Feature がトポロジーパイプを通じてコンシューマーに公開する下流のコンテキストキー)です。コンテンツの形によるディスパッチで、3 つの記述モードを受け付けます。(1) インラインコンテンツ(コンパクト形式、JSON Schema YAML、またはその混在を持つ YAML map)。(2) {$import: |
assertions | string のマップ | いいえ | ビルド時のフィールド間検証です。各エントリは名前付きのアサーションで、キーはエラーメッセージに表示される安定したルール識別子、値は {{ fail "message" }} による停止セマンティクスを持つ Go テンプレート文字列です。エンティティごとの複数の名前付きアサーションは、インスタンスごとに作成者が宣言した順序で評価され、最初に失敗したアサーションがビルドを停止します。Feature のアサーションは解決と静的解析の後、レンダリング前に評価され、契約のアーキテクチャ上の不変条件を表します。テンプレートコンテキスト:.values / .infra / .uses / .features / .metadata。評価器は missingkey=error を使用するため、未定義のキーへの参照は no-such-key 診断で停止します。無修飾の参照はフォールバックが実行される前に停止するため、このサーフェスでは単純な default ではオプションフィールドのフォールバックを提供できません。参照を hasKey でガードするか、存在チェックを直接行う optional ヘルパーを使用してください。index でキーを読み取っても同様に提供できません。index は map が保持していないキーに対して、そのキーを示して停止します。 |
追加のプロパティは許可されません。
feature.spec.interoperability
高度な運用上の安全性と相互運用性の制御です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
conflictsWith | string[] | いいえ | この Feature と同じコンポーネントに同時に到達できない Features の名前で、それぞれアタッチメントの type が Feature を指すのと同じ方法で書きます。1 つのコンポーネントがこの Feature とここに挙げた Feature の両方を持つことになると、レンダリングの前にビルドが停止します。各 Feature がコンポーネント上、それを含むサブシステムや境界上、Release のコンポーネントエントリ上、またはアノテーション駆動の展開のいずれでアタッチされたかは問いません。宣言は 1 つで十分であり、停止には相手の Feature がこの Feature を挙げている必要はありません。名前はバージョンを取り除いて比較されるため、エントリは指定した Feature のすべてのバージョンに一致します。コンポーネントを共有しない兄弟の境界にアタッチされた 2 つの Features は出会うことがなく、停止しません。 |
追加のプロパティは許可されません。