Passer au contenu principal
Cette section décrit le processus de mise à jour d’ABBYY Vantage vers la dernière version disponible.
Avant de mettre à jour Vantage, assurez-vous que tous les prérequis de la nouvelle version répertoriés dans la section System Requirements sont remplis.
Le processus de mise à jour se compose des étapes suivantes :
  1. Synchroniser les images de conteneurs.
  2. Sauvegarder les données.
  3. Exécuter les scripts d’installation.
  4. Désinstaller Vantage.
  5. Mettre à jour ABBYY Vantage.

Synchroniser les images de conteneurs

Pour synchroniser les images de conteneurs, suivez la procédure décrite dans Téléchargement des images de conteneurs.

Sauvegarder les données

Pour pouvoir restaurer Vantage dans l’état où il se trouvait au moment de la mise à jour, vous devez disposer d’une sauvegarde des bases de données, de Consul et de copies des secrets Kubernetes. Suivez les étapes ci-dessous pour sauvegarder correctement ces composants :
  1. Avant de créer une sauvegarde des bases de données et de Consul, vous devez arrêter le cluster. Arrêtez tous les nœuds du cluster.
  2. Effectuez une sauvegarde des éléments suivants :
    • Bases de données : la liste des bases de données est la suivante : apigatewayregistry, auth, auth-identity, catalogstorage, cron, documentset, folderimport, interactive-jobs, mail, mailimport, permissions, publicapi, reporting, secretstorage, security-audit, skillinfo, skillmonitor, storage, subscriptions, tokenmanagement, transactions, workflows, workspace.
    • Consul : le CronJob Kubernetes sauvegarde Consul sur un stockage RWX externe (tel que NFS) dans un pod nommé [X].consul-backup. Vous pouvez récupérer les fichiers TGZ sauvegardés depuis le répertoire PVC nommé consul-backup.
  3. Démarrez le cluster. Démarrez tous les nœuds du cluster.
  4. Sauvegardez les copies des secrets Kubernetes. Pour obtenir les clés, exécutez les commandes suivantes :
kubectl get secret -n abbyy-vantage secretstorage-encryptionkeys -o yaml
kubectl get secret -n abbyy-vantage tokenmanagement-encryptionkeys -o yaml
Avant de sauvegarder les copies des secrets Kubernetes, assurez-vous que le cluster est démarré.
Les sauvegardes sont effectuées par mesure de précaution. En cas de mise à niveau réussie, vous n’aurez pas besoin de restaurer la sauvegarde.

Exécuter les scripts d’installation

Avant de mettre à jour ABBYY Vantage, suivez les étapes de la section Installation. Pour exécuter les scripts d’installation :
  1. Configurez les fichiers de configuration.
Par défaut, la version 2 du noyau technologique est supprimée lors de la mise à jour de Vantage. Pour la conserver, ajoutez le paramètre techcore.keep_previous_version au fichier env_specific.yml et attribuez-lui la valeur true.
  1. Préparez les certificats.
  2. Téléchargez les images de conteneurs.
  3. Exécutez les scripts d’installation (étapes 1 à 3).

Désinstaller Vantage

Exécutez le playbook suivant pour désinstaller le produit :
ansible-playbook -i inventories/k8s -v playbooks/uninstall-vantage.yml
Ce playbook supprimera tous les services tout en conservant le stockage de données intact.

Mettre à jour ABBYY Vantage

Pour mettre à jour ABBYY Vantage :
  1. Exécutez les playbooks suivants pour effectuer une vérification de prédéploiement et pour lire et accepter les documents juridiques relatifs à Vantage :
ansible-playbook -i inventories/k8s -v playbooks/0-PreflightCheck-k8s.yml
ansible-playbook -i inventories/k8s -v playbooks/legal.yml
Les playbooks vont :
  • Effectuer une vérification préliminaire des ressources dont les paramètres sont spécifiés dans le fichier env_specific.yml du playbook (base de données, connexion SMTP, etc.).
  • Demander à l’administrateur système d’accepter les conditions du CLUF et la Politique de confidentialité ABBYY.
  1. Exécutez le playbook suivant pour mettre à jour Vantage :
