Passer au contenu principal

​
Liste de contrôle des prérequis

Préparez et configurez les composants externes suivants avant d’installer Vantage :
  • Une machine avec Docker et un accès à Internet (à partir de laquelle Vantage sera installé)
  • Des machines virtuelles (avec accès à Internet pendant l’installation) à utiliser comme nœuds Kubernetes
  • Un registre de conteneurs pour stocker les images Docker
  • Des systèmes de gestion de bases de données relationnelles (SGBDR, RDBMS) pour le fonctionnement de Vantage
  • Un serveur SMTP pour envoyer des messages électroniques aux utilisateurs de Vantage
  • Un certificat TLS pour établir des communications chiffrées
  • 2 adresses IP statiques : une pour la configuration/la gestion de Kubernetes, une pour l’accès à Vantage
  • Un enregistrement DNS pour l’accès à Vantage
  • Un stockage externe (facultatif dans une configuration sans haute disponibilité)

​
Exigences relatives à la machine d’installation

La machine à partir de laquelle Vantage est installé doit répondre aux exigences suivantes :
  • Système d’exploitation Linux ou Windows Subsystem for Linux (WSL)
  • Docker version 19.03 ou ultérieure
  • Accès réseau à abyvtgonprm27.azurecr.io
  • Fichiers locaux contenant une clé SSH privée (sans phrase de passe) pour le compte utilisateur ansible
Toutes les machines virtuelles doivent utiliser la même clé SSH.

​
Exigences relatives aux machines virtuelles

Toutes les machines virtuelles peuvent fonctionner sous VMware ou Hyper-V et doivent disposer de :
  • Une adresse IP statique
  • Un compte utilisateur nommé ansible avec :
    • Un accès par clé SSH partagée
    • Un accès sudo avec l’option NOPASSWD
  • Un disque ou volume LVM dédié et extensible monté sur /opt/local-path-provisioner sur chaque nœud worker
  • Un accès Internet pendant l’installation au registre de conteneurs et aux dépôts de paquets :
    • Registre de conteneurs avec les images synchronisées préparées comme prérequis à l’installation de Vantage. Pour plus d’informations, voir Downloading Container Images.
    • Dépôt de paquets : Ubuntu (archive.ubuntu.com), RHEL (cdn.redhat.com). Au lieu d’un accès aux dépôts de paquets, vous pouvez également configurer l’accès à votre propre dépôt, qui doit contenir tous les paquets requis répertoriés ci-dessous.
Commun (toutes distributions) : 
curl, socat, unzip, e2fsprogs, xfsprogs, ebtables, tar
Selon le système d’exploitation : 
python3-apt, apt-transport-https, software-properties-common,
conntrack, libseccomp2

​
Accès réseau après l’installation

Après l’installation du cluster, les machines virtuelles doivent avoir accès à :
  • https://licensing-us.abbyy.com
  • Au serveur de messagerie, pour lequel les paramètres SMTP sont spécifiés dans le fichier env_specific.yml (pour l’envoi d’invitations par e-mail, la récupération de mots de passe, etc.).
  • À tous les serveurs de messagerie à partir desquels vous allez importer vos e-mails dans des Compétences de processus Vantage. Il doit s’agir des serveurs de messagerie sur lesquels les adresses e-mail à importer sont enregistrées.

​
Configuration à haute disponibilité

Le nombre minimal requis de machines virtuelles est indiqué. Différents niveaux de performance peuvent nécessiter un nombre différent de machines virtuelles.
Type de nœud KubernetesNœuds maîtresNœuds worker (services)Nœuds worker (workers)
Système d’exploitationUbuntu 20.04 ou RHEL 8Ubuntu 20.04 ou RHEL 8Ubuntu 20.04 ou RHEL 8
Nombre de VM341
Cœurs CPU (par VM)21212
RAM, Go (par VM)44848
Stockage disque pour Kubernetes, Go (par VM)508080
Disque/volume pour le point de montage /opt/local-path-provisioner, GoNon requisMinimum 40Minimum 40
Bande passante réseau, Gbit/s (par VM)111

​
Sans configuration de haute disponibilité

