手动：高级安装体验

本页面说明如何使用 Automation Suite 的 cluster_config.json 配置文件。

cluster_config.json 文件定义应用于通过 Automation Suite 部署的 UiPath 产品的参数、设置和首选项。如果要更改默认值并为集群使用任何高级配置，则需要更新此文件。

要编辑 cluster_config.json，您可以使用以下任一方法：

• a 通过 SSH 直接在 Linux 计算机上使用 Linux 文本编辑器，例如 vi 或 GNU nano（例如，命令：vi cluster_config.json）；
• 使用您喜欢的文本编辑器，然后将文件复制粘贴到计算机上。

cluster_config.json 文件允许您配置要部署的 UiPath 产品。有两种类型的 UiPath 产品：

• mandatory products: these are installed by default and do not have the enabled flag available on them;
• optional products: these are not required to complete the install. However, be aware that products may have dependencies. Please see Product dependencies for more details on this.

要通过 cluster_config.json 文件启用或禁用产品，请对 enabled 标志使用 true 或 false。

Cluster_config.json 示例

{
  "fqdn": "PLACEHOLDER",
  "fixed_rke_address": "PLACEHOLDER",
  "multinode": "false",
  "admin_username": "PLACEHOLDER",
  "admin_password": "PLACEHOLDER",
  "profile": "ha",
  "telemetry_optout": "true",
  "rke_token": "PLACEHOLDER",
  "server_certificate": {
    "ca_cert_file": "/absolute/path/to/rootCA.crt",
    "tls_cert_file": "/absolute/path/to/server.crt",
    "tls_key_file": "/absolute/path/to/server.key"
  },
  "infra": {
    "docker_registry": {
      "username": "PLACEHOLDER",
      "password": "PLACEHOLDER"
    },
    "custom_dns_resolver": "/path/to/custom-resolv.conf"
  },
  "identity_certificate": {
    "token_signing_cert_file": "/absolute/path/to/identity.pfx",
    "token_signing_cert_pass": ""
  },
  "sql": {
    "server_url": "PLACEHOLDER",
    "username": "PLACEHOLDER",
    "password": "PLACEHOLDER",
    "port": "PLACEHOLDER",
    "create_db": "PLACEHOLDER"
  },
  "sql_connection_string_template": "PLACEHOLDER",
  "sql_connection_string_template_jdbc": "PLACEHOLDER",
  "sql_connection_string_template_odbc": "PLACEHOLDER",
  "orchestrator": {
    "testautomation": {
      "enabled": true
    },
    "updateserver": {
      "enabled": true
    }
  },
  "aicenter": {
    "enabled": true,
    "sql_connection_str": "PLACEHOLDER"
  },
  "documentunderstanding": {
    "enabled": true,
    "datamanager": {
      "sql_connection_str": "PLACEHOLDER"
    },
    "handwriting": {
      "enabled": true,
      "max_cpu_per_pod": 2
    }
  },
  "insights": {
    "enabled": true
  },
  "test_manager": {
    "enabled": true
  },
  "automation_ops": {
    "enabled": true
  },
  "automation_hub": {
    "enabled": true
  },
  "apps": {
    "enabled": true
  },
  "action_center": {
    "enabled": true
  },
  "task_mining": {
    "enabled": true
  },
  "dataservice": {
    "enabled": true
  }
}

常规配置

必填参数	描述
fqdn	负载均衡器（多节点 HA 就绪生产模式）或计算机（单节点评估模式）域名。
fixed_rke_address	用于对节点注册和 kube API 请求进行负载均衡的固定地址。如果按照建议配置负载均衡器，则此字段应为 fqdn。否则为第一个服务器节点的 FQDN。请参阅配置负载均衡器。 可以是设置中第一个 rke2 服务器的 IP/FQDN。
multinode	选择多节点 HA 就绪生产配置文件时，设置为 true。此标志的值由交互式安装向导自动设置。它仅用于内部目的，不应手动修改。
admin_username	您要为主机组织设置为 admin 的用户名（例如：admin）。
admin_password	要设置的主机管理员密码。
rke_token	在此处使用新生成的 GUID。这是一个预共享的、特定于集群的密码。加入集群的所有节点都需要它。
profile	设置安装的配置文件。可用的配置文件包括： default：单节点评估配置文件。 ha：多节点 HA 就绪生产配置文件。 此标志的值由交互式安装向导自动设置。它仅用于内部目的，不应手动修改。
infra.docker_registry.username	您要为 Docker 注册表安装设置的用户名。
infra.docker_registry.password	您要为 Docker 注册表安装设置的密码。

