Zum Hauptinhalt springen

Checkliste der Voraussetzungen

Bereiten Sie die folgenden externen Komponenten vor und konfigurieren Sie sie, bevor Sie Vantage installieren:
  • Ein Rechner mit Docker und Internetzugang (von dem aus Vantage installiert wird)
  • Virtuelle Maschinen (mit Internetzugang während der Installation), die als Kubernetes-Knoten verwendet werden
  • Eine Container-Registry zum Speichern von Docker-Images
  • Relationale Datenbankmanagementsysteme (RDBMS) für den Betrieb von Vantage
  • Ein SMTP-Server zum Senden von E-Mail-Nachrichten an Vantage-Benutzer
  • Ein TLS-Zertifikat zum Aufbau verschlüsselter Kommunikation
  • 2 statische IP-Adressen – eine für die Kubernetes-Konfiguration/-Verwaltung, eine für den Zugriff auf Vantage
  • Ein DNS-Eintrag für den Zugriff auf Vantage
  • Externer Speicherplatz (optional für eine Konfiguration ohne Hochverfügbarkeit)

Anforderungen an den Installationscomputer

Der Computer, von dem aus Vantage installiert wird, muss Folgendes erfüllen:
  • Linux OS oder Windows-Subsystem für Linux (WSL)
  • Docker-Version 19.03 oder höher
  • Netzwerkzugriff auf abyvtgonprm27.azurecr.io
  • Lokale Dateien mit einem privaten SSH-Schlüssel (ohne Passphrase) für das Benutzerkonto ansible
Alle virtuellen Maschinen müssen denselben SSH-Schlüssel verwenden.

Infrastrukturanforderungen

Alle virtuellen Maschinen können in VMware oder Hyper-V ausgeführt werden und müssen über Folgendes verfügen:
  • Eine statische IP-Adresse
  • Ein Benutzerkonto mit dem Namen ansible mit:
    • Zugriff per gemeinsam genutztem SSH-Schlüssel
    • sudo-Zugriff mit der Option NOPASSWD
  • Eine dedizierte erweiterbare Festplatte bzw. ein dediziertes erweiterbares lvm_volume, die bzw. das auf jedem Worker-Knoten unter /opt/local-path-provisioner eingehängt ist
  • Internetzugang während der Installation zur Container-Registry und zu Paket-Repositories:
    • Container-Registry mit den synchronisierten Container-Images, die als Voraussetzung für die Vantage-Installation vorbereitet wurden. Weitere Informationen finden Sie unter Herunterladen von Container-Images.
    • Paket-Repository: Ubuntu (archive.ubuntu.com), RHEL (cdn.redhat.com). Statt des Zugriffs auf die Paket-Repositories können Sie auch den Zugriff auf Ihr eigenes Repository konfigurieren, das alle unten aufgeführten erforderlichen Pakete enthalten sollte.
Allgemein (alle Distributionen):
OS-spezifische Pakete:

Netzwerkzugriff nach der Installation

Nach der Installation des Clusters benötigen die virtuellen Maschinen Zugriff auf:
  • https://licensing-us.abbyy.com
  • Den Mailserver, für den die SMTP-Einstellungen in der Datei env_specific.yml angegeben sind (zum Senden von E-Mail-Einladungen, Wiederherstellen von Kennwörtern usw.).
  • Alle Mailserver, von denen Sie E-Mails in Vantage Process-Skills importieren werden.

Hochverfügbare Konfiguration

Angegeben ist die mindestens erforderliche Anzahl virtueller Maschinen. Je nach Leistungsanforderungen kann eine andere Anzahl virtueller Maschinen erforderlich sein.

Konfiguration ohne Hochverfügbarkeit

Kubernetes-Version 1.33.3 wird bei der Installation von Vantage installiert.

Container Registry

Sie können eine beliebige Container Registry verwenden.

Datenbankanforderungen

Eine Microsoft SQL Server- oder PostgreSQL-Datenbank mit der folgenden Konfiguration ist erforderlich:Option 1: Microsoft SQL ServerOption 2: PostgreSQLEin externer Datenbankserver muss eingerichtet sein, und Sie müssen über die entsprechenden Anmeldedaten verfügen, um die neue Datenbank zu erstellen und zu verwalten.Das Installationsprogramm benötigt die IP-Adresse des SQL Servers sowie einen Benutzernamen und ein Kennwort, um eine Verbindung mit der Datenbank herzustellen.

