構成ファイルについて

cluster_config.json ファイルは、UiPath サービスに適用されるパラメーターや設定を定義します。クラスターに対する既定値を変更したり、何らかの高度な構成を使用したりする場合は、このファイルを更新する必要があります。

cluster_config.json の編集には、次のいずれかを使用できます。

• vi や GNU nano などの Linux テキスト エディター。SSH を介して Linux マシン上で直接使用できます (コマンドの例: vi cluster_config.json)。
• お好みのテキスト エディター。その後、マシン上でファイルをコピーして貼り付けます。

cluster_config.json ファイルによってサービスを有効または無効化するには、enabled フラグに true または false を使用します。

全般的な構成

必須パラメーター	説明
fqdn	ロード バランサー (マルチノード) またはマシン (シングルノード) のドメイン名。
fixed_rke_address	負荷分散ノードの登録と kube API 要求に使用する固定アドレス。 推奨どおりロード バランサーを構成している場合は、その FQDN を指定します。 その他の場合は、最初のサーバー ノードの FQDN を指定します。 言い及ぶ。 設定内の最初の rke2 サーバーの IP/FQDN を指定できます。
multinode	マルチノード インストールを行う場合は true に設定します。
admin_username	ホスト組織の管理者として設定するユーザー名 (admin など)。
admin_password	設定されるホスト テナント管理者パスワード。
rke_token	ここには、新たに生成された GUID を使用します。これは、事前共有されるクラスター固有のシークレットです。クラスターに参加させる、すべてのノードで必要です。
profile	インストールのプロファイルを設定します。使用可能なプロファイルは次のとおりです。 default: シングルノードの評価プロファイル ha: マルチノードの高可用性対応の運用プロファイル このフラグの値は、対話型のインストール ウィザードによって自動的に設定されます。内部目的にのみ使用されるものなので、手動で変更しないでください。
gpu_support	true または false - クラスターに対する GPU サポートを有効化または無効化します。 GPU を持つエージェント ノードがある場合は、「true」に設定します。既定では「false」に設定されています。
infra.docker_registry.username	Docker レジストリのインストール用に設定するユーザー名。
infra.docker_registry.password	Docker レジストリのインストール用に設定するパスワード。

任意パラメーター	説明
telemetry_optout	true または false - UiPath へのテレメトリ送信をオプトアウトするために使用します。既定では、false に設定されています。 オプトアウトする場合は、true に設定してください。

AI Center のパラメーター	説明
sql_connection_str	SQL 接続名です。
orchestrator_url	Orchestrator URL のアドレスです。
identity_server_url	Identity Server URL のアドレスです。
orchestrator_cert_file_path	Orchestrator 証明書ファイルへの絶対パスです。
identity_cert_file_path	Identity Server 証明書ファイルへの絶対パスです。
identity_access_token	Identity Server から取得するアクセス トークンです。

証明書を設定する

証明書を取得するには、次の前提条件のドキュメントをご覧ください。

インストール時に証明書を指定しない場合、インストーラーが自己発行の証明書を作成し、それをクラスターに設定します。この証明書の有効期間は 90 日です。

マルチノード インストールでは、証明書が必要なのは最初のノードだけです。

注: 必ず、証明書ファイルの絶対パスを指定してください。pwd を実行して、ファイルが配置されているディレクトリのパスを取得し、これに cluster_config.json に記載された証明書ファイル名を付加します。

マルチノード インストールでは、証明書が必要なのは最初のノードだけです。

パラメーター	説明
server_certificate.ca_cert_file	証明機関の証明書への絶対パス。この証明書は、TLS 証明書に署名する権威となります。自己署名証明書の場合、前の手順で作成した rootCA.crt です。インストーラーで生成する場合は空白のままにします。
server_certificate.tls_cert_file	TLS 証明書への絶対パス (前の手順で作成した自己署名証明書の場合は server.crt)。インストーラーで生成する場合は空白のままにします。
server_certificate.tls_key_file	証明書キーへの絶対パス (前の手順で作成した自己署名証明書の場合は server.key)。インストーラーで生成する場合は空白のままにします。
additional_ca_certs	Automation Suite の一部として実行されるすべてのサービスに信頼させる、追加の CA 証明書を含むファイルへの絶対パス。ファイルに含まれるすべての証明書は、有効な PEM 形式である必要があります。 たとえば、証明書が公的証明機関によって発行されていない場合、SQL Server の CA 証明書を含むファイルを指定する必要があります。

データベースの構成

必要なデータベースを自動作成する

インストーラーでデータベースを作成する場合は、次のフィールドに入力します。

パラメーター	説明
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 のデータベース ユーザー名において、英字の大文字と小文字のみをご利用ください。

独自のデータベースを利用する

独自のデータベースを提供する場合は、すべてのデータベースに対して SQL 接続文字列が必要になります。次の形式の SQL 接続文字列がサポートされています。

SQL 接続文字列の形式	製品
JDBC	AI Center
ODBC	Document Understanding

パラメーター	説明
sql_connection_string_template	カタログ名を DB_NAME_PLACEHOLDER に設定した ADO.NET の完全な接続文字列。インストーラーは、このプレースホルダーを、インストールするスイートのサービスの既定データベース名に置き換えます。
sql_connection_string_template_jdbc	データベース名を DB_NAME_PLACEHOLDER に設定した JDBC の完全な接続文字列。インストーラーは、このプレースホルダーを、インストールするスイートのサービスの既定データベース名に置き換えます。
sql_connection_string_template_odbc	データベース名を DB_NAME_PLACEHOLDER に設定した ODBC の完全な接続文字列。インストーラーは、このプレースホルダーを、インストールするスイートのサービスの既定データベース名に置き換えます。 このパラメーターは Document Understanding で使用されます。