可选参数	描述
telemetry_optout	true 或 false - 用于选择不将遥测数据发送回 UiPath™。默认情况下，它设置为 false。 如果您希望选择退出，请设置为 true。

证书配置

请参阅先决条件文件以获取证书：

• 单节点评估模式：配置证书
• 多节点 HA 就绪生产：配置证书

如果安装时未提供证书，则安装程序将创建一个自行颁发的证书并在集群中对其进行配置。证书的有效期为 90 天。

备注：

请务必指定证书文件的绝对路径。运行 pwd 以获取放置文件目录的路径，并将证书文件名附加到 cluster_config.json 中。

在多节点 HA 就绪生产安装中，仅需为第一个节点使用证书。

参数	描述
server_certificate.ca_cert_file	证书颁发机构 (CA) 证书的绝对路径。 此 CA 是签署 TLS 证书的颁发机构。 CA 捆绑包应仅包含用于签署 TLS 证书的链证书。 链限制为最多 9 个证书。 如果您使用的是自签名证书，则需要指定先前创建的 rootCA.crt 的路径。如果要生成安装程序，请留空。
server_certificate.tls_cert_file	TLS 证书的绝对路径（在前面的步骤中创建的自签名证书 server.crt）。如果要生成安装程序，请留空。
server_certificate.tls_key_file	证书密钥的绝对路径（在前面的步骤中创建的自签名证书 server.key）。如果要生成安装程序，请留空。
identity_certificate.token_signing_cert_file	用于对令牌进行签名的 Identity Service 证书的绝对路径（在前面的步骤中创建的自签名令牌 identity.pfx）。如果您希望安装程序使用服务器证书生成身份证书，请留空。
identity_certificate.token_signing_cert_pass	导出时设置的纯文本密码。
additional_ca_certs	包含其他 CA 证书的文件的绝对路径，作为 Automation Suite 的一部分运行的所有产品均会信任这些证书。文件中的所有证书均应为有效的 PEM 格式。 例如，如果证书不是由公共证书颁发机构颁发，则需要提供包含 SQL Server CA 证书的文件。

数据库配置

数据库创建工作流

交互式安装程序使用以下工作流自动创建数据库：

1. 交互式安装程序脚本会检查cluster_config.json文件中sql.create_db参数的值。

   • 如果sql.create_db参数设置为true ，则安装程序会代表您自动生成所有数据库。 在这种情况下，安装程序将使用默认数据库名称和默认模板，并忽略您提供的任何自定义数据库名称。

     For details, see Automatically create the necessary databases.

   • 如果将sql.create_db设置为false ，则您必须使用自己的数据库。 在这种情况下，您必须手动设置数据库。 请注意，您可以使用自定义数据库名称，前提是遵循提供的命名约定。 此步骤至关重要，因为我们将数据库名称与连接模板结合使用来构成数据库连接字符串。 如果您不遵循建议的命名约定，则必须自己提供 SQL 连接字符串。

     For details, see Bring your own databases.

2. 交互式安装程序会生成连接字符串，如下所示：
   • 如果您没有为服务定义连接字符串，则安装程序将使用连接模板生成所有数据库连接字符串。
   • 如果您为服务定义了连接字符串，则安装程序将使用为数据库提供的连接字符串。

自动创建必要的数据库

如果您希望安装程序创建数据库，请填写以下字段：

参数	描述
sql.create_db	设置为true以允许安装程序创建数据库。 请注意，安装程序将使用默认数据库名称和默认模板，并忽略您提供的任何自定义数据库名称。
sql.server_url	您希望安装程序在其中配置数据库的 SQL Server 的 FQDN。
sql.port	SQL Server 中应托管数据库实例的端口号。
sql.username	用于连接到 SQL Server 的用户名/用户 ID。
sql.password	之前提供的用于连接到 SQL Server 的用户名密码。

备注：

确保用户具有 dbcreator 角色。这将授予他们在 SQL Server 中创建数据库的权限。否则，安装将失败。

ODBC 连接不支持包含特殊字符的用户名。对于 AI Center 和 Document Understanding 的数据库用户名，请仅使用大写和小写字母。

请自带数据库

如果您选择为新安装的 Automation Suite 使用自己的数据库，我们强烈建议设置新的数据库，而不是使用现有数据库。此预防措施有必要，以防止旧数据库中的剩余元数据与 Automation Suite 的操作发生任何冲突。

如果您有自己的数据库，则必须为每个数据库提供 SQL 连接字符串。Automation Suite 支持以下 SQL 连接字符串格式：

