- 概述
- 要求
- 安装
- 先决条件检查
- 配置符合 OCI 的注册表
- 输出示例:先决条件检查
- 输出示例:Automation Suite 安装
- 下载安装包
- uipathctl cluster
- uipathctl 集群维护
- 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 集群升级
- uipathctl 配置
- uipathctl config add-host-admin
- uipathctl config additional-ca-certificates
- uipathctl config additional-ca-certificates get
- uipathctl config additional-ca-certificates update
- uipathctl 配置警示
- uipathctl configalerts 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 运行状况
- uipathctl 运行状况捆绑包
- uipathctl 运行状况检查
- uipathctl health diagnose
- uipathctl health test
- uipathctl 清单
- 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 先决条件
- uipathctl prereq create
- uipathctl prereq run
- uipathctl 资源
- uipathctl 资源报告
- uipathctl 快照
- uipathctl 快照备份
- 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 版本
- 安装后
- 迁移和升级
- 监控和警示
- 集群管理
- 特定于产品的配置
- 故障排除
配置符合 OCI 的注册表
在离线安装中,您需要一个符合 OCI(开放容器计划)的注册表来存储容器映像和部署 Helm 图表。
有两种方法可以将 Automation Suite 工件上传到外部符合 OCI 的注册表:
- 选项 A:通过使用 UiPath™ 注册表镜像符合 OCI 的注册表;
- 选项 B:通过使用离线捆绑包结合符合 OCI 的注册表。
下表比较了将工件上传到注册表的两个选项,以便您可以选择适合您需求的选项:
选项 A:镜像注册表 |
选项 B:结合使用注册表 |
---|---|
将工件从 UiPath™ 注册表复制到任何目标注册表。 |
使用离线 tarball 包解压缩工件并将其上传到目标注册表。 |
需要 Docker 和 Helm 工具。 |
需要 Podman 和 Helm 工具。 |
Requires internet access to copy the artifacts from the UiPath® registry to the target registry. |
只需访问互联网即可将离线 tarball 下载到跳转服务器。上传 tarball 不需要访问互联网。 |
在复制方法期间需要临时空间来缓存图像。此空间通常在 Docker 安装期间配置。默认位置为
/var/lib/docker 。
|
需要临时空间以提取 tarball,也需要临时空间以供 Podman 加载图像。 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.
|
提取所需的存储容量约为 200 GiB,
/var/tmp 必须为 256 GiB。
|
此方法需要跳转机能够访问互联网,您可以使用该跳转机将 Automation Suite 工件上传到符合 OCI 的注册表中。
镜像 UiPath™ 注册表的先决条件
要镜像 UiPath™ 注册表,您需要执行以下操作:
-
运行 Linux 发行版的虚拟机(推荐)或笔记本电脑(不推荐);
-
使用私有注册表进行身份验证的 Docker 客户端;
-
Helm 3.8 或更高版本通过私有注册表进行身份验证;
-
as-images.txt
; -
as-helm-charts.txt
; -
mirror-registry.sh
; -
到
registry.uipath.com
的出站连接; -
在上传容器映像和图表的计算机上,
/var/lib/docker
分区下有 128 GiB 可用磁盘空间用于 Docker。
安装 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
脚本不会对注册表执行身份验证。假定您已通过注册表的身份验证。
标记 |
环境变量 |
描述 |
---|---|---|
|
|
必填项。映像清单文件的路径。 |
|
|
必填项。Helm 图表清单文件的路径。 |
|
|
必填。传递目标注册表的 URL。 |
|
|
可选。传递源注册表的 URL;默认值为
registry.uipath.com 。
|
-
Ensure that you have the necessary permissions to execute the shell script, by running the following command:
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.txtNote: 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
./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
此方法仅需要跳转计算机能够访问互联网,即可下载离线捆绑包。捆绑包可用后,您可以在未连接互联网的情况下将其上传到符合 OCI 的注册表。
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.
结合使用注册表的先决条件
要结合使用注册表,您需要以下内容:
- 与在笔记本电脑上运行脚本相比,推荐使用运行 Linux 发行版的虚拟机;
- 能够下载并复制离线捆绑包或以某种方式将离线捆绑包传播到虚拟机;
- Helm 3.8 或更高版本通过私有注册表进行身份验证;
- 安装、配置 Podman 并使用私有注册表进行身份验证;
/var/lib/containers
下的 Podman 需要 150 GiB 的可用磁盘空间,用于在将容器推送到远程注册表之前在本地加载容器。您可以通过在podman info
命令的输出中更新图形根路径的位置来更改默认路径。- Set the
TMP_DIR
environment variable as described in the official Podman documentation. 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 文档。
下载 validate-registry.sh
hydrate-registry.sh
脚本,请参阅下载安装包。
将 Automation Suite 映像上传到注册表
hydrate-registry.sh
脚本。
hydrate-registry.sh
脚本不需要出站连接,目标注册表除外。
hydrate-registry.sh
脚本不会对注册表执行身份验证。假定您已通过注册表的身份验证。
标记 |
描述 |
---|---|
|
必填。离线捆绑包的路径。 |
|
必填。传递目标注册表的 URL。 |
|
用于解压缩离线捆绑包的位置。该位置可以是
/var/lib/containers 或自定义位置。确保您至少具有 100 GiB 的存储空间。建议使用 256 GiB 的存储空间。
|
-
通过运行以下命令,确保我们具有执行 Shell 脚本的必要权限:
chmod +x mirror-registry.sh
chmod +x mirror-registry.sh -
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 /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
./hydrate-registry.sh --target-registry-url my.registry.io:443/myproject --offline-bundle-path /path/to/as-cmk.tar.gz
./hydrate-registry.sh --target-registry-url my.registry.io:443/myproject --offline-bundle-path /path/to/as-cmk.tar.gz