Automatisée : mise à niveau hors ligne

Ansible est utilisé pour automatiser la mise à niveau de l'ensemble du cluster Automation Suite, en effectuant certaines opérations sur une machine du cluster.

Dans l'illustration suivante, le nœud du serveur 1 (ou le nœud hôte Ansible) utilise Ansible pour orchestrer la mise à niveau de l'ensemble du cluster Automation Suite.

Préparation

Important :

Before upgrading, make sure you have prepared your environment for using the uipathctl.sh script. For details, see Using uipathctl.sh.

Assurez-vous d'avoir 10 Go d'espace libre dans le dossier /opt/UiPathAutomationSuite sur tous les nœuds. Si vous ne disposez pas de suffisamment d'espace, vous pouvez augmenter la capacité de ce dossier ou supprimer tous les fichiers du programme d'installation précédent, à l'exception de cluster_config.json. Vous pouvez toujours télécharger à nouveau le programme d'installation précédent.

Pour vérifier l'espace disponible, exécutez la commande suivante : df -h /opt/UiPathAutomationSuite .

Pour préparer la mise à niveau, procédez comme suit :

1. Log into the server node that you previously identified as the Ansible host node via SSH. Make sure you have selected the primary server node with the UiPath bundle additional disk attached at /uipath as your Ansible host node.

2. Devenir utilisateur racine :

   sudo su -
   

3. Créez un dossier d'installation sous le répertoire /opt/UiPathAutomationSuite :

   # Please replace {version} with installer version
   mkdir -p /opt/UiPathAutomationSuite/{version}/installer
   

4. Download as-installer.zip and copy it to /opt/UiPathAutomationSuite/{version}/installer. For download instructions, see as-installer.zip.

   cp /path/to/as-installer.zip /opt/UiPathAutomationSuite/{version}/installer
   

5. Décompresser as-installer.zip :

   cd /opt/UiPathAutomationSuite/{version}/installer
   unzip as-installer.zip -d .
   

6. Download as-infra.tar.gz and copy it to /uipath/{version}. For download instructions, see as-infra.tar.gz.

   cp /path/to/as-infra.tar.gz /uipath/{version}
   

7. Download as.tar.gz and copy it to /uipath/{version}. For download instructions, see as.tar.gz.

   cp /path/to/as.tar.gz /uipath/{version}
   

8. Fournissez les autorisations nécessaires au programme d'installation :

   chmod 755 -R /opt/UiPathAutomationSuite/{version}/installer
   

9. Générez le dernier fichier cluster_config.json sur le nœud hôte Ansible.

   Remarque :

   For details on how to configure the cluster_config.json parameters, see Advanced installation experience.

   • Si vous avez l'ancien cluster_config.json , générez le fichier de configuration à partir du cluster :

     cd /opt/UiPathAutomationSuite/{version}/installer
     
     ./configureUiPathAS.sh config get -i /path/to/old/cluster_config.json -o ./cluster_config.json
     

   • Si vous ne disposez pas de l'ancien fichier cluster_config.json , générez un remplacement des valeurs par défaut, ce que vous avez peut-être fait au moment de l'installation de la version précédente :

     cd /opt/UiPathAutomationSuite/{version}/installer
     
     ./configureUiPathAS.sh config get -o ./cluster_config.json
     

   • If you upgrade from Automation Suite 2022.10 to Automation Suite 2023.4 or later, and Orchestrator is enabled on both the old and new versions, you must set the orchestrator.block_classic_executions flag to true in the cluster_config.json file. Using the flag shows that you agree with blocking classic folders executions. Not using the flag causes the upgrade operation to fail. For a configuration example, see Orchestrator-specific configuration.

   • If you upgrade Automation Suite from a previous version and now enable Process Mining as well, you must update the sql_connection_string_template_sqlalchemy_pyodbc. Below is an example.

     "sql_connection_string_template_sqlalchemy_pyodbc": "mssql+pyodbc://[e-mail]:[e-mail]:1433/DB_NAME_PLACEHOLDER?driver=ODBC+Driver+17+for+SQL+Server"
     

   • If you upgrade Automation Suite from a version previous to 2023.4 and you have Apps enabled, you must create the SQL database for Apps, and then update the cluster_config.json file with the following configuration:

     "apps": {
     "enabled": "true" // This will already be true in existing cluster_config.json if apps is enabled
     "sql_connection_str": "" // Provide ODBC database connection string if apps is enabled
     }
     

     Remarque :

     Utilisez le fichier cluster_config.json mis à jour dans les prochaines étapes de mise à niveau.

   See also Manual: Advanced installation experience.

Exécution

Important :

Si des erreurs ou des problèmes se produisent pendant ou après la mise à niveau, vous pouvez revenir à la version précédente, à condition d'avoir préalablement configuré une sauvegarde.

For instructions, see Rollback on error.

Hydrater le registre Docker

