Configuration du registre compatible OCI pour les installations hors ligne

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.

Remarque :

Nous vous recommandons fortement d'apporter votre propre registre. Si vous n'en avez pas de disponible, vous pouvez installer temporairement un registre compatible OCI sur l'une des machines serveur.

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: By mirroring your OCI-compliant registry with the UiPath® registry;
• 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
Copies the artifacts from the UiPath® registry to any target registry.	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.
Requires internet access while copying the artifacts from the UiPath® registry to the target registry.	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 Podman afin de charger les images. L'emplacement d'extraction de 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 /var/lib/docker est d’environ 128 Go.	La capacité de stockage requise pour l'extraction est d'environ 200 Gio, et /var/tmp doit être de 256 Gio.

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 Jump box, au lieu d'utiliser les nœuds de serveur.

Option A: Mirroring the UiPath® registry to your registry

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.

Prerequisites for mirroring the UiPath® registry

To mirror the UiPath® registry, you need the following:

• 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, consultez 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, consultez la documentation officielle.

• Pour authentifier le registre Helm, 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 :

  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, voir Téléchargement des bundles d'installation.

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

Pour télécharger as-helm-charts.txt, voir 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, consultez la section 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.

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 nous disposons des autorisations nécessaires pour exécuter le script Shell, en exécutant la commande suivante :

   chmod +x mirror-registry.sh

2. Pour télécharger les images Automation Suite dans votre registre, exécutez 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

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. Quoi qu'il en soit, 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 manière ou d'une autre manière le bundle hors ligne vers 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 Gio d'espace disque libre pour Podman sous /var/lib/containers pour charger les conteneurs localement avant de les transmettre au registre distant. Vous pouvez modifier le chemin par défaut en mettant à jour l'emplacement du chemin graphRoot dans la sortie de la commande podman-info.
• Définissez la variable d'environnement TMP_DIR comme décrit dans la documentation officielle de Podman.
• 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, consultez la documentation officielle.
• Pour authentifier le registre Helm, 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 :

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

Téléchargement de as.tar.gz

Pour télécharger as.tar.gz, voir 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, consultez la section 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.

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 Gio de stockage. Il est recommandé d'avoir 256 Gio de stockage.

Pour télécharger les images Automation Suite dans le registre, exécutez la commande suivante :

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

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, consultez 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 registry_ca_cert paramètre cluster_config.json . Pour plus de détails, consultez la section Configuration du registre compatible OCI externe.

Configuration du registre Docker temporaire

Remarque :

Cette étape est nécessaire uniquement pour les installations hors ligne qui utilisent un registre de 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, consultez la section 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 :

./configureUiPathAS.sh registry install-temp-registry -i cluster_config.json

Drapeau	Description
-i|--input	Facultatif. Accepte le chemin d'accès au fichier cluster_config.json. Il n'est requis que lors de la modification du port de registre par défaut et du chemin d'accès au fichier.

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

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 :

   ./configureUiPathAS.sh registry hydrate-temp-registry --offline-bundle /uipath/tmp/as-fs.tar.gz -i cluster_config.json

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

   ./configureUiPathAS.sh registry seed-internal-registry -i cluster_config.json

Drapeau	Description
--offline-bundle	Chemin d'accès au fichier contenant l'emplacement de as-fs.tar.gz sur votre nœud de serveur.
-i|--input	Facultatif. Accepte le chemin d'accès au fichier cluster_config.json. Il n'est requis que lors de la modification du port du registre Docker et du chemin d'accès par défaut.