订阅

UiPath Installation and Upgrade

UiPath 安装和升级指南

The Windows Installer

使用 UiPathOrchestrator.msi 安装程序,您可以根据需要在一个或多个节点上安装 Orchestrator。以下各节为您提供有关如何在单节点和多节点环境中成功执行安装的详细信息。

单节点安装

In single-node installations, the session is kept in the memory, as you do not need to share it.

  1. Run the Windows Installer (UiPathOrchestrator.msi). The UiPath Orchestrator Setup wizard is displayed.
  2. 选择“我接受许可协议中的条款”复选框以同意协议中的条款,然后单击“安装”。将显示“产品功能”选择窗口:
507507

🚧

重要

启用“测试自动化”功能时,将创建默认名称为 UiPathTestAutomation 的数据库。可以通过命令行 TA_DATABASE_NAME=<MyCustomDB> 选择其他名称。

  1. 选择以下功能是否与 Orchestrator 一起安装:Insights 和/或 测试自动化。单击“下一步”,将显示“Orchestrator IIS 设置”步骤。
741741
  1. Change the IIS Settings as desired:
    • Website name - the name of the website. This is set to UiPath Orchestrator by default and cannot be edited.
    • 网站端口 - 要用于启用计算机和 Orchestrator 之间通信的端口。默认情况下,这设置为 443,以使您能够使用 HTTPS。如果使用另一个端口,请确保将它附加到 PUBLIC_URL Identity Server 参数,如下所述。
    • Add firewall rules for this port - when selected, automatically adds firewall rules for this port, to ensure your machine's security.
    • SSL 证书 - 要用于保护与 Orchestrator 的连接的 SSL 证书的主题或指纹。默认情况下,这用完整的计算机名称填充。
    • Verify port availability - if selected, checks if the specified website port is available.
  2. Click Next. The Application Pool Settings step is displayed.
752752
  1. Configure the editable options as desired:

    • Name - the application pool name. This is set to UiPath Orchestrator by default and cannot be edited.
    • Identity - enables you to choose the identity under which the UiPath Orchestrator website runs. The following options are available:
      • Application Pool Identity - runs the Orchestrator website under the default identity of the application pool.
      • Custom account - runs the Orchestrator website under an existing Windows or Domain identity. Selecting this option displays two fields, Username and Password, which enable you to specify the identity under which to run.

    有关应用程序池标识的详细信息,请参阅 Microsoft 的官方文档

  2. Click Next. The Orchestrator Database Settings step is displayed.

