Configuration du registre compatible OCI pour les installations hors ligne

Référence pour la configuration d'un registre compatible OCI pour stocker des images de conteneur et des graphiques Helm pour les installations hors ligne dans Automation Suite.

Dans les installations hors ligne, vous avez besoin d'un registre compatible OCI (Open Container Initiative) pour stocker les images de conteneur et les graphiques Helm de déploiement. Si vous effectuez une installation en ligne, ignorez cette étape.

Assurez-vous d'exécuter les scripts présents dans le programme d'installation cible /opt/UiPathAutomationSuite/latest/installer.

Remarque :

Vous devez choisir l’une des options suivantes pour configurer le registre conforme à OCI :

• Recommandé. Fournissez votre propre registre. Pour plus de détails, consultez la section Charger les artefacts d’Automation Suite vers le registre conforme à OCI externe présente sur cette page.
• Si vous ne disposez pas de registre, vous pouvez installer temporairement un registre compatible OCI sur l’une des machines serveur. Pour plus de détails, consultez la section Configuration du registre Docker temporaire sur cette page.

Téléchargement des artefacts Automation Suite vers le registre externe compatible OCI

Il existe deux manières de télécharger les artefacts Automation Suite vers le registre compatible OCI externe :

• Option A: en mettant en miroir votre registre compatible OCI avec le registre UiPath®
• Option B: Hydrater votre registre compatible OCI avec le bundle hors ligne

Le tableau suivant compare les deux options de téléchargement des artefacts dans le registre afin que vous puissiez choisir celle qui convient le mieux à vos besoins :

Option A : Mettre en miroir le registre	Option B : hydrater le registre
Copie les artefacts du registre UiPath® vers n’importe quel registre cible.	Utilise tarball hors ligne pour décompresser et télécharger les artefacts dans le registre cible.
Nécessite les outils Docker et Helm.	Nécessite les outils Podman et Helm.
Nécessite un accès Internet pour copier les artefacts du registre UiPath® vers le registre cible.	Nécessite un accès à Internet uniquement pour télécharger tarball hors ligne sur Jump Server. Le téléchargement de tarball ne nécessite pas d’accès à Internet.
Nécessite un espace temporaire pour mettre les images en cache pendant la méthode de copie. Cet espace est généralement configuré lors de l'installation de Docker. Le dossier par défaut est /var/lib/docker.	Nécessite un espace temporaire pour extraire tarball et un espace temporaire pour que Podman puisse charger les images. L'emplacement de l'extraction tarball doit être fourni lors de l'étape d'hydratation. L'emplacement Podman peut être /var/tmp, qui doit disposer d'un stockage adéquat.
La capacité de stockage requise pour le répertoire /var/lib/docker est d’environ 128 Go.	La capacité de stockage requise pour l'extraction est d'environ 200 Go, et /var/tmp doit être de 256 Go.

Remarque :

Il est recommandé d'effectuer l'opération de mise en miroir ou d'hydratation à partir de la machine de gestion ou de la zone de saut, au lieu d'utiliser les nœuds de serveur.

Option A : mettre en miroir le registre UiPath® avec votre registre

Cette méthode nécessite un accès Internet sur la machine intermédiaire à partir de laquelle vous téléchargez les artefacts Automation Suite dans votre registre compatible OCI.

Prérequis pour mettre en miroir le registre UiPath®

Pour mettre en miroir le registre UiPath®, vous avez besoin des éléments suivants :

• une machine virtuelle exécutant une distribution Linux (recommandé) ou un ordinateur portable (non recommandé)
• un client Docker authentifié avec le registre privé
• Helm 3.8 ou une version plus récente authentifié avec le registre privé
• as-images.txt
• as-helm-charts.txt
• mirror-registry.sh
• connectivité sortante vers registry.uipath.com
• 128 Go d'espace disque libre pour Docker sous la partition /var/lib/docker , sur la machine à partir de laquelle vous téléchargez les images et les graphiques du conteneur

Installation de Docker et Helm

Docker et Helm doivent être installés et authentifiés sur la machine à partir de laquelle vous prévoyez de télécharger les images de conteneur Automation Suite et les graphiques dans votre registre.

• Pour télécharger les fichiers binaires Docker, reportez-vous à la documentation officielle.

• Pour authentifier le registre Docker, consultez la documentation officielle. Vous pouvez également utiliser la commande suivante en remplaçant les exemples d'informations d'identification par vos informations d'identification de registre réelles:

  docker login my.registry.io:443 --username "admin" --password "secret"
  

• Pour télécharger les fichiers binaires Helm, reportez-vous à la documentation officielle.

• Pour authentifier le registre Helm, reportez-vous à la documentation officielle. Vous pouvez également utiliser la commande suivante en remplaçant les exemples d'informations d'identification par vos informations d'identification de registre réelles:

  helm registry login my.registry.io:443 --username "admin" --password "secret"
  

