Konfigurieren der OCI-konformen Registrierung für Offline-Installationen

Bei Offline-Installationen benötigen Sie eine Registrierung, die mit OCI (Open Container Initiative) konform ist, um die Container-Images und Helm-Charts für die Bereitstellung zu speichern. Wenn Sie eine Online-Installation durchführen, überspringen Sie diesen Schritt.

Hinweis:

Sie müssen eine der folgenden Optionen auswählen, um die OCI-konforme Registrierung einzurichten:

• Empfohlen. Bringen Sie Ihre eigene Registrierung ein. Nähere Informationen finden Sie unter Hochladen der Automation Suite-Artefakte in die externe OCI-konforme Registrierung.

• Wenn Sie nicht über eine Registrierung verfügen, können Sie vorübergehend eine OCI-konforme Registrierung auf einer der Servermaschinen installieren. Nähere Informationen finden Sie unter Konfigurieren der temporären Docker-Registrierung auf dieser Seite.

Hochladen der Automation Suite-Artefakte in die externe OCI-konforme Registrierung

Es gibt zwei Möglichkeiten, die Automation Suite-Artefakte in die externe OCI-konforme Registrierung hochzuladen:

• Option A: Durch Spiegeln Ihrer OCI-konformen Registrierung mit der UiPath®-Registrierung;
• Option B: Durch Hydratisieren Ihrer OCI-konformen Registrierung mit dem Offlinepaket.

In der folgenden Tabelle werden die beiden Optionen zum Hochladen der Artefakte in die Registrierung verglichen, sodass Sie die geeignete Option auswählen können:

Option A: Spiegeln der Registrierung	Option B: Hydratisieren der Registrierung
Kopiert die Artefakte aus der UiPath®-Registrierung in eine beliebige Zielregistrierung.	Verwendet den Offline-Tarball, um die Artefakte zu entpacken und in die Zielregistrierung hochzuladen.
Erfordert Docker- und Helm-Tools.	Erfordert Podman- und Helm-Tools.
Requires internet access to copy the artifacts from the UiPath® registry to the target registry.	Erfordert Internetzugang nur, um den Offline-Tarball auf den Jump Server herunterzuladen. Das Hochladen des Tarballs erfordert keinen Internetzugang.
Erfordert einen temporären Speicherplatz zum Zwischenspeichern der Images während des Kopierens. Dieser Speicherplatz wird normalerweise während der Docker-Installation konfiguriert. Der standardmäßige Speicherort ist /var/lib/docker.	Erfordert einen temporären Speicherplatz zum Extrahieren des Tarballs und einen temporären Speicherplatz für Podman zum Laden der Images. The location of the tarball extraction must be provided during the hydration step. The Podman location can be /var/tmp, which must have adequate storage available.
The required storage capacity for the /var/lib/docker directory is around 128 GiB.	Die erforderliche Speicherkapazität für die Extraktion beträgt etwa 200 GiB, und /var/tmp erfordert 256 GiB.

Hinweis: Es wird empfohlen, den Spiegelungs- oder Hydratisierungsvorgang über die Verwaltungsmaschine oder Jump Box durchzuführen, anstatt die Serverknoten zu verwenden.

Option A: Spiegeln der UiPath®-Registrierung auf Ihre Registrierung

Diese Methode erfordert einen Internetzugang auf der Sprungmaschine, von der Sie die Artefakte der Automation Suite auf Ihre OCI-konforme Registrierung hochladen.

Voraussetzungen für die Spiegelung der UiPath®-Registrierung

Um die UiPath®-Registrierung zu spiegeln, benötigen Sie Folgendes:

• Eine VM mit einer Linux-Distribution (empfohlen) oder einen Laptop (nicht empfohlen);

• Einen Docker-Client, der mit der privaten Registrierung authentifiziert wurde;

• Helm 3.8 oder neuer, authentifiziert mit der privaten Registrierung;

• as-images.txt;
• as-helm-charts.txt;
• mirror-registry.sh;
• Ausgehende Konnektivität zu registry.uipath.com;
• 128 GiB freier Datenträgerspeicher für Docker unter der Partition /var/lib/docker auf der Maschine, von der Sie die Container-Images und Charts hochladen.

Installieren von Docker und Helm

Docker und Helm müssen auf der Maschine installiert und authentifiziert sein, von der Sie die Automation Suite Container-Images und -Charts in Ihre Registrierung hochladen möchten.