754754
  1. Fill in the fields with information about your SQL Server, as follows:
    • SQL Server Host - the name of the SQL Server machine. By default, this is set to localhost (.). If it is not the default instance, please also mention it in the MyMachine\MyInstance format. You can also specify a custom port number here using a comma, such as MyMachine\MyInstance,800.
    • 数据库名称 - 数据库的名称。默认情况下,它设置为 UiPath。请注意,不支持以下特殊字符:空格、\/*:;?"<>|,且最大长度为 123 个字符。
    • Authentication mode - enables you to choose the authentication mode for the UiPath Orchestrator website. The following options are available:
      • Windows 集成身份验证 - 这是默认选项。如果选择它,Orchestrator 将使用检测到的 IIS 应用程序池的 Windows 帐户连接到数据库,并使用您当前登录时所用的 Windows 凭据创建数据库。有关详细信息,请参阅“先决条件”一章。
      • SQL Server 身份验证 - 如果选择此选项,将显示“SQL 用户名”和“密码”字段,必须使用 SQL Server 用户名和密码填写这些字段。有关详细信息,请参阅“先决条件”一章注意:密码不支持使用分号 (;)。
  2. 单击“下一步”。安装程序验证 SQL 连接。如果 SQL 连接无效,将显示一个对话框。如果 SQL 连接有效,将显示“身份服务器设置”步骤。

📘

备注:

Orchestrator 附带身份服务器,在 UiPath 产品间实现集中身份验证和访问控制。

507507

🚧

重要

对于大型部署,我们建议为身份服务器使用单独的数据库。

  1. 填写有关身份服务器的信息的字段,如下所示:

    • 数据库名称 - 数据库的名称。默认情况下,这是 Orchestrator 数据库的名称,但可以更改。请注意,不支持以下特殊字符:空格、\/*:?"<>|,最大长度为 123 个字符。
    • Orchestrator 公共 URL - Identity Server 连接到的 Orchestrator 的 URL。在多节点应用场景中,这将是负载均衡器的 URL,用户通过该 URL 调用 Orchestrator 安装(例如:https://orchestrator.mydomain.local)。
      默认情况下,Orchestrator 公共 URL 设置为 https://<host name>。请注意,这仅适用于使用默认网站端口 443 的情况。如果选择自定义端口,那么 Orchestrator 公共 URL 为 https://<host name>:<custom port>。例如,如果网站端口设置为 444,那么 Orchestrator 公共 URL 为 https://<host name>:444
    • 签名证书 - 用于对访问令牌(用于在 Orchestrator 与身份服务器之间进行身份验证)进行签名的证书的主题或指纹。
  2. 单击“下一步”。系统将显示“更新服务器数据库设置”步骤:

497497
  1. 填写有关更新服务器数据库的信息的字段,如下所示:
  • SQL Server 主机 - SQL Server 计算机的名称。默认情况下,这设置为本地主机 (.)。如果它不是默认实例,也请以 MyMachine\MyInstance 格式提及它。您还可在此处使用逗号指定自定义端口号(如 MyMachine\MyInstance,800)。
  • 数据库名称 - 更新服务器使用的数据库的名称。默认情况下,这是 Orchestrator 数据库的名称,但可以更改。请注意,不支持以下特殊字符:空格、\/*:?"<>|,最大长度为 123 个字符。
  • 身份验证模式 - 用于选择更新服务器的身份验证模式。提供以下选项:
    • Windows 集成身份验证 - 这是默认选项。如果选择它,Orchestrator 将使用检测到的 IIS 应用程序池的 Windows 帐户连接到数据库,并使用您当前登录时所用的 Windows 凭据创建数据库。有关详细信息,请参阅“先决条件”一章。
    • SQL Server Authentication - If you select this option, the SQL Username and Password fields are displayed, which have to be filled in with the SQL Server username and password. For more information, see the Prerequisites chapter. Note: The password does not support the use of semicolons (;).
  1. 单击“下一步”。将显示 Elasticsearch 日志设置步骤。
550550
  1. (Optional) Fill in the fields with information about your Elasticsearch instance, as follows:
    • URL - The Elasticsearch URL to which you want to log information.
    • Requires authentication - Enables you to indicate if your Elasticsearch instance requires authentication. If selected, the Username and Password fields are displayed.
      • Username - The Elasticsearch username.
      • Password - The Elasticsearch password.

📘

备注:

If you do not want to use Elasticsearch for logging, please leave the URL field empty.

  1. Click Next. The Orchestrator Authentication Settings step is displayed.
616616
  1. Fill in the fields as follows:

    • 主机密码 - 为主机管理员设置自定义密码。请注意,密码长度必须介于 8 到 33 个字符之间,并且必须至少包含一个小写字符和一个数字。
    • Confirm password - Confirm the host administrator password.
    • Reset at first login - Enables you to enforce a password reset on the first login for the host administrator. This is also called a one-time password.
    • 默认租户密码 - 为默认租户管理员设置自定义密码。请注意,密码长度必须介于 8 到 33 个字符之间,并且必须至少包含一个小写字符和一个数字。
    • Confirm password - Confirm the default tenant administrator password.
    • Reset at first login - Enables you to enforce a password reset on the first login for the default tenant administrator. This is also called a one-time password.
  2. 单击“下一步”。如果选择了 Insights 功能,将显示 Insights 步骤。
    在 Insights SQL Server 配置期间,添加数据库所有者角色时,请确保按照要求选择 db_owner 角色。

507507
  1. 填写有关 Insights 实例信息的字段,如下所示:

    • SQL Server 主机 - Insights SQL Server 计算机的名称。默认情况下,这设置为本地主机 (.)。如果它不是默认实例,也请以 MyMachine\MyInstance 格式提及它。您还可在此处使用逗号指定自定义端口号,如 MyMachine\MyInstance,800
    • 数据库名称 - 数据库的名称。默认情况下,它设置为 UiPath。请注意,不支持以下特殊字符:空格、\/*:;?"<>|,且最大长度为 123 个字符。
    • Authentication mode - enables you to choose the authentication mode for the UiPath Orchestrator website. The following options are available:
      • Windows 集成身份验证 - 这是默认选项。如果选择它,Orchestrator 将使用检测到的 IIS 应用程序池的 Windows 帐户连接到数据库,并使用您当前登录时所用的 Windows 凭据创建数据库。
      • SQL Server 身份验证 - 如果选择此选项,将显示“SQL 用户名”和“密码”字段,这些字段必须使用 SQL Server 用户名和密码填写。
  2. 单击“下一步”。如果选择了测试自动化功能,将显示测试自动化步骤。

507507
  1. 在字段中填写有关测试自动化实例的信息,如下所示:

    • SQL Server 主机 - TA SQL 服务器计算机的名称。默认情况下,这设置为本地主机 (.)。如果它不是默认实例,也请以 MyMachine\MyInstance 格式提及它。您还可在此处使用逗号指定自定义端口号(如 MyMachine\MyInstance,800)。
    • 数据库名称 - 数据库的名称。请注意,不支持以下特殊字符:空格、\/*:;?"<>|,最大长度为 123 个字符。
    • Authentication mode - enables you to choose the authentication mode for the UiPath Orchestrator website. The following options are available:
      • Windows 集成身份验证 - 这是默认选项。如果选择它,Orchestrator 将使用检测到的 IIS 应用程序池的 Windows 帐户连接到数据库,并使用您当前登录时所用的 Windows 凭据创建数据库。
      • SQL Server 身份验证 - 如果选择此选项,将显示“SQL 用户名”和“密码”字段,这些字段必须使用 SQL Server 用户名和密码填写。注意:密码不支持使用分号 (;)。
  2. 单击“下一步”。系统将显示“Orchestrator 存储设置”步骤。

497497
  1. 输入所需的存储类型存储位置。有关详细信息,请参阅此处

  2. Click Next. The Ready to install UiPath step is displayed.

  3. Click Install. The installation process starts. Note that Orchestrator is installed at the following location: C:\Program Files (x86)\UiPath\Orchestrator.

🚧

重要

仔细检查选定的安装路径。不支持将安装从一个位置移动到另一个安装后位置。

  1. Navigate to IIS Manager.

  2. Select the Orchestrator server. The Features View is updated accordingly.

  3. Double-click Feature Delegation. The Feature Delegation view is displayed.

  4. Right-click Authentication - Windows and click Read/Write.

  5. Start the website. You can now use Orchestrator.

📘

备注:

若要以主机管理员身份登录,请使用我们的团队在购买许可证时提供的凭据,并在“租户名称”字段中写入 host。详情请参阅此处

多节点安装

🚧

重要

多节点 Orchestrator 部署使用 RESP(REdis 序列化协议)进行通信,因此可以使用依赖于此协议的任何解决方案进行配置。

仅当使用 UiPath 高可用性插件时,UiPath 才支持 Orchestrator 的高可用性多节点部署。

🚧

重要

:warning:多节点安装必须使用 CERTIFICATE_SUBJECTIS_CERTIFICATE_SUBJECT 参数。如果对身份使用不同的证书,则 Orchestrator-身份服务器集成不起作用。其在参数文件中的值必须是所有节点的通用值。这可以通过以下方法实现:

  • 通配符证书 (subject=*.domain.local);或
  • 使用者可选名称 (SAN) 证书,其中包含公共负载均衡器的 DNS 名称,以及所有节点的 DNS 名称(可选),在创建证书时或在继续安装辅助节点之前编辑参数文件中的值。

证书可以按主题或指纹输入。

  1. 在主节点上:使用以下命令行从提升的命令提示符安装 Orchestrator:UiPathOrchestrator.msi OUTPUT_PARAMETERS_FILE=install.json REDIS_HOST=redis.corp.local REDIS_PASSWORD=secretPass STORAGE_TYPE=FileSystem STORAGE_LOCATION="RootPath=\\fileserver\Share" PUBLIC_URL=<Orchestrator_LoadBalancer_URL> CERTIFICATE_SUBJECT=*.domain.local IS_CERTIFICATE_SUBJECT=*.domain.local

    有关可用参数的详细信息,请参阅此处

📘

备注:

You can also specify a port for the installed RESP (REdis Serialization Protocol) solution using the REDIS_PORT parameter if you do not want to use the default port (6379).
HAA 使用端口 10000

🚧

重要

对于包括 Insights 在内的部署,请先完成 Insights 安装,然后再继续安装 Orchestrator 的辅助节点。

  1. 在所有辅助节点上,使用带有命令行参数的 UiPathOrchestrator.msi 安装 Orchestrator,确保提供参数设置为 true 的 SECONDARY_NODE 以及在主要节点安装过程中生成的参数文件。我们还建议使用 /passive 参数,因为被动安装会显示进度条和错误弹出窗口。您还可以通过指定 /Q 参数选择静默模式,这仅适用于无人值守安装。

    For example: UiPathOrchestrator.msi SECONDARY_NODE=1 PARAMETERS_FILE=install.json /Q.

    应用程序池已启动,您可以开始使用 Orchestrator 实例。
    The database is initialized when you install the primary node. When setting up the secondary nodes, the database initialization step is no longer needed.

将节点添加到多节点 Orchestrator

如果上述方法假定在初始部署期间安装和配置主节点和辅助节点,则也可从任何现有节点生成参数文件,以用于安装任何其他节点。

这是使用 Generate-ParametersFile.ps1 脚本完成的,该脚本位于 Orchestrator 安装目录的 Tools 子文件夹中:

  1. 打开 Orchestrator 安装目录的 Tools 子文件夹并执行 Generate-ParametersFile.ps1
    注意appPool 自定义用户密码必须传递,除非 appPoolIdentity 用于身份验证。
  2. 根据现有 Orchestrator 的配置文件和环境生成 JSON 文件。
  3. 使用此文件,完成次节点安装(上述多节点安装中的第 2 步)。

Packages Storage Considerations

The metadata (definition) of all packages - activities, workflows, libraries - is kept in the SQL database for faster search and filtering.

In addition to this, it is possible to keep the actual files and execution media in the FileSystem or a blob storage of your choosing - Azure, Amazon S3, or Minio. This feature allows for a more performant file synchronization, especially in complex multi-node Orchestrator environments.

考虑到,无论使用什么存储来保存包,每次上传的最大文件大小是 28.6MB - IIS 给出的限制。若要了解如何针对 Amazon、Minio 和文件系统更改此设置,请访问此页面。若要了解如何在 Azure 中执行此操作,请参阅此页

Updated 5 days ago


The Windows Installer


建议的编辑仅限用于 API 参考页面

您只能建议对 Markdown 正文内容进行编辑,而不能建议对 API 规范进行编辑。