メインコンテンツへスキップ

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

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

API グループ

Vantage

Vantage は vantages API のスキーマです
spec の検証: !self.reportingEnabled || !has(self.databaseProvider) || self.databaseProvider == 'SqlServer': reportingEnabled を使用するには、databaseProvider を ‘SqlServer’ に設定する必要があります。レポート機能は SQL Server 専用であり、PostgreSQL では使用できません

Vantage.spec

spec は Vantage の望ましい状態を定義します。
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 が必須です
storage の検証: !has(self.s3): S3 ストレージはまだサポートされていません
storage の検証: (has(self.azure) ? 1 : 0) + (has(self.s3) ? 1 : 0) + (has(self.custom) ? 1 : 0) <= 1: 指定できるストレージプロバイダーは最大 1 つです

Vantage.spec.secrets

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

Vantage.spec.secrets.azure

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

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

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

Vantage.spec.secrets.kubernetes

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

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

Vantage.spec.updatePolicy

updatePolicy は、オペレーターによる Vantage のアップグレードの扱い方を制御します。 現在はサポートされていません。これらのfieldsを設定したリソースは、オペレーターによって拒否されます。

Vantage.spec.updatePolicy.auto

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

Vantage.spec.workloads

workloads は、チャートおよびイメージに関するデータを含む ConfigMap を構成します

Vantage.spec.workloads.pods

pods は、ワークロードの pod に追加するメタデータを設定します。

Vantage.spec.workloads.pods.charts[key]

ChartPodsConfig は、単一の Vantage Helm チャート内のワークロードの pod に付与するメタデータを定義します。

Vantage.spec.workloads.pods.charts[key].deployment

deployment は、チャートのデプロイメントに属する pod を設定します。

Vantage.spec.workloads.pods.charts[key].migrator

migrator は、チャートの移行ジョブの pod を設定します。

Vantage.spec.workloads.pods.charts[key].statefulSet

statefulSet は、チャートの StatefulSet の pod を設定します。

Vantage.spec.workloads.serviceAccounts

serviceAccounts は、特定のワークロードに対して spec.serviceAccountName を上書きします。

Vantage.spec.workloads.serviceAccounts.charts[key]

ChartServiceAccountsConfig は、単一の Vantage Helm チャート内のワークロードで使用するサービスアカウントの設定を定義します。

Vantage.spec.workloads.serviceAccounts.charts[key].deployment

deployment は、チャートのデプロイメントで使用するサービスアカウントを設定します。

Vantage.spec.workloads.serviceAccounts.charts[key].migrator

migrator は、チャートの移行ジョブが使用するサービスアカウントを設定します。

Vantage.spec.workloads.serviceAccounts.charts[key].statefulSet

statefulSet は、チャートの StatefulSet が使用するサービスアカウントを設定します。

Vantage.spec.argocd

argocd は、Vantage のワークロードをインストールするためにオペレーターが作成する Argo CD リソースを設定します。 省略した場合は、“default” プロジェクトにインストールされます。
namespace の検証: self == oldSelf: namespace は変更できません

Vantage.spec.keda

keda では KEDA の設定を構成します。指定しない場合、KEDA サポートは無効になります。

Vantage.spec.ociMigration