• Informationen zum Herunterladen der Docker-Binärdateien finden Sie in der offiziellen Dokumentation.

• Informationen zum Authentifizieren der Docker-Registrierung finden Sie in der offiziellen Dokumentation. Alternativ können Sie den folgenden Befehl verwenden, indem Sie die Beispielanmeldeinformationen durch Ihre tatsächlichen Registrierungsanmeldeinformationen ersetzen:

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

• Informationen zum Herunterladen der Helm-Binärdateien finden Sie in der offiziellen Dokumentation.

• Informationen zum Authentifizieren der Helm-Registrierung finden Sie in der offiziellen Dokumentation. Alternativ können Sie den folgenden Befehl verwenden, indem Sie die Beispielanmeldeinformationen durch Ihre tatsächlichen Registrierungsanmeldeinformationen ersetzen:

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

Herunterladen von as-images.txt

Informationen zum Herunterladen von as-images.txt finden Sie unter Herunterladen von Installationspaketen.

Herunterladen von as-helm-charts.txt

Informationen zum Herunterladen von as-helm-charts.txt finden Sie unter Herunterladen von Installationspaketen.

Herunterladen der optionalen Document Understanding-Pakete

Informationen zum Herunterladen der optionalen Document Understanding-Pakete finden Sie in der Document Understanding-Dokumentation.

Herunterladen von mirror-registry.sh

Informationen zum Herunterladen des Skripts mirror-registry.sh finden Sie unter Herunterladen der Installationspakete.

Hochladen der Automation Suite-Images in Ihre Registrierung

Das mirror-registry.sh-Skript erfordert ausgehende Konnektivität zu den Quell- (Standard: registry.uipath.com) und Ziel-Registern.

Hinweis:

Das Skript mirror-registry.sh führt keine Authentifizierung bei der Registrierung durch. Es wird davon ausgegangen, dass Sie sich bereits bei der Registrierung authentifiziert haben.

Markieren	Umgebungsvariable	Beschreibung
--images-manifest	IMAGES_MANIFEST	Obligatorisch. Der Pfad zur Image-Manifestdatei.
--helm-charts-manifest	HELM_CHARTS_MANIFEST	Obligatorisch. Pfad zur Helm-Chart-Manifestdatei.
--target-registry-url	TARGET_REGISTRY_URL	Obligatorisch. Übergeben Sie die URL für die Zielregistrierung.
--source-registry-url	SOURCE_REGISTRY_URL	Optional. Übergeben Sie die URL für die Quellregistrierung; der Standardwert ist registry.uipath.com.

So laden Sie die Automation Suite-Images in Ihre Registrierung hoch:

1. Ensure that you have the necessary permissions to execute the shell script, by running the following command:

   chmod +x mirror-registry.sh

2. Um die Automation Suite-Images in die Registrierung hochzuladen, führen Sie den folgenden Befehl aus:

   ./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

   Note: For registries, such as Harbor, which require using a project, make sure you append the project name to the target registry URL you include in the command, as shown in the following example:

   ./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: Hydratisieren der Registrierung mit dem Offlinepaket

Diese Methode erfordert nur einen Internetzugang auf der Sprungmaschine, um das Offline-Paket herunterzuladen. Sobald das Paket verfügbar ist, können Sie es ohne Internetverbindung in Ihre OCI-konforme Registrierung hochladen.

Hinweis:

This method may also require additional space on the machine to un-tar and upload to your registry. In addition, this method may take longer than the mirroring approach.

Voraussetzungen für die Hydratisierung der Registrierung

Um die Registrierung zu unterstützen, benötigen Sie Folgendes:

• Eine VM mit einer Linux-Distribution ist der Ausführung des Skripts auf einem Laptop vorzuziehen;
• Die Möglichkeit, das Offlinepaket herunterzuladen und zu kopieren oder anderweitig zur VM weiterzugeben;
• Helm 3.8 oder neuer, authentifiziert mit der privaten Registrierung;
• Podman installiert, konfiguriert und mit der privaten Registrierung authentifiziert;
• 150 GiB freier Datenträgerspeicher für Podman unter /var/lib/containers zum lokalen Laden der Container, bevor sie per Push in die Remote-Registrierung übertragen werden. Sie können den Standardpfad ändern, indem Sie den Ort des graphRoot-Pfads in der Ausgabe des Befehls podman info aktualisieren.
• Set the TMP_DIR environment variable as described in the official Podman documentation.
• as.tar.gz

