インストール - ABBYY Documentation

Vantage 3.0 ではこのデプロイモデルは廃止されました。 Vantage 2.7 以前では、ABBYY が提供する Ansible スクリプトと Azure CLI スクリプトで構築される、ABBYY 指定のインフラストラクチャが必要でした。3.0 ではこのモデルはサポートされておらず、お客様が独自にインフラストラクチャをプロビジョニングする必要があります。また、ABBYY はプロビジョニングスクリプトやその他のインフラストラクチャ自動化を提供しません。このページは Vantage 2.7 にのみ適用されます。Vantage 3.0 の概要と Vantage 2.7 からの移行を参照してください。

インストールの概要

Vantageをインストールするには、次の手順に従ってください。

リソースを準備します。
リソースの認証情報を指定します。
インストールスクリプトを実行します。

リソースの準備

仮想マシン
Azure AKS

作業を始める前に、システム要件に記載されている要件をすべて満たしていることを確認してください。

リソース認証情報の指定

インストーラーを実行する前に、次の準備を行ってください。

設定ファイルを準備します。
証明書を準備します。
コンテナーイメージをダウンロードします。

設定ファイルの準備

1. インストールディレクトリを作成します。 インストールを実行するインストールディレクトリと、そのサブディレクトリ (ssh、kube、ssl) を作成します。次に、インストールディレクトリに移動します。

mkdir -p /opt/vantage-install/{ssh,kube,ssl} && cd /opt/vantage-install

仮想マシン
Azure AKS

2. SSHキーファイルを作成します。ssh フォルダーに ansible という名前のファイルを作成し、そのファイルに ansible ユーザーの SSH 秘密鍵を配置します。3. インベントリファイルを作成します。インストールディレクトリに inventory ファイルを作成します。X.X.X.X はご利用の VM の IP アドレスに置き換えてください。

[localhost]
127.0.0.1

###########################################
[kube_control_plane]
ub01master01 ansible_host=X.X.X.X

[abbyy_services]
ub01worker12-48-s01 ansible_host=X.X.X.X

[abbyy_workers]
ub01worker12-48-w01 ansible_host=X.X.X.X
ub01worker12-48-w02 ansible_host=X.X.X.X
ub01worker12-48-w03 ansible_host=X.X.X.X

###########################################
[kube_workers:children]
abbyy_services
abbyy_workers

[kube_cluster:children]
kube_control_plane
kube_workers

ワーカー用のマシンが 3 台ではなく 1 台または 2 台だけ必要な場合は、[abbyy_workers] セクションの不要な行を削除してください。

4. env_specific.yml ファイルを作成します。 環境に合わせて値を指定してください。

仮想マシン
Azure AKS

env: null
poc: true

domain: null
product_host: "{{ env }}.{{ domain }}"

logging:
  enabled: true
  elasticsearch:
    enabled: false
    host: null
    port: 9200
    username: null
    password: null
    scheme: https
  file:
    enabled: true

loadbalancer:
  external_ip: X.X.X.X

k8s:
  api:
    ip: X.X.X.X

techcore:
  use_gpu_workers: false
  use_nn_extraction_training_workers: false

platform_admin_email: admin@yourdomain.tld

source_container_registry_host: abyvtgonprm27.azurecr.io
source_container_registry_user: null      # 調達時に取得した認証情報に置き換えてください
source_container_registry_password: null  # 調達時に取得した認証情報に置き換えてください
source_container_registry_name: "{{ source_container_registry_host }}"

container_registry_host: registry.yourdomain.tld
container_registry_user: null
container_registry_password: null
container_registry_name: "{{ container_registry_host }}/vantage"

smtp:
  host: null
  login: null
  password: null
  port: 587
  useSSL: false
  secureSocketOptions: null

database:
  host: X.X.X.X
  port: 1433
  username: null
  password: null

reporting:
  enabled: false

id_reading:
  enabled: false

