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

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

Vantage 3.0 セルフホスト版のインストーラーは、単一の Kubernetes カスタムリソースによって制御されます。それが、vantage.abbyy.com/v1alpha1 API グループに属する Vantage オブジェクトです。以下の field は、ユーザーとオペレーターとの間の取り決めをすべて網羅しています。 オペレーターがこのリソースをどのように利用するかについての概念的な説明は、アーキテクチャを参照してください。インストール手順については、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 ネイティブの Secrets をシークレットのソースとして設定します。

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

Vantage.spec.updatePolicy

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

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」プロジェクトにインストールされます。

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 は却下されます。 まだサポートされていません。これらのfieldを設定したリソースは、オペレーターによって拒否されます。

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 は高度なストレージオプションを設定します。 まだサポートされていません。これらのフィールドを設定したリソースは、オペレーターによって拒否されます。

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.status

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

Vantage.status.conditions[index]

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

Vantage.status.degradationReasons[index]

DegradationReason は、インストール環境内の個々のコンポーネントが劣化状態にある理由を表します。