SMTP-Server

Der Server sollte das SMTP-Protokoll verwenden. Das Installationsprogramm benötigt die IP-Adresse/den DNS-Namen und den Port des SMTP-Servers sowie ein Kennwort für die Verbindung zum Server (falls der Server eine Authentifizierung erfordert). Der SMTP-Server muss E-Mails an Vantage-Benutzer senden können. Konfigurieren Sie SMTP mit oder ohne Authentifizierung in env_specific.yml.
Wir empfehlen, die Option mit Authentifizierung zu verwenden (mit Login und Kennwort).
Mit Authentifizierung (empfohlen) Mit Login und Kennwort. In diesem Fall sollte der smtp-Abschnitt in der Datei env_specific.yml wie folgt definiert werden:
Ohne Authentifizierung Ohne Login und Kennwort. In diesem Fall sollte der smtp-Abschnitt in der Datei env_specific.yml folgendermaßen definiert werden:
Vergessen Sie nicht, den Parameter mailFrom zum Wurzelelement hinzuzufügen.
Wir empfehlen, die Option mit Authentifizierung zu verwenden (mit Login und Kennwort).

TLS-Zertifikat

Sie benötigen entweder ein Wildcard-Zertifikat oder ein domänenspezifisches Zertifikat. Wenn Ihre Vantage-Installation über die Benutzerdefinierte Aktivität Verbindungen zu externen Services herstellt oder in externe Systeme exportiert, sollte das Zertifikat von einer öffentlichen Zertifizierungsstelle ausgestellt sein, zum Beispiel https://letsencrypt.org/.

Statische IP-Adressen

1. Zugriff auf die Kubernetes-API. Eine statische IP-Adresse, die als virtuelle IP-Adresse für den Zugriff auf den Endpunkt des Kubernetes-API-Servers verwendet wird, um den Cluster zu konfigurieren und zu verwalten. Die IP-Adresse sollte in der Datei env_specific.yml wie folgt definiert werden. Weitere Informationen finden Sie unter Einrichten von Konfigurationsdateien:
2. Zugriff auf Vantage-Services. Eine statische IP-Adresse, die für den Zugriff auf Vantage-Services über HTTPS verwendet wird. Ein entsprechender DNS-A-Eintrag muss vorab erstellt werden. Die IP-Adresse sollte in der Datei env_specific.yml wie folgt definiert werden. Weitere Informationen finden Sie unter Installation:

DNS-Eintrag für den Zugriff auf Vantage

Keine besonderen Anforderungen. Das Installationsprogramm erfordert eine primäre Domain und einen DNS-Namen, über den auf Vantage zugegriffen wird. Der DNS-Eintrag muss auf die für den Zugriff auf Vantage vorgesehene IP-Adresse verweisen.

Speicheranforderungen

Externer Speicher ist nur für die Konfiguration Without high availability optional erforderlich. Die Anforderungen an die Festplattengröße für eine hochverfügbare Konfiguration sind im Performance-Leitfaden beschrieben.ABBYY Vantage verwendet lokalen Speicher auf den Festplatten der bereitgestellten virtuellen Maschinen, was die Installation des Produkts beschleunigt. Diese Option kann jedoch weiterhin durch unerwartete Neustarts und Ausfälle virtueller Maschinen beeinträchtigt werden. Da dies zum Verlust der gespeicherten Daten führen kann, wird bei der Installation die Verwendung eines externen Speichers empfohlen.ABBYY Vantage ermöglicht Ihnen, die Verwendung bestimmter Speichertypen auf die unten beschriebenen Arten festzulegen.

Verwendung von lokalem Speicher