env: vantage
poc: false  # 高可用性なしの構成では true に設定してください

domain: yourdomain.tld
product_host: "vantage.{{ domain }}"

loadbalancer:
  external_ip: X.X.X.X  # Azure の Public IP アドレス

container_registry_host: "registry.yourdomain.tld"
container_registry_user: "service"
container_registry_password: "password"
container_registry_name: "{{ container_registry_host }}/vantage"

techcore:
  use_gpu_workers: false
  use_nn_extraction_training_workers: false

logging:
  enabled: true
  elasticsearch:
    enabled: false
    host: null
    port: 9200
    username: null
    password: null
    scheme: https
    ilm:
      create: false
  file:
    enabled: true

platform_admin_email: admin@yourdomain.tld

# メール設定 - SendGrid または SMTP のいずれかを使用してください
sendgrid:
  enabled: false
  apiKey: ""

smtp:
  host: X.X.X.X
  login: null
  password: ""
  port: 587
  useSSL: false

mailFrom: noreply@yourdomain.tld

# Azure SQL Database の構成
database:
  type: sqlserver
  host: X.X.X.X  # Azure SQL Server のホスト名
  username: login
  password: password
  encrypt: false

# Azure Storage Accounts の構成 - ストレージ アカウントの認証情報に置き換えてください
s3storage:
  skills:
    accessKey: skills_storage_account_name
    secretKey: skills_storage_account_key
  processing:
    accessKey: processing_storage_account_name
    secretKey: processing_storage_account_key
  temporary:
    accessKey: temporary_storage_account_name
    secretKey: temporary_storage_account_key
  sharedfolder:
    accessKey: sharedfolder_storage_account_name
    secretKey: sharedfolder_storage_account_key
    resourcegroup: your_resource_group
  archive:
    accessKey: archive_storage_account_name
    secretKey: archive_storage_account_key

# Redis クラスターの構成（高可用性の場合のみ必須）
# 高可用性なしの構成では空の配列のままにしてください
redis:
  ips: ['172.16.10.101', '172.16.10.102', '172.16.10.103', '172.16.10.104', '172.16.10.105', '172.16.10.106']
  port: 6379
  password: redispassword
  ssl: false

reporting:
  enabled: false

id_reading:
  enabled: false

k8s_fips_enabled: false

s3storage セクションでは、accessKey は Azure Storage Account 名、secretKey は Storage Account のアクセスキーです。これらの値は、Azure ポータルまたは Azure CLI を使用して取得できます。

設定パラメーター

