Zum Hauptinhalt springen

​
Installationsübersicht

Um Vantage zu installieren, führen Sie die folgenden Schritte aus:
  1. Ressourcen vorbereiten.
  2. Anmeldeinformationen für Ressourcen angeben.
  3. Installationsskripte ausführen.

​
Ressourcen vorbereiten

Bevor Sie beginnen, stellen Sie sicher, dass alle Anforderungen im Abschnitt Systemanforderungen erfüllt sind.

​
Angeben von Ressourcen-Zugangsdaten

Bevor Sie das Installationsprogramm ausführen:
  1. Konfigurationsdateien einrichten.
  2. Zertifikate vorbereiten.
  3. Container-Images herunterladen.

​
Einrichten von Konfigurationsdateien

1. Erstellen Sie das Installationsverzeichnis: Erstellen Sie ein Installationsverzeichnis und dessen Unterverzeichnisse (ssh, kube, ssl), von dem aus die Installation erfolgt. Navigieren Sie zum Installationsverzeichnis. 
mkdir -p /opt/vantage-install/{ssh,kube,ssl} && cd /opt/vantage-install
2. Erstellen Sie die SSH-Schlüsseldatei: Erstellen Sie im Ordner ssh eine Datei mit dem Namen ansible und legen Sie in dieser Datei den privaten SSH-Schlüssel für den Benutzer ansible ab. 3. Erstellen Sie die Inventory-Datei: Erstellen Sie im Installationsverzeichnis eine Datei mit dem Namen inventory. Ersetzen Sie X.X.X.X durch die IP-Adressen Ihrer VMs: 
[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
Wenn Sie nur 1 oder 2 Maschinen für Worker anstelle von 3 benötigen, löschen Sie die zusätzlichen Zeilen im Abschnitt [abbyy_workers].
4. Erstellen Sie die Datei env_specific.yml: Tragen Sie Ihre eigenen Werte ein. 
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: [email protected]

source_container_registry_host: abyvtgonprm27.azurecr.io
source_container_registry_user: null      # durch bei der Beschaffung erhaltene Anmeldeinformationen ersetzen
source_container_registry_password: null  # durch bei der Beschaffung erhaltene Anmeldeinformationen ersetzen
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

​
Konfigurationsparameter

ParameterBeschreibung
envInstallationspräfix, das standardmäßig als Subdomainnamen verwendet wird.
poctrue für Betrieb ohne Hochverfügbarkeit, false für hochverfügbaren Betrieb.
domainDie primäre Domain.
product_hostDNS-Name für den Zugriff auf das Produkt (Standard: env.domain).
logging.enabledAktiviert oder deaktiviert die Protokollierung (true/false).
logging.elasticsearch.enabledGibt an, ob Elasticsearch aktiviert werden soll. Dieser Parameter kann entweder auf true oder false gesetzt werden. Hinweis: Setzen Sie diesen Parameter nur dann auf true, wenn Sie Elasticsearch bereits haben und die Vantage-Protokolle damit verbinden möchten. Wenn Sie noch keine Elasticsearch- und Kibana-Instanzen haben, können Sie diese als Cluster bereitstellen, indem Sie die Anweisungen in Elasticsearch und Kibana befolgen. Dies muss vor der Installation des Produkts erfolgen.
logging.elasticsearch.hostDie IP-Adresse des Servers.
logging.elasticsearch.portPort für die Verbindung zu Elasticsearch.
logging.elasticsearch.usernameBenutzername für die Verbindung mit Elasticsearch.
logging.elasticsearch.passwordDas Passwort, das für die Verbindung mit Elasticsearch verwendet wird.
logging.elasticsearch.schemeDas Protokollschema, das für die Verbindung zu Elasticsearch verwendet wird.
logging.file.enabledGibt an, ob Protokolle in Dateien geschrieben werden sollen. Dieser Parameter kann entweder auf true oder false gesetzt werden.
loadbalancer.external_ipFloating-IP-Adresse für den Load-Balancer.
k8s.api.ipIP-Adresse des Kubernetes-API-Endpunkts.
securityContext.global.runAsUserGibt die Benutzer-ID des Benutzers an, unter der der Containerprozess ausgeführt werden soll. Diese Einstellung gilt nur für Pods, die mit externen rwx-Speichern (z. B. NFS) arbeiten. Standardmäßig ist der Parameter auf 65532 festgelegt.
securityContext.global.runAsGroupGibt die Kennung der Gruppe an, unter der der Containerprozess ausgeführt werden soll.

Diese Einstellung gilt nur für Pods, die mit externen rwx-Speichern (wie NFS) arbeiten. Standardmäßig ist der Parameter auf 65532 festgelegt.
securityContext.global.fsGroupGibt die Kennung der Gruppe an, der die an den Pod angehängten Volumes gehören. Diese Einstellung gilt nur für Pods, die mit externen rwx-Speichern (wie NFS) arbeiten. Standardmäßig ist der Parameter auf 65532 gesetzt.
techcore.nn_training_workers.gpuGibt an, ob die GPU-Worker bereitgestellt werden sollen. GPU-Worker werden zum Trainieren von Skills mit der Deep-Learning-Aktivität verwendet, um Daten aus halbstrukturierten Dokumenten zu extrahieren. Dieser Parameter kann entweder auf true oder false gesetzt werden. Wenn der Parameter auf true gesetzt ist, muss der Parameter techcore.nn_training_workers.enabled ebenfalls auf true gesetzt werden. Sie können diese Option aktivieren und die Parameter techcore.nn_training_workers.gpu und techcore.nn_training_workers.enabled vor oder nach der Installation von Vantage auf true setzen. Weitere Informationen finden Sie unter Einrichten von GPUs.
techcore.nn_training_workers.enabledGibt an, ob die nn-extraction-training- und nlp-model-train-Worker bereitgestellt werden sollen. Diese Worker werden zum Trainieren von Skills mit der Deep-Learning-Aktivität verwendet, um mithilfe der CPU Daten aus halbstrukturierten Dokumenten zu extrahieren. Dieser Parameter kann entweder auf true oder false gesetzt werden.
techcore.keep_previous_versionLegt fest, ob die Technology-Core-Version 2 beim Aktualisieren von Vantage beibehalten werden soll. Standardmäßig wird der Parameter techcore.keep_previous_version nicht gesetzt und die Technology-Core-Version 2 wird gelöscht. Um sie beizubehalten, setzen Sie den Wert des Parameters auf true.
platform_admin_emailE-Mail-Adresse des Systemadministrators.
container_registry_hostDomainname der Container-Registry.
container_registry_userDer Name des Benutzers, der berechtigt ist, Images aus der Container Registry herunterzuladen. Dieser Parameter bleibt leer, wenn keine Container Registry vorhanden ist.
container_registry_passwordPasswort oder Token zum Herunterladen von Images aus der Container-Registry. Dieser Parameter bleibt leer, wenn keine Container-Registry vorhanden ist.
container_registry_nameDas Verzeichnis in der Container-Registry, in dem die Images abgelegt sind.
smtp.hostIP-Adresse oder Hostname des SMTP-Servers.
smtp.loginBenutzername für die Verbindung mit dem SMTP-Server.
smtp.passwordDas Passwort für die Verbindung zum SMTP-Server.
smtp.portDer Port des SMTP-Servers.
smtp.useSSLGibt an, ob eine verschlüsselte Verbindung verwendet werden soll. Dieser Parameter kann den Wert true oder false haben.
smtp.secureSocketOptionsLegt fest, welche SSL- und/oder TLS-Verschlüsselung für eine Verbindung verwendet werden soll.
database.enabledGibt an, ob der Datenbankserver aktiviert ist.
database.hostIP-Adresse des SQL-Servers.
database.portDer Port des Datenbankservers.
database.usernameDer für die Verbindung zur Datenbank verwendete Benutzername (dieser Benutzer muss über die zum Erstellen von Datenbanken erforderlichen Berechtigungen verfügen).
database.passwordPasswort für den Zugriff auf die Datenbank.
reporting.enabledGibt an, ob der Warehouse Reporting Service bereitgestellt werden soll. Dieser Parameter kann auf true oder false gesetzt werden.
id_reading.enabledGibt an, ob das Identity Documents-Add-on bereitgestellt werden soll. Dieser Parameter kann den Wert true oder false haben.
Die folgenden vier Parameter sind optional und werden nur benötigt, wenn die Hochverfügbarkeitskonfiguration installiert wird und wenn der Vantage-Installer die Installation von Redis erfordert.
ParameterBeschreibung
redis.ipsDie IP-Adresse des Redis-Clusters im folgenden Format: [‘192.168.0.1”192.168.0.2’,,‘192.168.0.3’]. Wenn der Parameter als [] definiert ist, wird eine In-Cluster-Redis-Instanz bereitgestellt.
redis.portDer Port, der für die Verbindung mit dem Redis-Cluster verwendet wird.
redis.passwordDas Kennwort, das für die Verbindung zu Redis verwendet wird.
redis.sslGibt an, ob eine verschlüsselte Verbindung zum Redis-Cluster verwendet werden soll. Dieser Parameter kann entweder auf true oder false gesetzt werden.
Alle anderen Parameter bleiben unverändert.

​
Vorbereitung der Zertifikate

  1. Wechseln Sie in das Verzeichnis ssl. Legen Sie das Wildcard-Zertifikat (zusammen mit dem Zwischenzertifikat), das dem primären Domänennamen entspricht, in dieses Verzeichnis und speichern Sie den Schlüssel (im PEM-Format) in den folgenden Dateien: ./ssl/cert.pem und ./ssl/key.pem. Konvertieren Sie Ihre CRT-Datei in das PEM-Format, indem Sie den Inhalt der Datei in das folgende Format ändern:
-----BEGIN CERTIFICATE-----
[your certificate]
-----END CERTIFICATE-----
  1. Wenn Sie einen externen Authentifizierungsanbieter (ADFS) mit einem von einer internen CA signierten Zertifikat verwenden, legen Sie das Root-Zertifikat unter ./ssl/adfs-root.pem ab.
Wenn von Vantage aus auf Endpunkte von Drittanbietern zugegriffen wird (Custom-Activity-Skripte oder externe Authentifizierung), muss der externe Endpunkt über ein Zertifikat einer öffentlichen Zertifizierungsstelle verfügen.

​
Herunterladen von Container-Images

Migrationsskripte verwenden die folgenden Einstellungen in 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"
Wichtig! Stellen Sie sicher, dass Sie die erforderlichen Eigenschaften für die Quell- und Ziel-Container-Registry in Ihrer Datei env_specific.yml unter dem entsprechenden Installationstyp hinzufügen, unabhängig davon, ob es sich um AKS oder eine VM handelt.
Für /ansible/inventories/azure/group_vars/all/env_specific.yml führen Sie Folgendes aus: 
ansible-playbook -i inventories/azure playbooks/validate-artifact-manifest.yml
ansible-playbook -i inventories/azure playbooks/oci-migration.yml
Führen Sie für /ansible/inventories/k8s/group_vars/all/env_specific.yml Folgendes aus: 
ansible-playbook -i inventories/k8s playbooks/validate-artifact-manifest.yml
ansible-playbook -i inventories/k8s playbooks/oci-migration.yml

​
Ausführen der Installationsskripte

Die Installation von ABBYY Vantage erfolgt automatisch. Sie wird mit dem Tool Ansible ausgeführt, das im für die Installation verwendeten Container installiert und konfiguriert ist. Ansible interagiert mit den Rechnern über verschiedene Konfigurationsskripte (YAML-Playbooks). Führen Sie zum Installieren von ABBYY Vantage die folgenden Schritte aus: 1. Navigieren Sie zum Installationsverzeichnis. 2. Führen Sie das Installationsprogramm aus einem Docker-Image aus, falls Sie es noch nicht ausgeführt haben: 
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 \
registry.local/vantage-installer:2.7.1
ParameterBeschreibung
-v \$PWD/kube:/root/.kubeDer Pfad zu dem Kubernetes-Verzeichnis, in dem die kube/config-Datei gespeichert ist.
-v \$PWD/ssh/ansible:/root/ansibleDer Pfad zum privaten SSH-Schlüssel, der für die Installation und Konfiguration des Kubernetes-Clusters und einiger Voraussetzungen erforderlich ist.
-v "//var/run/docker.sock:/var/run/docker.sock"Erforderlich, um Images mit Ihrer Container Registry zu synchronisieren.
-v \$PWD/inventory:/ansible/inventories/k8s/inventoryDer Pfad zur inventory-Datei.
-v \$PWD/env_specific.yml:/ansible/inventories/k8s/group_vars/all/env_specific.y mlDer Pfad zur Datei env_specific.yml.
-v \$PWD/ssl:/ansible/files/ssl:roDer Pfad zum Ordner mit SSL-Zertifikaten, der die folgenden Dateien enthalten sollte: cert.pem, key.pem, adfsroot.pem.
3. SSH-Schlüssel-Berechtigungen festlegen: 
chmod 600 /root/.ssh/ansible
4. Führen Sie den folgenden Befehl aus, um den Kubernetes-Cluster auf den virtuellen Maschinen zu installieren und einzurichten, die in der Inventory-Datei definiert sind: 
ansible-playbook -i inventories/k8s -v playbooks/4-Kubernetes-k8s.yml
5. Führen Sie den Pre-Deployment-Check aus und akzeptieren Sie die Rechtsdokumente: 
ansible-playbook -i inventories/k8s -v playbooks/0-PreflightCheck-k8s.yml
ansible-playbook -i inventories/k8s -v playbooks/legal.yml
Das Playbook wird:
  • Eine Vorabprüfung der Ressourcen durchführen, deren Parameter in der Datei env_specific.yml des Playbooks angegeben sind (z. B. Datenbank- und SMTP-Verbindung).
  • Den Systemadministrator auffordern, die Bedingungen der EULA und der ABBYY-Datenschutzerklärung zu akzeptieren.
6. Installieren Sie das Produkt: 
ansible-playbook -i inventories/k8s -v playbooks/site-k8s-deploy.yml
Das Playbook wird das Metrik- und Protokollerfassungssystem bereitstellen und ABBYY Vantage installieren. Die für den Abschluss des Installationsprozesses erforderliche Zeit hängt von der Leistung der ausgewählten Maschinen ab. Im Durchschnitt dauert der Vorgang etwa 10 Minuten. Sie können die Pods und die Ausführung des Jobs in einem Cluster mit jedem Tool für die Arbeit mit Kubernetes überwachen, zum Beispiel mit dem Tool Lens. Verwenden Sie dazu die Datei kubeconfig, die im Ordner kube erstellt wird, nachdem Kubernetes auf den virtuellen Maschinen installiert wurde. Sie können außerdem die Protokolldateien der Ansible-Installation auf Ihren lokalen Rechner herunterladen, indem Sie die folgenden Schritte ausführen:
  1. Verlassen Sie den Docker-Container.
  2. Führen Sie den folgenden Befehl aus, um die Liste der Container anzuzeigen:
docker ps -a
Suchen Sie den Namen des Containers mit dem Installationsprogramm.
  1. Führen Sie den folgenden Befehl aus, wobei Sie container_name durch den Namen des Containers ersetzen, um die Protokolle abzurufen:
docker cp container_name:/ansible/ansible.log ansible.log
Sobald die Bereitstellung abgeschlossen ist, erhalten Sie Folgendes:
  • URL für den bereitgestellten Domainnamen.
  • Systemadministrator-Login und -Passwort, mit denen Sie sich anmelden, Mandanten anlegen und Dokumente verarbeiten können.

​
Installationsprotokolle abrufen

# Beenden Sie den Docker-Container, dann:
docker ps -a
# Ermitteln Sie den Container-Namen, dann:
docker cp container_name:/ansible/ansible.log ansible.log

​
Optionale Bereitstellungsszenarien

​
Bereitstellen des Protokollierungssystems

Wenn das Protokollierungssystem bei der Installation von Vantage nicht aktiviert wurde (der Wert des Parameters logging.enabled in der Datei env_specific.yml war false), können Sie es nach der Installation von Vantage aktivieren. Setzen Sie dazu den Wert des Parameters logging.enabled in der Datei env_specific.yml auf true und führen Sie den folgenden Befehl aus: 
ansible-playbook -i inventories/k8s playbooks/6-DeployMonitoring-k8s.yml

​
Bereitstellung des Business Processing Reporting Warehouse

Das Business Processing Reporting Warehouse wird zur Analyse von Geschäftsprozessen und zur Nachverfolgung von Daten für bestimmte Zeiträume verwendet. Während der Vantage-Installation wird das Business Processing Reporting Warehouse ebenfalls installiert, wenn der Wert des Parameters reporting.enabled in der Datei env_specific.yml auf true gesetzt wurde. Wenn der Wert des Parameters reporting.enabled auf false gesetzt wurde, können Sie das Business Processing Reporting Warehouse nach der Installation von Vantage durch Ausführen des folgenden Befehls installieren: 
ansible-playbook -i inventories/k8s -v playbooks/deploy-reporting.yml

​
Bereitstellen des Identity Documents-Add-ons

Das Identity Documents-Add-on erfordert, dass Vantage Internetzugriff auf https://lic.regulaforensics.com und https://lic2.regulaforensics.com hat.
Der Identity Documents-Add-on-Dienst ermöglicht die Ausführung des Identity Documents Skills, der zum Extrahieren von Daten aus in verschiedenen Ländern ausgestellten Ausweisdokumenten verwendet wird. Während der Vantage-Installation wird das Identity Documents-Add-on ebenfalls installiert, wenn der Wert des Parameters id_reading.enabled in der Datei env_specific.yml auf true gesetzt wurde. Wenn der Wert des Parameters id_reading.enabled auf false gesetzt wurde, können Sie das Identity Documents-Add-on nach der Installation von Vantage installieren, indem Sie den folgenden Befehl ausführen: ansible-playbook -i inventories/k8s -v playbooks/12-DeployDocumentReader.yml Es ist erforderlich, dass vom Cluster, in dem Vantage installiert ist, aus der Zugriff auf die folgenden Adressen möglich ist: https://lic.regulaforensics.com https://lic2.regulaforensics.com