APIリファレンス: 2026.06.16

アーティファクトのバージョン

アーティファクト	バージョン
`vantage-operator` チャート	`0.63.7`
`vantage-selfhosted` チャート	`0.63.7`
`vantage-operator` イメージ	`v0.63.7`

Vantage 3.0 セルフホスト版のインストーラーは、単一の Kubernetes カスタムリソース、つまり vantage.abbyy.com/v1alpha1 API グループの Vantage オブジェクトによって制御されます。以下の field は、ユーザーとオペレーターとの間の取り決めを網羅したものです。オペレーターがこのリソースをどのように利用するかの概要については、アーキテクチャを参照してください。インストール手順については、Azure またはセルフマネージド Kubernetes のいずれかを選択してください。

API グループ

グループ	バージョン	リソース
`vantage.abbyy.com`	`v1alpha1`	`Vantage`

Vantage

Vantage は vantages API のスキーマです。

フィールド	型	必須	説明
`apiVersion`	`string`	はい	vantage.abbyy.com/v1alpha1
`kind`	`string`	はい	Vantage
`metadata`	`object`	はい	`metadata` フィールドに含まれるフィールドについては、Kubernetes API のドキュメントを参照してください。
`spec`	`object`	はい	spec は Vantage の望ましい状態を定義します。詳細は `spec` を参照してください。
`status`	`object`	いいえ	status は Vantage の観測された状態を定義します。詳細は `status` を参照してください。

Vantage.spec

spec は Vantage の望ましい状態を定義します。

Field	型	必須	説明
`dnsRecord`	`string`	はい	dnsRecord は Vantage インストール環境の DNS レコードです。形式: `hostname`。
`mailFrom`	`string`	はい	mailFrom は送信メールの差出人として使用するメールアドレスです。形式: `email`。
`platformAdminEmail`	`string`	はい	platformAdminEmail はプラットフォーム管理者のメールアドレスです。形式: `email`。
`secrets`	`object`	はい	secrets はシークレットプロバイダーを選択して設定します。プロバイダーは 1 つだけ指定する必要があります。`secrets` を参照してください。
`updatePolicy`	`object`	はい	updatePolicy は、オペレーターによる Vantage のアップグレードの扱い方を制御します。`updatePolicy` を参照してください。
`vantageVersion`	`string`	はい	vantageVersion はインストールする Vantage のバージョンです。
`workloads`	`object`	はい	workloads は、チャートとイメージに関するデータを含む ConfigMap を設定します。`workloads` を参照してください。
`idReadingEnabled`	`boolean`	いいえ	idReadingEnabled は ID reading 機能を有効にします。デフォルト: `false`。
`ociMigration`	`object`	いいえ	ociMigration は、インストール前にソースレジストリから移行先レジストリへアーティファクトをコピーする処理を設定します。移行をスキップするには、この項目自体を省略するか、enabled=false を設定します。有効にした場合は destination の指定が必須です。`ociMigration` を参照してください。
`reportingEnabled`	`boolean`	いいえ	reportingEnabled は SQL Server のレポート機能を有効にします。デフォルト: `false`。
`serviceAccountName`	`string`	いいえ	serviceAccountName は、Vantage のワークロードで使用するサービスアカウントの名前です。デフォルトのサービスアカウントを使用する場合は省略します。デフォルト: `default` · 最小長: `1`。
`smtp`	`object`	いいえ	smtp は SMTP メールサーバーを設定します。指定しない場合は、メールプロバイダーとして Sendgrid が使用されます。`smtp` を参照してください。
`storage`	`object`	いいえ	storage は高度なストレージオプションを設定します。`storage` を参照してください。
`techcore`	`object`	いいえ	techcore には TechCore processing engine の設定が含まれます。`techcore` を参照してください。

secrets の検証: has(self.kubernetes) != has(self.azure): プロバイダーは 1 つだけ指定する必要があります。

updatePolicy の検証: !has(self.auto): 自動更新は現在サポートされていません

