手動: 高度なインストール

このページでは、Automation Suite の cluster_config.json 構成ファイルの使用方法について説明します。

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

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

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

cluster_config.json ファイルでは、デプロイする UiPath 製品を構成できます。UiPath 製品には、次の 2 つの種類があります。

• 必須製品: 既定でインストールされ、そこで enabled フラグを使用することはできません。
• 任意製品: インストールを完了するのに必須ではありません。ただし、製品が依存関係を持つ可能性があることに注意してください。この件に関する詳細は「製品の依存関係」をご覧ください。

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
  }
}

全般的な構成

必須パラメーター	説明
fqdn	ロード バランサー (マルチノードの HA 対応の運用モード) またはマシン (シングルノード評価モード) のドメイン名です。
fixed_rke_address	負荷分散ノードの登録と kube API 要求に使用する固定アドレスです。推奨どおりロード バランサーを構成している場合は、その FQDN を指定します。その他の場合は、最初のサーバー ノードの FQDN を指定します。「ロード バランサーを構成する」をご覧ください。 設定内の最初の rke2 サーバーの IP/FQDN を指定できます。
multinode	マルチノードの HA 対応の運用プロファイルを選択する場合は、[true] に設定します。このフラグの値は、対話型のインストール ウィザードによって自動的に設定されます。内部目的にのみ使用されるものなので、手動で変更しないでください。
admin_username	ホスト組織の管理者として設定するユーザー名 (admin など)。
admin_password	設定されるホスト管理者パスワード。
rke_token	ここには、新たに生成された GUID を使用します。これは、事前共有されるクラスター固有のシークレットです。クラスターに参加させる、すべてのノードで必要です。
profile	インストールのプロファイルを設定します。使用可能なプロファイルは次のとおりです。 default: シングルノードの評価プロファイル 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) の証明書への絶対パスです。この証明機関は、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	トークンへの署名に使用する ID サービス証明書への絶対パス (前の手順で作成した自己署名証明書の場合は identity.pfx) です。サーバー証明書を使用して、インストーラーで ID 証明書を生成する場合は、空白のままにします。
identity_certificate.token_signing_cert_pass	エクスポートされたときに設定されたプレーン テキストのパスワード。
additional_ca_certs	Automation Suite の一部として実行されるすべてのサービスに信頼させる、追加の CA 証明書を含むファイルへの絶対パス。ファイルに含まれるすべての証明書は、有効な PEM 形式である必要があります。 たとえば、証明書が公的証明機関によって発行されていない場合、SQL Server の CA 証明書を含むファイルを指定する必要があります。

データベースの構成

データベース作成ワークフロー

対話型インストーラーは、以下のワークフローを使用して自動的にデータベースを作成します。

1. 対話型インストーラー スクリプトは、cluster_config.json ファイル内の sql.create_db パラメーターの値を確認します。
   • sql.create_db パラメーターが trueに設定されている場合、インストーラーはユーザーに代わってすべてのデータベースを自動的に生成します。この場合、インストーラーは既定のデータベース名と既定のテンプレートを使用し、指定したカスタム データベース名はすべて無視します。

     詳細については、「 必要なデータベースを自動的に作成する」をご覧ください。

   • sql.create_db が falseに設定されている場合は、独自のデータベースを利用する必要があります。この場合、データベースを手動で設定する必要があります。 カスタム データベース名を使用できるのは、提供されている命名規則に従っている場合です。 データベース名と接続テンプレートを組み合わせて使用してデータベース接続文字列を形成するため、この手順は重要です。 推奨される名前付け規則に従っていない場合は、SQL 接続文字列を自分で指定する必要があります。

     詳しくは、「 独自データベースを利用する」をご覧ください。

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	カタログ名を DB_NAME_PLACEHOLDER に設定した ADO.NET の完全な接続文字列。インストーラーは、このプレースホルダーを、インストールするスイートのサービスの既定データベース名に置き換えます。	Platform、Orchestrator、Test Manager、Automation Hub、Automation Ops、Insights、Task Mining、Document Understanding
sql_connection_string_template_jdbc	データベース名を DB_NAME_PLACEHOLDER に設定した JDBC の完全な接続文字列。インストーラーは、このプレースホルダーを、インストールするスイートのサービスの既定データベース名に置き換えます。	AI Center
sql_connection_string_template_odbc	データベース名を DB_NAME_PLACEHOLDER に設定した ODBC の完全な接続文字列。インストーラーは、このプレースホルダーを、インストールするスイートのサービスの既定データベース名に置き換えます。	Document Understanding

重要:

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

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

注:

既定では TrustServerCertificate は False に設定されており、SQL Server 用に追加の CA 証明書を指定する必要があります。SQL Server の証明書が自己署名証明書の場合、または社内 CA によって署名された証明書の場合はこれが必須になります。

詳細については、このページの「証明書の構成」をご覧ください。

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 サービスの既定および任意のデータベース名。

{
  "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",
  "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 の接続文字列は、既定値を独自の値で上書きする場合のみの任意の設定です。

オンライン インストールでは、手書き文字が常に有効です。

max_cpu_per-pod の既定値は 2 ですが、必要に応じて調整できます。詳細については、「Document Understanding 構成ファイル」を参照してください。

重要:

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

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

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

監視の構成

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

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

パラメーター	説明
prometheus_retention	日数単位。 Grafana での視覚化や Prometheus コンソールからの手動のクエリを目的として、メトリックが保持される日数です。 既定値は 7 です。
prometheus_storage_size	GiB 単位で指定します。 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	MiB 単位で指定します。 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
}

任意: プロキシ サーバーを構成する

注:

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

詳しくは、「手順 2: 各ノードにプロキシ構成を追加する」をご覧ください。

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

必須パラメーター	説明
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 からは参照しないでください。