Pour minimiser les temps d'arrêt requis, hydratez docker-registry avec des images de conteneur pour la nouvelle version des produits avant la mise à niveau.

Important :

• Assurez-vous de ne pas hydrater avec des images conteneur et/ou d'autres images d'infrastructure plus de 10 heures avant la mise à niveau.
• If you upgrade Document Understanding and Computer Vision, you must download the base images that match your upgraded Automation Suite version (use the base image that corresponds with your ML Package version) and hydrate them to your docker registry prior to upgrade to avoid disruption to your running DU skills. To download the Document Understanding and Computer Vision installation packages, see Downloading the installation packages.

Pour hydrater docker-registry , exécutez la commande suivante sur le premier nœud du serveur :

cd /opt/UiPathAutomationSuite/{version}/installer

./configureUiPathAS.sh registry upload --offline-bundle /uipath/{version}/as.tar.gz --offline-tmp-folder /uipath/tmp

Configuration de la sauvegarde

Pour configurer la sauvegarde, procédez comme suit :

1. Make sure you have enabled the backup on the cluster. You must create the backup using the same version of the installer as the one you used for the current deployment. For instructions, see the backup and restore documentation corresponding to the Automation Suite version from which you plan to upgrade. For instance, if you plan to upgrade from Automation Suite 2021.10, follow the instructions in the 2021.10 guide.

2. Log into the server node that you previously identified as the Ansible host node via SSH.

3. Vérifiez que tous les volumes souhaités ont des sauvegardes dans le cluster :

   /path/to/old-installer/configureUiPathAS.sh verify-volumes-backup
   

   Remarque :

   La sauvegarde peut prendre un certain temps, attendez environ 15 à 20 minutes, puis vérifiez à nouveau la sauvegarde des volumes.

Une fois la sauvegarde créée, passez aux étapes suivantes.

Mettre le cluster en mode maintenance

Mettre le cluster en mode maintenance arrêtera le contrôleur d'entrée et tous les services UiPath, bloquant ainsi tout le trafic entrant vers le cluster Automation Suite.

Important :

Cette opération entraînera des temps d'arrêt et l'automatisation de votre entreprise sera suspendue pendant l'ensemble du processus de mise à niveau.

1. Pour mettre le cluster en mode maintenance, exécutez :

   cd /opt/UiPathAutomationSuite/{version}/installer
   ./configureUiPathAS.sh enable-maintenance-mode
   

2. Pour vérifier que le cluster est en mode maintenance, exécutez :

   ./configureUiPathAS.sh is-maintenance-enabled
   

   Important :

   Créez une sauvegarde de votre serveur SQL après avoir activé le mode de maintenance afin qu'aucune autre transaction ne soit enregistrée dans votre base de données SQL.

Mise à niveau du cluster

Pour mettre à niveau le cluster Automation Suite, procédez comme suit :

1. Connectez-vous au nœud hôte Ansible via SSH et devenez l'utilisateur root.

