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

​
インストールの概要

Vantage をインストールするには、次の手順に従います。
  1. リソースを準備します。
  2. リソースの認証情報を指定します。
  3. インストール スクリプトを実行します。

​
リソースの準備

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

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

インストーラーを実行する前に、次の準備を行います。
  1. 設定ファイルを準備します。
  2. 証明書を準備します。
  3. コンテナーイメージをダウンロードします。

​
設定ファイルのセットアップ

1. インストールディレクトリを作成する: インストールを実行する元となるインストールディレクトリと、そのサブディレクトリ（ssh、kube、ssl）を作成します。そのインストールディレクトリに移動します。 
mkdir -p /opt/vantage-install/{ssh,kube,ssl} && cd /opt/vantage-install
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 ファイルを作成します： 環境に固有の値を指定します。 
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

​
構成用 Parameter

Parameter説明
envインストールプレフィックス。デフォルトではサブドメイン名として使用されます。
poc高可用性を使用しない場合は true、高可用性を使用する場合は false。
domainプライマリ ドメイン名。
product_host製品へのアクセスに使用する DNS 名（デフォルト: env.domain）。
logging.enabledログ記録を有効／無効にします（true／false）。
logging.elasticsearch.enabledElasticsearch を有効にするかどうかを指定します。この Parameter には true または false のいずれかを設定できます。注意: すでに Elasticsearch を利用していて、Vantage のログをそこに接続したい場合にのみ、この Parameter の値を true に設定してください。既存の Elasticsearch および Kibana インスタンスがない場合は、「Elasticsearch および Kibana」の手順に従ってクラスターにデプロイできます。これは製品をインストールする前に実行する必要があります。
logging.elasticsearch.hostサーバーの IP アドレス。
logging.elasticsearch.portElasticsearch への接続に使用するポート。
logging.elasticsearch.usernameElasticsearch への接続に使用するユーザー名。
logging.elasticsearch.passwordElasticsearch への接続に使用するパスワード。
logging.elasticsearch.schemeElasticsearch への接続に使用するプロトコルスキーム。
logging.file.enabledログをファイルに書き出すかどうかを指定します。この Parameter は true または false のいずれかに設定できます。
loadbalancer.external_ipロードバランサー用のフローティング IP アドレス。
k8s.api.ipKubernetes API エンドポイントの IP アドレス。
securityContext.global.runAsUserコンテナプロセスを実行するユーザー ID を指定します。この設定は、外部の rwx ストレージ（NFS など）を使用する Pod にのみ適用されます。デフォルトでは、この Parameter は 65532 に設定されています。
securityContext.global.runAsGroupコンテナプロセスを実行するグループの識別子を指定します。