Parameter	説明
`env`	インストールプレフィックスです。既定ではサブドメイン名として使用されます。
`poc`	高可用性なしの場合は `true`、高可用性の場合は `false` です。
`domain`	プライマリドメインです。
`product_host`	製品アクセス用の DNS 名です (既定値: `env.domain`) 。
`logging.enabled`	logging を有効/無効にします (`true`/`false`) 。
`logging.elasticsearch.enabled`	Elasticsearch を有効にするかどうかを指定します。このパラメーターには true または false を設定できます。注: このパラメーターの値を true に設定するのは、既存の Elasticsearch があり、Vantage のログをそこに接続する場合のみです。既存の Elasticsearch および Kibana のインスタンスがない場合は、Elasticsearch and Kibana の手順に従ってクラスターにデプロイできます。これは製品をインストールする前に実施する必要があります。
`logging.elasticsearch.host`	サーバーの IP アドレスです。
`logging.elasticsearch.port`	Elasticsearch への接続に使用するポートです。
`logging.elasticsearch.username`	Elasticsearch への接続に使用するユーザー名です。
`logging.elasticsearch.password`	Elasticsearch への接続に使用するパスワードです。
`logging.elasticsearch.scheme`	Elasticsearch への接続に使用するプロトコルのスキームです。
`logging.file.enabled`	ログをファイルとして書き込むかどうかを指定します。このパラメーターには true または false を設定できます。
`loadbalancer.external_ip`	ロードバランサー用の Floating IP アドレスです。
`k8s.api.ip`	Kubernetes API エンドポイントの IP アドレスです。
`securityContext.global.runAsUser`	コンテナーのプロセスを実行するユーザーの識別子を指定します。この設定は、外部 rwx ストア (NFS など) を使用する pod にのみ適用されます。既定では、このパラメーターは 65532 に設定されています。
`securityContext.global.runAsGroup`	コンテナーのプロセスを実行するグループの識別子を指定します。この設定は、外部 rwx ストア (NFS など) を使用する pod にのみ適用されます。既定では、このパラメーターは 65532 に設定されています。
`securityContext.global.fsGroup`	pod にアタッチされるボリュームの所有者となるグループの識別子を指定します。この設定は、外部 rwx ストア (NFS など) を使用する pod にのみ適用されます。既定では、このパラメーターは 65532 に設定されています。
`techcore.nn_training_workers.gpu`	GPU worker をデプロイするかどうかを指定します。GPU worker は、半構造化文書からデータを抽出するために Deep Learning activity を使用する Skill の学習に使用されます。このパラメーターには true または false を設定できます。パラメーターを true に設定する場合は、`techcore.nn_training_workers.enabled` パラメーターも true に設定する必要があります。Vantage のインストール前でも後でも、このオプションをデプロイし、`techcore.nn_training_workers.gpu` と `techcore.nn_training_workers.enabled` パラメーターを true に設定できます。詳細は、Setting up GPU を参照してください。
`techcore.nn_training_workers.enabled`	nn-extraction-training worker と nlp-model-train worker をデプロイするかどうかを指定します。これらの worker は、CPU を使用して半構造化文書からデータを抽出するために Deep Learning activity を使用する Skill の学習に使用されます。このパラメーターには true または false を設定できます。
`techcore.keep_previous_version`	Vantage の更新時に Technology Core バージョン 2 を保持するかどうかを指定します。既定では、`techcore.keep_previous_version` パラメーターは指定されておらず、Technology Core バージョン 2 は削除されます。これを保持するには、このパラメーターの値を true に設定します。
`platform_admin_email`	システム管理者のメールアドレスです。
`container_registry_host`	Container Registry のドメイン名です。
`container_registry_user`	Container Registry からイメージをダウンロードする権限を持つユーザー名です。Container Registry がない場合、このパラメーターは空欄のままです。
`container_registry_password`	Container Registry からイメージをダウンロードするためのパスワード/トークンです。Container Registry がない場合、このパラメーターは空欄のままです。
`container_registry_name`	イメージが格納されている Container Registry のディレクトリです。
`smtp.host`	SMTP Server の IP アドレスまたはホスト名です。
`smtp.login`	SMTP Server への接続に使用するユーザー名です。
`smtp.password`	SMTP Server への接続に使用するパスワードです。
`smtp.port`	SMTP Server のポートです。
`smtp.useSSL`	暗号化接続を使用するかどうかを指定します。このパラメーターには true または false を設定できます。
`smtp.secureSocketOptions`	接続に使用する SSL または TLS の暗号化を指定します。
`database.enabled`	データベースサーバーを有効にするかどうかを指定します。
`database.host`	SQL Server の IP アドレス。
`database.port`	データベースサーバーのポート。
`database.username`	データベースへの接続に使用する Username (ユーザーにはデータベースの作成に必要な権限が必要です) 。
`database.password`	データベースへのアクセスに使用するパスワード。
`reporting.enabled`	Warehouse レポートサービスをデプロイするかどうかを指定します。このパラメーターには true または false を設定できます。
`id_reading.enabled`	Identity Documents アドオンをデプロイするかどうかを指定します。このパラメーターには true または false を設定できます。

以下の 4 つのパラメーターはオプションであり、高可用性構成をインストールする場合で、かつ Vantage インストーラーによって Redis のインストールが必要な場合にのみ必須です。