ansible-playbook -i inventories/k8s -v playbooks/site-k8s-deploy.yml
Les playbooks installeront une nouvelle version du produit. En moyenne, le processus prendra environ 20 à 30 minutes.
Après la mise à jour d’ABBYY Vantage, vous devrez vous authentifier de nouveau. Les jetons d’autorisation obtenus avant la mise à niveau ne fonctionneront plus.
Pour travailler avec Advanced Designer et Scanning Station, vous devez télécharger leurs nouvelles versions et les installer sur vos machines :
  • https://<your-vantage-host>/ad/latest - pour télécharger Advanced Designer
  • https://<your-vantage-host>/ss/latest - pour télécharger Scanning Station
Si le processus de mise à jour échoue, voir la section suivante : Récupération.

Récupération

Si le processus de mise à jour a échoué, suivez les étapes suivantes :
  1. Vérifiez que les pods du cluster fonctionnent correctement et redémarrez-les s’ils ne fonctionnent pas correctement.
  2. Analysez les journaux des pods qui ne fonctionnent pas comme prévu.
  3. Suivez les étapes de dépannage indiquées dans les journaux des pods.
  4. Si la mise à niveau échoue à n’importe quelle étape de l’installation d’une nouvelle version de Vantage (par exemple, en attendant les tâches Vantage, en attendant les déploiements Vantage), corrigez la cause de l’erreur, puis exécutez le playbook d’installation :
ansible-playbook -i inventories/k8s -v playbooks/site-k8s-deploy.yml

Installation de Vantage avec récupération des données sur un nouveau cluster

Si les étapes décrites ci-dessus ne suffisent pas, vous pouvez installer Vantage avec récupération des données sur un nouveau cluster en procédant comme suit :
  1. Assurez-vous de disposer des sauvegardes les plus récentes de vos données.
  2. Restaurez les données à partir des sauvegardes que vous avez créées précédemment.
  3. Préparez le fichier env_specific contenant les informations de connexion aux bases de données et au stockage externe restaurés à partir des sauvegardes.
  4. Installez Vantage en suivant les étapes de la section Installation, à partir de Running the installation scripts. Pour l’étape 2 (exécution du programme d’installation à partir d’une image Docker), utilisez la commande ci-dessous :
docker run -it --net=host \
-v $PWD/kube:/root/.kube \
-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/vantage-k8s:2.7.1
  1. Remplacez les valeurs des clés dans les secrets secretstorage-encryptionkeys et tokenmanagement-encryptionkeys par les valeurs que vous avez sauvegardées précédemment : a. Exécutez la commande :
    kubectl edit secrets -n abbyy-vantage secretstorage-encryptionkeys
    
    b. Dans le fichier qui s’ouvre après key-<guid>.xml, remplacez la chaîne base64 par la chaîne base64 contenue dans la clé précédemment sauvegardée pour le secret secretstorage-encryptionkeys. c. Enregistrez vos modifications et fermez l’éditeur. d. Faites de même pour le secret tokenmanagement-encryptionkeys en utilisant la commande :
    kubectl edit secrets -n abbyy-vantage tokenmanagement-encryptionkeys
    
  2. Après avoir remplacé les clés, redémarrez les pods secretstorage et tokenmanagement :
kubectl -n abbyy-vantage rollout restart $(kubectl -n abbyy-vantage get deployments -l app.kubernetes.io/component=secretstorage -o name)
kubectl -n abbyy-vantage rollout restart $(kubectl -n abbyy-vantage get deployments -l app.kubernetes.io/component=tokenmanagement -o name)
  1. Redémarrez les transactions. Sur une machine connectée au cluster, exécutez cette commande pour accéder au service de transactions :
kubectl port-forward -n abbyy-vantage deployments/abbyy-vantage-transactions 8080:8080
Dans votre navigateur, ouvrez l’adresse http://localhost:8080/index.html, puis exécutez la méthode d’API suivante :
/api/recovery/transactions/restart
Si, après la restauration, l’adresse de l’hôte Vantage a changé et que le système contient des invitations en attente d’acceptation, vous devez les renvoyer.