この設定は、外部の rwx ストレージ（NFS など）を使用する Pod にのみ適用されます。既定では、この Parameter は 65532 に設定されています。
securityContext.global.fsGroupPod にアタッチされるボリュームの所有者となるグループの識別子を指定します。この設定は、外部の rwx ストレージ（NFS など）を使用する Pod にのみ適用されます。既定では、Parameter は 65532 に設定されています。
techcore.nn_training_workers.gpuGPU ワーカーをデプロイするかどうかを指定します。GPU ワーカーは、Deep Learning アクティビティを使用して半構造化文書からデータを抽出する Skill をトレーニングするために使用されます。この Parameter は true または false のいずれかに設定できます。Parameter を true に設定する場合、techcore.nn_training_workers.enabled Parameter も true に設定する必要があります。Vantage をインストールする前後のいずれかのタイミングで、このオプションをデプロイし、techcore.nn_training_workers.gpu および techcore.nn_training_workers.enabled Parameter を true に設定できます。詳細については、GPU の設定 を参照してください。
techcore.nn_training_workers.enablednn-extraction-training および nlp-model-train ワーカーをデプロイするかどうかを指定します。これらのワーカーは、CPU を使用して半構造化ドキュメントからデータを抽出する Deep Learning アクティビティを用いた Skill のトレーニングに使用されます。この Parameter には true または false を設定できます。
techcore.keep_previous_versionVantage をアップデートする際に、technology core バージョン 2 を保持するかどうかを指定します。既定では techcore.keep_previous_version Parameter は指定されておらず、technology core バージョン 2 は削除されます。保持する場合は、Parameter の値を true に設定します。
platform_admin_emailシステム管理者のメールアドレス。
container_registry_hostコンテナレジストリのドメイン名。
container_registry_userコンテナー・レジストリからイメージをダウンロードする権限を持つユーザーの名前。コンテナー・レジストリが存在しない場合は、このParameterは空のままにします。
container_registry_passwordコンテナレジストリからイメージをダウンロードするためのパスワードまたはトークン。コンテナレジストリがない場合は、この Parameter は空のままにします。
container_registry_nameイメージがホストされているコンテナレジストリのディレクトリ名。
smtp.hostSMTP サーバーの IP アドレスまたはホスト名。
smtp.loginSMTP サーバーへの接続に使用するユーザー名。
smtp.passwordSMTP サーバーへの接続に使用するパスワード。
smtp.portSMTP サーバーが使用するポート番号。
smtp.useSSL暗号化された接続を使用するかどうかを指定します。この Parameter には true または false のいずれかを設定できます。
smtp.secureSocketOptions接続に使用する SSL または TLS の暗号化方式を指定します。
database.enabledデータベース サーバーを有効にするかどうかを指定します。
database.hostSQL Server のIPアドレス。
database.portデータベースサーバーのポート番号。
database.usernameデータベースに接続するためのユーザー名（データベースを作成するために必要な権限をユーザーが持っている必要があります）。
database.passwordデータベースに接続するために使用するパスワード。
reporting.enabledWarehouse reporting サービスをデプロイするかどうかを指定します。この Parameter には true または false を設定できます。
id_reading.enabledIdentity Documents アドオンをデプロイするかどうかを指定します。この Parameter には true または false のいずれかの値を設定できます。
次の4つの Parameter はオプションであり、高可用性構成 (Highly available configuration) をインストールする場合で、かつ Vantage インストーラーによって Redis のインストールが要求される場合にのみ必要です。
ParameterDescription
redis.ipsRedis クラスターの IP アドレスを次の形式で指定します: [‘192.168.0.1”192.168.0.2’,,‘192.168.0.3’]。Parameter が [] として定義されている場合、クラスター内の Redis インスタンスがデプロイされます。
redis.portRedis クラスターへの接続に使用されるポートです。
redis.passwordRedis への接続に使用されるパスワードです。
redis.sslRedis クラスターへの暗号化された接続を使用するかどうかを指定します。この Parameter には true または false を設定できます。
その他のすべての Parameter は変更されません。

​
証明書の準備

  1. ssl ディレクトリに移動します。プライマリドメイン名に対応するワイルドカード証明書（中間証明書を含む）をそのディレクトリ内に配置し、秘密鍵（PEM 形式）をそれぞれ次のファイルに保存します：./ssl/cert.pem、./ssl/key.pem。CRT ファイルは、内容を次の形式にして PEM 形式に変換する必要があります。
-----BEGIN CERTIFICATE-----
[your certificate]
-----END CERTIFICATE-----
  1. 内部 CA が署名した証明書を使用する外部の認証プロバイダー (ADFS) を使用している場合は、ルート証明書を ./ssl/adfs-root.pem に配置します。
Vantage からサードパーティのエンドポイント (Custom activity scripts や外部認証など) にアクセスする場合、その外部エンドポイントはパブリックな認証局が発行した証明書を使用している必要があります。

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

ABBYY Vantage のインストールは自動的に行われます。インストールに使用するコンテナ内にインストールおよび設定された Ansible ツールを使用して実行されます。Ansible は、さまざまな構成シナリオ（YAML プレイブック）を使用してマシンとやり取りします。 ABBYY Vantage をインストールするには、次の手順に従います。 1. インストールディレクトリに移動します。 2. インストーラー配信用レジストリにログインします。 
# <username> と <password> を調達時に取得した認証情報で置き換えてください
docker login abyvtgonprm27.azurecr.io -u <username> -p <password>
3. まだインストーラーを実行していない場合は、Docker イメージからインストーラーを実行します。 
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
ParameterDescription
-v $PWD/kube:/home/ansible/.kubekube/config ファイルが保存されている Kubernetes ディレクトリへのパス。
-v $PWD/ssh/ansible:/home/ansible/.ssh/ansibleKubernetes クラスターおよび一部の前提条件をインストールおよび構成するために必要な SSH 秘密鍵へのパス。
-v "//var/run/docker.sock:/var/run/docker.sock"コンテナーレジストリへのイメージ同期に必要です。
-v $PWD/inventory:/ansible/inventories/k8s/inventoryinventory ファイルへのパス。
-v $PWD/env_specific.yml:/ansible/inventories/k8s/group_vars/all/env_specific.ymlenv_specific.yml ファイルへのパス。
-v $PWD/ssl:/ansible/files/ssl:ro次のファイルを含める必要がある SSL 証明書フォルダーへのパス: cert.pem、key.pem、adfsroot.pem。
4. Azure AKS クラスターに接続します。
Virtual Machine デプロイの場合はこの手順をスキップしてください。クラスター資格情報は、手順 7 の Kubernetes インストール中に自動的に構成されます。
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"

