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

前提条件チェックリスト

Vantage をインストールする前に、次の外部コンポーネントを準備および設定しておきます。
  • Docker とインターネット接続を備えたマシン(Vantage のインストールに使用するマシン)
  • Kubernetes ノードとして使用する仮想マシン(インストール中はインターネット接続が必要)
  • Docker イメージを保存するコンテナレジストリ
  • 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 アクセス
  • 各ワーカーノード上で /opt/local-path-provisioner にマウントされた、拡張可能な専用ディスク / lvm_volume
  • インストール時にコンテナレジストリおよびパッケージリポジトリへアクセス可能なインターネット接続:
    • Vantage のインストール前提条件として準備された同期済みイメージを含むコンテナレジストリ。詳細については、コンテナイメージのダウンロードを参照してください。
    • パッケージリポジトリ: Ubuntu (archive.ubuntu.com)、RHEL (cdn.redhat.com)。パッケージリポジトリへのアクセスの代わりに、以下に列挙される必要なパッケージをすべて含む独自のリポジトリへのアクセスを構成することもできます。
共通 (すべてのディストリビューション):
curl, socat, unzip, e2fsprogs, xfsprogs, ebtables, tar
OS ごと:
python3-apt, apt-transport-https, software-properties-common,
conntrack, libseccomp2

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

クラスターのインストール後、仮想マシンは次のリソースにアクセスできる必要があります。
  • https://licensing-us.abbyy.com
  • メールサーバー(メールによる招待送信やパスワードのリカバリなどのため)。SMTP 設定は env_specific.yml ファイルで指定します。
  • Vantage の Process skills でメールをインポートする予定のすべてのメールサーバー。これらは、それぞれインポート対象のメールアドレスが登録されているメールサーバーでなければなりません。

高可用性構成

必要となる仮想マシン数の最小値を示しています。求めるパフォーマンスによっては、異なる台数の仮想マシンが必要になる場合があります。
Kubernetes ノード種別マスターノードワーカーノード(Services)ワーカーノード(Workers)
オペレーティングシステムUbuntu 20.04 または RHEL 8Ubuntu 20.04 または RHEL 8Ubuntu 20.04 または RHEL 8
VM 数341
CPU コア数(VM ごと)21212
RAM(VM ごと、GB)44848
Kubernetes 用ディスクストレージ(VM ごと、GB)508080
/opt/local-path-provisioner マウントポイント用ディスク/ボリューム(GB)不要最小 40最小 40
ネットワーク帯域幅(VM ごと、Gbps)111

高可用性構成なし

Kubernetes ノード種別マスターノードワーカーノード(Services)ワーカーノード(Workers)
オペレーティングシステムUbuntu 20.04 または RHEL 8Ubuntu 20.04 または RHEL 8Ubuntu 20.04 または RHEL 8
VM の台数111
CPU コア数(各 VM あたり)21212
RAM(GB)(各 VM あたり)44848
Kubernetes 用ディスクストレージ(GB)(各 VM あたり)508080
/opt/local-path-provisioner マウントポイント用ディスク/ボリューム(GB)不要最小 40最小 40
ネットワーク帯域幅(Gbps)(各 VM あたり)111
Vantage のインストール中に Kubernetes バージョン 1.28.4 がインストールされます。

コンテナー レジストリ

どのコンテナー レジストリも使用できます。

データベース要件

次の構成を備えた Microsoft SQL Server データベースが必要です。
バージョンOSCPU コア数RAM, GBディスク容量, GBフルテキスト検索
Enterprise 2022Linux44推奨: 400, 最小: 200有効
外部 SQL データベース サーバーを用意し、新しいデータベースを作成および管理するための適切な資格情報を保有している必要があります。 インストーラーでは、SQL Server の IP アドレスおよびデータベースに接続するためのユーザー名とパスワードが必要です。

SMTP サーバー