参数	描述	产品
sql_connection_string_template	完整的 ADO.NET 连接字符串，其中目录名称设置为 DB_NAME_PLACEHOLDER。安装程序将使用已安装的套件服务的默认数据库名称替换此占位符。	平台、Orchestrator、Test Manager、Automation Hub、Automation Ops、Insights、Task Mining、Data Service、Document Understanding
sql_connection_string_template_jdbc	完整的 JDBC 连接字符串，其中数据库名称设置为 DB_NAME_PLACEHOLDER。安装程序将使用已安装的套件服务的默认数据库名称替换此占位符。	AI Center
sql_connection_string_template_odbc	完整的 ODBC 连接字符串，其中数据库名称设置为 DB_NAME_PLACEHOLDER。安装程序将使用已安装的套件服务的默认数据库名称替换此占位符。	Document Understanding

重要提示：

确保已向连接字符串中指定的 SQL 帐户授予所有 Automation Suite 数据库的 db_securityadmin 和 db_owner 角色。如果安全限制不允许使用 db_owner，则 SQL 帐户应在所有数据库上具有以下角色和权限：

• db_ddladmin
• db_datawriter
• db_datareader
• 对 dbo 架构的 EXECUTE 权限

重要提示：

如果在配置文件中手动设置连接字符串，则可以对 SQL、JDBC 或 ODBC 密码进行转义，如下所示：

• 对于 SQL：在密码的开头和结尾添加' ，并将任何其他'加倍。
• 对于 JDBC/ODBC：在密码的开头添加{ ，在密码的末尾添加} ，并将其他任何}加倍。

备注：

默认情况下将 TrustServerCertificate 设置为 False，并且您必须为 SQL Server 提供其他 CA 证书。如果 SQL Server 证书是自签名证书或由内部 CA 签名，则这是必要项。

See Certificate configuration for more details.

sql_connection_string_template 示例

Server=tcp:sfdev1804627-c83f074b-sql.database.windows.net:1433;Initial Catalog=DB_NAME_PLACEHOLDER;Persist Security Info=False;User Id=[e-mail];Password=***;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;

sql_connection_string_template_jdbc 示例

jdbc:sqlserver://sfdev1804627-c83f074b-sql.database.windows.net:1433;database=DB_NAME_PLACEHOLDER;user=testadmin;password=***;encrypt=true;trustServerCertificate=false;Connection Timeout=30;hostNameInCertificate=sfdev1804627-c83f074b-sql.database.windows.net"

sql_connection_string_template_odbc 示例

SERVER=sfdev1804627-c83f074b-sql.database.windows.net,1433;DATABASE=DB_NAME_PLACEHOLDER;DRIVER={ODBC Driver 17 for SQL Server};UID=testadmin;PWD=***;MultipleActiveResultSets=False;Encrypt=YES;TrustServerCertificate=NO;Connection Timeout=30;"

Automation Suite 服务的默认和可选 DB 名称

{
  "orchestrator": "AutomationSuite_Orchestrator",
  "orchestrator_ta": "AutomationSuite_Orchestrator",
  "orchestrator_upd": "AutomationSuite_Platform",
  "platform": "AutomationSuite_Platform",
  "test_manager": "AutomationSuite_Test_Manager",
  "automation_ops": "AutomationSuite_Platform",
  "automation_hub": "AutomationSuite_Automation_Hub",
  "insights": "AutomationSuite_Insights",
  "task_mining": "AutomationSuite_Task_Mining",
  "dataservice": "AutomationSuite_DataService",
  "aicenter": "AutomationSuite_AICenter",
  "documentunderstanding": "AutomationSuite_DU_Datamanager",
}

备注：

如果要覆盖上述任何服务的连接字符串，请为该特定服务设置 sql_connection_str。

在运行安装程序之前，您仍然必须手动创建这些数据库。

覆盖 Orchestrator 和平台的默认连接字符串

{
  "orchestrator": {
    "sql_connection_str": "Server=tcp:sfdev1804627-c83f074b-sql.database.windows.net,1433;Initial Catalog=CustomOrchDB;Persist Security Info=False;User Id=[e-mail];Password=***;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;"
  },
  "platform": {
    "sql_connection_str": "Server=tcp:sfdev1804627-c83f074b-sql.database.windows.net,1433;Initial Catalog=CustomIDDB;Persist Security Info=False;User Id=[e-mail];Password=***;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;"
  }
}

要覆盖其他产品的数据库连接字符串，请在相应的产品块中设置 sql_connection_str。连接字符串应具有相应产品支持的格式。

为 AI Center 设置数据库连接字符串的示例

参数	描述
aicenter.sql_connection_str	AI Center JDBC 连接字符串（有关 JDBC 格式，请参阅下文）

