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

前提条件チェックリスト

Vantage をインストールする前に、次の外部コンポーネントを準備して構成してください。
  • Docker とインターネット接続を備えたマシン (Vantage のインストール元)
  • Kubernetes ノードとして使用する仮想マシン (インストール中はインターネット接続が必要)
  • Docker イメージを保存するための Container Registry
  • Vantage の運用に必要なリレーショナル データベース管理システム (RDBMS)
  • Vantage ユーザーにメールを送信するための SMTP サーバー
  • 暗号化通信を確立するための TLS 証明書
  • 2 つの静的 IP アドレス (1 つは Kubernetes の構成/管理用、もう 1 つは Vantage へのアクセス用)
  • Vantage へのアクセス用の DNS レコード
  • 外部ストレージ (高可用性なし構成では任意)

インストール元マシンの要件

Vantage をインストールするマシンには、次の要件が必要です。
  • Linux OS または Windows Subsystem for Linux (WSL)
  • Docker バージョン 19.03 以降
  • abyvtgonprm27.azurecr.io へのネットワークアクセス
  • ansible ユーザーアカウント用の秘密 SSH キー (パスフレーズなし) が含まれるローカルファイル
すべての仮想マシンで同じ SSH キーを使用する必要があります。

インフラストラクチャ要件

すべての仮想マシンは VMware または Hyper-V 上で実行でき、次の要件を満たしている必要があります。
  • 静的 IP アドレス
  • ansible という名前のユーザーアカウント。要件は次のとおりです。
    • 共有 SSH キーによるアクセス
    • NOPASSWD オプション付きの sudo アクセス
  • 各 worker node で、/opt/local-path-provisioner にマウントされた専用の拡張可能な disk/lvm_volume
  • インストール時に、Container Registry およびパッケージリポジトリへのインターネットアクセス:
    • Vantage のインストールの前提条件として準備された、同期済みイメージを含む Container Registry。詳しくは、Downloading Container Images を参照してください。
    • パッケージリポジトリ: Ubuntu (archive.ubuntu.com)、RHEL (cdn.redhat.com)。パッケージリポジトリへのアクセスの代わりに、以下に示すすべての必須パッケージを含む独自のリポジトリへのアクセスを構成することもできます。
共通 (すべてのディストリビューション) :
OS 固有のパッケージ:

インストール後のネットワークアクセス

クラスターのインストール後、仮想マシンは次へのアクセスが必要です。
  • https://licensing-us.abbyy.com
  • env_specific.yml ファイルで SMTP settings が指定されているメールサーバー (メール招待の送信、パスワードの再設定などのため) 。
  • Vantage Process skills でメールをインポートする予定の、すべてのメールサーバー。

高可用性構成

必要最小限の仮想マシン数を示しています。必要なパフォーマンスによっては、さらに多くの仮想マシンが必要になる場合があります。

高可用性なしの構成

Vantage のインストール時に Kubernetes バージョン 1.33.3 がインストールされます。

Container Registry

任意のコンテナー レジストリを使用できます。

データベース要件

次の構成を満たす Microsoft SQL Server または PostgreSQL データベースが必要です。オプション 1: Microsoft SQL Serverオプション 2: PostgreSQL外部データベース サーバーをセットアップし、新しいデータベースを作成および管理するための適切な認証情報を用意する必要があります。インストーラーでは、データベースへの接続に必要な SQL Server の IP アドレス、および Username とパスワードが必要です。

SMTP Server

サーバーは SMTP プロトコルで動作している必要があります。 インストーラーには、SMTP サーバー の IP アドレス/DNS 名、ポート、およびサーバーへの接続に使用する password (サーバーで認証が必要な場合) が必要です。SMTP サーバー は、Vantage ユーザー宛てのメール送信を許可されている必要があります。 認証の有無にかかわらず、env_specific.yml で SMTP を設定します。
認証あり (login と password を使用) のオプションを推奨します。
認証あり (推奨) login と password を使用します。この場合、env_specific.yml ファイルの smtp セクションは次のように定義する必要があります。
認証なし ログイン名とパスワードを使用しない場合、env_specific.yml ファイル内の smtp セクションは次のように定義する必要があります。
mailFrom パラメーターをルート要素に追加するのを忘れないでください。
認証あり (ログイン名とパスワードを使用) のオプションを使用することをお勧めします。

TLS 証明書