サーバーは SMTP プロトコル経由で動作する必要があります。 インストーラーでは、SMTP サーバーの IP アドレス/DNS 名、ポート、サーバーへの接続パスワード(サーバーが認証を要求する場合)を指定する必要があります。SMTP サーバーは、Vantage ユーザー宛てにメールを送信できるように許可されている必要があります。 env_specific.yml で、認証ありまたは認証なしの SMTP を設定します。
認証あり(ログインとパスワード あり)のオプションを使用することを推奨します。
認証あり(推奨) ログインとパスワード あり の場合。この場合、env_specific.yml ファイル内の smtp セクションは次のように定義する必要があります。
smtp:
  host: X.X.X.X
  login: email
  password: password
  port: 587
  useSSL: false
  secureSocketOptions: null
認証なし ログイン名とパスワードを使用しない場合は、env_specific.yml ファイル内の smtp セクションを次のように定義する必要があります。
mailFrom: email
smtp:
  host: X.X.X.X
  login: null
  password: null
  port: 25
  useSSL: false
  secureSocketOptions: None
ルートに mailFrom Parameter を追加するのを忘れないでください。
認証(ログインとパスワード)付きのオプションを使用することを推奨します。

TLS 証明書

ワイルドカード証明書またはドメイン専用証明書のいずれかが必要です。 Vantage のインストール環境で Custom activity を使用して外部サービスに接続する場合、または外部システムへエクスポートする場合は、その証明書は https://letsencrypt.org/ などのパブリック認証局によって発行されたものである必要があります。

固定 IP アドレス

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

Vantage へのアクセス用 DNS レコード

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

外部ストレージ

外部ストレージは、高可用性なし構成においてのみ任意の要件となります。高可用性構成でのディスクサイズ要件については、Performance Guide を参照してください。 ABBYY Vantage は、提供される仮想マシンのハードディスク上にローカルストレージをデプロイし、製品のインストールを高速化します。ただし、このオプションは予期しない再起動や仮想マシンのクラッシュの影響を受ける可能性があります。これにより保存中のデータを失う可能性があるため、インストール時には外部ストレージを使用することを推奨します。 ABBYY Vantage では、以下に示す方法で特定のストレージタイプの利用方法を指定できます。

提供された仮想マシンのハードディスク上のローカルストレージを使用する

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

外部 NFS ストレージの使用

Vantage インストーラーでは、インポートや共有フォルダーへのエクスポート、モニタリングで収集されたデータの保存など、特定のサービス向けに Vantage のストレージとして使用する NFS ストレージを自動的に構成できます。 env_specific.yml ファイル内の該当セクションは次のようになります。
k8s:
  storage:
    rwx:
      external:
        enabled: true
        type: "nfs"
        nfs:
          address: <NFSサーバーのIPアドレス>
          path: <NFSサーバーのエクスポート共有パス>
Vantage を正しく動作させるために、NFS サーバーのルートディレクトリ(例: /opt/nfs)には、次の権限および所有者を設定することを推奨します。
drwxr-xr-x 4 65532 65532 4096 Dec 12 09:25 /opt/nfs/
以下は、Linux マシンを NFS サーバーとして使用する場合の /etc/exports ファイルにおけるディレクトリ設定例です。
/opt/nfs *(rw,sync,all_squash,insecure,no_subtree_check,anonuid=65532,anongid=65532)
別の種類のストレージを接続する必要がある場合は、下記の独自のストレージクラスの定義セクションを参照してください。

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

NFS 以外の外部ストレージを使用する場合は、次の手順に従います。
  1. インストール手順の中で、Kubernetes クラスターの作成(インストールスクリプトの実行 のステップ 4)後に、該当する CSI(Container Storage Interface)ドライバーをデプロイし、それに対応するストレージクラスを作成します。
  2. 次のコードを使用して、env_specific.yml ファイル内の k8s セクションを設定します。
k8s:
  storage:
    rwo:
      class_name: "<rwo posix compatible storage class>"
    rwx:
      class_name: "<read_write_many_storage_class>"
  1. インストールを続行します。
NFS ストレージを使用する場合は、env_specific.yml で設定を行います:
k8s:
  storage:
    rwx:
      external:
        enabled: true
        type: "nfs"
        nfs:
          address: <your nfs server IP address>
          path: <your nfs server exported share>
ローカル永続ボリュームの空き容量が不足すると、データが失われて Vantage が動作しなくなる可能性があります。空き容量を監視し、アラートを設定してください。