备注：

请检查 JDBC 连接字符串是否具有以下示例中的格式。

"aicenter": {
    "enabled": true,
    "sql_connection_str": "jdbc:sqlserver://sfdev1804627-c83f074b-sql.database.windows.net;database=aicenter;user=[e-mail];password=TFgID_9GsE7_P@srCQp0WemXX_euHQZJ"
}

Document Understanding 连接字符串示例

"documentUnderstanding": {
  "datamanager": {
    "sql_connection_str": "SERVER=sql-server.database.windows.net;DATABASE=datamanager;DRIVER={ODBC Driver 17 for SQL Server};UID=testadmin;PWD=myPassword"
  },
  "sql_connection_str": "Server=tcp:database.example.com,1433;Initial Catalog=db;Persist Security Info=False;User Id=[e-mail];Password=***;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;",
  "cjkOcr":
  {
    "enabled": true
  }
}

备注：

仅当您要用自己的连接字符串覆盖默认值时，数据管理器 SQL 连接字符串才是可选的。

在线安装时始终启用手写功能。

The default value for max_cpu_per-pod is 2, but you can adjust it according to your needs. For more information, check the Document Understanding configuration file.

特定于 Orchestrator 的配置

Orchestrator 可以将机器人日志保存到 Elasticsearch 服务器。您可以在 orchestrator.orchestrator_robot_logs_elastic 部分中配置此功能。如果未提供，则系统会将机器人日志保存到 Orchestrator 的数据库中。

下表列出了 orchestrator.orchestrator_robot_logs_elastic 字段：

参数	描述
elastic_uri	应使用的 Elasticsearch 实例的地址。应以 URI 的形式提供。如已提供，则还需要用户名和密码。
elastic_auth_username	用于身份验证的 Elasticsearch 用户名。
elastic_auth_password	用于身份验证的 Elasticsearch 密码。

示例：

"orchestrator": {
    "orchestrator_robot_logs_elastic": {
        "elastic_uri": "https://elastic.example.com:9200",
        "elastic_auth_username": "elastic-user",
        "elastic_auth_password": "elastic-password"
    }
}

Insights 特定配置

如果启用 Insights，则用户可以包含将用于发送计划电子邮件/警示电子邮件的 SMTP 服务器配置。如果未提供，计划电子邮件和警示电子邮件将不起作用。

insights.smtp_configuration 字段详细信息：

参数	描述
tls_version	有效值为 TLSv1_2、TLSv1_1、SSLv23。如果不使用 TLS，则完全省略密钥。
from_email	警示/计划电子邮件的发件人地址。
host	SMTP 服务器的主机名。
port	SMTP 服务器的端口
username	用于 SMTP 服务器身份验证的用户名。
password	用于 SMTP 服务器身份验证的密码。

示例：

"insights": {
    "enabled": true,
    "smtp_configuration": {
      "tls_version": "TLSv1_2",
      "from_email": "[e-mail]",
      "host": "smtp.sendgrid.com",
      "port": 587,
      "username": "login",
      "password": "password123"
    }
  }

监控配置

To provision enough resources for monitoring (see Using the monitoring stack), you should consider the number of vCPUs in the cluster and the amount of desired metric retention. See below for how to set the following monitoring resource configurations.

下表描述了监控字段的详细信息：

参数	描述
prometheus_retention	以天为单位。 此为指标将保留的天数，用于在 Grafana 中进行可视化并通过 Prometheus 控制台进行手动查询。 默认值为 7。
prometheus_storage_size	以 GiB 为单位。 每个 Prometheus 副本要保留的存储空间量。 根据经验，将此值设置为： 0.65 * vCPU cores * (prometheus_retention / 7) 示例： 如果您将 prometheus_retention 设置为 14 天，并且集群具有分布在 5 台计算机上的 80 个核心，则这将变为： 0.65 * 80 * (14 / 7) 52 * (2) 104 默认值为 45，不应设置得更低。 If Prometheus starts to run out of storage space, an alert will be triggered with specific remediation instructions. See here.
prometheus_memory_limit	以 MiB 为单位。 限制每个 Prometheus 副本的内存量。 根据经验，将此值设置为： 100 * vCPU cores * (prometheus_retention / 7) 示例： 如果您已将 prometheus_retention 设置为 14 天，并且集群具有分布在 5 台计算机上的 80 个核心，则这将变为： 100 * 80 * (14 / 7) 8000 * (2) 16000 对于单节点评估模式，默认值为 3200，对于多节点 HA 就绪生产模式，默认值为 6000，并且不应低于这个值。 If Prometheus starts to run out of memory, an alert will be triggered with specific remediation instructions. See here.