重要:

構成ファイルに接続文字列を手動で設定する場合、次の方法で SQL、JDBC、または ODBC のパスワードをエスケープできます。

• SQL の場合: パスワードの最初と末尾に ' を追加し、他の ' を 2 個に増やします。
• JDBC/ODBC の場合: パスワードの先頭に { を追加し、末尾に } を追加し、他のすべての } を 2 個に増やします。

ql_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;

ql_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 example</summary>

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;"

AI Center に対して、以下の aicenter SQL 構成パラメーターを設定します。

パラメーター	説明
aicenter.ai_appmanager.sql_connection_str	AI アプリ マネージャーの JDBC 接続文字列 (JDBC 形式については以下を参照)。

注: JDBC 接続文字列が、下記の例の形式であることを確認してください。

AI Center 接続文字列の例

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

Document Understanding 接続文字列の例

注: これは、既定のデータベースを独自のデータベースで置き換える場合にのみ使用してください。

"documentunderstanding":
{
  "datamanager": {
    "sql_connection_str": "mssql+pyodbc://testadmin:[e-mail]:1433/datamanager?driver=ODBC+Driver+17+for+SQL+Server",
  }

重要: 接続文字列で指定している SQL アカウントに、すべてのデータベースに対する db_owner ロールが付与されていることを確認してください。セキュリティの制約により db_owner の使用が許可されない場合は、すべてのデータベースに対する次のロールと権限を SQL アカウントに付与する必要があります。

• db_ddladmin
• db_datawriter
• db_datareader
• dbo スキーマに対する EXECUTE 権限

監視の構成

監視のために十分なリソースをプロビジョニングするには (「監視スタックを使用する」参照)、クラスター内の vCPU の数と、メトリックの必要な保持日数について検討する必要があります。監視リソース構成の設定方法については、次の表をご覧ください。

次の表で、監視フィールドの詳細について説明します。

パラメーター	説明
prometheus_retention	日数単位。 Grafana での視覚化や Prometheus コンソールからの手動のクエリを目的として、メトリックが保持される日数です。 既定値は 7 です。
prometheus_storage_size	GB 単位。 Prometheus レプリカ 1 つあたりに確保するストレージ容量です。 適切な経験則としては、この値を次のように設定します。 0.65 * vCPU cores * (prometheus_retention / 7) 例： prometheus_retention を 14 日に設定し、クラスターが 5 つのマシンにまたがる 80 個のコアから構成されている場合は、次のようになります。 0.65 * 80 * (14 / 7) 52 * (2) 104 既定値は 45 で、これより小さな値は設定しないでください。 Prometheus でストレージ容量が不足しはじめると、具体的な修正策を含むアラートがトリガーされます。
prometheus_memory_limit	MB 単位。 Prometheus レプリカ 1 つあたりのメモリ容量の制限値です。 適切な経験則としては、この値を次のように設定します。 100 * vCPU cores * (prometheus_retention / 7) 例： prometheus_retention を 14 日に設定し、クラスターが 5 つのマシンにまたがる 80 個のコアから構成されている場合は、次のようになります。 100 * 80 * (14 / 7) 8000 * (2) 16000 既定値は、シングルノードの評価モードでは 3200 で、マルチノードの HA 対応の運用モードでは 6000 であり、これより小さい値に設定しないでください。 Prometheus でメモリが不足しはじめると、具体的な修正策を含むアラートがトリガーされます。こちらをご覧ください。

例：

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

任意: プロキシ構成を追加する

注: インストールでプロキシ サーバーの構成を行う前に、プロキシ サーバーの要件が満たされていることを確認してください。

対話型のインストーラー ウィザードを実行中終了し、高度な構成手順で 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": "<Comma separated list of ips that should not got though proxy server>"
    }

• VM 上の 30070 ポートでの送受信呼び出しを許可します。

  必須パラメーター	説明
  enabled	true または false を使用して、プロキシ設定を有効または無効化します。
  http_proxy	クラスターからの HTTP アウトバウンド要求をルーティングするために使用します。これはプロキシ サーバーの FQDN とポートとする必要があります。
  https_proxy	クラスターからの HTTPS アウトバウンド要求をルーティングするために使用します。これはプロキシ サーバーの FQDN とポートとする必要があります。
  no_proxy	プロキシ サーバー経由でルーティングしない、ホスト、IP アドレス、CIDR 形式による 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 Server のホスト metadata server address - Azure や AWS などのクラウド サービスがマシンのメタデータの取得に使用する IP アドレス 169.254.169.254

任意: マルチノードの HA 対応の運用クラスターにおけるゾーン障害に対する復元設定を有効化する

マルチノード クラスターでゾーン障害に対する復元機能を有効化するには、次の手順を実行します。

1. 使用可能な 3 つのゾーンにノードが均等に分散されていることを確認します。ベアメタル サーバーの場合、または 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 を使用して、ゾーン障害に対する復元機能を有効または無効化します。

任意: カスタムの Resolv.con を渡す

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 からは参照しないでください。