Téléchargement du fichier as-images.txt

Pour télécharger as-images.txt, reportez-vous à Téléchargement des bundles d'installation.

Téléchargement du fichier as-helm-charts.txt

Pour télécharger as-helm-charts.txt, reportez-vous à Téléchargement des bundles d'installation.

Téléchargement des bundles Document Understanding facultatifs

Pour télécharger des bundles Document Understanding facultatifs, consultez la documentation Document Understanding.

Téléchargement de miroir-registre.sh

Pour télécharger le script mirror-registry.sh , reportez-vous à Téléchargement des packages d'installation.

Téléchargement des images Automation Suite dans votre registre

Le script mirror-registry.sh nécessite une connectivité sortante vers les registres source (registry.uipath.com par défaut) et cible.

Remarque :

Le script mirror-registry.sh n'authentifie pas le registre. Il suppose que vous vous êtes déjà authentifié auprès du registre.

Le tableau suivant décrit les indicateurs et les variables d'environnement pour le script mirror-registry.sh .

Drapeau	Variable d'environnement	Description
--images-manifest	IMAGES_MANIFEST	Obligatoire. Chemin d'accès au fichier manifeste de l'image.
--helm-charts-manifest	HELM_CHARTS_MANIFEST	Obligatoire. Chemin d'accès au fichier manifeste du graphique Helm.
--target-registry-url	TARGET_REGISTRY_URL	Obligatoire. Transmettez l'URL du registre cible.
--source-registry-url	SOURCE_REGISTRY_URL	Facultatif. Transmettez l'URL du registre source. La valeur par défaut est registry.uipath.com.

Pour télécharger les images Automation Suite dans votre registre :

1. Assurez-vous que vous disposez des autorisations nécessaires pour exécuter le script Shell, en exécutant la commande suivante :

   chmod +x mirror-registry.sh
   
   

2. Chargez les images Automation Suite dans votre registre en exécutant la commande suivante :

   ./mirror-registry.sh --target-registry-url my.registry.io:443 --source-registry-url registry.uipath.com --images-manifest /home/myuser/as-images.txt --helm-charts-manifest /home/myuser/as-helm-charts.txt
   

   Remarque :

   Pour les registres tels que Harbor, qui nécessitent l'utilisation d'un projet, veillez à bien ajouter le nom du projet à l'URL du registre cible que vous incluez dans la commande, comme l'illustre l'exemple suivant :

   ./mirror-registry.sh --target-registry-url my.registry.io:443/myproject --source-registry-url registry.uipath.com --images-manifest /home/myuser/as-images.txt --helm-charts-manifest /home/myuser/as-helm-charts.txt
   

Option B : hydrater le registre avec le bundle hors ligne

Cette méthode nécessite uniquement un accès Internet sur la machine intermédiaire pour télécharger le bundle hors ligne. Une fois le bundle disponible, vous pouvez le télécharger vers votre registre compatible OCI sans connexion Internet.

Remarque :

Cette méthode peut également nécessiter un espace supplémentaire sur la machine pour le décompresser et télécharger dans votre registre. De plus, cette méthode peut prendre plus de temps que l'approche de mise en miroir.

Prérequis pour hydrater le registre

Pour hydrater le registre, vous avez besoin des éléments suivants :

• une machine virtuelle exécutant une distribution Linux est préférable à l'exécution du script sur un ordinateur portable
• possibilité de télécharger et de copier ou de propager d'une quelconque manière le bundle hors ligne à la machine virtuelle
• Helm 3.8 ou une version plus récente authentifié avec le registre privé
• Podman installé, configuré et authentifié avec le registre privé
• 150 Go d'espace disque libre pour Podman sous /var/lib/containers pour charger les conteneurs localement avant de les transmettre au registre distant. Si vous devez modifier le chemin par défaut, mettez à jour la variable graphRoot dans le fichier /etc/containers/storage.conf .

Par exemple, vous pouvez modifier storage.conf à l'aide de sudo nano /etc/containers/storage.conf, remplacer graphRoot par votre nouveau chemin, puis vérifier que le chemin est mis à jour à l'aide de la commande podman info .

• Définissez la variable d'environnement TMP_DIR comme décrit dans la documentation officielle de Podman. Cette variable spécifie le stockage temporaire des images de conteneur téléchargées lors des opérations d’extraction et de construction, ce qui est crucial pour éviter les erreurs d’espace insuffisant si /var/tmp est limité.
• as.tar.gz

Installation de Podman et Helm

Vous devez vous assurer que Podman et Helm sont installés et authentifiés sur la machine à partir de laquelle vous prévoyez de télécharger les images de conteneur Automation Suite et les graphiques dans votre registre.

• Pour télécharger les fichiers binaires Podman, consultez la documentation officielle.