updatePolicy の検証: (has(self.auto) ? 1 : 0) + (has(self.manual) ? 1 : 0) == 1: 更新ポリシーはちょうど 1 つだけ指定する必要があります

ociMigration の検証: !has(self.enabled) || self.enabled == false || has(self.destination): ociMigration が有効な場合は destination の指定が必須です

Vantage.spec.secrets

secrets は、シークレットプロバイダーを選択して設定します。プロバイダーは 1 つだけ指定する必要があります。

フィールド	型	必須	説明
`azure`	`object`	いいえ	azure は、Azure Key Vault (Secrets Store CSIドライバー経由) をシークレットのソースとして構成します。詳しくは `azure` を参照してください。
`kubernetes`	`object`	いいえ	kubernetes は、Kubernetes ネイティブのシークレットをシークレットのソースとして構成します。詳しくは `kubernetes` を参照してください。

Vantage.spec.secrets.azure

azure は、シークレットのソースとして Azure Key Vault を (Secrets Store CSIドライバー経由で) 構成します。

Field	型	必須	Description
`keyVaultName`	`string`	はい	keyVaultName は、シークレットを格納する Azure Key Vault です。
`tenantId`	`string`	はい	tenantId は、Key Vault を所有する Azure AD テナントです。
`clientId`	`string`	いいえ	clientId は、Key Vault への読み取りアクセス権を持つユーザー割り当てマネージドIDの Azure AD クライアントIDです。identityMode が “workloadIdentity” (デフォルト) の場合は必須です。
`identityMode`	`enum`	いいえ	identityMode は、CSI ドライバーが Azure で認証する方法を選択します。デフォルト: `workloadIdentity` · 列挙値: `workloadIdentity, podIdentity, vmManagedIdentity`。
`objects`	`map[string]object`	いいえ	objects は、シークレットのエイリアス (workloads-secrets.yml で参照されるもの) と特定の Key Vault オブジェクトとのマッピングを必要に応じて上書きします。エイリアスがこのマップに存在しない場合は、エイリアス自体が Key Vault オブジェクト名として使用され、オブジェクトは型 “secret” として取得されます。`objects` を参照してください。
`userAssignedIdentityID`	`string`	いいえ	userAssignedIdentityID は、identityMode が “vmManagedIdentity” の場合に使用するユーザー割り当てマネージドIDのクライアントIDです。

Vantage.spec.secrets.azure.objects[key]

AzureSecretObjectConfig は、シークレットのエイリアスの参照先となる単一の Key Vault オブジェクトを定義します。

Field	型	必須	Description
`objectName`	`string`	はい	objectName は、Azure Key Vault 内のオブジェクト名です。
`objectType`	`enum`	いいえ	objectType は、Key Vault オブジェクトの種類です。既定値は “secret” です。デフォルト: `secret` · Enum: `secret, key, cert`。
`objectVersion`	`string`	いいえ	objectVersion は、使用する Key Vault オブジェクトのバージョンを固定します。指定しない場合は最新バージョンが使用されます。

Vantage.spec.secrets.kubernetes

kubernetes は、シークレットのソースとして Kubernetes ネイティブのシークレットを構成します。

Field	型	必須	Description
`objects`	`map[string]object`	いいえ	objects は、使用する Kubernetes シークレットを定義します。定義しない場合は、デフォルトのシークレット名が使用されます。詳細は `objects` を参照してください。

Vantage.spec.secrets.kubernetes.objects[key]

Field	型	必須	説明
`secretName`	`string`	はい	secretName は Kubernetes Secret の名前です

Vantage.spec.updatePolicy

updatePolicy は、オペレーターによる Vantage のアップグレードの扱い方を制御します。

Field	型	必須	Description
`manual`	`object`	いいえ	manual を指定すると、自動アップグレードが無効になります。アップグレードは、オペレーターの Helm チャートの新しいバージョンをインストールして行います。

現在はサポートされていません。これらの fields を設定したリソースは、オペレーターによって拒否されます。

Field	型	必須	Description
`auto`	`object`	いいえ	auto は、バージョンの自動アップグレードを有効にします。まだ実装されていません。`auto` を参照してください。

