メインコンテンツへスキップ
Vantage 3.0 self-hosted は、2 つの Helm チャートとして提供されます。vantage-operator (Vantage カスタムリソースを監視するコントローラー) と、vantage-selfhosted (選択したインストール先の名前空間に Vantage リソースと関連マニフェストを作成するチャート) です。このページでは、その両方の値のリファレンスを示します。 field レベルの CRD の詳細については、API リファレンス を参照してください。インストール手順については、Azure または セルフマネージド Kubernetes を選択してください。
vantage-operatorvantage-selfhosted は同じバージョンをインストールしてください。現在のセルフマネージド手順では、両方のチャートにバージョン 0.70.13 を使用します。

vantage-operator

クラスターごとに1回、任意の名前空間にインストールします。このオペレーターは、Vantage カスタムリソースで定義された Vantage のインストールをリコンサイルします。
各クラスターにはインスタンスを1つだけインストールしてください。 このチャートでは、クラスター スコープのテンプレート化されていないリソース名 (manager-role ClusterRole、manager-rolebinding ClusterRoleBinding、controller-manager ServiceAccount) を使用します。同じクラスターに2つ目をインストールすると (別の名前空間であっても) 、これらのリソース名が競合します。既知の制限事項を参照してください。

トップレベルのスタンザ

  • nameOverride / fullnameOverride: 生成されるリソース名のプレフィックスを部分的または完全に上書きします。
  • manager: オペレーター の Deployment です。replicasimage、コンテナーの args (leader election はデフォルトで有効) 、env (downward API 経由の pod 名と名前空間) 、imagePullSecrets、pod とコンテナーの security context (non-root、権限昇格なし、読み取り専用 root filesystem) 、resources、およびスケジューリング (affinitynodeSelectortolerations) を指定します。
  • rbacHelpers: vantage.abbyy.com CRD を扱うための任意の admin/editor/viewer ClusterRole です。デフォルトでは無効です。
  • crd: CRD のライフサイクルです。チャートとともに CRD をインストールする (enable) 、またはアンインストール時に保持する (keep) かを指定します。
  • metrics: RBAC で保護された /metrics エンドポイントです。
  • certManager: webhook と metrics エンドポイントの証明書用の cert-manager 統合です。デフォルトでは無効です。
  • prometheus: metrics エンドポイント用の Prometheus ServiceMonitor です。クラスター内に prometheus-operator が必要です。デフォルトでは無効です。

主な値

デフォルト値は、このリリース向けにチャートが生成した values.yaml を反映しています。正式な定義はチャート自体です。詳しくは、使用可能な値の確認を参照してください。 オペレーター チャートでは、Vantage アプリケーションの設定は 一切 受け付けません。アプリケーション設定はすべて Vantage カスタムリソースにあり、これは vantage-selfhosted チャートによって作成されます。

vantage-selfhosted

各 Vantage インスタンスに対して 1 回、任意の名前空間にインストールします。このチャートには、Vantage カスタムリソース、関連する RBAC とともに Vantage の ワークロード データを含む ConfigMap、ならびに ABBYY のアップストリーム infrastructure リポジトリに由来する Vantage 関連の CRD とロールが含まれています。 ほとんどの値は、Vantage カスタムリソース上の field に直接マップされます。field レベルの仕様については、API リファレンスを参照してください。

トップレベルのスタンザ

  • operator: オペレーター のインストール先 (namespacecontrollerManagerServiceAccount) への参照です。チャートはこれらの値を使って、Vantage リリースの名前空間内で オペレーター の Secret-reader ClusterRole をバインドします。
  • ingress: 組み込みの Istio ingress 構成です。別の ingress コントローラーを使用する場合は、enabled: false に設定します。
  • vantage: Vantage.spec のペイロードです: databaseProvider, dnsRecord, mailFrom, platformAdminEmail, secrets, vantageVersion, workloads, idReadingEnabled, keda, ociMigration, reportingEnabled, serviceAccountName, smtp, storage, techcore.
  • observability: チャートによって生成される Prometheus ServiceMonitor の設定です。これはトップレベルのスタンザであり、Vantage.spec の field ではありません。

必須の値

オプション値

利用可能な値の確認

vantage-operator チャート (values.yaml を含む) は Kubebuilder Helm プラグインによって生成されます。一方、vantage-selfhosted チャートのテンプレートは手動で保守されています。いずれの場合も、特定のバージョンで受け入れられる内容については、公開済みのチャートが正規の参照元です。このページのテーブルは、テスト済みのスナップショットを要約したものです。このページとチャートの内容に相違がある場合は、チャートを正としてください。
$charts_uri$chart_uri、およびバージョン変数は、インストール変数の規則に従います。 適用する前に、レンダリングされたマニフェストを確認するには、次のようにします。

Operator と Vantage の設定

設定は明確に次のように分かれます。

TechCore workerのデプロイ

vantage-selfhosted チャートは Vantage カスタムリソースを適用し、その後、オペレーター が spec.techcore.* に基づいて TechCore worker チャートの一部をデプロイします。どれが選択されるかは オペレーター 側で決まりますが、以下のマトリクスが基準となります。これを使用すると、特定の構成でどの worker が実行されるかを予測できます。

命名規則

worker チャートの名前は vtc-{version}-worker-{name} です。ここで、{version}spec.techcore.version に由来し、{previousVersion}spec.techcore.previousVersion に由来します。バージョン番号はあくまで名前のプレフィックスであり、オペレーターにとって特別な意味はありません。利用可能な worker のセットは、ABBYY が各リリースで公開する ワークロード ConfigMap に含まれています。

2つのデプロイパス

keepPreviousVersion: true を設定すると、以前の TechCore バージョンのワーカーが新しいワーカーと並行して稼働し続けるため、段階的な TechCore アップグレードに役立ちます。このフラグが true の場合、CRD では previousVersion の設定が必須です。

インクルージョンマトリクス: 現行バージョンのパス

インクルージョンマトリクス: 前バージョンのパス

spec.techcore.keepPreviousVersion: true の場合にのみ実行されます。
ID reading は TechCore の対象ではなく、プラットフォーム レベルの機能です。これを制御するフラグは spec.idReadingEnabled で、spec.techcore の外側にあります。Vantage.spec リファレンスを参照してください。
このマトリクスは、選択したバージョンの ワークロード ConfigMap に存在するワーカーのうち、どれを含めるかだけを決定します。そのバージョンの ワークロード に存在しないチャートは、単にデプロイできません。たとえば、worker-ocr-join は現時点では vtc-2 の workload セットにのみ含まれているため、keepPreviousVersion: truepreviousVersion: 2 を指定していても、vtc-2-worker-ocr-join としてのみデプロイされます。

次へ

API リファレンス

Vantage カスタムリソースの各 field のリファレンス。

Azure へのインストール

これらのチャートを使用したインストール手順です。

セルフマネージド Kubernetes

ingress、mesh、シークレット、ストレージ、データサービスをお客様側で管理する構成でインストールします。