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

# システム要件

> 仮想マシンまたは Azure AKS 上に ABBYY Vantage セルフホスト型を導入するための、ハードウェア、ソフトウェア、ネットワークの要件（RDBMS、SMTP、ストレージの前提条件を含む）。

<div id="prerequisites-checklist">
  ## 前提条件チェックリスト
</div>

Vantage をインストールする前に、次の外部コンポーネントを準備して構成してください。

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

  <Tab title="Azure AKS">
    * リソースの作成および管理の権限を持つ Microsoft Azure サブスクリプション
    * インストール マシンにインストールされた Azure CLI
    * Docker とインターネット接続を備えたマシン (Vantage のインストール元)
    * 適切なノード プールを備えた Azure Kubernetes Service (AKS) クラスター
    * Docker イメージを保存するための Azure Container Registry
    * Vantage の運用に必要な Azure SQL Database
    * Vantage データ用の Azure Storage Accounts
    * Vantage ユーザーにメールを送信するための SMTP サーバーまたは Azure SendGrid
    * 暗号化通信を確立するための TLS 証明書
    * Vantage へのアクセス用の Azure Public IP アドレス (Standard Static IPv4)
    * Vantage へのアクセス用の DNS レコード
    * Redis クラスター (高可用性構成でのみ必須)
  </Tab>
</Tabs>

<div id="installation-machine-requirements">
  ## インストール元マシンの要件
</div>

Vantage をインストールするマシンには、次の要件が必要です。

<Tabs>
  <Tab title="仮想マシン">
    * Linux OS または Windows Subsystem for Linux (WSL)
    * Docker バージョン 19.03 以降
    * `abyvtgonprm27.azurecr.io` へのネットワークアクセス
    * `ansible` ユーザーアカウント用の秘密 SSH キー (パスフレーズなし) が含まれるローカルファイル

    <Note>
      すべての仮想マシンで同じ SSH キーを使用する必要があります。
    </Note>
  </Tab>

  <Tab title="Azure AKS">
    * Linux OS または Windows Subsystem for Linux (WSL)
    * Docker バージョン 19.03 以降
    * Azure CLI がインストールおよび構成されていること
    * kubectl がインストールされていること
    * `abyvtgonprm27.azurecr.io` へのネットワークアクセス
  </Tab>
</Tabs>

<div id="infrastructure-requirements">
  ## インフラストラクチャ要件
</div>