Vantage.spec.updatePolicy.auto

auto は、バージョンの自動アップグレードを有効にします。現時点では未実装です。

Field	型	必須	Description
`releaseURL`	`string`	はい	releaseURL は、Vantage のリリースバンドルの取得元となる URL です。形式: `uri`。

Vantage.spec.workloads

workloads は、チャートとイメージに関するデータを格納した ConfigMap を設定します

Field	型	必須	Description
`configMap`	`string`	はい	configMap は、ワークロードデータを格納した ConfigMap の名前です
`metadataTemplateKey`	`string`	はい	metadataTemplateKey は、チャートのインストールに関するメタデータテンプレートが格納されている ConfigMap 内のキーです
`secretsKey`	`string`	はい	secrets は、シークレットのメタデータが格納されている ConfigMap 内のキーです。
`workloadsKey`	`string`	はい	workloadsKey は、チャートとイメージの一覧が格納されている ConfigMap 内のキーです

Vantage.spec.ociMigration

ociMigration は、インストール前にソースレジストリから宛先へアーティファクトをコピーする処理を設定します。移行をスキップするには、このセクション全体を省略するか、enabled=false を設定します。有効にした場合、destination は必須です。

Field	型	必須	説明
`concurrency`	`integer`	はい	concurrency は、並列でコピーするアーティファクトの数です。デフォルト: `5` · 最小値: `1`。
`destination`	`object`	いいえ	destination は、アーティファクトのコピー先です。`destination` を参照してください。
`enabled`	`boolean`	いいえ	enabled は、OCI 移行を有効にします。デフォルト: `true`。
`imagePullSecrets`	`[]object`	いいえ	imagePullSecrets は、同じ名前空間内のシークレットへの参照を指定するオプションのリストです。これらのシークレットは、この名前空間で OCI 移行ジョブを実行するオペレーターイメージをプルする際に使用されます。`imagePullSecrets` を参照してください。
`labels`	`map[string]JSON`	いいえ	labels は、OCI 移行ジョブおよび pod テンプレートに適用するラベルのセットです。文字列以外の値は [fmt.Sprint] で文字列に変換されます。
`serviceAccountName`	`string`	いいえ	serviceAccountName は、OCI 移行ジョブの実行に使用する ServiceAccount の名前です。
`sources`	`[]object`	いいえ	sources は、アーティファクトのコピー元となるレジストリ (例: JFrog) にアクセスするための認証情報です。 (最大長 20) 最大項目数: `20`。`sources` を参照してください。

destination の検証: !self.host.contains('/'): host にパスを含めることはできません。レジストリのパスは repository フィールドで指定してください