2. Pour effectuer les étapes de mise à niveau sur tous les nœuds, exécutez la commande suivante avec les paramètres de base. Pour un contrôle plus précis, consultez la section Paramètres.

   Remarque :

   Assurez-vous d'avoir mis à jour cluster_config.json généré comme décrit dans les étapes de préparation.

   # Please replace {version} with installer version, in all the below commands
   cd /opt/UiPathAutomationSuite/{version}/installer
   
   ./uipathctl.sh upgrade --cluster-config ./cluster_config.json --install-type offline --steps all --offline-infra-bundle /uipath/{version}/as-infra.tar.gz --accept-license-agreement
   

   Important :

   Le processus de mise à niveau nécessite la migration de Canal CNI vers Cilium CNI. La mise à niveau automatisée exécute cette étape automatiquement, puis redémarre tous les nœuds du cluster pour terminer la migration.

   Une fois les nœuds redémarrés, attendez quelques minutes pour vous assurer que tous les services sont à nouveau en ligne. Vous pouvez vous connecter à ArgoCD pour surveiller le statut de toutes les applications.

   Important :

   If you get the following error, follow the instructions in Downgrading Ceph from 16.2.6 to 15.2.9.

   Ceph cluster is running on version: 16.2.6 with known bug(https://docs.ceph.com/en/quincy/releases/pacific/#v16-2-6-pacific). Please provide temporary backup directory (via environment variable 'TMP_CEPH_BACKUP_PATH') to downgrade ceph

Paramètres de base

Paramètre	Valeur (Value)
--install-type	Valeurs possibles : online et offline . Étant donné que cette page fournit des instructions pour un environnement hors ligne, choisissez la valeur offline .
--steps	Les valeurs possibles sont : all , infra , fabric et services . Indique chaque étape du processus d'installation et de mise à niveau. all – Recommended: A superset of all the other steps, which upgrades the entire Automation Suite. infra – Met à niveau Kubernetes et d'autres composants d'infrastructure sur Automation Suite sur tous les nœuds. bundles – Télécharge et hydrate le registre Docker hébergé dans le cluster Automation Suite avec les images de conteneur Fabric et Services. You must upload and hydrate the Docker registry at the same time as upgrading Kubernetes and the infrastructure components. To execute the two steps simultaneously, run --steps bundles infra. Do not run --steps bundles alone as it will damage the cluster. fabric – Met à niveau tous les composants Fabric et partagés d'Automation Suite. services – Met à niveau tous les services produit UiPath installés sur Automation Suite. Si une erreur se produit pendant la mise à niveau, vous pouvez utiliser ces points de contrôle pour reprendre l'opération de mise à niveau au lieu de réessayer depuis le début.
--offline-bundle	Chemin d'accès au bundle hors ligne as.tar.gz , contenant les images de conteneur de fabric et de services. Il est recommandé de le stocker dans /uipath/{version}/as.tar.gz
--offline-infra-bundle	Chemin d'accès au bundle hors ligne as-infra.tar.gz , contenant Kubernetes et les bundles d'infrastructure.
--cluster-config	cluster_config.json , qui définit les paramètres, les paramètres et les préférences appliqués aux services UiPath déployés via Automation Suite.

Paramètres avancés

Paramètre	Valeur (Value)
--ansible-username	Spécifiez le nom d'utilisateur à utiliser pour les connexions SSH à tous les nœuds. La valeur par défaut est l'utilisateur actuel. Si vous utilisez un nom d'utilisateur différent pour tous les nœuds, au lieu d'utiliser ce paramètre, définissez le nom d'utilisateur pour tous les nœuds dans inventory.ini et transmettez-le au script. Exemple : Lors de l'exécution du script, vous êtes connecté sous le nom d'utilisateur myadminuser . Cependant, si vous souhaitez utiliser le nom d'utilisateur testadmin pour vous connecter via SSH, vous devez fournir testadmin à ce paramètre.
--inventory	Spécifiez un fichier d'inventaire Ansible existant. S'il n'est pas spécifié, un sera généré automatiquement à partir du cluster existant avec la configuration de base. Dans certains scénarios où vous souhaitez avoir un contrôle plus précis, vous souhaiterez peut-être fournir votre propre fichier d'inventaire. Par exemple, si vous souhaitez utiliser un nom d'utilisateur SSH ou une clé SSH différent pour tous les nœuds du cluster. For details, see Generating the Ansible inventory.ini file.

Remarque :

Si la mise à niveau a échoué pour une raison quelconque, mais que le téléchargement vers le registre Docker a réussi, aucun nouveau téléchargement n'est requis. Vous pouvez reprendre la mise à niveau en exécutant directement l'installation de la structure ou du service : ./uipathctl.sh upgrade --install-type offline --steps {fabric | services} .

Une fois la mise à niveau terminée, le mode maintenance sera automatiquement désactivé.

Une fois la mise à niveau effectuée, vous pouvez effectuer les étapes supplémentaires suivantes :

• Pour vérifier si Automation Suite est sain, exécutez :

  kubectl get applications -n argocd
  

• Lors de la mise à niveau à partir d'une version d'Automation Suite antérieure à 2023.4.0, vérifiez si Apps est en cours d'exécution, puis supprimez MongoDB :

  ./configureUiPathAS.sh mongodb uninstall --force
  

• Si vous rencontrez une erreur lors de la suppression de MongoDB avec la commande ./configureUiPathAS.sh mongodb uninstall --force, exécutez la commande suivante :

  kubectl patch application "fabric-installer" -n argocd --type=merge -p '{"spec" : {"syncPolicy" : {"automated" : {"selfHeal": false }}}}'
  
  ./configureUiPathAS.sh mongodb uninstall --force
  
  kubectl patch application "fabric-installer" -n argocd --type=merge -p '{"spec" : {"syncPolicy" : {"automated" : {"selfHeal": true }}}}'
  

• If you experience issues with image vulnerabilities or storage consumption after performing an upgrade, delete the images from the old installer. For details, see the Troubleshooting section.

• After upgrading to Automation Suite 2023.4.8 or newer, you can clean up the previous version images after the upgrade from the in-cluster Docker registry. For instructions, see How to delete images from the old installer after upgrade.

Activation de la sauvegarde après la mise à niveau

Remarque :

Assurez-vous qu'Automation Suite est opérationnelle et que votre automatisation se poursuit comme prévu avant de passer aux étapes suivantes.

Avant de commencer à mettre à niveau le cluster, le script de mise à niveau crée automatiquement une sauvegarde du cluster, puis la désactive temporairement. Une fois la mise à niveau du cluster terminée, assurez-vous de reconfigurer et mettre à niveau Velero, puis activez la sauvegarde manuellement.

To enable the backup, follow the instructions in described in the Backing up and restoring the cluster documentation.