示例：

"monitoring": {
  "prometheus_retention": 14,
  "prometheus_memory_limit": 16000,
  "prometheus_storage_size": 104
}

可选：配置代理服务器

备注：

在安装过程中配置代理服务器之前，请确保您满足代理服务器要求。

For details, see Step 2: Adding proxy configuration to each node.

运行交互式安装程序向导时，您需要在高级配置步骤中退出该向导并更新 cluster_config.json。

您需要使用 vim 或您喜欢的编辑器将以下内容添加到配置文件中：

"proxy": {
  "enabled": true,
  "http_proxy": "http://<PROXY-SERVER-IP>:<PROXY-PORT>",
  "https_proxy": "http://<PROXY-SERVER-IP>:<PROXY-PORT>",
  "no_proxy": "alm.<fqdn>,<fixed_rke_address>:9345,<fixed_rke_address>:6443,<named server address>,<metadata server address>,<k8s address range>,<private_subnet_ip>,<sql server host>,<Comma separated list of ips that should not go through proxy server>"
}

必填参数	描述
enabled	使用 true 或 false 启用或禁用代理设置。
http_proxy	用于路由来自集群的 HTTP 出站请求。这应该是代理服务器 FQDN 和端口。
https_proxy	用于路由来自集群的 HTTPS 出站请求。这应该是代理服务器 FQDN 和端口。
no_proxy	您不希望通过代理服务器路由的 CIDR 格式的主机、IP 地址或 IP 范围的逗号分隔列表。这应该是私有子网范围、SQL Server 主机、命名服务器地址、元数据服务器地址： *.<fqdn>,<fixed_rke_address>:9345,<fixed_rke2_address>:6443。 fqdn - cluster_config.json 中定义的集群 FQDN fixed_rke_address - cluster_config.json 中定义的 fixed_rke_address named server address - /etc/resolv.conf 中的 IP 地址 private_subnet_ip - 集群 VNet sql server host - SQL 服务器主机 metadata server address - 云服务（例如 Azure 和 AWS）用于获取计算机元数据的 IP 地址 169.254.169.254 k8s address range - Kubernetes 节点使用的 IP 地址范围，即 10.0.0.0/8

可选：在多节点 HA 就绪生产集群中启用区域故障恢复

要在多节点集群中启用区域故障恢复，请执行以下步骤：

1. 确保节点均匀分布在三个可用区。对于除 AWS、Azure 或 GCP 以外的任何供应商提供的裸机服务器或虚拟机，必须通过每台计算机上 /etc/default/k8s-node-labels 处的配置文件以下列格式提供区域元数据。

   NODE_REGION_LABEL=<REGION_NAME>
   NODE_ZONE_LABEL=<ZONE_NAME>
   cat > /etc/default/k8s-node-labels <<EOF
   EXTRA_K8S_NODE_LABELS="topology.kubernetes.io/region=$NODE_REGION_LABEL,topology.kubernetes.io/zone=${NODE_ZONE_LABEL}"
   EOF
   

2. 在高级配置步骤中更新 cluster_config.json 文件。

要使用交互式安装向导更新 cluster_config.json，请在高级配置步骤中退出，然后使用 vim 或您喜欢的编辑器将以下内容添加到配置文件中：

"zone_resilience": true

必填参数	描述
zone_resilience	使用 true 或 false 启用或禁用区域故障恢复。

重要提示：

如果启用对区域故障的恢复，则传递 --zone 和 --region 参数为：

• 如果您在 AWS、Azure 或 GCP 上配置计算机，并且在安装程序填充区域和区域详细信息时启用了元数据服务，则建议使用此选项。
• 如果您在 AWS、Azure 或 GCP 上配置计算机，并且元数据服务已禁用，或者您选择其他云提供商，则为必填项。

可选：传递自定义 resolv.conf

Automation Suite 部署的 Kubernetes 集群使用 /etc/resolv.conf 中配置的名称服务器。Kubernetes 不适用于本地 DNS 解析程序（127.0.0.1 或 127.0.0.0/8），因此，如果您在 /etc/resolv.conf 文件中配置了此类名称服务器，则需要在 cluster_config.json 的 .infra.custom_dns_resolver 参数中传递具有可从虚拟机任何位置访问的正确名称服务器条目的参考文件。

有关已知限制的详细信息，请参阅 Kubernetes 文档。

可选参数	描述
.infra.custom_dns_resolver	服务器条目名称正确的文件路径，可从虚拟机上的任意位置加以访问。这些名称服务器条目不得来自 127.0.0.0/8。