• Pour vous authentifier auprès du registre Podman, consultez la documentation officielle. Vous pouvez également utiliser la commande suivante en remplaçant les exemples d'informations d'identification par vos informations d'identification de registre réelles:

  podman login my.registry.io:443 --username "admin" --password "secret"
  

• Pour télécharger les fichiers binaires Helm, reportez-vous à la documentation officielle.

• Pour authentifier le registre Helm, reportez-vous à la documentation officielle. Vous pouvez également utiliser la commande suivante en remplaçant les exemples d'informations d'identification par vos informations d'identification de registre réelles:

  helm registry login my.registry.io:443 --username "admin" --password "secret"
  

Téléchargement du fichier as.tar.gz

Pour télécharger as.tar.gz, reportez-vous à Téléchargement des bundles d'installation.

Téléchargement des bundles Document Understanding facultatifs

Pour télécharger des bundles Document Understanding facultatifs, consultez la documentation Document Understanding.

Téléchargement de hydrate-registry.sh

Pour télécharger le script hydrate-registry.sh , reportez-vous à Téléchargement des packages d'installation.

Téléchargement des images Automation Suite dans le registre

Pour télécharger les images Automation Suite dans le registre, utilisez le script hydrate-registry.sh.

Le script hydrate-registry.sh ne nécessite pas de connectivité sortante, sauf avec les registres cibles.

Remarque :

Le script hydrate-registry.sh n'authentifie pas le registre. Il suppose que vous vous êtes déjà authentifié auprès du registre.

Le tableau suivant décrit les indicateurs disponibles pour le script hydrate-registry.sh .

Drapeau	Description
--offline-bundle-path	Obligatoire. Chemin d'accès au bundle hors ligne.
--target-registry-url	Obligatoire. Transmettez l'URL du registre cible.
--extract-path	Emplacement à utiliser pour décompresser le bundle hors ligne. Il peut s'agir d'un emplacement /var/lib/containers ou d'un emplacement personnalisé. Assurez-vous d'avoir un minimum de 100 Go de stockage. Il est recommandé d'avoir 256 Go de stockage.

Pour télécharger des images Automation Suite dans le registre :

1. Assurez-vous que nous disposons des autorisations nécessaires pour exécuter le script Shell, en exécutant la commande suivante :

   chmod +x hydrate-registry.sh
   

2. Chargez les images Automation Suite dans votre registre en exécutant la commande suivante :

   ./hydrate-registry.sh --target-registry-url my.registry.io:443 --offline-bundle-path ./as.tar.gz --extract-path /extract/to/path
   

Remarque :

Pour les registres tels que Harbor, qui nécessitent l'utilisation d'un projet, veillez à bien ajouter le nom du projet à l'URL du registre cible que vous incluez dans la commande, comme l'illustre l'exemple suivant :

./hydrate-registry.sh --target-registry-url my.registry.io:443/myproject --offline-bundle-path ./as.tar.gz --extract-path /extract/to/path

Pour les bundles Document Understanding hors ligne, assurez-vous d'inclure --extract-path dans la commande, comme indiqué dans l'exemple suivant :

./hydrate-registry.sh --target-registry-url my.registry.io:443 --optional-bundle-path ./dusemistructured-2023.10.0.tar.gz --extract-path /tmp

Configuration du certificat pour le registre externe compatible OCI

Pour configurer correctement votre registre externe compatible OCI, vous devez mettre à jour le magasin approuvé de toutes les machines sur lesquelles vous prévoyez d'installer Automation Suite. Pour obtenir des instructions sur la façon d'effectuer cette étape après l'installation, reportez-vous à la section Gestion des certificats.

Pour ce faire, procédez comme suit :

1. Ajoutez le fichier CA à l'emplacement /etc/pki/ca-trust/source/anchors/.

2. Exécutez update-ca-trust pour mettre à jour le magasin approuvé du système d'exploitation. Une fois le magasin d'approbations mis à jour, le fichier de certificat extrait est fusionné dans /etc/pki/ca-trust/extracted/ca-bundle.trust.crt.

   Remarque :

   Vous devez fournir le certificat CA lors de l’installation d’Automation Suite. Vous devez fournir le certificat dans le paramètre registry_ca_cert du fichier cluster_config.json. Pour plus de détails, consultez la section Configuration du registre externe compatible OCI.

Configuration du registre Docker temporaire

Remarque :

Cette étape est nécessaire uniquement pour les installations hors ligne qui utilisent un registre intégré au cluster. Vous pouvez ignorer cette étape si vous effectuez une installation hors ligne qui utilise un registre externe compatible OCI, ou une installation en ligne. Vous devez effectuer cette étape uniquement sur l'un des nœuds de serveur. Vous devez vous assurer que le nœud dispose d'une capacité supplémentaire de 512 Go pour pouvoir être utilisé comme backend pour le registre. Il est généralement recommandé qu'il se trouve sur le point de montage /uipath .