Parameter	Description
`redis.ips`	Redis クラスターの IP アドレスです。形式は次のとおりです: [‘192.168.0.1”192.168.0.2’,,‘192.168.0.3’]。パラメーターが [] として定義されている場合は、クラスター内 Redis インスタンスがデプロイされます。
redis.port	Redis クラスターへの接続に使用するポートです。
`redis.password`	Redis への接続に使用するパスワードです。
`redis.ssl`	Redis クラスターへの暗号化接続を使用するかどうかを指定します。このパラメーターには true または false を設定できます。

その他のすべてのパラメーターは変更ありません。

証明書の準備

ssl ディレクトリに移動します。プライマリのドメイン名に対応するワイルドカード証明書 (中間証明書を含む) をそのディレクトリに配置し、キー (PEM 形式) をそれぞれ次のファイルに配置します：./ssl/cert.pem、./ssl/key.pem。CRT ファイルは、内容を次の形式に変更して PEM に変換する必要があります。

-----BEGIN CERTIFICATE-----
[your certificate]
-----END CERTIFICATE-----

証明書が内部CAによって署名された外部認証プロバイダー (ADFS) を使用している場合は、ルート証明書を ./ssl/adfs-root.pem に配置します。

Vantage からサードパーティのエンドポイント (カスタムアクティビティスクリプトまたは外部認証) にアクセスする場合、接続先のエンドポイントには公的認証局が発行した証明書が必要です。

インストールスクリプトの実行

ABBYY Vantage のインストールは自動的に行われます。インストールは、インストール用のコンテナー内にインストールおよび設定された Ansible ツールを使用して実行されます。Ansible は、さまざまな構成シナリオ (YAML プレイブック) を使用して各マシンとやり取りします。 ABBYY Vantage をインストールするには、次の手順に従います。 1. インストールディレクトリに移動します。 2. インストーラー配布レジストリにログインします

# 調達時に取得したcredentialsで<username>と<password>を置き換えてください
docker login abyvtgonprm27.azurecr.io -u <username> -p <password>

3. まだ実行していない場合は、Dockerイメージを使用してインストーラーを実行します。

仮想マシン
Azure AKS

docker run -it \
-v $PWD/kube:/home/ansible/.kube \
-v $PWD/ssh/ansible:/home/ansible/.ssh/ansible \
-v "//var/run/docker.sock:/var/run/docker.sock" \
-v $PWD/inventory:/ansible/inventories/k8s/inventory \
-v $PWD/env_specific.yml:/ansible/inventories/k8s/group_vars/all/env_specific.yml \
-v $PWD/ssl:/ansible/files/ssl:ro \
--privileged \
abyvtgonprm27.azurecr.io/vantage-installer:2.7.1

Parameter	説明
`-v $PWD/kube:/home/ansible/.kube`	kube/config ファイルが保存されている Kubernetes ディレクトリへのパス。
`-v $PWD/ssh/ansible:/home/ansible/.ssh/ansible`	Kubernetes クラスターおよび一部の前提条件のインストールと構成に必要な SSH 秘密鍵へのパス。
`-v "//var/run/docker.sock:/var/run/docker.sock"`	イメージをコンテナーレジストリに同期するために必要です。
`-v $PWD/inventory:/ansible/inventories/k8s/inventory`	inventory ファイルへのパス。
`-v $PWD/env_specific.yml:/ansible/inventories/k8s/group_vars/all/env_specific.yml`	env_specific.yml ファイルへのパス。
`-v $PWD/ssl:/ansible/files/ssl:ro`	SSL 証明書が格納されているフォルダーへのパス。このフォルダーには次のファイルが含まれている必要があります: cert.pem、key.pem、adfsroot.pem。

docker run -it \
-v $PWD/env_specific.yml:/ansible/inventories/azure/group_vars/all/env_specific.yml \
-v $PWD/ssl:/ansible/files/ssl:ro \
abyvtgonprm27.azurecr.io/vantage-installer:2.7.1

