手順 1: オフライン インストール用に OCI 準拠レジストリを設定する

オフライン インストールでは、コンテナー イメージとデプロイ Helm チャートを格納するために、OCI (Open Container Initiative) に準拠したレジストリが必要です。 オンライン インストールを実行する場合は、この手順をスキップしてください。

注:

独自のレジストリを利用することを強くお勧めします。使用可能なレジストリがない場合は、いずれかのサーバー・マシンに OCI 準拠のレジストリを一時的にインストールできます。

Automation Suite の成果物を外部 OCI 準拠レジストリにアップロードする

Automation Suite の成果物を外部 OCI 準拠レジストリにアップロードするには、次の 2 つの方法があります。

• オプション A: OCI 準拠のレジストリを UiPath® レジストリにミラーリングする
• オプション B: オフライン バンドルを使用して OCI 準拠のレジストリをハイドレートする

次の表では、成果物をレジストリにアップロードする 2 つのオプションを比較しています。ニーズに合うほうのオプションを選択してください。

オプション A: レジストリをミラーリングする	オプション B: レジストリをハイドレートする
成果物を UiPath® レジストリから任意のターゲット レジストリにコピーします。	オフラインの tarball を使用して成果物を解凍し、ターゲット レジストリにアップロードします。
Docker ツールと Helm ツールが必要です。	Podman ツールと Helm ツールが必要です。
UiPath® レジストリからターゲット レジストリに成果物をコピーするには、インターネットへのアクセスが必要です。	オフラインの tarball をジャンプ サーバーにダウンロードするためにのみインターネットへのアクセスが必要です。 tarball のアップロードには、インターネットへのアクセスは必要ありません。
コピー中にイメージをキャッシュするための一時的な領域が必要です。 この領域は通常、Docker のインストール中に構成されます。 既定の場所は /var/lib/docker です。	tarball を抽出するための一時的な領域と、Podman がイメージを読み込むための一時的な領域が必要です。 tarball の抽出場所は、ハイドレート手順中に指定する必要があります。 Podman の場所は /var/tmpにすることができ、ストレージに十分な空き容量が必要になります。
/var/lib/docker ディレクトリに必要なストレージ容量は約 128 GB です。	抽出に必要なストレージ容量は約 200 GB で、 /var/tmp は 256 GB である必要があります。

注: ミラーリングまたはハイドレート操作は、サーバー ノードを使用せずに管理マシンまたはジャンプ ボックスから実行することをお勧めします。

オプション A: UiPath® レジストリをレジストリにミラーリングする

この方法では、OCI 準拠のレジストリに Automation Suite のアーティファクトをアップロードするジャンプ マシンでインターネットにアクセスできる必要があります。

UiPath® レジストリをミラーリングするための前提条件

UiPath® レジストリをミラーリングするには、以下が必要です。

• Linux ディストリビューション (推奨) またはノート PC (非推奨) を実行する VM

• プライベート レジストリで認証された Docker クライアント

• プライベート レジストリで認証された 3.8 以降の Helm

• as-images.txt

• as-helm-charts.txt

• mirror-registry.sh

• registry.uipath.com へのアウトバウンド接続
• コンテナー イメージとグラフをアップロードするマシンの /var/lib/docker パーティション下に Docker 用の 128 GB の空きディスク領域

Docker と Helm をインストールする

Automation Suite のコンテナー イメージとグラフをレジストリにアップロードする予定のマシンに Docker と Helm がインストールされ、認証されている必要があります。

• Docker バイナリをダウンロードするには、公式ドキュメントをご覧ください。

• Docker レジストリに対する認証を行うには、公式ドキュメントをご覧ください。または、次のコマンドを使用して、資格情報のサンプルを実際のレジストリ資格情報に置き換えることもできます。

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

• Helm バイナリをダウンロードするには、公式ドキュメントをご覧ください。

• Helm レジストリに対する認証を行うには、公式ドキュメントをご覧ください。または、次のコマンドを使用して、資格情報のサンプルを実際のレジストリ資格情報に置き換えることもできます。

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

as-images.txt をダウンロードする

as-images.txt をダウンロードするには、「インストール バンドルをダウンロードする」をご覧ください。

as-helm-charts.txt をダウンロードする

as-helm-charts.txt をダウンロードするには、「インストール バンドルをダウンロードする」をご覧ください。

任意の Document Understanding バンドルをダウンロードする

任意の Document Understanding バンドルをダウンロードするには、Document Understanding のドキュメントをご覧ください。

mirror-registry.sh をダウンロードする

mirror-registry.sh スクリプトをダウンロードするには、「インストール パッケージをダウンロードする」をご覧ください。

Automation Suite イメージをレジストリにアップロードする

mirror-registry.sh スクリプトを使用するには、ソース (既定の registry.uipath.com) レジストリとターゲット レジストリへのアウトバウンド接続が必要です。

注:

mirror-registry.sh スクリプトは、レジストリに対する認証を実行しません。レジストリに対して既に認証済みであることを前提としています。

フラグ	Environment Variable (環境変数)	説明
--images-manifest	IMAGES_MANIFEST	必須です。イメージのマニフェスト ファイルへのパスです。
--helm-charts-manifest	HELM_CHARTS_MANIFEST	必須です。Helm グラフのマニフェスト ファイルへのパスです。
--target-registry-url	TARGET_REGISTRY_URL	必須です。ターゲット レジストリの URL を渡します。
--source-registry-url	SOURCE_REGISTRY_URL	随意。 ソース レジストリの URL を渡します。 既定値は registry.uipath.comです。