<Tabs>
  <Tab title="仮想マシン">
    すべての仮想マシンは 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](/ja/vantage/self-hosted/v2.7/installation#downloading-container-images) を参照してください。
      * パッケージリポジトリ: Ubuntu ([archive.ubuntu.com](http://archive.ubuntu.com))、RHEL ([cdn.redhat.com](http://cdn.redhat.com))。パッケージリポジトリへのアクセスの代わりに、以下に示すすべての必須パッケージを含む独自のリポジトリへのアクセスを構成することもできます。

    **共通 (すべてのディストリビューション) :**

    ```
    curl, socat, unzip, e2fsprogs, xfsprogs, ebtables, tar
    ```

    **OS 固有のパッケージ:**

    | Ubuntu 20.04                                                                         | RHEL 8                                                            |
    | ------------------------------------------------------------------------------------ | ----------------------------------------------------------------- |
    | python3-apt, apt-transport-https, software-properties-common, conntrack, libseccomp2 | device-mapper-libs, nss, conntrack, container-selinux, libseccomp |

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

    クラスターのインストール後、仮想マシンは次へのアクセスが必要です。

    * `https://licensing-us.abbyy.com`
    * `env_specific.yml` ファイルで SMTP settings が指定されているメールサーバー (メール招待の送信、パスワードの再設定などのため) 。
    * Vantage Process skills でメールをインポートする予定の、すべてのメールサーバー。
  </Tab>

  <Tab title="Azure AKS">
    Azure Kubernetes Service (AKS) クラスターの要件:

    * Kubernetes バージョン: 1.33.3
    * 必要な VM サイズをサポートする Azure リージョン
    * ネットワーク プラグイン: Azure CNI を推奨
    * ingress 用の Azure Public IP アドレス (Standard Static IPv4)

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

    クラスターのデプロイ後、AKS クラスターは次へのアクセスが必要です。

    * `https://licensing-us.abbyy.com`
    * メール招待の送信、パスワードの再設定などのためのメールサーバー、または Azure SendGrid
    * Vantage Process skills でメールをインポートする予定の、すべてのメールサーバー。
  </Tab>
</Tabs>

<div id="highly-available-configuration">
  ## 高可用性構成
</div>

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

    | Kubernetes ノードタイプ                                     | マスターノード                | ワーカーノード (サービス)         | ワーカーノード (ワーカー)         |
    | ----------------------------------------------------- | ---------------------- | ---------------------- | ---------------------- |
    | オペレーティングシステム                                          | Ubuntu 20.04 or RHEL 8 | Ubuntu 20.04 or RHEL 8 | Ubuntu 20.04 or RHEL 8 |
    | VM 数                                                  | 3                      | 4                      | 1                      |
    | CPU コア数 (各 VM)                                        | 2                      | 12                     | 12                     |
    | RAM、GB (各 VM)                                         | 4                      | 48                     | 48                     |
    | Kubernetes 用ディスクストレージ、GB (各 VM)                       | 50                     | 80                     | 80                     |
    | `/opt/local-path-provisioner` のマウントポイント用ディスク/ボリューム、GB | 不要                     | 最小 40                  | 最小 40                  |
    | ネットワーク帯域幅、Gbps (各 VM)                                 | 1                      | 1                      | 1                      |
  </Tab>

  <Tab title="Azure AKS">
    <Note>
      必要最小限のノード数を示しています。必要なパフォーマンスによっては、追加のノードが必要になる場合があります。
    </Note>

    | ノードプール構成      | サービスノードプール         | ワーカーノードプール          |
    | ------------- | ------------------ | ------------------- |
    | Azure VM Size | Standard\_D8as\_v5 | Standard\_D16as\_v5 |
    | vCPU 数 (各ノード) | 8                  | 16                  |
    | RAM、GB (各ノード) | 32                 | 64                  |
    | ノード数          | 4                  | 1                   |
    | ノードプールモード     | User               | User                |
    | OS ディスクサイズ、GB | 128                | 128                 |

    **ワーカーノードプールのラベルとテイント**

    `Standard_D16as_v5` の workers pool **には必ず**、次のラベルとテイントを設定する必要があります。

    ラベル:

    * `k8s.abbyy.com/techcore: "true"`
    * `k8s.abbyy.com/overprovision-label: workers`

    テイント:

    * `k8s.abbyy.com/techcore=true:NoSchedule`
  </Tab>
</Tabs>

<div id="without-high-availability-configuration">
  ## 高可用性なしの構成
</div>

<Tabs>
  <Tab title="仮想マシン">
    | Kubernetes ノードタイプ                                      | マスターノード                | ワーカーノード (サービス)         | ワーカーノード (ワーカー)         |
    | ------------------------------------------------------ | ---------------------- | ---------------------- | ---------------------- |
    | OS                                                     | Ubuntu 20.04 or RHEL 8 | Ubuntu 20.04 or RHEL 8 | Ubuntu 20.04 or RHEL 8 |
    | 仮想マシン数                                                 | 1                      | 1                      | 1                      |
    | CPU コア数 (各 VM)                                         | 2                      | 12                     | 12                     |
    | RAM (各 VM、GB)                                          | 4                      | 48                     | 48                     |
    | Kubernetes 用ディスクストレージ (各 VM、GB)                        | 50                     | 80                     | 80                     |
    | `/opt/local-path-provisioner` マウントポイント用ディスク/ボリューム (GB) | 不要                     | 最低 40                  | 最低 40                  |
    | ネットワーク帯域幅 (各 VM、Gbps)                                  | 1                      | 1                      | 1                      |

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

  <Tab title="Azure AKS">
    | ノードプール構成        | サービスノードプール         | ワーカーノードプール          |
    | --------------- | ------------------ | ------------------- |
    | Azure VM Size   | Standard\_D8as\_v5 | Standard\_D16as\_v5 |
    | vCPU 数 (各ノード)   | 8                  | 16                  |
    | RAM (各ノード、GB)   | 32                 | 64                  |
    | ノード数            | 2                  | 1                   |
    | ノードプールモード       | User               | User                |
    | OS ディスクサイズ (GB) | 128                | 128                 |

    **ワーカーノードプールのラベルと Taint**

    `Standard_D16as_v5` のワーカープールには、次のラベルと Taint を**必ず**設定する必要があります。

    ラベル:

    * `k8s.abbyy.com/techcore: "true"`
    * `k8s.abbyy.com/overprovision-label: workers`

    Taint:

    * `k8s.abbyy.com/techcore=true:NoSchedule`

    <Note>
      AKS は Kubernetes のコントロールプレーンを管理します。Kubernetes バージョン 1.33.3 が必要です。
    </Note>
  </Tab>
</Tabs>

<div id="container-registry">
  ## Container Registry
</div>

<Tabs>
  <Tab title="仮想マシン">
    任意のコンテナー レジストリを使用できます。
  </Tab>

  <Tab title="Azure AKS">
    Azure へのデプロイには、Azure Container Registry (ACR) を推奨します。AKS クラスターにレジストリへのプル アクセスがあることを確認してください。
  </Tab>
</Tabs>

<div id="database-requirements">
  ## データベース要件
</div>

<Tabs>
  <Tab title="仮想マシン">
    次の構成を満たす Microsoft SQL Server または PostgreSQL データベースが必要です。

    **オプション 1: Microsoft SQL Server**

    | バージョン           | OS    | CPU コア | RAM, GB | Disk Storage, GB | Full-Text Search |
    | --------------- | ----- | ------ | ------- | ---------------- | ---------------- |
    | Enterprise 2022 | Linux | 4      | 4       | 推奨: 400、最小: 200  | 有効               |

    **オプション 2: PostgreSQL**

    | バージョン | CPU コア | RAM, GB | Disk Storage, GB |
    | ----- | ------ | ------- | ---------------- |
    | 14+   | 4      | 4       | 推奨: 400、最小: 200  |

    外部データベース サーバーをセットアップし、新しいデータベースを作成および管理するための適切な認証情報を用意する必要があります。

    インストーラーでは、データベースへの接続に必要な SQL Server の IP アドレス、および Username とパスワードが必要です。
  </Tab>

  <Tab title="Azure AKS">
    エラスティック プールを使用する Azure SQL Database が必要です。

    | 構成            | 値                       |
    | ------------- | ----------------------- |
    | サービス レベル      | 汎用                      |
    | コンピューティング レベル | Standard-series (Gen 5) |
    | vCores        | 4                       |
    | 最大ストレージ       | 100 GB                  |

    Azure SQL Database には AKS クラスターからアクセスできる必要があります。Vantage インストーラーには、サーバーのホスト名、データベース名、認証情報 (Username とパスワード) が必要です。

    <Note>
      Azure SQL Database のファイアウォール ルールで、AKS クラスターの送信元 IP アドレスからの接続が許可されていることを確認してください。
    </Note>
  </Tab>
</Tabs>

<div id="smtp-server">
  ## SMTP Server
</div>

サーバーは SMTP プロトコルで動作している必要があります。

インストーラーには、SMTP サーバー の IP アドレス/DNS 名、ポート、およびサーバーへの接続に使用する password (サーバーで認証が必要な場合) が必要です。SMTP サーバー は、Vantage ユーザー宛てのメール送信を許可されている必要があります。

認証の有無にかかわらず、`env_specific.yml` で SMTP を設定します。

<Note>
  認証あり (**login** と password を使用) のオプションを推奨します。
</Note>

**認証あり (推奨) **

**login** と password を使用します。この場合、env\_specific.yml ファイルの smtp セクションは次のように定義する必要があります。

```yaml theme={null}
smtp:
  host: X.X.X.X
  login: email
  password: password
  port: 587
  useSSL: false
  secureSocketOptions: null
```

**認証なし**

ログイン名とパスワードを使用しない場合、env\_specific.yml ファイル内の smtp セクションは次のように定義する必要があります。

```yaml theme={null}
mailFrom: email
smtp:
  host: X.X.X.X
  login: null
  password: null
  port: 25
  useSSL: false
  secureSocketOptions: None
```

**mailFrom** パラメーターをルート要素に追加するのを忘れないでください。

<Note>
  認証あり (ログイン名とパスワードを使用) のオプションを使用することをお勧めします。
</Note>

<div id="tls-certificate">
  ## TLS 証明書
</div>

ワイルドカード証明書またはドメイン固有の証明書のいずれかが必要です。

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

<div id="static-ip-addresses">
  ## 静的IPアドレス
</div>

<Tabs>
  <Tab title="仮想マシン">
    **1. Kubernetes APIへのアクセス。** クラスターの構成と管理のために、Kubernetes APIサーバーのエンドポイントへアクセスする際の仮想IPアドレスとして使用する静的IPアドレスです。IPアドレスは、次のように **env\_specific.yml** ファイルで定義する必要があります。詳細については、「設定ファイルの設定」を参照してください。

    ```yaml theme={null}
    k8s:
      api:
        ip: X.X.X.X
    ```

    **2. Vantage サービスへのアクセス。** HTTPS経由でVantage サービスにアクセスするために使用する静的IPアドレスです。適切な **DNS Aレコード** を事前に作成しておく必要があります。IPアドレスは、次のように **env\_specific.yml** ファイルで定義する必要があります。詳細については、[インストール](/ja/vantage/self-hosted/v2.7/installation)を参照してください。

    ```yaml theme={null}
    loadbalancer:
      external_ip: X.X.X.X
    ```
  </Tab>

  <Tab title="Azure AKS">
    HTTPS経由でVantage サービスにアクセスするには、Azure Public IP アドレス (Standard Static IPv4) が必要です。このIPアドレスは、イングレス コントローラーによって使用されます。

    パブリック IP は、AKS クラスターと同じリージョンに作成してください。このIPアドレスを指す適切な **DNS Aレコード** も作成する必要があります。
  </Tab>
</Tabs>

<div id="dns-record-for-vantage-access">
  ## Vantageアクセス用DNSレコード
</div>

特別な要件はありません。

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

<div id="storage-requirements">
  ## ストレージ要件
</div>

<Tabs>
  <Tab title="仮想マシン">
    外部ストレージは、**高可用性なし**構成でのみオプション要件となります。高可用性構成のディスク サイズ要件については、パフォーマンス ガイドで説明しています。

    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 ノードがローカルの永続ボリューム ストレージもホストします。これには、処理負荷に応じて追加のハードドライブ容量が必要です。必要な容量の詳細については、[パフォーマンス ガイド](/ja/vantage/self-hosted/v2.7/performance-guide)を参照してください。

    <Warning>
      ローカルの永続ボリューム ストレージの空き容量が不足すると、Vantage が停止し、一部のデータが失われる可能性があります。空き容量はお客様側で監視し、容量不足時のアラートを設定して、適切なタイミングでストレージを追加し、データ損失を防ぐことをお勧めします。
    </Warning>

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

    Vantage インストーラーでは、共有フォルダーへの import と export、monitoring で収集されたデータの保存など、特定のサービスで Vantage ストレージとして使用する NFS ストレージを自動的に構成できます。

    `env_specific.yml` ファイル内のセクションは、次のようになります。

    ```yaml theme={null}
    k8s:
      storage:
        rwx:
          external:
            enabled: true
            type: "nfs"
            nfs:
              address: <your nfs server IP address>
              path: <your nfs server exported share>
    ```

    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 クラスターの作成後 ([インストールスクリプトの実行](/ja/vantage/self-hosted/v2.7/installation) の手順 4) 、適切な CSI (Container Storage Interface) ドライバーをデプロイし、それらのストレージクラスを作成します。
    2. 次のコードを使用して、`env_specific.yml` ファイルの `k8s` セクションに入力します。

    ```yaml theme={null}
    k8s:
      storage:
        rwo:
          class_name: "<rwo posix compatible storage class>"
        rwx:
          class_name: "<read_write_many_storage_class>"
    ```

    3. インストールを続行します。

    <Warning>
      ローカルの永続ボリュームストレージの空き容量が不足すると、Vantage はデータが失われて動作を停止するおそれがあります。空き容量を監視し、アラートを設定してください。
    </Warning>
  </Tab>

  <Tab title="Azure AKS">
    Vantage のデータ ストレージには Azure Storage Accounts が必要です。次のストレージ アカウントを、AKS クラスターと同じリージョンに作成してください。

    | ストレージ アカウントの用途 | パフォーマンス層            | アクセス層 | 最小サイズ  |
    | -------------- | ------------------- | ----- | ------ |
    | Skills         | Premium             | Hot   | -      |
    | Processing     | Standard            | Hot   | -      |
    | Temporary      | Standard            | Hot   | -      |
    | Shared Folders | Premium FileStorage | -     | 100 GB |
    | Archive        | Standard            | Cool  | -      |

    <Note>
      すべてのストレージ アカウントは、AKS クラスターからアクセスできる必要があります。ネットワーク セキュリティ要件に応じて、プライベート エンドポイントまたはサービス エンドポイントを構成してください。
    </Note>

    Vantage インストーラーにより、これらの Azure Storage Accounts を使用するための適切な Kubernetes ストレージ クラスが構成されます。
  </Tab>
</Tabs>

<div id="redis-cluster-azure-aks-only">
  ## Redis クラスター (Azure AKS のみ)
</div>

<Note>
  Redis クラスターが必要なのは、**Azure AKS の高可用性構成の場合のみ**です。仮想マシンへのデプロイや、高可用性ではない Azure へのデプロイでは必要ありません。
</Note>

Azure AKS の高可用性デプロイでは、次の構成の外部 Redis クラスターが必要です。

| 設定          | 要件        |
| ----------- | --------- |
| Redis バージョン | 6.2 以降    |
| ノード数        | 6 以上      |
| ノードあたりの RAM | 4 GB (最小) |
| クラスターモード    | 有効        |
| クラスターパスワード  | 必須        |
| SSH ポート     | 22 (構成用)  |

`redis.conf` では、次のオプションを設定する必要があります。

```
appendonly yes
cluster-config-file nodes-6379.conf
cluster-enabled yes
cluster-node-timeout 5000
cluster-require-full-coverage no
maxclients 10000
maxmemory 2048mb
maxmemory-policy noeviction
repl-backlog-size 256mb
repl-ping-slave-period 5
save ""
slave-serve-stale-data yes
stop-writes-on-bgsave-error no
supervised auto
masterauth <password>
requirepass <password>
```

<Note>
  `maxmemory` の値は、各 Redis ノードで使用可能なメモリの半分に設定してください。`<password>` はクラスターのパスワードに置き換えてください。
</Note>

<Warning>
  Azure Cache for Redis は**現在サポートされていません**。Redis は AKS クラスター外の仮想マシンにデプロイする必要があります。Azure Cache for Redis のサポートは今後のリリースで提供される予定です。
</Warning>

<div id="related-documentation">
  ## 関連ドキュメント
</div>

* [Azure インフラストラクチャの作成](/ja/vantage/self-hosted/v2.7/azure-infrastructure) - ARM テンプレートを使用した Azure リソース作成の手順
* [FIPS コンプライアンス](/ja/vantage/self-hosted/v2.7/fips-compliance) - 政府機関向けデプロイメントにおける FIPS 140-2 コンプライアンス要件
* [インストール](/ja/vantage/self-hosted/v2.7/installation) - 包括的なインストール ガイド
* [パフォーマンス ガイド](/ja/vantage/self-hosted/v2.7/performance-guide) - スケーリングとパフォーマンス チューニング
