orchestrator
2023.10
false
- 入门指南
- 要求
- 最佳实践
- 安装
- 正在更新
- 身份服务器
- 对启动错误进行故障排除
重要 :
新发布内容的本地化可能需要 1-2 周的时间才能完成。
Orchestrator 安装指南
概述
Azure 安装脚本使您能够在一个或多个节点上安装 Orchestrator。
重要提示:
- 在下面列出的安装过程中,必须执行所有步骤。如果不安装身份服务器,Orchestrator 将不起作用。
- 在开始安装 Orchestrator 之前,请确保证书由 Azure 信任的证书颁发机构颁发,例如 DigiCert。
- 不支持 Azure Stack,因为可能会发生 API 不兼容的情况。请使用 Azure Cloud 进行部署。
单节点安装
要在 Azure 应用程序服务上安装 Orchestrator,请执行以下步骤:
Orchestrator 步骤
- 在 Azure 门户的“应用程序服务”下,使用自定义名称(例如
UiPathOrchestrator)创建新的应用程序服务。创建网页应用程序时,请确保选择堆栈.NET 8 (LTS)。有关详细信息,请参阅 Microsoft 官方文档。 - 在 Azure 门户中打开新创建的网页应用程序,然后在“配置”选项卡上选择“常规设置”,并更改以下配置:
- 将平台设置为“64 位”。
- 将 WebSockets 设置为“启用”。
- 将“FTP 状态”设置为“全部允许”。
- 在网页应用程序的“配置” > “应用程序设置” > “连接字符串”中,设置数据库连接字符串,名称为
Default。例如Server=13.13.13.13;Initial Catalog=UiPath;Persist Security Info=False;User ID=dbUser;Password=pass123; MultipleActiveResultSets=False;Encrypt=True; Connection Timeout=30;TrustServerCertificate=True。重要提示:- 此处提供的 Azure Server 用户必须拥有服务器级别的访问权限,数据库级别的访问权限不足以执行成功安装。
- 确保将数据库连接字符串中的
TrustServerCertificate属性设为True。 - 确保选择
SQL Azure作为数据库连接字符串的类型。 - 要为测试自动化模块设置数据库连接字符串,请遵循 Publish-Orchestrator.ps1 参数中适用于
-testAutomationFeatureEnabled参数的说明步骤。 - 要为更新服务器模块设置数据库连接字符串,请遵循 Publish-Orchestrator.ps1 参数中适用于
-updateServerFeatureEnabled参数的说明步骤。
- 我们的脚本支持以下两种 Azure PowerShell 身份验证机制:
- 通过您自己的用户身份 - 使用 Azure PowerShell 登录 时,请使用 -noAzureAuthentication 参数。
- 通过服务主体 - 创建可以访问 Orchestrator 应用程序服务和资源组的 Azure AD 应用程序和服务主体。或者,请让友好的 DevOps 团队为您提供 Azure 服务主体 ID 和密码,该 ID 和密码可以访问应用程序服务和相关资源组。
身份服务器步骤
- 在 Azure 门户的“应用程序服务”下,使用自定义名称(例如
UiPathIdentity)创建新的应用程序服务。创建网页应用程序时,请确保选择堆栈.NET 8 (LTS)。有关详细信息,请参阅 Microsoft 官方文档。 - 在网页应用程序的“配置”>“连接字符串”中设置数据库连接字符串,名称为
DefaultConnection。例如Server=13.13.13.13;Initial Catalog=UiPath;Persist Security Info=False;User ID=dbUser;Password=pass123; MultipleActiveResultSets=False;Encrypt=True; Connection Timeout=30;TrustServerCertificate=True。重要提示:确保将数据库连接字符串中的
TrustServerCertificate属性设为True。 - 导航到“设置”>“配置”> “常规设置”选项卡,然后进行以下配置更改:
- 将平台设置为“64 位”。
- 将“FTP 状态”设置为“全部允许”。
- 我们的脚本支持以下两种 Azure PowerShell 身份验证机制:
- 通过您自己的用户身份 - 使用 Azure PowerShell 登录 时,请使用 -noAzureAuthentication 参数。
- 创建可以访问身份应用程序服务和资源组的 Azure AD 应用程序和服务主体。或者,请让友好的 DevOps 团队为您提供 Azure 服务主体 ID 和密码,该 ID 和密码可以访问应用程序服务和相关资源组。
Webhook 步骤
- 从 Azure 门户中,创建一个包含自定义名称的新网页应用程序,例如:
UiPathWebhookService. - 在“发布”字段中,选择“代码”。
- 对于运行时堆栈,请选择.NET Core 8 (LTS) 。
- 打开新的网页应用程序并导航到“设置”>“配置”>“常规设置”,然后进行以下配置更改:
- 将平台设置为“64 位”。
- 将“FTP 状态”设置为“全部允许”。
- 选择“保存”。
重要提示:
如果您以前没有通过 Azure 上的 Orchestrator 安装创建 Azure AD 应用程序和服务主体,请立即创建它们。您必须配置它们才能访问您的
UiPathWebhookService和资源组。
资源目录步骤
- 在 Azure 门户的“应用程序服务”下,使用自定义名称(例如
UiPathResourceCatalogService)创建新的应用程序服务。创建网页应用程序时,请确保选择堆栈.NET 8 (LTS)。有关详细信息,请参阅 Microsoft 官方文档。 - 导航到“设置”>“配置”> “常规设置”选项卡,然后进行以下配置更改:
- 将平台设置为“64 位”。
- 将“FTP 状态”设置为“全部允许”。
- 在网页应用程序的“配置”>“连接字符串”中设置数据库连接字符串,名称为
DefaultConnection。例如Server=13.13.13.13;Initial Catalog=UiPath;Persist Security Info=False;User ID=dbUser;Password=pass123; MultipleActiveResultSets=False;Encrypt=True; Connection Timeout=30;TrustServerCertificate=True。 - 我们的脚本支持以下两种 Azure PowerShell 身份验证机制:
- 通过您自己的用户身份 - 使用 Azure PowerShell 登录 时,请使用 -noAzureAuthentication 参数。
- 通过服务主体 - 创建可以访问资源目录应用程序服务和资源组的 Azure AD 应用程序和服务主体。或者,请让友好的 DevOps 团队为您提供 Azure 服务主体 ID 和密码,该 ID 和密码可以访问应用程序服务和相关资源组。
常规步骤
- 将
UiPathOrchestrator.zip存档下载到本地计算机。其中包含安装 Orchestrator、身份服务器、资源目录和 Webhook 服务所需的所有脚本。UiPath 可应要求提供UiPathOrchestrator.zip存档。请与我们联系以获取详细信息。 - 将
UiPathOrchestrator.zip文件的内容提取到计算机上的文件夹中。这将显示UiPath.Orchestrator.Web.zip文件。备注:- 以下步骤需要运行 PowerShell 脚本。要禁用任何中断这些任务的提示,请在上一步选择的目录中运行
Get-ChildItem *.ps1 -Recurse | Unblock-File命令。 - 解压缩
UiPathOrchestrator.zip存档以提取UiPath.Orchestrator.Web.zip存档。
- 以下步骤需要运行 PowerShell 脚本。要禁用任何中断这些任务的提示,请在上一步选择的目录中运行
- 使用此处描述的参数,在 PowerShell 中运行
Publish-Orchestrator.ps1脚本。重要提示:- 在运行
Publish-Orchestrator.ps1脚本之前,请确保卸载 AzureRM PowerShell 模块。我们建议使用 Az PowerShell 模块作为替代方案。不支持同时安装 AzureRM 和 Az 模块。 - 如果未检测到所需的 Az 版本,并且在运行脚本时存在 AzureRM,则即使在无人值守的安装上,系统也会提示您确认是否删除 AzureRM。
- 如果在使用任何先前版本的模块时升级到 Az v6.0.0,则系统会弹出以下消息:
WARNING: The version 'x.x.x' of module 'Az.<Name>' is currently in use. Retry the operation after closing the applications.。为了解决此问题,请确保在新的 PowerShell 会话中执行Publish-Orchestrator.ps1。 - 如果您使用的是 Microsoft 托管的代理,则
Publish-Orchestrator.ps1问题将导致无法运行正确的 Az 版本。您将继续使用版本 4.7.0,而不是版本 5.4.0 或 6.0.0。要解决此问题,请确保删除C:\Modules\az_4.7.0文件夹。
- 在运行
- 使用此处描述的参数,在 PowerShell 中运行
Publish-IdentityServer.ps1脚本。重要提示:确保执行发布到 Identity Server 页面中所述的步骤以完成上述过程。
- 使用此处描述的参数,在 PowerShell 中运行
MigrateTo-IdentityServer.ps1脚本。 - 使用此处描述的参数,在 PowerShell 中运行
Publish-ResourceCatalog.ps1脚本。 - 使用此处描述的参数,在 PowerShell 中运行
MigrateTo-ResourceCatalog.ps1脚本。 - 使用此处描述的参数,在 PowerShell 中运行
Publish-Webhooks.ps1脚本。 - 使用此处描述的参数,在 PowerShell 中运行
MigrateTo-Webhooks.ps1脚本。 - 启动业务流程和身份应用程序服务。享受在 Azure 门户上使用 Orchestrator。
多节点安装
备注:
多节点安装需要设置。
要在 Azure 应用程序服务的多个节点上安装 Orchestrator,请执行以下步骤:
Orchestrator 步骤
- 在 Azure 门户的“应用程序服务”下,使用自定义名称(例如
UiPathOrchestrator)创建新的应用程序服务。创建网页应用程序时,请确保选择堆栈.NET 8 (LTS)。有关详细信息,请参阅 Microsoft 官方文档。 - 在 Azure 门户中打开新创建的网页应用程序,然后在“配置”选项卡上选择“常规设置”,并更改以下配置:
- 将平台设置为“64 位”。
- 将 WebSockets 设置为“启用”。
- 在网页应用程序的“配置” > “应用程序设置”> “连接字符串”中设置数据库连接字符串,名称为“默认”。例如
Server=13.13.13.13;Initial Catalog=UiPath;Persist Security Info=False;User ID=dbUser;Password=pass123; MultipleActiveResultSets=False;Encrypt=True; Connection Timeout=30;TrustServerCertificate=True。重要提示:- 此处提供的 Azure Server 用户必须拥有服务器级别的访问权限,数据库级别的访问权限不足以执行成功安装。
- 确保将数据库连接字符串中的
TrustServerCertificate属性设为True。 - 确保选择
SQL Azure作为数据库连接字符串的类型。 - 不保留 Nlog 配置。
- 我们的脚本支持以下两种 Azure PowerShell 身份验证机制:
- 通过您自己的用户身份 - 使用 Azure PowerShell 登录 时,请使用 -noAzureAuthentication 参数。
- 通过服务主体 - 创建可以访问 Orchestrator 应用程序服务和资源组的 Azure AD 应用程序和服务主体。或者,请让友好的 DevOps 团队为您提供 Azure 服务主体 ID 和密码,该 ID 和密码可以访问应用程序服务和相关资源组。
- In the Scale out (App Service plan) tab, select the Scale to a specific instance count option and provide the desired Instance count.
身份服务器步骤
- 在 Azure 门户的“应用程序服务”下,使用自定义名称(例如
UiPathIdentity)创建新的应用程序服务。创建网页应用程序时,请确保选择堆栈.NET 8 (LTS)。有关详细信息,请参阅 Microsoft 官方文档。 - 在网页应用程序的“配置”>“连接字符串”中设置数据库连接字符串,名称为
DefaultConnection。例如Server=13.13.13.13;Initial Catalog=UiPath;Persist Security Info=False;User ID=dbUser;Password=pass123; MultipleActiveResultSets=False;Encrypt=True; Connection Timeout=30;TrustServerCertificate=True。重要提示:确保将数据库连接字符串中的
TrustServerCertificate属性设为True。 - 导航到“设置”>“配置”>“常规设置”选项卡,然后为平台选择“64 位”。
- 我们的脚本支持以下两种 Azure PowerShell 身份验证机制:
- 通过您自己的用户身份 - 使用 Azure PowerShell 登录 时,请使用 -noAzureAuthentication 参数。
- 创建可以访问身份应用程序服务和资源组的 Azure AD 应用程序和服务主体。或者,请让友好的 DevOps 团队为您提供 Azure 服务主体 ID 和密码,该 ID 和密码可以访问应用程序服务和相关资源组。
Webhook 步骤
- 从 Azure 门户中,创建一个包含自定义名称的新网页应用程序,例如:
UiPathWebhookService. - 在“发布”字段中,选择“代码”。
- 对于运行时堆栈,请选择“.NET 8 (LTS)”。
- 打开新的网页应用程序并导航到“设置”>“配置”。
- 在“常规设置”选项卡中,为平台选择“64 位”。
- 选择“保存”。
重要提示:
如果您以前没有通过 Azure 上的 Orchestrator 安装创建 Azure AD 应用程序和服务主体,请立即创建它们。您必须配置它们才能访问您的
UiPathWebhookService和资源组。
资源目录步骤
- 在 Azure 门户的“应用程序服务”下,使用自定义名称(例如
UiPathResourceCatalogService)创建新的应用程序服务。创建网页应用程序时,请确保选择堆栈.NET 8 (LTS)。有关详细信息,请参阅 Microsoft 官方文档。 - 导航到“设置”>“配置”>“常规设置”选项卡,然后为平台选择“64 位”。
- 在网页应用程序的“配置”>“连接字符串”中设置数据库连接字符串,名称为
DefaultConnection。例如Server=13.13.13.13;Initial Catalog=UiPath;Persist Security Info=False;User ID=dbUser;Password=pass123; MultipleActiveResultSets=False;Encrypt=True; Connection Timeout=30;TrustServerCertificate=True。 - 我们的脚本支持以下两种 Azure PowerShell 身份验证机制:
- 通过您自己的用户身份 - 使用 Azure PowerShell 登录 时,请使用 -noAzureAuthentication 参数。
- 通过服务主体 - 创建可以访问资源目录应用程序服务和资源组的 Azure AD 应用程序和服务主体。或者,请让友好的 DevOps 团队为您提供 Azure 服务主体 ID 和密码,该 ID 和密码可以访问应用程序服务和相关资源组。
常规步骤
- 将
UiPathOrchestrator.zip存档下载到本地计算机。其中包含安装 Orchestrator、身份服务器、资源目录和 Webhook 服务所需的所有脚本。UiPath 可应要求提供UiPathOrchestrator.zip存档。请与我们联系以获取详细信息。 - 将 zip 文件的内容提取到计算机上的文件夹中。
备注:
以下步骤需要运行 PowerShell 脚本。要禁用任何中断这些任务的提示,请在上一步选择的目录中运行
Get-ChildItem *.ps1 -Recurse | Unblock-File命令。 - 使用此处描述的参数,在 PowerShell 中运行
Publish-Orchestrator.ps1脚本。重要提示:- 在运行
Publish-Orchestrator.ps1脚本之前,请确保卸载 AzureRM PowerShell 模块。我们建议使用 Az PowerShell 模块作为替代方案。不支持同时安装 AzureRM 和 Az 模块。 - 如果未检测到所需的 Az 版本,并且在运行脚本时存在 AzureRM,则即使在无人值守的安装上,系统也会提示您确认是否删除 AzureRM。
- 如果在使用任何先前版本的模块时升级到 Az v6.0.0,则系统会弹出以下消息:
WARNING: The version 'x.x.x' of module 'Az.<Name>' is currently in use. Retry the operation after closing the applications.。为了解决此问题,请确保在新的 PowerShell 会话中执行Publish-Orchestrator.ps1。 - 如果您使用的是 Microsoft 托管的代理,则
Publish-Orchestrator.ps1问题将导致无法运行正确的 Az 版本。您将继续使用版本 4.7.0,而不是版本 5.4.0 或 6.0.0。要解决此问题,请确保删除C:\Modules\az_4.7.0文件夹。
- 在运行
- 使用此处描述的参数,在 PowerShell 中运行
Publish-IdentityServer.ps1脚本。重要提示:确保执行发布到 Identity Server 页面中所述的步骤以完成上述过程。
- 使用此处描述的参数,在 PowerShell 中运行
MigrateTo-IdentityServer.ps1脚本。 - 使用此处描述的参数,在 PowerShell 中运行
Publish-ResourceCatalog.ps1脚本。 - 使用此处描述的参数,在 PowerShell 中运行
MigrateTo-ResourceCatalog.ps1脚本。 - 使用此处描述的参数,在 PowerShell 中运行
Publish-Webhooks.ps1脚本。 - 使用此处描述的参数,在 PowerShell 中运行
MigrateTo-Webhooks.ps1脚本。 - 启动业务流程和身份应用程序服务。享受在 Azure 门户上使用 Orchestrator。