ワイルドカード証明書またはドメイン固有の証明書のいずれかが必要です。 Vantage のインストール環境で、カスタム アクティビティを使用して外部サービスに接続したり、外部システムにエクスポートしたりする場合は、公開認証局 (例: https://letsencrypt.org/) が発行した証明書を使用する必要があります。

静的IPアドレス

1. Kubernetes APIへのアクセス。 クラスターの構成と管理のために、Kubernetes APIサーバーのエンドポイントへアクセスする際の仮想IPアドレスとして使用する静的IPアドレスです。IPアドレスは、次のように env_specific.yml ファイルで定義する必要があります。詳細については、「設定ファイルの設定」を参照してください。
2. Vantage サービスへのアクセス。 HTTPS経由でVantage サービスにアクセスするために使用する静的IPアドレスです。適切な DNS Aレコード を事前に作成しておく必要があります。IPアドレスは、次のように env_specific.yml ファイルで定義する必要があります。詳細については、インストールを参照してください。

Vantageアクセス用DNSレコード

特別な要件はありません。 インストーラーには、プライマリドメインと、Vantageへのアクセスに使用するDNS名が必要です。DNSレコードは、Vantageへのアクセス専用のIPアドレスを指している必要があります。

ストレージ要件

外部ストレージは、高可用性なし構成でのみオプション要件となります。高可用性構成のディスク サイズ要件については、パフォーマンス ガイドで説明しています。ABBYY Vantage は、提供された仮想マシンのハードドライブ上にローカル ストレージを配置することで、製品のインストールを高速化します。ただし、このオプションも予期しない再起動や仮想マシンのクラッシュの影響を受ける可能性があります。保存されているデータが失われるおそれがあるため、インストール時には外部ストレージの使用をお勧めします。ABBYY Vantage では、以下の方法で特定のストレージ タイプの使用を設定できます。

ローカル ストレージを使用する

この場合、ReadWriteOnce の POSIX 互換アクセスを持つボリュームが、各 Kubernetes ノードの /opt/local_path_provisioner ディレクトリにローカルでプロビジョニングされます。ReadWriteMany ボリューム タイプの場合、Vantage は最初の abbyy_services ノードに in-cluster nfs-kernel-server をデプロイします (このノードの IP は、inventory ファイル内の対応するブロックの先頭に記載されたものです) 。NFS サーバーのデータは /opt/local_path_provisioner ディレクトリに保存されるため、最初の abbyy_services ノード (このグループの最初のノードは inventory ファイルで定義されています) では、このパス用に少なくとも 500 GB の専用ボリュームまたはディスクを必ず用意してください。高可用性構成では、最初の abbyy_services ノードがローカルの永続ボリューム ストレージもホストします。これには、処理負荷に応じて追加のハードドライブ容量が必要です。必要な容量の詳細については、パフォーマンス ガイドを参照してください。
ローカルの永続ボリューム ストレージの空き容量が不足すると、Vantage が停止し、一部のデータが失われる可能性があります。空き容量はお客様側で監視し、容量不足時のアラートを設定して、適切なタイミングでストレージを追加し、データ損失を防ぐことをお勧めします。

外部 NFS ストレージを使用する

Vantage インストーラーでは、共有フォルダーへの import と export、monitoring で収集されたデータの保存など、特定のサービスで Vantage ストレージとして使用する NFS ストレージを自動的に構成できます。env_specific.yml ファイル内のセクションは、次のようになります。
Vantage が正しく動作するよう、NFS サーバーのルートディレクトリ (たとえば /opt/nfs) には、次の権限と所有者を設定することを推奨します。
以下は、Linux マシンを NFS サーバーとして使用する場合の /etc/exports ファイルにおけるディレクトリ設定例です:
別の種類のストレージを接続する必要がある場合は、以下の独自のストレージクラスの定義セクションを参照してください。

独自のストレージクラスの定義

NFS 以外の外部ストレージを使用する場合は、以下の手順に従ってください。
  1. インストール時に、Kubernetes クラスターの作成後 (インストールスクリプトの実行 の手順 4) 、適切な CSI (Container Storage Interface) ドライバーをデプロイし、それらのストレージクラスを作成します。
  2. 次のコードを使用して、env_specific.yml ファイルの k8s セクションに入力します。
  1. インストールを続行します。
ローカルの永続ボリュームストレージの空き容量が不足すると、Vantage はデータが失われて動作を停止するおそれがあります。空き容量を監視し、アラートを設定してください。

Redis クラスター (Azure AKS のみ)

Redis クラスターが必要なのは、Azure AKS の高可用性構成の場合のみです。仮想マシンへのデプロイや、高可用性ではない Azure へのデプロイでは必要ありません。
Azure AKS の高可用性デプロイでは、次の構成の外部 Redis クラスターが必要です。 redis.conf では、次のオプションを設定する必要があります。
maxmemory の値は、各 Redis ノードで使用可能なメモリの半分に設定してください。<password> はクラスターのパスワードに置き換えてください。
Azure Cache for Redis は現在サポートされていません。Redis は AKS クラスター外の仮想マシンにデプロイする必要があります。Azure Cache for Redis のサポートは今後のリリースで提供される予定です。