destination の検証: !self.host.contains('://'): host にスキーム (例: https://) を含めることはできません

Vantage.spec.ociMigration.destination

destination は、アーティファクトのコピー先です。

フィールド	型	必須	説明
`host`	`string`	はい	host は、レジストリのホスト名と、オプションのポート番号です (例: registry.example.com、registry.example.com:5000) 。最小長: `1`。
`credentialsRef`	`object`	いいえ	credentialsRef は、ユーザー名とパスワードのキーを含む Secret、または kubernetes.io/dockerconfigjson 型の Secret を参照します。指定した場合は、username/password よりも優先されます。詳細は `credentialsRef` を参照してください。
`password`	`string`	いいえ	レジストリ認証用のパスワード (平文。本番環境では credentialsRef を使用してください)
`repository`	`string`	いいえ	repository は、アーティファクトの格納先となるレジストリのパス/名前空間です (例: “abbyy-docker”、“vantage/images”) 。パターン: `^[a-z0-9]+([._-][a-z0-9]+)(/[a-z0-9]+([._-][a-z0-9]+))*$`。
`username`	`string`	いいえ	レジストリ認証用のユーザー名 (平文。本番環境では credentialsRef を使用してください)
`workloadIdentity`	`object`	いいえ	workloadIdentity は、ワークロードの ID (Kubernetes サービスアカウント) を使用してレジストリにアクセスするための設定を定義します。詳細は `workloadIdentity` を参照してください。

Vantage.spec.ociMigration.destination.credentialsRef

credentialsRef は、ユーザー名とパスワードのキーを含む Secret、または kubernetes.io/dockerconfigjson 型の Secret を参照します。指定した場合は、username/password よりも優先されます。

Field	型	必須	Description
`name`	`string`	はい	name は Secret の名前です

Vantage.spec.ociMigration.destination.workloadIdentity

workloadIdentity は、ワークロードの ID (Kubernetes サービスアカウント) を使用してレジストリにアクセスするための設定を定義します。

Field	型	必須	Description
`audience`	`string`	いいえ	audience は、サービスアカウントトークンを OAuth アクセストークンと交換する際に使用するエンドポイントです。
`clientId`	`string`	いいえ	clientId は、サービスアカウントトークンを OAuth アクセストークンと交換する際に使用するクライアントIDです。
`tokenEndpoint`	`string`	いいえ	tokenEndpoint は、サービスアカウントトークンを OAuth アクセストークンと交換する際に使用するエンドポイントです。

Vantage.spec.ociMigration.imagePullSecrets[index]

LocalObjectReference には、同じ名前空間内にある参照先のオブジェクトを特定するために必要な情報が含まれています。

Field	型	必須	説明
`name`	`string`	いいえ	参照先の名前。この field は事実上必須ですが、後方互換性のために空のままにすることも許可されています。この値が空になっているこの型のインスタンスは、ほぼ確実に誤りです。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names デフォルト: “。

Vantage.spec.ociMigration.sources[index]

ContainerRegistryConfig は、コンテナレジストリの接続設定を定義します。

Field	型	必須	Description
`host`	`string`	はい	host は、レジストリのホスト名と任意のポート番号です (例: registry.example.com、registry.example.com:5000) 。最小の長さ: `1`。
`credentialsRef`	`object`	いいえ	credentialsRef は、ユーザー名とパスワードのキーを含む Secret、または kubernetes.io/dockerconfigjson 型の Secret を参照します。指定した場合は、username/password よりも優先されます。`credentialsRef` を参照してください。
`password`	`string`	いいえ	レジストリ認証用のパスワードです (平文で指定します。本番環境では credentialsRef を使用してください)
`repository`	`string`	いいえ	repository は、アーティファクトを格納するレジストリのパス／名前空間です (例: “abbyy-docker”、“vantage/images”) 。パターン: `^[a-z0-9]+([._-][a-z0-9]+)(/[a-z0-9]+([._-][a-z0-9]+))*$`。
`username`	`string`	いいえ	レジストリ認証用のユーザー名です (平文で指定します。本番環境では credentialsRef を使用してください)
`workloadIdentity`	`object`	いいえ	workloadIdentity は、ワークロードの ID (Kubernetes サービスアカウント) を使用してレジストリにアクセスするための設定を定義します。`workloadIdentity` を参照してください。

Vantage.spec.ociMigration.sources[index].credentialsRef

Field	型	必須	Description
`name`	`string`	はい	name は Secret の名前です

Vantage.spec.ociMigration.sources[index].workloadIdentity

workloadIdentity は、ワークロードの ID (Kubernetes サービスアカウント) を使用してレジストリにアクセスするための設定を定義します。

フィールド	型	必須	説明
`audience`	`string`	いいえ	audience は、サービスアカウントトークンを OAuth アクセストークンと交換する際に使用するエンドポイントです。
`clientId`	`string`	いいえ	clientId は、サービスアカウントトークンを OAuth アクセストークンと交換する際に使用するクライアントIDです。
`tokenEndpoint`	`string`	いいえ	tokenEndpoint は、サービスアカウントトークンを OAuth アクセストークンと交換する際に使用するエンドポイントです。

Vantage.spec.smtp

smtp は SMTP メールサーバーを設定します。指定しない場合は、メールプロバイダーとして Sendgrid が使用されます。

Field	型	必須	説明
`host`	`string`	はい	host は SMTP サーバーのホスト名です
`login`	`string`	いいえ	SMTP 認証に使用するログイン名です
`password`	`string`	いいえ	SMTP 認証に使用するパスワードです
`port`	`integer`	いいえ	port は SMTP サーバーのポート番号です。デフォルト: `587` · 書式: `int32`。
`useSSL`	`boolean`	いいえ	useSSL は SMTP 接続で TLS を有効にします。デフォルト: `false`。

Vantage.spec.storage

storage は高度なストレージオプションを設定します。

Field	型	必須	Description
`custom`	`object`	いいえ	custom はカスタムストレージバックエンドを設定します。詳細は `custom` を参照してください。

Vantage.spec.storage.custom

custom は、カスタムストレージバックエンドを設定します。

Field	型	必須	説明
`size`	`intorstring`	はい	size は PVC のサイズを定義します。デフォルト: `300Gi` · パターン: `^(\+\|-)?(([0-9]+(\.[0-9])?)\|(\.[0-9]+))(([KMGTPE]i)\|[numkMGTPE]\|([eE](\+\|-)?(([0-9]+(\.[0-9])?)\|(\.[0-9]+))))?$`。
`storageClass`	`string`	はい	storageClass は、カスタムストレージバックエンドのボリュームをマウントする PVC で使用するストレージクラスを定義します。

Vantage.spec.techcore

techcore には、TechCore processing engine の設定が含まれます。

フィールド	型	必須	説明
`versions`	`[]integer`	はい	versions には、デプロイする TechCore のバージョンを指定します (使用可能なバージョンは 2、3、4) 。最小項目数: `1` · 列挙値: `2, 3, 4`。
`nnTrainingWorkers`	`object`	いいえ	nnTrainingWorkers では、ニューラルネットワークのトレーニングワーカーを設定します。詳細は `nnTrainingWorkers` を参照してください。

Vantage.spec.techcore.nnTrainingWorkers

nnTrainingWorkers は、ニューラルネットワークのトレーニングワーカーを設定します。

Field	型	必須	説明
`enabled`	`boolean`	いいえ	ニューラルネットワークのトレーニングワーカーを有効にします。デフォルト: `false`。
`gpu`	`boolean`	いいえ	トレーニングワーカーの GPU アクセラレーションを有効にします。デフォルト: `false`。

Vantage.status

status は Vantage の観測された状態を定義します。

Field	型	必須	Description
`availableVersions`	`[]string`	いいえ	availableVersions は、リリース URL から入手可能なバージョンのリストです。
`conditions`	`[]object`	いいえ	conditions は、Vantage リソースの現在の状態を表します。各状態は一意の型を持ち、リソースの特定の側面のステータスを示します。標準の状態の型は次のとおりです: - “Available”: リソースが完全に機能している - “Progressing”: リソースが作成中または更新中である - “Degraded”: リソースが目的の状態に到達できなかった、またはその状態を維持できなかった各状態のステータスは True、False、Unknown のいずれかです。`conditions` を参照してください。
`degradationReasons`	`[]object`	いいえ	degradationReasons は、インストールが機能低下状態にある理由を表します。`degradationReasons` を参照してください。
`installedVantageVersion`	`string`	いいえ	installedVantageVersion は、現在実行中のバージョンです。
`observedGeneration`	`integer`	いいえ	observedGeneration は、コントローラーによって「処理済み」となった spec の世代です。書式: `int64`。

Vantage.status.conditions[index]

Condition には、この API リソースの現在の状態のうち、ある 1 つの側面に関する詳細が含まれます。

フィールド	型	必須	説明
`lastTransitionTime`	`string`	はい	lastTransitionTime は、状態があるステータスから別のステータスへ最後に遷移した時刻です。基になる状態が変化した時刻を指定してください。それが不明な場合は、API フィールドが変更された時刻を使用しても構いません。形式: `date-time`。
`message`	`string`	はい	message は、遷移の詳細を示す人間が読める形式のメッセージです。空文字列でも構いません。最大長: `32768`。
`reason`	`string`	はい	reason には、状態が最後に遷移した理由を示す、プログラムで扱うための識別子が含まれます。特定の条件の型のプロデューサーは、このフィールドに想定される値とその意味、およびそれらの値を保証された API と見なすかどうかを定義できます。値は CamelCase の string にしてください。このフィールドを空にすることはできません。最小長: `1` · 最大長: `1024` · パターン: `^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$`。
`status`	`enum`	はい	状態のステータスです。True、False、Unknown のいずれかになります。列挙値: `True, False, Unknown`。
`type`	`string`	はい	状態の種類です。CamelCase または foo.example.com/CamelCase の形式で指定します。最大長: `316` · パターン: `^([a-z0-9]([-a-z0-9][a-z0-9])?(\.[a-z0-9]([-a-z0-9][a-z0-9])?)/)?(([A-Za-z0-9][-A-Za-z0-9_.])?[A-Za-z0-9])$`。
`observedGeneration`	`integer`	いいえ	observedGeneration は、状態を設定する際に基準とした .metadata.generation を表します。たとえば、.metadata.generation が現在 12 であるのに .status.conditions[x].observedGeneration が 9 の場合、その状態はインスタンスの現在の状態から見て古くなっています。形式: `int64` · 最小値: `0`。

Vantage.status.degradationReasons[index]

DegradationReason は、インストール環境の個々のコンポーネントが機能低下状態になっている理由を表します。

Field	型	必須	Description
`component`	`string`	はい	component は、インストール環境のうち機能低下状態になっている部分です。
`message`	`string`	はい	message は、コンポーネントの機能低下について人が読める形式で記述した説明です。
`reason`	`string`	はい	reason には、コンポーネントが機能低下状態になった理由を示す、プログラムで処理するための識別子が格納されます。値は CamelCase 形式の文字列にする必要があります。

​アーティファクトのバージョン

​API グループ

​Vantage

​Vantage.spec

​Vantage.spec.secrets

​Vantage.spec.secrets.azure

​Vantage.spec.secrets.azure.objects[key]

​Vantage.spec.secrets.kubernetes

​Vantage.spec.secrets.kubernetes.objects[key]

​Vantage.spec.updatePolicy

​Vantage.spec.updatePolicy.auto

​Vantage.spec.workloads

​Vantage.spec.ociMigration

​Vantage.spec.ociMigration.destination

​Vantage.spec.ociMigration.destination.credentialsRef

​Vantage.spec.ociMigration.destination.workloadIdentity

​Vantage.spec.ociMigration.imagePullSecrets[index]

​Vantage.spec.ociMigration.sources[index]

​Vantage.spec.ociMigration.sources[index].credentialsRef

​Vantage.spec.ociMigration.sources[index].workloadIdentity

​Vantage.spec.smtp

​Vantage.spec.storage

​Vantage.spec.storage.custom

​Vantage.spec.techcore

​Vantage.spec.techcore.nnTrainingWorkers

​Vantage.status

​Vantage.status.conditions[index]

​Vantage.status.degradationReasons[index]

アーティファクトのバージョン

API グループ

Vantage

Vantage.spec

Vantage.spec.secrets

Vantage.spec.secrets.azure

Vantage.spec.secrets.azure.objects[key]

Vantage.spec.secrets.kubernetes

Vantage.spec.secrets.kubernetes.objects[key]

Vantage.spec.updatePolicy

Vantage.spec.updatePolicy.auto

Vantage.spec.workloads

Vantage.spec.ociMigration

Vantage.spec.ociMigration.destination

Vantage.spec.ociMigration.destination.credentialsRef

Vantage.spec.ociMigration.destination.workloadIdentity

Vantage.spec.ociMigration.imagePullSecrets[index]

Vantage.spec.ociMigration.sources[index]

Vantage.spec.ociMigration.sources[index].credentialsRef

Vantage.spec.ociMigration.sources[index].workloadIdentity

Vantage.spec.smtp

Vantage.spec.storage

Vantage.spec.storage.custom

Vantage.spec.techcore

Vantage.spec.techcore.nnTrainingWorkers

Vantage.status

Vantage.status.conditions[index]

Vantage.status.degradationReasons[index]