Installieren von Podman und Helm

Sie müssen sicherstellen, dass Podman und Helm auf der Maschine installiert und authentifiziert sind, von der Sie die Automation Suite-Container-Images und -Charts in Ihre Registrierung hochladen möchten.

• Informationen zum Herunterladen der Podman-Binärdateien finden Sie in der offiziellen Dokumentation.
• Informationen zur Authentifizierung bei der Podman-Registrierung finden Sie in der offiziellen Dokumentation. Alternativ können Sie den folgenden Befehl verwenden, indem Sie die Beispielanmeldeinformationen durch Ihre tatsächlichen Registrierungsanmeldeinformationen ersetzen:

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

• Informationen zum Herunterladen der Helm-Binärdateien finden Sie in der offiziellen Dokumentation.
• Informationen zum Authentifizieren der Helm-Registrierung finden Sie in der offiziellen Dokumentation. Alternativ können Sie den folgenden Befehl verwenden, indem Sie die Beispielanmeldeinformationen durch Ihre tatsächlichen Registrierungsanmeldeinformationen ersetzen:

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

Herunterladen von as.tar.gz

Informationen zum Herunterladen von as.tar.gz finden Sie unter Herunterladen von Installationspaketen.

Herunterladen der optionalen Document Understanding-Pakete

Informationen zum Herunterladen optionaler Document Understanding-Pakete finden Sie in der Document Understanding-Dokumentation.

Herunterladen von hydrate-registry.sh

Informationen zum Herunterladen des Skripts hydrate-registry.sh finden Sie unter Herunterladen der Installationspakete.

Hochladen der Automation Suite-Images in die Registrierung

Um die Automation Suite-Images in die Registrierung hochzuladen, verwenden Sie das Skript hydrate-registry.sh.

Das Skript hydrate-registry.sh erfordert keine ausgehende Konnektivität außer zu den Zielregistern.

Hinweis:

Das Skript hydrate-registry.sh führt keine Authentifizierung bei der Registrierung durch. Es wird davon ausgegangen, dass Sie sich bereits bei der Registrierung authentifiziert haben.

Markieren	Beschreibung
--offline-bundle-path	Obligatorisch. Pfad zum Offlinepaket.
--target-registry-url	Obligatorisch. Übergeben Sie die URL für die Zielregistrierung.
--extract-path	Der Speicherort, der zum Entpacken des Offlinepakets verwendet werden soll. Er kann entweder /var/lib/containers oder ein benutzerdefinierter Speicherort sein. Stellen Sie sicher, dass Sie über mindestens 100 GiB Speicherplatz verfügen. Es werden 256 GiB Speicher empfohlen.

Zum Hochladen der Automation Suite-Images in die Registrierung:

1. Stellen Sie sicher, dass die erforderlichen Berechtigungen zum Ausführen des Shell-Skripts verfügbar sind, indem Sie den folgenden Befehl ausführen:

   chmod +x mirror-registry.sh

2. Upload the Automation Suite images to your registry by running the following command:

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

Hinweis: Bei Registrierungen wie Harbor, die die Verwendung eines Projekts erfordern, hängen Sie den Projektnamen an die URL der Zielregistrierung an, die Sie im Befehl angeben, wie im folgenden Beispiel gezeigt:

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

Konfigurieren des Zertifikats für die externe OCI-konforme Registrierung

To properly configure your external OCI-compliant registry, you must update the trust store of all the machines on which you plan to install Automation Suite. For instructions on how to perform this step post-installation, see Managing certificates.

Führen Sie dazu die folgenden Schritte aus:

1. Fügen Sie die Zertifizierungsstellendatei unter /etc/pki/ca-trust/source/anchors/ hinzu.
2. Führen Sie update-ca-trust aus, um den Vertrauensspeicher des Betriebssystems zu aktualisieren. Sobald der Vertrauensspeicher aktualisiert wurde, wird die extrahierte Zertifikatsdatei in /etc/pki/ca-trust/extracted/ca-bundle.trust.crt zusammengeführt.

Hinweis:

Sie müssen das Zertifikat der Zertifizierungsstelle bei der Installation der Automation Suite angeben. Sie müssen das Zertifikat im Parameter registry_ca_cert in der Datei cluster_config.json angeben. Weitere Informationen finden Sie unter Konfiguration der externen OCI-konformen Registrierung.

