- 概要
- 要件
- インストール
- 前提条件の確認
- OCI 準拠のレジストリを設定する
- 出力例: 前提条件の確認
- 出力例: Automation Suite のインストール
- インストール パッケージをダウンロードする
- uipathctl cluster
- uipathctl cluster maintenance
- uipathctl cluster maintenance disable
- uipathctl cluster maintenance enable
- uipathctl cluster maintenance is-enabled
- uipathctl cluster migration
- uipathctl cluster migration export
- uipathctl cluster migration import
- uipathctl cluster migration run
- uipathctl cluster upgrade
- uipathctl config
- uipathctl config add-host-admin
- uipathctl config additional-ca-certificates
- uipathctl config additional-ca-certificates get
- uipathctl config additional-ca-certificates update
- uipathctl config alerts
- uipathctl config alerts add-email
- uipathctl config alerts remove-email
- uipathctl config alerts update-email
- uipathctl config argocd
- uipathctl config argocd ca-certificates
- uipathctl config argocd ca-certificates get
- uipathctl config argocd ca-certificates update
- uipathctl config argocd generate-dex-config
- uipathctl config argocd generate-rbac
- uipathctl config argocd registry
- uipathctl config argocd registry get
- uipathctl config argocd registry update
- uipathctl config enable-basic-auth
- uipathctl config orchestrator
- uipathctl config orchestrator get-config
- uipathctl config orchestrator update-config
- uipathctl config saml-certificates get
- uipathctl config saml-certificates rotate
- uipathctl config saml-certificates update
- uipathctl config tls-certificates
- uipathctl config tls-certificates get
- uipathctl config tls-certificates update
- uipathctl config token-signing-certificates
- uipathctl config token-signing-certificates get
- uipathctl config token-signing-certificates rotate
- uipathctl config token-signing-certificates update
- uipathctl health
- uipathctl health bundle
- uipathctl health check
- uipathctl health diagnose
- uipathctl health test
- uipathctl manifest
- uipathctl manifest apply
- uipathctl manifest diff
- uipathctl manifest get
- uipathctl manifest get-revision
- uipathctl manifest list-applications
- uipathctl manifest list-revisions
- uipathctl manifest render
- uipathctl prereq
- uipathctl prereq create
- uipathctl prereq run
- uipathctl resource
- uipathctl resource report
- uipathctl snapshot
- uipathctl snapshot backup
- uipathctl snapshot backup create
- uipathctl snapshot backup disable
- uipathctl snapshot backup enable
- uipathctl snapshot delete
- uipathctl snapshot list
- uipathctl snapshot restore
- uipathctl snapshot restore create
- uipathctl snapshot restore delete
- uipathctl snapshot restore history
- uipathctl snapshot restore logs
- uipathctl version
- インストール後
- 移行とアップグレード
- 監視とアラート機能
- クラスターの管理
- 製品固有の設定
- トラブルシューティング
OCI 準拠のレジストリを設定する
オフライン インストールでは、コンテナー イメージとデプロイ Helm グラフを格納するために、OCI (Open Container Initiative) に準拠したレジストリが必要です。
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 GiB です
|
抽出に必要なストレージ容量は約 200 GiB で、
/var/tmp には 256 GiB が必要です。
|
この方法では、OCI 準拠のレジストリに Automation Suite のアーティファクトをアップロードするジャンプ マシンでインターネットにアクセスできる必要があります。
UiPath® レジストリをミラーリングするための前提条件
UiPath® レジストリをミラーリングするには、以下が必要です。
-
Linux ディストリビューションを実行している VM (推奨) またはノート PC (非推奨)
-
プライベート レジストリで認証された Docker クライアント
-
プライベート レジストリで認証された 3.8 以降の Helm。
-
as-images.txt
; -
as-helm-charts.txt
; -
mirror-registry.sh
; -
registry.uipath.com
へのアウトバウンド接続。 -
コンテナー イメージとグラフをアップロードするマシンの
/var/lib/docker
パーティション下に Docker 用の 128 GiB の空きディスク領域。
Docker と Helm をインストールする
Automation Suite のコンテナー イメージとグラフをレジストリにアップロードする予定のマシンに Docker と Helm がインストールされ、認証されている必要があります。
-
Docker バイナリをダウンロードするには、公式ドキュメントをご覧ください。
-
Docker レジストリに対する認証を行うには、公式ドキュメントをご覧ください。または、次のコマンドを使用して、資格情報のサンプルを実際のレジストリ資格情報に置き換えることもできます。
docker login my.registry.io:443 --username "admin" --password "secret"
docker login my.registry.io:443 --username "admin" --password "secret" -
Helm バイナリをダウンロードするには、公式ドキュメントをご覧ください。
-
Helm レジストリに対する認証を行うには、公式ドキュメントをご覧ください。または、次のコマンドを使用して、資格情報のサンプルを実際のレジストリ資格情報に置き換えることもできます。
helm registry login my.registry.io:443 --username "admin" --password "secret"
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 (環境変数) |
説明 |
---|---|---|
|
|
必須です。イメージのマニフェスト ファイルへのパスです。 |
|
|
必須です。Helm グラフのマニフェスト ファイルへのパスです。 |
|
|
必須です。ターゲット レジストリの URL を渡します。 |
|
|
任意です。ソース レジストリの URL を渡します。既定値は
registry.uipath.com です。
|
-
次のコマンドを実行して、シェルスクリプトを実行するために必要な権限があることを確認します。
chmod +x mirror-registry.sh
chmod +x mirror-registry.sh -
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
./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
この方法で必要なものは、ジャンプ マシンでオフライン バンドルをダウンロードするためのインターネット アクセスだけです。バンドルが使用可能になると、インターネットに接続せずに OCI 準拠のレジストリにアップロードできます。
この方法では、tar を解凍してレジストリにアップロードするために、マシンに追加の空き領域が必要になる場合もあります。それ以外にも、この方法はミラーリング アプローチよりも時間がかかる場合があります。
レジストリをハイドレートするための前提条件
レジストリをハイドレートするには以下が必要です。
- スクリプトをノート PC で実行するより VM で Linux ディストリビューションを実行する方法が望ましい
- オフライン バンドルを VM にダウンロードしてコピーする、または何らかの方法で反映することができる
- プライベート レジストリで認証された 3.8 以降の Helm。
- Podman がプライベート レジストリでインストール、構成、認証されている
- コンテナーをリモート レジストリにプッシュする前にローカルに読み込むため、
/var/lib/containers
の下に Podman 用に 150 GiB の空きディスク領域が必要です。既定のパスを変更するには、podman-info
コマンドの出力内の graphRoot パスの場所を更新します。 - Podman の公式ドキュメントの説明に従って、
TMP_DIR
環境変数を設定します。 as-cmk.tar.gz
Podman と Helm をインストールする
Automation Suite のコンテナー イメージとグラフをレジストリにアップロードする予定の元のマシンに、Podman と Helm がインストールされ、認証されていることを確認する必要があります。
- Podman バイナリをダウンロードするには、公式ドキュメントをご覧ください。
- Podman レジストリに対する認証を行うには、公式ドキュメントをご覧ください。または、次のコマンドを使用して、資格情報のサンプルを実際のレジストリ資格情報に置き換えることもできます。
podman login my.registry.io:443 --username "admin" --password "secret"
podman login my.registry.io:443 --username "admin" --password "secret" - Helm バイナリをダウンロードするには、公式ドキュメントをご覧ください。
- Helm レジストリに対する認証を行うには、公式ドキュメントをご覧ください。または、次のコマンドを使用して、資格情報のサンプルを実際のレジストリ資格情報に置き換えることもできます。
helm registry login my.registry.io:443 --username "admin" --password "secret"
helm registry login my.registry.io:443 --username "admin" --password "secret"
as-cmk.tar.gz をダウンロードする
as-cmk.tar.gz
をダウンロードするには、「インストール バンドルをダウンロードする」をご覧ください。
任意の Document Understanding バンドルをダウンロードする
任意の Document Understanding バンドルをダウンロードするには、Document Understanding のドキュメントをご覧ください。
hydrate-registry.sh をダウンロードする
hydrate-registry.sh
スクリプトをダウンロードするには、「インストール パッケージをダウンロードする」をご覧ください。
Automation Suite イメージをレジストリにアップロードする
hydrate-registry.sh
スクリプトを使用します。
hydrate-registry.sh
スクリプトは、ターゲット・レジストリー以外のアウトバウンド接続を必要としません。
hydrate-registry.sh
スクリプトは、レジストリに対する認証を実行しません。レジストリに対して既に認証済みであることを前提としています。
フラグ |
説明 |
---|---|
|
必須です。オフライン バンドルへのパスです。 |
|
必須です。ターゲット レジストリの URL を渡します。 |
|
オフライン バンドルを解凍するために使用する場所です。
/var/lib/containers またはカスタムの場所を指定できます。100 GiB 以上のストレージがあることを確認します。 ストレージは 256 GiB をお勧めします。
|
./hydrate-registry.sh --target-registry-url my.registry.io:443 --offline-bundle-path /path/to/as-cmk.tar.gz
./hydrate-registry.sh --target-registry-url my.registry.io:443 --offline-bundle-path /path/to/as-cmk.tar.gz
外部 OCI 準拠のレジストリを適切に構成するには、Automation Suite をインストールする予定のすべてのマシンの信頼ストアを更新する必要があります。 インストール後にこの手順を実行する方法については、「証明書を管理する」をご覧ください。