Checkliste der Voraussetzungen
Bereiten und konfigurieren Sie die folgenden externen Komponenten, bevor Sie Vantage installieren:
- Einen 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
- Einen SMTP-Server zum Senden von E-Mail-Nachrichten an Vantage-Benutzer
- Ein TLS-Zertifikat zum Aufbau verschlüsselter Verbindungen
- 2 statische IP-Adressen – eine für die Kubernetes-Konfiguration/-Verwaltung, eine für den Zugriff auf Vantage
- Einen DNS-Eintrag für den Zugriff auf Vantage
- Externer Speicher (optional für die Konfiguration ohne Hochverfügbarkeit)
Anforderungen an die Installationsmaschine
Der Rechner, von dem aus Vantage installiert wird, benötigt:
- Linux-Betriebssystem oder Windows Subsystem for Linux (WSL)
- Docker-Version 19.03 oder höher
- Netzwerkzugriff auf
abyvtgonprm27.azurecr.io
- Lokale Dateien, die einen privaten SSH-Schlüssel (ohne Passphrase) für das
ansible-Benutzerkonto enthalten
Alle virtuellen Maschinen müssen denselben SSH-Schlüssel haben.
Anforderungen an virtuelle Maschinen
Alle virtuellen Maschinen können unter VMware oder Hyper-V ausgeführt werden und müssen folgende Anforderungen erfüllen:
- Eine statische IP-Adresse
- Ein Benutzerkonto mit dem Namen
ansible mit:
- SSH-Schlüsselzugriff (Shared Key)
- sudo-Zugriff mit der Option NOPASSWD
- Einen dedizierten, erweiterbaren Datenträger bzw. ein dediziertes, erweiterbares lvm_volume, das auf jedem Worker-Knoten unter
/opt/local-path-provisioner eingehängt ist
- Internetzugang während der Installation zur Container-Registry und zu den Paket-Repositories:
- Container-Registry mit den synchronisierten Images, die als Voraussetzung für die Vantage-Installation vorbereitet wurden. Weitere Informationen finden Sie unter Container-Images herunterladen.
- Paket-Repository: Ubuntu (archive.ubuntu.com), RHEL (cdn.redhat.com). Anstelle 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.
Gemeinsam (alle Distributionen):
curl, socat, unzip, e2fsprogs, xfsprogs, ebtables, tar
Betriebssystemabhängig:
python3-apt, apt-transport-https, software-properties-common,
conntrack, libseccomp2
device-mapper-libs, nss, conntrack, container-selinux, libseccomp
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 Versenden von E-Mail-Einladungen, zum Zurücksetzen von Passwörtern usw.).
- alle Mailserver, von denen Sie Ihre E-Mails in Vantage Process-Skills importieren möchten. Dies müssen die Mailserver sein, auf denen die zu importierenden E-Mail-Adressen registriert sind.
Hochverfügbare Konfiguration
Die erforderliche Mindestanzahl virtueller Maschinen ist angegeben. Abhängig von der gewünschten Performance kann eine andere Anzahl virtueller Maschinen erforderlich sein.
| Kubernetes-Knotentyp | Master-Knoten | Worker-Knoten (Services) | Worker-Knoten (Workers) |
|---|
| Betriebssystem | Ubuntu 20.04 oder RHEL 8 | Ubuntu 20.04 oder RHEL 8 | Ubuntu 20.04 oder RHEL 8 |
| Anzahl der VMs | 3 | 4 | 1 |
| CPU-Kerne (für jede VM) | 2 | 12 | 12 |
| RAM, GB (für jede VM) | 4 | 48 | 48 |
| Festspeicher für Kubernetes, GB (für jede VM) | 50 | 80 | 80 |
Festplatte/Volume für Mount-Punkt /opt/local-path-provisioner, GB | Nicht erforderlich | Mindestens 40 | Mindestens 40 |
| Netzwerkbandbreite, Gbit/s (für jede VM) | 1 | 1 | 1 |
Ohne Konfiguration für Hochverfügbarkeit
| Kubernetes-Knotentyp | Master-Knoten | Worker-Knoten (Services) | Worker-Knoten (Workers) |
|---|
| Betriebssystem | Ubuntu 20.04 oder RHEL 8 | Ubuntu 20.04 oder RHEL 8 | Ubuntu 20.04 oder RHEL 8 |
| Anzahl der VMs | 1 | 1 | 1 |
| CPU-Kerne (für jede VM) | 2 | 12 | 12 |
| RAM, GB (für jede VM) | 4 | 48 | 48 |
| Speicherplatz für Kubernetes, GB (für jede VM) | 50 | 80 | 80 |
Datenträger/Volume für /opt/local-path-provisioner-Einhängepunkt, GB | Nicht erforderlich | mindestens 40 | mindestens 40 |
| Netzwerkbandbreite, Gbit/s (für jede VM) | 1 | 1 | 1 |
Kubernetes-Version 1.28.4 wird während der Vantage-Installation installiert.
Sie können eine beliebige Container-Registry verwenden.
Eine Microsoft SQL Server-Datenbank mit der folgenden Konfiguration ist erforderlich:
| Version | OS | CPU-Kerne | RAM, GB | Festplattenspeicher, GB | Volltextsuche |
|---|
| Enterprise 2022 | Linux | 4 | 4 | Empfohlen: 400, Min.: 200 | Aktiviert |
Ein externer SQL-Datenbankserver muss eingerichtet sein, und Sie müssen über die entsprechenden Zugangsdaten 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 Passwort, um eine Verbindung zur Datenbank herzustellen.
Der Server sollte über das SMTP-Protokoll betrieben werden.
Das Installationsprogramm benötigt die IP-Adresse/den DNS-Namen, den Port des SMTP-Servers sowie ein Passwort für die Verbindung zum Server (falls der Server eine Authentifizierung erfordert). Der SMTP-Server muss berechtigt sein, E-Mails an Vantage-Benutzer zu senden.
Konfigurieren Sie SMTP mit oder ohne Authentifizierung in env_specific.yml.
Wir empfehlen die Variante mit Authentifizierung (mit Benutzername und Passwort).
Mit Authentifizierung (empfohlen)
Mit Benutzername und Passwort. In diesem Fall sollte der Abschnitt smtp in der Datei env_specific.yml wie folgt definiert werden:
smtp:
host: X.X.X.X
login: email
password: password
port: 587
useSSL: false
secureSocketOptions: null
Ohne Authentifizierung
Ohne Benutzername und Passwort. In diesem Fall sollte der Abschnitt smtp in der Datei env_specific.yml wie folgt definiert werden:
mailFrom: email
smtp:
host: X.X.X.X
login: null
password: null
port: 25
useSSL: false
secureSocketOptions: None
Vergessen Sie nicht, den mailFrom-Parameter im Root-Element hinzuzufügen.
Wir empfehlen, die Option mit Authentifizierung (mit Benutzername und Passwort) zu verwenden.
Sie benötigen entweder ein Wildcard- oder ein domainspezifisches Zertifikat.
Wenn Ihre Vantage-Installation externe Dienste über die „Custom“-Aktivität nutzt oder in externe Systeme exportiert, sollte das Zertifikat von einer öffentlichen Zertifizierungsstelle ausgestellt werden, zum Beispiel https://letsencrypt.org/.
1. Kubernetes-API-Zugriff. Eine statische IP-Adresse, die als virtuelle IP-Adresse für den Zugriff auf den Kubernetes-API-Server-Endpunkt zur Konfiguration und Verwaltung des Clusters verwendet wird. Die IP-Adresse sollte in der Datei env_specific.yml wie folgt definiert werden. Weitere Informationen finden Sie im Abschnitt „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-Record muss vorab angelegt werden. Die IP-Adresse sollte in der Datei env_specific.yml wie folgt definiert werden. Weitere Informationen finden Sie unter Installation:
loadbalancer:
external_ip: X.X.X.X
DNS-Eintrag für den Zugriff auf Vantage
Keine besonderen Anforderungen.
Das Installationsprogramm benötigt eine primäre Domäne und einen DNS-Namen, über den auf Vantage zugegriffen wird. Der DNS-Eintrag muss auf die IP-Adresse verweisen, die für den Zugriff auf Vantage vorgesehen ist.
Externer Speicher ist nur für die Konfiguration ohne Hochverfügbarkeit eine optionale Anforderung. Die Anforderungen an die Festplattengröße für eine hochverfügbare Konfiguration sind im Performance Guide beschrieben.
ABBYY Vantage verwendet lokalen Speicher auf den Festplatten der bereitgestellten virtuellen Maschinen, was die Installation des Produkts beschleunigt. Diese Option kann jedoch weiterhin von unerwarteten Neustarts und Abstürzen virtueller Maschinen betroffen sein. Da dies zu einem Verlust der gespeicherten Daten führen kann, wird bei der Installation die Verwendung eines externen Speichers empfohlen.
ABBYY Vantage ermöglicht es Ihnen, die Verwendung bestimmter Speichertypen wie unten beschrieben festzulegen.
Verwendung des lokalen Speichers auf Festplatten der bereitgestellten virtuellen Maschinen
In diesem Fall werden Volumes mit ReadWriteOnce, POSIX-kompatiblem Zugriff lokal im Verzeichnis /opt/local_path_provisioner auf jedem Kubernetes-Knoten provisioniert. Für Volumetypen mit ReadWriteMany stellt Vantage einen in-cluster nfs-kernel-server auf dem ersten abbyy_services-Knoten bereit (die IP dieses Knotens ist die erste im entsprechenden Block in der inventory-Datei). 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/eine dedizierte Festplatte für diesen Pfad mit einer Größe von mindestens 500 GB zur Verfügung haben.
Für eine hochverfügbare Konfiguration stellt der erste abbyy_services-Knoten ebenfalls lokalen Persistent-Volume-Speicher bereit. Dieser erfordert zusätzliche Festplattenkapazität, abhängig von der Verarbeitungslast. Details zu den erforderlichen Kapazitäten finden Sie im Performance Guide.
Wenn der lokale Persistent-Volume-Speicher keinen freien Platz mehr hat, kann Vantage unter Verlust einiger Daten den Betrieb einstellen. Wir empfehlen, dass Sie den freien Speicherplatz überwachen und Warnmeldungen für geringen freien Speicher einrichten, damit Sie rechtzeitig zusätzlichen Speicher hinzufügen und Datenverlust verhindern können.
Verwendung von externem NFS-Speicher
Der Vantage-Installer ermöglicht es, einen NFS-Speicher automatisch zu konfigurieren, der als Vantage-Speicher für bestimmte Dienste verwendet wird, z. B. für den Import und Export in einen freigegebenen Ordner sowie für das Speichern der durch das Monitoring erfassten Daten.
Der Abschnitt in der Datei env_specific.yml sieht wie folgt aus:
k8s:
storage:
rwx:
external:
enabled: true
type: "nfs"
nfs:
address: <IP-Adresse Ihres NFS-Servers>
path: <exportierter Freigabepfad Ihres NFS-Servers>
Damit Vantage korrekt funktioniert, empfehlen wir, dass das Root-Verzeichnis des NFS-Servers (zum Beispiel /opt/nfs) über die folgenden Berechtigungen und den folgenden Besitzer verfügt:
drwxr-xr-x 4 65532 65532 4096 Dec 12 09:25 /opt/nfs/
Nachfolgend ein Beispiel für einen Verzeichniseintrag in der Datei /etc/exports, wenn ein Linux-Rechner als NFS-Server verwendet wird:
/opt/nfs *(rw,sync,all_squash,insecure,no_subtree_check,anonuid=65532,anongid=65532)
Wenn ein anderer Speichertyp angebunden werden soll, lesen Sie den Abschnitt Defining your own storage classes weiter unten.
Eigene StorageClasses definieren
Wenn Sie externen Speicher verwenden möchten, der nicht auf NFS basiert, folgen Sie den folgenden Schritten:
- Stellen Sie während der Installation, nachdem Sie den Kubernetes-Cluster erstellt haben (Schritt 4 in Ausführen der Installationsskripte), die entsprechenden CSI-Treiber (Container Storage Interface) bereit und erstellen Sie dafür StorageClasses.
- Füllen Sie den Abschnitt
k8s in der Datei env_specific.yml mithilfe des folgenden Codes aus:
k8s:
storage:
rwo:
class_name: "<rwo posix compatible storage class>"
rwx:
class_name: "<read_write_many_storage_class>"
- Fahren Sie mit der Installation fort.
Für NFS-Speicher konfigurieren Sie Folgendes in env_specific.yml:
k8s:
storage:
rwx:
external:
enabled: true
type: "nfs"
nfs:
address: <your nfs server IP address>
path: <your nfs server exported share>
Wenn der lokale Persistent-Volume-Speicher keinen freien Platz mehr hat, kann Vantage den Betrieb einstellen, was zu Datenverlust führen kann. Überwachen Sie den freien Speicherplatz und richten Sie Warnmeldungen ein.