In diesem Fall werden Volumes mit POSIX-kompatiblem ReadWriteOnce-Zugriff lokal im Verzeichnis /opt/local_path_provisioner auf jedem Kubernetes-Knoten bereitgestellt. Für ReadWriteMany-Volume-Typen stellt Vantage auf dem ersten abbyy_services-Knoten (die IP dieses Knotens ist die erste im entsprechenden Block der inventory-Datei) einen in-cluster nfs-kernel-server bereit. Die Daten des NFS-Servers werden im Verzeichnis /opt/local_path_provisioner gespeichert. Stellen Sie daher sicher, dass Sie auf dem ersten abbyy_services-Knoten (der erste Knoten dieser Gruppe ist in der inventory-Datei definiert) ein dediziertes Volume bzw. eine dedizierte Festplatte für diesen Pfad mit einer Größe von mindestens 500 GB haben.Bei einer hochverfügbaren Konfiguration hostet der erste abbyy_services-Knoten außerdem lokalen persistenten Volume-Speicher. Dafür ist abhängig von der Verarbeitungslast zusätzliche Festplattenkapazität erforderlich. Einzelheiten zu den erforderlichen Größen finden Sie im Performance-Leitfaden.
Wenn dem lokalen persistenten Volume-Speicher der Platz ausgeht, funktioniert Vantage möglicherweise nicht mehr, und es können Daten verloren gehen. Wir empfehlen, den freien Speicherplatz zu überwachen und Warnmeldungen bei knappem Speicherplatz einzurichten, damit Sie rechtzeitig zusätzlichen Speicher bereitstellen und Datenverlust verhindern können.

Verwendung von externem NFS-Speicher

Mit dem Vantage-Installationsprogramm können Sie einen NFS-Speicher automatisch so konfigurieren, dass er für bestimmte Service als Vantage-Speicher verwendet wird, z. B. für den Import und Export in einen freigegebenen Ordner sowie zum Speichern der von der Überwachung erfassten Daten.Der Abschnitt in der Datei env_specific.yml sieht wie folgt aus:
Damit Vantage ordnungsgemäß funktioniert, empfehlen wir, dem Root-Verzeichnis des NFS-Servers (zum Beispiel /opt/nfs) die folgenden Berechtigungen zuzuweisen und den folgenden Eigentümer festzulegen:
Nachfolgend finden Sie ein Beispiel für eine Verzeichniseinstellung in der Datei /etc/exports, wenn ein Linux-Rechner als NFS-Server verwendet wird:
Falls ein anderer Speichertyp angebunden werden soll, siehe den Abschnitt Eigene Speicherklassen definieren weiter unten.

Eigene Speicherklassen definieren

Wenn Sie externen Speicher verwenden möchten, der nicht auf NFS basiert, gehen Sie wie folgt vor:
  1. Stellen Sie während des Installationsprozesses nach dem Erstellen des Kubernetes-Clusters (Schritt 4 in Ausführen der Installationsskripte) die entsprechenden CSI-Treiber (Container Storage Interface) bereit und erstellen Sie die zugehörigen Speicherklassen.
  2. Füllen Sie den Abschnitt k8s in der Datei env_specific.yml mit dem folgenden Code aus:
  1. Fahren Sie mit der Installation fort.
Wenn der lokale persistente Volumenspeicher voll läuft, funktioniert Vantage möglicherweise nicht mehr und es kann zu Datenverlust kommen. Überwachen Sie den freien Speicherplatz und richten Sie Warnmeldungen ein.

Redis-Cluster (nur für Azure AKS)

Ein Redis-Cluster ist nur für eine hochverfügbare Azure-AKS-Konfiguration erforderlich. Für Bereitstellungen auf virtuellen Maschinen oder nicht hochverfügbare Azure-Bereitstellungen ist er nicht erforderlich.
Für hochverfügbare Azure-AKS-Bereitstellungen ist ein externer Redis-Cluster mit der folgenden Konfiguration erforderlich: Die folgenden Optionen müssen in redis.conf festgelegt werden:
Der maxmemory-Wert sollte auf die Hälfte des auf jedem Redis-Knoten verfügbaren Speichers festgelegt werden. Ersetzen Sie <password> durch Ihr Cluster-Kennwort.
Azure Cache for Redis wird derzeit nicht unterstützt. Sie müssen Redis auf virtuellen Maschinen außerhalb des AKS-Clusters bereitstellen. Die Unterstützung für Azure Cache for Redis ist für eine zukünftige Release geplant.