Type de nœud KubernetesNœuds maîtresNœuds workers (Services)Nœuds workers (Workers)
Système d’exploitationUbuntu 20.04 ou RHEL 8Ubuntu 20.04 ou RHEL 8Ubuntu 20.04 ou RHEL 8
Nombre de VM111
Cœurs CPU (par VM)21212
RAM, Go (par VM)44848
Espace disque pour Kubernetes, Go (par VM)508080
Disque/volume pour le point de montage /opt/local-path-provisioner, GoNon requisMinimum 40Minimum 40
Bande passante réseau, Gbit/s (par VM)111
La version 1.28.4 de Kubernetes sera installée lors de l’installation de Vantage.

​
Registre de conteneurs

Vous pouvez utiliser n’importe quel registre de conteneurs.

​
Configuration requise pour la base de données

Une base de données Microsoft SQL Server avec la configuration suivante est requise :
VersionOSCœurs CPURAM, GoStockage sur disque, GoRecherche en texte intégral
Enterprise 2022Linux44Recommandé : 400, Min. : 200Activée
Un serveur de base de données SQL externe doit être installé et configuré, et vous devez disposer des identifiants appropriés pour créer et gérer la nouvelle base de données. Le programme d’installation nécessite l’adresse IP du serveur SQL, ainsi qu’un nom d’utilisateur et un mot de passe pour se connecter à la base de données.

​
Serveur SMTP

Le serveur doit utiliser le protocole SMTP. Le programme d’installation nécessite l’adresse IP ou le nom DNS, le port du serveur SMTP, ainsi qu’un mot de passe pour se connecter au serveur (si le serveur nécessite une authentification). Le serveur SMTP doit être autorisé à envoyer des e-mails aux utilisateurs de Vantage. Configurez SMTP avec ou sans authentification dans env_specific.yml.
Nous recommandons d’utiliser l’option avec authentification (avec nom d’utilisateur et mot de passe).
Avec authentification (recommandé) Avec nom d’utilisateur et mot de passe. Dans ce cas, la section smtp du fichier env_specific.yml doit être définie comme suit : 
smtp:
  host: X.X.X.X
  login: email
  password: password
  port: 587
  useSSL: false
  secureSocketOptions: null
Sans authentification Sans nom d’utilisateur et mot de passe. Dans ce cas, la section smtp du fichier env_specific.yml doit être définie comme suit : 
mailFrom: email
smtp:
  host: X.X.X.X
  login: null
  password: null
  port: 25
  useSSL: false
  secureSocketOptions: None
N’oubliez pas d’ajouter le paramètre mailFrom à la racine.
Nous recommandons d’utiliser l’option avec authentification (par identifiant et mot de passe).

​
Certificat TLS

Vous aurez besoin soit d’un certificat générique (wildcard), soit d’un certificat spécifique à un domaine. Si votre installation de Vantage se connecte à des services externes à l’aide de l’activité Custom ou exporte vers des systèmes externes, le certificat doit être émis par une autorité de certification publique, par exemple https://letsencrypt.org/.

​
Adresses IP statiques

1. Accès à l’API Kubernetes. Une adresse IP statique qui sera utilisée comme adresse IP virtuelle pour accéder au point de terminaison du serveur d’API Kubernetes, afin de configurer et gérer le cluster. L’adresse IP doit être définie dans le fichier env_specific.yml comme suit. Pour plus d’informations, voir Mise en place des fichiers de configuration : 
k8s:
  api:
    ip: X.X.X.X
2. Accès aux services Vantage. Une adresse IP statique sera utilisée pour accéder aux services Vantage en HTTPS. Un enregistrement DNS de type A approprié doit être créé au préalable. L’adresse IP doit être définie dans le fichier env_specific.yml comme suit. Pour plus d’informations, consultez Installation : 
loadbalancer:
  external_ip: X.X.X.X

​
Enregistrement DNS pour un accès ultérieur à Vantage

Aucune exigence spécifique. Le programme d’installation nécessite un domaine principal et un nom DNS qui sera utilisé pour accéder à Vantage. L’enregistrement DNS doit pointer vers l’adresse IP dédiée à l’accès à Vantage.

​
Stockage externe