Le registre Docker temporaire n'est requis que lors de l'installation ou de la mise à niveau. Une fois l'installation ou la mise à niveau réussie, le registre temporaire n'est plus nécessaire et doit être désinstallé.

Prérequis pour la configuration du registre temporaire

Pour configurer le registre temporaire, vous avez besoin des éléments suivants :

• as-fs.tar.gz : pour le télécharger, reportez-vous à Téléchargement des packages d'installation.

Installation du registre temporaire

Pour installer le registre Docker temporaire sur l'un des nœuds, exécutez la commande suivante :

./bin/uipathctl registry install-temp-registry -i /opt/UiPathAutomationSuite/latest/installer/cluster_config.json

• -i, --input: Mandatory. Accepts the path to the cluster_config.json.

Par défaut, le registre temporaire est installé sur la machine sur le port 30070 et utilise le chemin d'accès au fichier /uipath/data/registry. Vous devez ouvrir le port 30070 sur l'équilibreur de charge et le nœud sur lequel vous installez le registre Docker temporaire.

Remarque :

Le pool principal de l’équilibreur de charge doit cibler exclusivement les nœuds hébergeant le registre docker temporaire.

Si vous souhaitez modifier le port de registre temporaire par défaut ainsi que le chemin d'accès au fichier, vous devez mettre à jour le fichier cluster_config.json comme indiqué dans l'exemple suivant :

{
  "infra": {
    "tmp_docker_registry": {
      "node_port": "<new port number>",
      "file_path": "/uipath/data/registry"
    }
  }
}

Hydratation du registre temporaire

L’installation de Podman est obligatoire avant d’hydrater le registre temporaire. Si vous avez déjà validé et installé les packages RPM requis, Podman est automatiquement installé. Sinon, il est essentiel d’installer manuellement Podman avant de procéder à la configuration du registre Docker temporaire pour les installations hors ligne.

Après avoir installé le registre temporaire, procédez comme suit :

1. Hydratez le registre temporaire avec les images de conteneur et les graphiques Helm en exécutant la commande suivante :

   ./bin/uipathctl registry hydrate-temp-registry --offline-bundle /uipath/as-fs.tar.gz -i /opt/UiPathAutomationSuite/latest/installer/cluster_config.json
   

2. Référencez le registre interne à partir du registre temporaire en exécutant la commande suivante. Si vous appliquez un correctif, suivez les étapes décrites dans la note ci-dessous.

   ./bin/uipathctl rke2 registry hydrate-registry /opt/UiPathAutomationSuite/latest/installer/cluster_config.json
   

   Remarque :

   Si vous rencontrez des problèmes de mémoire lors de l’exécution de la commande ci-dessus, utilisez l’option --serial pour éviter les problèmes de mémoire insuffisante:

   ./bin/uipathctl rke2 registry hydrate-registry /opt/UiPathAutomationSuite/latest/installer/cluster_config.json --serial
   

   Remarque :

   Si vous appliquez un correctif à une version existante d’Automation Suite, suivez plutôt les étapes ci-dessous. Cela ne s'applique pas à LTS ou CU.

   1. Téléchargez les fichiers docker-image.json et versions.json, puis procédez comme suit :

      1. Modifiez le répertoire pour pointer vers le dossier du programme d’installation :

      cd "${INSTALLER_PATH}"
      

      2. Créez une sauvegarde des fichiers docker-image.json et helm-charts.json :

      cp versions/docker-images.json versions/docker-images.json.bak
      cp versions/helm-charts.json versions/helm-charts.json.bak
      

      3. Copiez les fichiers docker-images.json et versions.json téléchargés dans le dossier du programme d’installation :

      cp <PATH_OF_PATCH_VERSION_docker-images.json> versions/docker-images.json
      cp <PATH_OF_PATCH_VERSION_versions.json> versions/helm-charts.json
      

   2. Référencez le registre interne à partir du registre temporaire en exécutant la commande suivante :

      ./bin/uipathctl rke2 registry hydrate-registry /opt/UiPathAutomationSuite/latest/installer/cluster_config.json
      

   3. Rétablissez les fichiers docker-image.json et helm-charts.json vers les fichiers d’origine :

      cp versions/docker-images.json.bak versions/docker-images.json
      cp versions/helm-charts.json.bak versions/helm-charts.json
      

3. Si vous utilisez des projets modernes Document Understanding, référencez le bundle dumodernexperience . Pour de plus amples informations, consultez la section Installation de bundles hors ligne.

• --offline-bundle: chemin d'accès au fichier contenant l'emplacement de as-fs.tar.gz sur votre nœud de serveur.
• -i, --input: Mandatory. Accepts the path to the cluster_config.json file.