Konfigurieren der temporären Docker-Registrierung

Hinweis:

Dieser Schritt ist nur für Offline-Installationen erforderlich, die eine Registrierung im Cluster verwenden. Sie können diesen Schritt überspringen, wenn Sie eine Offline-Installation, die eine externe OCI-konforme Registrierung verwendet, oder eine Online-Installation durchführen.

Dieser Schritt muss nur auf einem der Serverknoten durchgeführt werden. Sie müssen sicherstellen, dass der Knoten über eine zusätzliche Kapazität von 512 GiB verfügt, um als Backend für die Registrierung verwendet zu werden. Dies wird in der Regel auf dem Mount-Punkt /uipath empfohlen.

Die temporäre Docker-Registrierung wird nur während der Installation oder dem Upgrade benötigt. Sobald die Installation oder das Upgrade erfolgreich ist, wird die temporäre Registrierung nicht mehr benötigt und sollte deinstalliert werden.

Voraussetzungen zum Festlegen der temporären Registrierung

Zum Einrichten der temporären Registrierung benötigen Sie Folgendes:

• as-fs.tar.gz – Informationen zum Herunterladen finden Sie unter Herunterladen der Installationspakete.

Installieren der temporären Registrierung

Um die temporäre Docker-Registrierung auf einem der Knoten zu installieren, führen Sie den folgenden Befehl aus:

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

Markieren	Beschreibung
-i|--input	Optional. Akzeptiert den Pfad zur cluster_config.json. Es ist nur erforderlich, wenn Standardregistrierungsport und Dateipfad geändert werden.

Standardmäßig wird die temporäre Registrierung auf der Maschine auf Port 30070 installiert und verwendet den Dateipfad /uipath/data/registry. Sie müssen Port 30070 auf dem Lastausgleich und dem Knoten öffnen, auf dem Sie die temporäre Docker-Registrierung installieren.

Hinweis:

Der Backend-Pool des Lastenausgleichs darf ausschließlich auf die Knoten abzielen, die die temporäre Docker-Registrierung hosten.

Wenn Sie den standardmäßigen temporären Registrierungsport und Dateipfad ändern möchten, müssen Sie die Datei cluster_config.json wie im folgenden Beispiel aktualisieren:

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

Hydrierung der temporären Registrierung

Die Installation von Podman ist vor der Hydratisierung der temporären Registrierung obligatorisch. Wenn Sie die erforderlichen RPM-Pakete bereits validiert und installiert haben, wird Podman automatisch installiert. Andernfalls muss Podman unbedingt manuell installiert werden, bevor Sie mit der Konfiguration der temporären Docker-Registrierung für Offlineinstallationen fortfahren.

Führen Sie nach dem Installieren der temporären Registrierung die folgenden Schritte aus:

1. Hydratisieren Sie die temporäre Registrierung mit den Container-Images und Helm-Charts, indem Sie den folgenden Befehl ausführen:

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

2. Legen Sie die interne Registrierung über die temporäre Registrierung an, indem Sie den folgenden Befehl ausführen. Wenn Sie einen Patch anwenden, führen Sie die im folgenden Hinweis beschriebenen Schritte aus.

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

   Hinweis:

   If you apply a patch to an existing Automation Suite version, take the following steps instead. This is not applicable for LTS or CU.

   For more details on how to apply an Automation Suite hotfix, see Applying a patch.

   1. Laden Sie die Dateien docker-image.json und versions.json herunter und führen Sie dann die folgenden Schritte aus:

      1. Wechseln Sie das Verzeichnis in den Installationsordner:

         cd "${INSTALLER_PATH}"

      2. Erstellen Sie eine Sicherung der Dateien docker-image.json und helm-charts.json:

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

      3. Kopieren Sie die heruntergeladenen Dateien docker-images.json und versions.json in den Installationsordner:

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

   2. Legen Sie die interne Registrierung über die temporäre Registrierung an, indem Sie den folgenden Befehl ausführen:

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

   3. Setzen Sie docker-image.json und helm-charts.json auf die ursprünglichen Dateien zurück:

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

Markieren	Beschreibung
--offline-bundle	Dateipfad, der den Speicherort von as-fs.tar.gz auf Ihrem Serverknoten enthält.
-i|--input	Optional. Akzeptiert den Pfad zur cluster_config.json-Datei. Dies ist nur erforderlich, wenn der standardmäßige Docker-Registrierungsport und der Dateipfad geändert werden.