ociMigration は、インストール前にソースレジストリから宛先へアーティファクトをコピーする処理を構成します。 移行をスキップするには、この項目全体を省略するか、enabled=false を設定します。 有効にした場合、destination は必須です。
destination の検証: !self.host.contains('/'): host にパスを含めることはできません。レジストリのパスは repository フィールドで指定してください
destination の検証: !self.host.contains('://'): host にスキーム (例: https://) を含めることはできません
resources の検証: !has(self.claims) || size(self.claims) == 0: resources.claims は OCI 移行ジョブではサポートされていません

Vantage.spec.ociMigration.destination

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

Vantage.spec.ociMigration.destination.credentialsRef

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

Vantage.spec.ociMigration.destination.workloadIdentity

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

Vantage.spec.ociMigration.imagePullSecrets[index]

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

Vantage.spec.ociMigration.resources

resources は、OCI 移行ジョブのコンテナーのコンピューティングリソースです。デフォルトでは、コピー処理がバーストできるように CPU は無制限になっています。すべてのコンテナーに CPU 制限を設けることをポリシーで義務付けているクラスターでは、 CPU 制限を設定してください。適用されるのは requests と limits のみです。このジョブは pod レベルの resourceClaims を宣言しないため、claims は却下されます。 まだサポートされていません。これらのフィールドが設定されたリソースは、オペレーターによって拒否されます。

Vantage.spec.ociMigration.resources.claims[index]

ResourceClaim は、PodSpec.ResourceClaims 内のエントリを 1 つ参照します。

Vantage.spec.ociMigration.sources[index]

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

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

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

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

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

Vantage.spec.smtp

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

Vantage.spec.storage

storage は高度なストレージオプションを構成します。 まだサポートされていません。これらの fields が設定されたリソースは、オペレーターによって拒否されます。

Vantage.spec.storage.custom

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

Vantage.spec.storage.s3

s3 は S3 ストレージバックエンドを設定します。

Vantage.spec.storage.s3.buckets

buckets は、ストレージバケットの名前を設定します。

Vantage.spec.storage.s3.scopedClientCredentials

scopedClientCredentials は、ストレージサービスが自身のキーレス接続を使用する代わりに、単一のストレージにスコープ設定された有効期間の短い認証情報 (STS AssumeRole) をクライアントに発行するように構成します。

Vantage.spec.techcore

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

Vantage.spec.techcore.nnTrainingWorkers

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

Vantage.spec.techcore.workers

workers は、TechCore worker のデプロイメントとそのオートスケーリングを調整します。replicaCount を除くすべてのフィールドは、 keda.enabled が true の場合にのみ有効です。replicaCount は例外で、Deployment の replicas の設定にも使用されます。

Vantage.spec.techcore.workers.defaults

defaults は、デプロイされたすべてのバージョンのすべての TechCore worker に適用されます。

Vantage.spec.techcore.workers.defaults.resources

resources は、1 つのワーカーに割り当てるリソースを設定します。サイジングガイドに記載されている合計値は、このワーカー単位の値を基に算出されています。そのため、この値を変更すると、インストールに必要なリソースも変わります。

Vantage.spec.techcore.workers.defaults.scaling

scaling はオートスケーリングの動作を設定します。keda.enabled が有効でない場合、この設定は効果がありません。

Vantage.spec.techcore.workers.defaults.scaling.cron

cron は、業務時間中はワーカーをウォーム状態に保ち、業務時間外はワーカーをゼロまでスケールダウンできるようにします。scaleInactiveToZero の設定が必要です。 なお、低優先度キューのみを処理するワーカーには影響しません。

Vantage.spec.techcore.workers.overrides[key]

WorkerConfig は、TechCore worker の調整可能な設定を定義します。未設定の field には、ワーカー チャート自体のデフォルト値がそのまま適用されます。

Vantage.spec.techcore.workers.overrides[key].resources

resources は、1 つのワーカーに割り当てるリソースを設定します。サイジングガイドに記載されている合計値は、これらのワーカー単位の値をもとに算出されています。そのため、この値を変更すると、インストールに必要なリソースも変わります。

Vantage.spec.techcore.workers.overrides[key].scaling

scaling はオートスケーリングの動作を設定します。この設定は keda.enabled を指定しない限り効果がありません。

Vantage.spec.techcore.workers.overrides[key].scaling.cron

cron は、業務時間中はワーカーを起動状態に保ち、業務時間外にはワーカーをゼロまでスケールダウンできるようにします。 scaleInactiveToZero が必要です。また、低優先度のキューのみを処理するワーカーには影響しません。

Vantage.status

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

Vantage.status.conditions[index]

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

Vantage.status.degradationReasons[index]

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