Le stockage externe est une exigence facultative uniquement pour la configuration Sans haute disponibilité. Les exigences de taille de disque pour la configuration à haute disponibilité sont décrites dans le Guide des performances. ABBYY Vantage déploie un stockage local sur les disques durs des machines virtuelles fournies, ce qui accélère l’installation du produit. Cependant, cette option peut être affectée par des redémarrages inattendus et des pannes de machines virtuelles. Étant donné que cela peut entraîner une perte des données stockées, il est recommandé d’utiliser un stockage externe lors de l’installation. ABBYY Vantage vous permet de définir l’utilisation de types de stockage spécifiques de la manière indiquée ci-dessous.

​
Utilisation du stockage local sur les disques durs des machines virtuelles fournies

Dans ce cas, des volumes avec un accès ReadWriteOnce compatible POSIX seront provisionnés localement dans le répertoire /opt/local_path_provisioner sur chaque nœud Kubernetes. Pour les types de volumes ReadWriteMany, Vantage déploiera un in-cluster nfs-kernel-server sur le premier nœud abbyy_services (l’IP de ce nœud est la première dans le bloc correspondant du fichier inventory). Les données du serveur NFS seront stockées dans le répertoire /opt/local_path_provisioner ; assurez-vous donc de disposer, sur le premier nœud abbyy_services (le premier nœud de ce groupe est défini dans le fichier inventory), d’un volume/disque dédié pour ce chemin d’une taille d’au moins 500 Go. Pour une configuration à haute disponibilité, le premier nœud abbyy_services hébergera également un stockage de volumes persistants locaux. Cela nécessitera une capacité de disque dur supplémentaire en fonction de la charge de traitement. Pour plus de détails sur les capacités nécessaires, consultez le Performance Guide.
Si le stockage de volumes persistants locaux vient à manquer d’espace, Vantage peut cesser de fonctionner, avec perte de certaines données. Nous vous recommandons de surveiller l’espace libre de votre côté et de configurer des alertes en cas de faible espace disponible, afin de pouvoir ajouter du stockage à temps et d’éviter toute perte de données.

​
Utilisation d’un stockage NFS externe

Le programme d’installation de Vantage vous permet de configurer automatiquement un stockage NFS pour l’utiliser comme stockage Vantage pour certains services, tels que l’import et l’export vers un dossier partagé, ainsi que le stockage des données collectées par la fonction de monitoring. La section du fichier env_specific.yml sera semblable à ce qui suit : 
k8s:
  storage:
    rwx:
      external:
        enabled: true
        type: "nfs"
        nfs:
          address: <adresse IP de votre serveur NFS>
          path: <partage exporté de votre serveur NFS>
Pour que Vantage fonctionne correctement, nous recommandons que le répertoire racine du serveur NFS (par exemple, /opt/nfs) dispose des permissions et du propriétaire suivants : 
drwxr-xr-x 4 65532 65532 4096 Dec 12 09:25 /opt/nfs/
Voici un exemple de configuration de répertoire dans le fichier /etc/exports lorsqu’une machine Linux est utilisée comme serveur NFS : 
/opt/nfs *(rw,sync,all_squash,insecure,no_subtree_check,anonuid=65532,anongid=65532)
Si vous devez connecter un autre type de stockage, reportez-vous à la section Définir vos propres classes de stockage ci-dessous.

​
Définir vos propres classes de stockage

Si vous souhaitez utiliser un stockage externe autre que NFS, suivez les étapes ci-dessous :
  1. Pendant l’installation, après la création du cluster Kubernetes (étape 4 dans Exécution des scripts d’installation), déployez les pilotes CSI (Container Storage Interface) appropriés et créez les classes de stockage correspondantes.
  2. Renseignez la section k8s dans le fichier env_specific.yml en utilisant le code suivant :
k8s:
  storage:
    rwo:
      class_name: "<rwo posix compatible storage class>"
    rwx:
      class_name: "<read_write_many_storage_class>"
  1. Poursuivez l’installation.
Pour un stockage NFS, configurez le fichier env_specific.yml : 
k8s:
  storage:
    rwx:
      external:
        enabled: true
        type: "nfs"
        nfs:
          address: <your nfs server IP address>
          path: <your nfs server exported share>
Si l’espace de stockage du volume persistant local vient à manquer, Vantage peut cesser de fonctionner et provoquer une perte de données. Surveillez l’espace disque disponible et configurez des alertes.