Parameter	説明
`-v $PWD/env_specific.yml:/ansible/inventories/azure/group_vars/all/env_specific.yml`	env_specific.yml ファイルへのパス。
`-v $PWD/ssl:/ansible/files/ssl:ro`	SSL 証明書が格納されているフォルダーへのパス。このフォルダーには次のファイルが含まれている必要があります: cert.pem、key.pem、adfsroot.pem。

4. Azure AKS クラスターに接続します。

仮想マシン
Azure AKS

仮想マシンへのデプロイでは、この手順はスキップしてください。クラスターの資格情報は、手順 7 の Kubernetes インストール時に自動的に構成されます。

Docker コンテナーの起動後、Azure にサインインして AKS クラスターに接続します。

# Azure にログイン
az login

# サブスクリプションを設定します（ご使用のサブスクリプション ID に置き換えてください）
az account set --subscription <subscription_id>

# AKS クラスターの資格情報を取得します（ご使用の Resource Group とクラスター名に置き換えてください）
az aks get-credentials --resource-group <resource_group_name> --name <cluster_name>

# クラスターへの接続を確認します
kubectl cluster-info

5. コンテナーイメージをダウンロードします 移行スクリプトは、env_specific.yml 内の次のプロパティに依存します

source_container_registry_host: sourcerepo.azurecr.io
source_container_registry_user: user
source_container_registry_password: pass
source_container_registry_name: "{{ source_container_registry_host }}/optional/subpath"

container_registry_host: destinationrepo.azurecr.io
container_registry_user: user
container_registry_password: pass
container_registry_name: "{{ container_registry_host }}/optional/subpath"

仮想マシン
Azure AKS

ansible-playbook -i inventories/k8s playbooks/validate-artifact-manifest.yml
ansible-playbook -i inventories/k8s playbooks/oci-migration.yml

ansible-playbook -i inventories/azure playbooks/validate-artifact-manifest.yml
ansible-playbook -i inventories/azure playbooks/oci-migration.yml

仮想マシン
Azure AKS

6. SSH キーの権限を設定します：

chmod 600 /home/ansible/.ssh/ansible

7. Kubernetes クラスターをインストールして設定します：

ansible-playbook -i inventories/k8s -v playbooks/4-Kubernetes-k8s.yml

8. デプロイ前チェックを実行し、法的文書に同意します：

仮想マシン
Azure AKS

ansible-playbook -i inventories/k8s -v playbooks/0-PreflightCheck-k8s.yml
ansible-playbook -i inventories/k8s -v playbooks/legal.yml

ansible-playbook -i inventories/azure playbooks/0-PreflightCheck-azure.yml
ansible-playbook -i inventories/azure playbooks/legal.yml

プレイブックでは次の処理が行われます。

プレイブックの env_specific.yml ファイルでパラメーターが指定されているリソース (データベースや SMTP 接続など) について、事前チェックを実行します。
システム管理者に、EULA および ABBYY プライバシーポリシーの条件への同意を求めます。

9. 製品をインストールします：

仮想マシン
Azure AKS

ansible-playbook -i inventories/k8s -v playbooks/site-k8s-deploy.yml

ansible-playbook -i inventories/azure playbooks/site-azure-deploy.yml

プレイブックは、メトリックおよびログ収集システムと ABBYY Vantage をデプロイします。インストール処理の完了にかかる時間は、選択したマシンの性能によって異なります。平均すると、処理には約 10 分かかります。Kubernetes 用の任意のツール (たとえば Lens ユーティリティ) を使用して、クラスター内の pod と job の実行を監視できます。そのためには、仮想マシンに Kubernetes をインストールした後に kube フォルダー内に作成される kubeconfig ファイルを使用します。以下の手順に従って、Ansible のインストールログファイルをローカルマシンにダウンロードすることもできます。