ansible-playbook -i inventories/k8s playbooks/validate-artifact-manifest.yml
ansible-playbook -i inventories/k8s playbooks/oci-migration.yml
6. SSH キーの権限を設定します:
chmod 600 /home/ansible/.ssh/ansible
7. Kubernetes クラスターのインストールとセットアップ:
ansible-playbook -i inventories/k8s -v playbooks/4-Kubernetes-k8s.yml
8. 事前デプロイチェックを実行し、法的文書に同意する: 
ansible-playbook -i inventories/k8s -v playbooks/0-PreflightCheck-k8s.yml
ansible-playbook -i inventories/k8s -v playbooks/legal.yml
この playbook は次の処理を行います。
  • playbook の env_specific.yml ファイルで指定されているパラメーターを持つリソース（データベースや SMTP 接続など）について、事前チェックを実行します。
  • システム管理者に対し、EULA および ABBYY Privacy Policy の条件に同意するよう求めます。
9. 製品をインストールする: 
ansible-playbook -i inventories/k8s -v playbooks/site-k8s-deploy.yml
この playbook はメトリクスおよびログ収集システムをデプロイし、ABBYY Vantage をデプロイします。インストール処理の完了に必要な時間は、選択したマシンのパフォーマンスによって左右されます。平均して、この処理には約 10 分かかります。Kubernetes 用の任意のツール（たとえば Lens ユーティリティ）を使用して、クラスター内の Pod とジョブの実行状況を監視できます。そのためには、仮想マシンに Kubernetes をインストールした後に kube フォルダー内に作成される kubeconfig ファイルを使用します。以下の手順に従って、Ansible のインストールログファイルをローカルマシンにダウンロードすることもできます。
  1. Docker コンテナーからログアウトします。
  2. コンテナーの一覧を取得するには、次のコマンドを実行します。
docker ps -a
インストーラーが入っているコンテナの名前を確認します。
  1. ログを取得するには、次のコマンドを実行します。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 Parameter の値が false だった場合）は、Vantage のインストール後に有効化できます。その場合は、env&#95;specific.yml ファイル内の logging.enabled Parameter の値を true に設定し、次のコマンドを実行します。 
ansible-playbook -i inventories/k8s playbooks/6-DeployMonitoring-k8s.yml

​
Business Processing Reporting Warehouse のデプロイ

Business Processing Reporting Warehouse は、ビジネス プロセスを分析し、特定期間のデータを追跡するためのコンポーネントです。Vantage のインストール時に、env_specific.yml ファイル内の reporting.enabled Parameter の値が true に設定されている場合は、Business Processing Reporting Warehouse も同時にインストールされます。reporting.enabled Parameter の値が false に設定されている場合は、Vantage のインストール後に次のコマンドを実行して、Business Processing Reporting Warehouse をインストールできます。 
ansible-playbook -i inventories/k8s -v playbooks/deploy-reporting.yml

​
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 Parameter の値が true に設定されている場合は、Identity Documents アドオンもインストールされます。id_reading.enabled Parameter の値が false に設定されていた場合は、Vantage のインストール後に次のコマンドを実行して Identity Documents アドオンをインストールできます。 
ansible-playbook -i inventories/k8s -v playbooks/12-DeployDocumentReader.yml
Vantage がインストールされているクラスターから、次のアドレスにアクセスできるようにしておく必要があります。 https://lic.regulaforensics.com https://lic2.regulaforensics.com