> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Helmチャートの値
> vantage-operator と vantage-selfhosted の Helm チャートで公開される値のリファレンスです。
Vantage 3.0 self-hosted は、2 つの Helm チャートとして提供されます。`vantage-operator` (`Vantage` カスタムリソースを監視するコントローラー) と、`vantage-selfhosted` (選択したインストール先の名前空間に `Vantage` リソースと関連マニフェストを作成するチャート) です。このページでは、その両方の値のリファレンスを示します。
field レベルの CRD の詳細については、[API リファレンス](/ja/vantage/self-hosted/v3.0/api-reference) を参照してください。インストール手順については、[Azure](/ja/vantage/self-hosted/v3.0/providers/azure) または [セルフマネージド Kubernetes](/ja/vantage/self-hosted/v3.0/providers/self-managed) を選択してください。
`vantage-operator` と `vantage-selfhosted` は同じバージョンをインストールしてください。現在のセルフマネージド手順では、両方のチャートにバージョン `0.70.13` を使用します。
## `vantage-operator`
クラスターごとに1回、任意の名前空間にインストールします。このオペレーターは、`Vantage` カスタムリソースで定義された Vantage のインストールをリコンサイルします。
**各クラスターにはインスタンスを1つだけインストールしてください。** このチャートでは、クラスター スコープのテンプレート化されていないリソース名 (`manager-role` ClusterRole、`manager-rolebinding` ClusterRoleBinding、`controller-manager` ServiceAccount) を使用します。同じクラスターに2つ目をインストールすると (別の名前空間であっても) 、これらのリソース名が競合します。[既知の制限事項](/ja/vantage/self-hosted/v3.0/known-limitations#one-operator-instance-per-cluster)を参照してください。
### トップレベルのスタンザ
* **`nameOverride` / `fullnameOverride`**: 生成されるリソース名のプレフィックスを部分的または完全に上書きします。
* **`manager`**: オペレーター の Deployment です。`replicas`、`image`、コンテナーの `args` (leader election はデフォルトで有効) 、`env` (downward API 経由の pod 名と名前空間) 、`imagePullSecrets`、pod とコンテナーの security context (non-root、権限昇格なし、読み取り専用 root filesystem) 、`resources`、およびスケジューリング (`affinity`、`nodeSelector`、`tolerations`) を指定します。
* **`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` を反映しています。正式な定義はチャート自体です。詳しくは、[使用可能な値の確認](#inspecting-available-values)を参照してください。
| Value | Purpose |
| ------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `manager.replicas` | オペレーター のレプリカ数。デフォルトは `1`。 |
| `manager.image.repository` / `tag` / `pullPolicy` | オペレーター のコンテナーイメージ。`pullPolicy` のデフォルトは `IfNotPresent`。 |
| `manager.imagePullSecrets` | レジストリで認証が必要な場合に、オペレーター イメージを取得するためのシークレットです。例: `--set "manager.imagePullSecrets[0].name=my-pull-secret"`。デフォルトは `[]`。AKS で kubelet ID に `AcrPull` が付与されている場合は不要です。詳しくは、[Image pull access](/ja/vantage/self-hosted/v3.0/providers/azure#image-pull-access)を参照してください。 |
| `manager.args` | コンテナー引数。デフォルトは `[--leader-elect]` (リーダー選出が有効) 。 |
| `manager.resources` | CPU/メモリの requests と limits。デフォルト: requests は `10m` CPU / `64Mi` メモリ、limits は `500m` CPU / `128Mi` メモリ。 |
| `manager.affinity` / `manager.nodeSelector` / `manager.tolerations` | オペレーター Pod 用の標準的な Kubernetes スケジューリング制御です。デフォルトでは空です。 |
| `rbacHelpers.enable` | `vantage.abbyy.com` CRD 用の管理者 / エディター / ビューアーの簡易ロールをインストールします。デフォルトは `false`。 |
| `crd.enable` | チャートとともに CRD をインストールします。デフォルトは `true`。 |
| `crd.keep` | チャートをアンインストールしても、クラスター内の CRD (およびそれらが定義する `Vantage` リソース) を保持します。デフォルトは `true`。 |
| `metrics.enable` / `metrics.port` | RBAC で保護された `/metrics` エンドポイントを公開します。デフォルトは `true` / `8443`。 |
| `certManager.enable` | webhook および metrics エンドポイントの証明書に cert-manager を使用します。デフォルトは `false`。 |
| `prometheus.enable` | metrics エンドポイント用の Prometheus `ServiceMonitor` を作成します。クラスター内に prometheus-operator が必要です。デフォルトは `false`。 |
オペレーター チャートでは、Vantage アプリケーションの設定は **一切** 受け付けません。アプリケーション設定はすべて `Vantage` カスタムリソースにあり、これは `vantage-selfhosted` チャートによって作成されます。
## `vantage-selfhosted`
各 Vantage インスタンスに対して 1 回、任意の名前空間にインストールします。このチャートには、`Vantage` カスタムリソース、関連する RBAC とともに Vantage の ワークロード データを含む ConfigMap、ならびに ABBYY のアップストリーム infrastructure リポジトリに由来する Vantage 関連の CRD とロールが含まれています。
ほとんどの値は、`Vantage` カスタムリソース上の field に直接マップされます。field レベルの仕様については、[API リファレンス](/ja/vantage/self-hosted/v3.0/api-reference)を参照してください。
### トップレベルのスタンザ
* **`operator`**: オペレーター のインストール先 (`namespace` と `controllerManagerServiceAccount`) への参照です。チャートはこれらの値を使って、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 ではありません。
### 必須の値
| 値 | 対応先 | 注記 |
| ------------------------------------------------------------------------------------- | --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `operator.namespace` | N/A | `vantage-operator` をインストールした名前空間です。 |
| `operator.controllerManagerServiceAccount` | N/A | この Vantage リリースの名前空間で Secret-reader ClusterRole にバインドする、オペレーター コントローラーの ServiceAccount です。オペレーター のインストールでデフォルト以外の名前を使用している場合にのみ変更してください。 |
| `ingress.tls.secretName` | N/A | 組み込みの Istio ingress が有効な場合に必須です。Istio external ingress gateway の名前空間にある既存の `kubernetes.io/tls` Secret の名前を指定します。`ingress.enabled` が `false` の場合は使用されません。 |
| `vantage.dnsRecord` | `Vantage.spec.dnsRecord` | Vantage へのアクセスに使用する DNS ホスト名です。 |
| `vantage.mailFrom` | `Vantage.spec.mailFrom` | 送信メールの送信元です。 |
| `vantage.platformAdminEmail` | `Vantage.spec.platformAdminEmail` | 初期プラットフォーム管理者のメールアドレスです。 |
| `vantage.secrets.azure` or `vantage.secrets.kubernetes` | `Vantage.spec.secrets` | シークレット provider は必ず 1 つだけ指定する必要があります。[Secrets and Key Vault](/ja/vantage/self-hosted/v3.0/secrets-and-keyvault) を参照してください。 |
| `vantage.workloads.configMap` / `metadataTemplateKey` / `secretsKey` / `workloadsKey` | `Vantage.spec.workloads` | ワークロード データを含む `ConfigMap` を参照します。この `ConfigMap` はチャートに含まれており、作成もされます。 |
### オプション値
| 値 | 用途 |
| ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `ingress.enabled` | チャートの組み込み ingress を有効にします。Traefik または他のお客様管理の ingress コントローラーを使用する場合は `false` に設定します。既定値は `true` です。 |
| `vantage.databaseProvider` | Vantage サービスで使用するデータベースエンジンです。指定可能な値は `SqlServer` (既定) または `PostgreSQL` です。大文字と小文字は区別されます。 |
| `vantage.secrets.azure.identityMode` | `workloadIdentity` (既定) 、`podIdentity`、`vmManagedIdentity` のいずれかです。[Secrets and Key Vault](/ja/vantage/self-hosted/v3.0/secrets-and-keyvault#azure-key-vault-provider) を参照してください。 |
| `vantage.secrets.azure.userAssignedIdentityID` | `identityMode` が `vmManagedIdentity` の場合に使用する UAMI の Client ID です。 |
| `vantage.secrets.azure.objects` | 名前がエイリアスと一致しない Key Vault オブジェクトに対して、シークレットのエイリアス → `{objectName, objectType, objectVersion}` をマッピングします。 |
| `vantage.secrets.kubernetes` | Azure Key Vault の代わりに、既存の Kubernetes `Secret` リソースを使用します。任意の `objects` マッピングで既定のシークレット名を上書きできます。 |
| `vantage.smtp.host` / `port` / `login` / `password` | 送信用 SMTP の設定です。設定されている場合にのみ使用され、既定では SendGrid が使われます。`Vantage.spec.smtp` に対応します。 |
| `vantage.serviceAccountName` | Vantage ワークロード用の既定の ServiceAccount です。`Vantage.spec.serviceAccountName` に対応します。既定値は `default` です。pull Secret を使ってイメージを取得するには、この ServiceAccount の `imagePullSecrets` にその Secret を追加します。[Azure image pull access](/ja/vantage/self-hosted/v3.0/providers/azure#image-pull-access) または [self-managed registry access](/ja/vantage/self-hosted/v3.0/providers/self-managed#configure-registry-access) を参照してください。 |
| `vantage.storage.custom.storageClass` / `size` | Azure Blob の代わりに、Kubernetes `StorageClass` ベースのバックエンドを使用します。`Vantage.spec.storage.custom` に対応します。 |
| `vantage.idReadingEnabled` | ID 読み取り機能の有効/無効を切り替えます。既定値は `false` です。 |
| `vantage.reportingEnabled` | SQL Server のレポート機能の有効/無効を切り替えます。既定値は `false` です。PostgreSQL を使用する場合は `false` のままにする必要があります。 |
| `vantage.ociMigration.enabled` | OCI 移行ジョブを実行します。既定値は `true` です。 |
| `vantage.ociMigration.serviceAccountName` | OCI 移行ジョブの実行に使用する ServiceAccount です。`Vantage.spec.ociMigration.serviceAccountName` に対応します。pull Secret を使ってジョブのイメージを取得するには、この ServiceAccount の `imagePullSecrets` にその Secret を追加します。 |
| `vantage.ociMigration.sources[]` | アーティファクトのコピー元となるソースレジストリです。ドキュメントに記載されているソースは `sources[0].host=abbyy.jfrog.io` および `sources[0].repository=abbyy-docker` です。レジストリ認証情報を保持する Secret を指定するには `sources[].credentialsRef.name` を設定します。これは、pull 設定における移行ジョブ用 ServiceAccount の代替手段です。 |
| `vantage.ociMigration.destination.host` / `repository` | アーティファクトのコピー先となる宛先レジストリです。 |
| `vantage.keda.enabled` | Vantage ワークロードのオートスケーリングに [KEDA](https://keda.sh/) を使用するかどうかを設定します。現在の Vantage ワークロードチャートでは KEDA 2.17.x が必要です。[Autoscaling with KEDA](/ja/vantage/self-hosted/v3.0/performance/autoscaling) を参照してください。 |
| `observability.prometheus.namespace` | Prometheus が含まれる名前空間です。既定値は `observability` です。一部の Vantage オートスケーラーでは、この名前空間内の `prometheus-operated` Service が必要です。 |
| `observability.prometheus.serviceMonitor.create` | Vantage の `/metrics-text` エンドポイントをスクレイプする `ServiceMonitor` を作成します。既定値は `false` です。 |
| `observability.prometheus.serviceMonitor.selectorMatchLabels` | Prometheus インスタンスが Vantage の `ServiceMonitor` を選択するために必要なラベルです。既定値は `{}` です。 |
| `vantage.techcore.versions` | TechCore エンジンのバージョンです。 |
| `vantage.techcore.nnTrainingWorkers.enabled` / `gpu` | ニューラルネットワーク学習ワーカーです。 |
## 利用可能な値の確認
`vantage-operator` チャート (`values.yaml` を含む) は Kubebuilder Helm プラグインによって生成されます。一方、`vantage-selfhosted` チャートのテンプレートは手動で保守されています。いずれの場合も、特定のバージョンで受け入れられる内容については、公開済みのチャートが正規の参照元です。このページのテーブルは、テスト済みのスナップショットを要約したものです。このページとチャートの内容に相違がある場合は、チャートを正としてください。
```bash theme={null}
# vantage-operator
helm show values $charts_uri/vantage-operator --version $operator_version
# vantage-selfhosted
helm show values $chart_uri/vantage-selfhosted --version $selfhosted_version
```
`$charts_uri`、`$chart_uri`、およびバージョン変数は、[インストール変数](/ja/vantage/self-hosted/v3.0/providers/azure#install-variables)の規則に従います。
適用する前に、レンダリングされたマニフェストを確認するには、次のようにします。
```bash theme={null}
helm template $release_name $chart_uri/vantage-selfhosted \
--version $selfhosted_version \
--namespace $install_namespace \
-f my-values.yaml
```
## Operator と Vantage の設定
設定は明確に次のように分かれます。
| 項目 | 定義場所 | 理由 |
| ----------------------------------------------------------------------------- | ------------------------------------------------- | -------------------------------------------- |
| Operator ランタイム (replicas、image、pull secrets、scheduling、CRD lifecycle、metrics) | `vantage-operator` Helm values | クラスター管理者向けの運用設定。 |
| Vantage アプリケーション (シークレット、SMTP、ワークロード、ストレージ、TechCore) | `vantage-selfhosted` Helm values → `Vantage.spec` | CRD は API コントラクトであり、チャートはそれを定義するための手段にすぎません。 |
## 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つのデプロイパス
| パス | 実行タイミング | 対象のチャート |
| -------- | --------------------------------------------- | ------------------------------- |
| 現在のバージョン | 常に | `vtc-{version}-worker*` |
| 以前のバージョン | `spec.techcore.keepPreviousVersion: true` の場合 | `vtc-{previousVersion}-worker*` |
`keepPreviousVersion: true` を設定すると、以前の TechCore バージョンのワーカーが新しいワーカーと並行して稼働し続けるため、段階的な TechCore アップグレードに役立ちます。このフラグが true の場合、CRD では `previousVersion` の設定が必須です。
### インクルージョンマトリクス: 現行バージョンのパス
| チャートパターン | 含まれる条件 |
| ---------------------------- | ------------------------------------------------------------------- |
| `worker-id-reading` | 含まれない (すべての構成で除外) |
| `nn-extraction-training` | `nnTrainingWorkers.enabled: true` かつ `nnTrainingWorkers.gpu: false` |
| `nn-extraction-training-gpu` | `nnTrainingWorkers.enabled: true` かつ `nnTrainingWorkers.gpu: true` |
| `nn-nlp-model-train` | `nnTrainingWorkers.enabled: true` かつ `nnTrainingWorkers.gpu: false` |
| `nn-nlp-model-train-gpu` | `nnTrainingWorkers.enabled: true` かつ `nnTrainingWorkers.gpu: true` |
| その他すべてのワーカー | 常に |
### インクルージョンマトリクス: 前バージョンのパス
`spec.techcore.keepPreviousVersion: true` の場合にのみ実行されます。
| チャートパターン | 含まれる条件 |
| --------------------------------------- | -------------------------------- |
| `worker-id-reading` | 含まれない |
| `nn-extraction-training*` (CPU and GPU) | 含まれない (NN の学習は現在のバージョンでのみ実行されます) |
| `nn-nlp-model-train*` (CPU and GPU) | 含まれない (NN の学習は現在のバージョンでのみ実行されます) |
| その他のすべてのワーカー | 常に |
ID reading は TechCore の対象ではなく、プラットフォーム レベルの機能です。これを制御するフラグは `spec.idReadingEnabled` で、`spec.techcore` の外側にあります。[`Vantage.spec` リファレンス](/ja/vantage/self-hosted/v3.0/api-reference#vantagespec)を参照してください。
このマトリクスは、選択したバージョンの ワークロード ConfigMap に存在するワーカーのうち、どれを含めるかだけを決定します。そのバージョンの ワークロード に存在しないチャートは、単にデプロイできません。たとえば、`worker-ocr-join` は現時点では `vtc-2` の workload セットにのみ含まれているため、`keepPreviousVersion: true` と `previousVersion: 2` を指定していても、`vtc-2-worker-ocr-join` としてのみデプロイされます。
## 次へ
`Vantage` カスタムリソースの各 field のリファレンス。
これらのチャートを使用したインストール手順です。
ingress、mesh、シークレット、ストレージ、データサービスをお客様側で管理する構成でインストールします。