Docker コンテナーからログアウトします。
次のコマンドを実行して、コンテナーの一覧を取得します。

docker ps -a

installer が含まれるコンテナーの名前を確認します。

ログを取得するには、container_name をそのコンテナー名に置き換えて、次のコマンドを実行します。

docker cp container_name:/ansible/ansible.log ansible.log

デプロイが完了すると、次の情報が提供されます。

提供されたドメイン名に対応するURL。
ログイン、テナントの作成、ドキュメントの処理に使用できる、システム管理者のログイン名とパスワード。

インストールログを取得する

# Docker コンテナーを終了してから、次を実行します:
docker ps -a
# コンテナー名を確認してから、次を実行します:
docker cp container_name:/ansible/ansible.log ansible.log

任意のデプロイ

ロギングシステムのデプロイ

Vantageのインストール時にロギングシステムが有効になっていなかった場合 (env_specific.yml ファイルの logging.enabled パラメーターの値が false だった場合) でも、Vantageのインストール後に有効化できます。そのためには、env_specific.yml ファイルの logging.enabled パラメーターの値を true に設定し、次のコマンドを実行します。

仮想マシン
Azure AKS

ansible-playbook -i inventories/k8s playbooks/6-DeployMonitoring-k8s.yml

ansible-playbook -i inventories/azure playbooks/6-DeployMonitoring-azure.yml

Business Processing Reporting Warehouseのデプロイ

Business Processing Reporting Warehouse は、業務プロセスの分析や、特定期間におけるトラッキングデータの確認に使用されます。Vantage のインストール時に、env_specific.yml ファイル内の reporting.enabled パラメーターの値が true に設定されている場合、Business Processing Reporting Warehouse もインストールされます。reporting.enabled パラメーターの値が false に設定されている場合は、次のコマンドを実行して、Vantage のインストール後に Business Processing Reporting Warehouse をインストールできます。

仮想マシン
Azure AKS

ansible-playbook -i inventories/k8s -v playbooks/deploy-reporting.yml

ansible-playbook -i inventories/azure -v playbooks/deploy-reporting.yml

インストール後、正しいレポート用 URL がロードされるように、Public API の pod を再起動する必要があります。

Identity Documents アドオンのデプロイ

Identity Documents アドオンでは、Vantage から https://lic.regulaforensics.com および https://lic2.regulaforensics.com へのインターネットアクセスが必要です。

Identity Documents アドオンサービスを使用すると、各国で発行された身分証明書からデータを抽出するための Identity Documents Skill を実行できます。 Vantage のインストール時に、env_specific.yml ファイル内の id_reading.enabled パラメーターの値が true に設定されている場合は、Identity Documents アドオンもインストールされます。id_reading.enabled パラメーターの値が false に設定されている場合は、Vantage のインストール後に次のコマンドを実行して Identity Documents アドオンをインストールできます。

仮想マシン
Azure AKS

ansible-playbook -i inventories/k8s -v playbooks/12-DeployDocumentReader.yml

ansible-playbook -i inventories/azure -v playbooks/12-DeployDocumentReader.yml

Vantage がインストールされているクラスターから、次のアドレスにアクセスできる必要があります。 https://lic.regulaforensics.com https://lic2.regulaforensics.com

​インストールの概要

​リソースの準備

​リソース認証情報の指定

​設定ファイルの準備

​設定パラメーター

​証明書の準備

​インストールスクリプトの実行

​インストールログを取得する

​任意のデプロイ

​ロギングシステムのデプロイ

​Business Processing Reporting Warehouseのデプロイ

​Identity Documents アドオンのデプロイ

インストールの概要

リソースの準備

リソース認証情報の指定

設定ファイルの準備

設定パラメーター

証明書の準備

インストールスクリプトの実行

インストールログを取得する

任意のデプロイ

ロギングシステムのデプロイ

Business Processing Reporting Warehouseのデプロイ

Identity Documents アドオンのデプロイ