Automation Suite イメージをレジストリにアップロードするには以下を実行します。

1. 次のコマンドを実行して、シェル スクリプトを実行するために必要な権限があることを確認します。

   chmod +x mirror-registry.sh

2. 次のコマンドを実行して、Automation Suite イメージをレジストリにアップロードします。

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

   注: プロジェクトの使用が必要な Harbor などのレジストリの場合は、コマンドに含めるターゲット レジストリ URL にプロジェクト名を追加する必要があります。以下に例を示します。

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

オプション B: オフライン バンドルでレジストリをハイドレートする

この方法で必要なものは、ジャンプ マシンでオフライン バンドルをダウンロードするためのインターネット アクセスだけです。バンドルが使用可能になると、インターネットに接続せずに OCI 準拠のレジストリにアップロードできます。

注:

この方法では、tar を解凍してレジストリにアップロードするために、マシンに追加の空き領域が必要になる場合もあります。 さらに、この方法はミラーリング アプローチよりも時間がかかる場合があります。

レジストリをハイドレートするための前提条件

レジストリをハイドレートするには以下が必要です。

• スクリプトをノート PC で実行するより VM で Linux ディストリビューションを実行する方法が望ましい
• オフライン バンドルを VM にダウンロードしてコピーする、または何らかの方法で反映することができる
• プライベート レジストリで認証された 3.8 以降の Helm
• Podman がプライベート レジストリでインストール、構成、認証されている
• コンテナーをリモート レジストリにプッシュする前にローカルに読み込むため、 /var/lib/containers の下に Podman 用に 150 GB の空きディスク領域が必要です。 既定のパスを変更するには、 podman info コマンドの出力内の graphRoot パスの場所を更新します
• Podman の公式ドキュメントの説明に従って、TMP_DIR 環境変数を設定します
• as.tar.gz

Podman と Helm をインストールする

Automation Suite のコンテナー イメージとグラフをレジストリにアップロードする予定の元のマシンに、Podman と Helm がインストールされ、認証されていることを確認する必要があります。

• Podman バイナリをダウンロードするには、公式ドキュメントをご覧ください。
• Podman レジストリに対する認証を行うには、公式ドキュメントをご覧ください。または、次のコマンドを使用して、資格情報のサンプルを実際のレジストリ資格情報に置き換えることもできます。

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

• Helm バイナリをダウンロードするには、公式ドキュメントをご覧ください。
• Helm レジストリに対する認証を行うには、公式ドキュメントをご覧ください。または、次のコマンドを使用して、資格情報のサンプルを実際のレジストリ資格情報に置き換えることもできます。

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

as.tar.gz をダウンロードする

as.tar.gz をダウンロードするには、「インストール バンドルをダウンロードする」をご覧ください。

任意の Document Understanding バンドルをダウンロードする

任意の Document Understanding バンドルをダウンロードするには、Document Understanding のドキュメントをご覧ください。

hydrate-registry.sh をダウンロードする

hydrate-registry.sh スクリプトをダウンロードするには、「インストール パッケージをダウンロードする」をご覧ください。

Automation Suite イメージをレジストリにアップロードする

Automation Suite のイメージをレジストリにアップロードするには、hydrate-registry.sh スクリプトを使用します。

hydrate-registry.sh スクリプトは、ターゲット・レジストリー以外のアウトバウンド接続を必要としません。

注:

hydrate-registry.sh スクリプトは、レジストリに対する認証を実行しません。レジストリに対して既に認証済みであることを前提としています。

フラグ	説明
--offline-bundle-path	必須です。オフライン バンドルへのパスです。
--target-registry-url	必須です。ターゲット レジストリの URL を渡します。
--extract-path	オフライン バンドルを解凍するために使用する場所です。 /var/lib/containersまたはカスタムの場所を指定できます。100 GB 以上のストレージがあることを確認します。 ストレージは 256 GB をお勧めします。

Automation Suite イメージをレジストリにアップロードするには、以下の手順を実行します。

1. 次のコマンドを実行して、シェルスクリプトを実行するために必要な権限があることを確認します。

   chmod +x hydrate-registry.sh

2. 次のコマンドを実行して、Automation Suite のイメージをレジストリにアップロードします。

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

注: プロジェクトの使用が必要な Harbor などのレジストリの場合は、コマンドに含めるターゲット レジストリ URL にプロジェクト名を追加する必要があります。以下に例を示します。

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

対して Document Understanding オフライン バンドルには、必ず以下を含めてください --extract-path をコマンドで指定します (次を参照) 例：

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

外部 OCI 準拠レジストリの証明書を設定する

外部の OCI 準拠レジストリを適切に構成するには、Automation Suite をインストールする予定のすべてのマシンの信頼ストアを更新する必要があります。 インストール後にこの手順を実行する方法については、「 証明書を管理する」をご覧ください。

そのためには、以下の手順に従ってください。

1. CA ファイルを /etc/pki/ca-trust/source/anchors/ の場所に追加します。
2. update-ca-trust を実行して、オペレーティング システムの信頼ストアを更新します。信頼ストアが更新されると、抽出された証明書ファイルは /etc/pki/ca-trust/extracted/ca-bundle.trust.crt に結合されます。

注:

Automation Suite のインストール時に CA 証明書を指定する必要があります。証明書は、cluster_config.json ファイルの registry_ca_cert パラメーターで指定する必要があります。詳しくは、「外部の OCI 準拠レジストリの設定」を参照してください。