Configuring input.json

input.json ファイルでは、デプロイする UiPath 製品、選択した製品に適用するパラメーター、設定、およびクラウド インフラストラクチャの設定を構成できます。クラスターに対する既定値を変更したり、何らかの高度な構成を使用したりする場合は、このファイルを更新する必要があります。

注:

一部の製品には依存関係があります。詳しくは、「製品間の依存関係」をご覧ください。

input.json を編集するには、クライアント マシン上でお気に入りのテキスト エディターを使用できます。

一般的なパラメーター	説明
kubernetes_distribution	使用する Kubernetes ディストリビューションを指定します。aks または eks を指定できます。
registries	UiPath 製品および Automation Suite の Docker イメージと Helm チャートをプルするための URL です。 registry.uipath.com
fqdn	Automation Suite のロード バランサーのエンドポイントです。
admin_username	ホスト組織の管理者として設定するユーザー名です。
admin_password	設定されるホスト管理者パスワード。
profile	既定値は変更できません。 ha: マルチノードの高可用性対応の運用プロファイル
telemetry_optout	true または false - UiPath へのテレメトリ送信をオプトアウトするために使用します。既定では、false に設定されます。 オプトアウトする場合は、true に設定してください。

"kubernetes_distribution": "aks",

  "registries": {
    "docker": {
      "url": "registry.uipath.com"
    },
    "helm": {
      "url": "registry.uipath.com"
    }
  },
  "fqdn": "replace with your fqdn",
  
  "admin_username": "replace with your UiPath admin username",
  "admin_password": "replace with your UiPath admin password",
  
  "profile": "ha",
  
  "telemetry_optout": false

UiPath® 製品

Automation Suite の製品は、インストール時に有効化/無効化するか、インストール後にいつでも有効化/無効化できます。各製品構成について詳しくは、「製品を管理する」をご覧ください。

Orchestrator の例:

"orchestrator": {
  "enabled": true,
  "external_object_storage": {
    "bucket_name": "uipath-as-orchestrator"
  },
  "testautomation": {
    "enabled": true
  },
  "updateserver": {
    "enabled": true
  }

独自のコンポーネントを利用する

Automation Suite では、独自の Gatekeeper (および OPA ポリシー)、Cert Manager、監視、ログ コンポーネントを利用できます。これらのコンポーネントを除外する場合は、Automation Suite をインストールする前に、対応するコンポーネントがクラスターに存在することを確認してください。

• 任意のコンポーネントのリストと責任マトリクスについては、「EKS/AKS の Automation Suite のスタック」をご覧ください。

• Automation Suite で検証済みのバージョンについては、相互運用性マトリクスを確認してください。

以下のように指定した場合、すべてのコンポーネントが除外されます。ただし、Automation Suite でプロビジョニングするコンポーネントは削除できます。

"exclude_components": [
    "gatekeeper",
    "opa-policies",
    "network-policies",
    "cert-manager",
    "monitoring",
    "logging",
    "velero"
  ]

証明書の設定

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

注:

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

パラメーター	説明
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	ID トークン署名証明書をエクスポートする際に設定するプレーン テキストのパスワードです。
additional_ca_certs	Automation Suite の一部として実行されるすべてのサービスに信頼させる、追加の CA 証明書を含むファイルへの絶対パス。ファイルに含まれるすべての証明書は、有効な PEM 形式である必要があります。 たとえば、証明書が公的証明機関によって発行されていない場合、SQL Server の CA 証明書を含むファイルを指定する必要があります。

インフラストラクチャの前提条件

Azure または AWS に設定した前提条件の構成の詳細を指定する必要があります。input.json のパラメーターの要件については、以下の前提条件のセクションをご覧ください。

• SQL データベース (必須)

• キャッシュ (必須)

• ストレージ (必須)

• ネットワーク (必須)

• NGINX のイングレス構成 (任意)

• プロキシ構成 (任意)

Orchestrator 固有の設定

Orchestrator はロボット ログを Elasticsearch サーバーに保存できます。この機能は、orchestrator.orchestrator_robot_logs_elastic セクションで設定できます。指定しない場合、ロボット ログは Orchestrator のデータベースに保存されます。

次の表に、orchestrator.orchestrator_robot_logs_elastic パラメーターのリストを示します。

パラメーター	説明
orchestrator_robot_logs_elastic	Elasticsearch の構成。
elastic_uri	使用する Elasticsearch インスタンスのアドレスです。URI の形式で指定する必要があります。指定すると、ユーザー名とパスワードも必要になります。
elastic_auth_username	認証に使用される Elasticsearch のユーザー名です。
elastic_auth_password	認証に使用される Elasticsearch のパスワードです。

Insights 固有の構成

Insights を有効化する場合、スケジュールされたメールやアラート メールの送信に使用する SMTP サーバーの構成を含めることができます。—これを指定しない場合、スケジュールされたメールやアラート メールは機能しません。

insights.smtp_configuration フィールドの詳細を以下に示します。

パラメーター	説明
tls_version	有効な値は TLSv1_2、TLSv1_1、SSLv23 です。TLS を使用しない場合は、すべてのキーを省略します。
from_email	アラート メールやスケジュールされたメールの送信元となるアドレスです。
host	SMTP サーバーのホスト名。
port	SMTP サーバーのポート。
username	SMTP サーバー認証用のユーザー名。
password	SMTP サーバー認証用のパスワード。
enable_realtime_monitoring	Insights のリアルタイム監視を有効化するフラグ。有効な値は true または false です。既定値は false です。

例

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

Process Mining 固有の構成

Process Mining を有効化する場合、プライマリ Automation Suite SQL Server とは別に、データ ウェアハウスとして機能するセカンダリ SQL Server を指定することをお勧めします。データ ウェアハウス SQL Server には重い負荷がかかります。この SQL Server は processmining セクションで構成できます。

パラメーター	説明
sql_connection_str	データベースをプレースホルダー Initial Catalog=DB_NAME_PLACEHOLDER に設定した .NET 形式の接続文字列。
sqlalchemy_pyodbc_sql_connection_str	カスタム Airflow メタデータ データベースの場所を表す SQLAlchemy の PYODBC 形式の接続文字列は sqlServer:1433/DB_NAME_PLACEHOLDER です。 例： mssql+pyodbc://testadmin%40myhost:mypassword@myhost:1433/AutomationSuite_Airflow?driver=ODBC+Driver+17+for+SQL+Server&TrustServerCertificate=YES&Encrypt=YES 場所 ユーザー: testadmin%40myhost 注: ユーザー名に「@」が含まれている場合は、%40 に URL エンコードする必要があります。 例: (Kerberos 認証を使用した SQL Server 設定) mssql+pyodbc://:@assql2019.autosuitead.local:1433/AutomationSuite_ProcessMining_Warehouse?driver=ODBC+Driver+17+for+SQL+Server&TrustServerCertificate=YES&Encrypt=YES&Trusted_Connection=yes
warehouse.sql_connection_str	Process Mining のデータ ウェアハウス SQL Server への .NET 形式の SQL 接続文字列。dbname のプレースホルダーは Initial Catalog=DB_NAME_PLACEHOLDER です。
warehouse.sqlalchemy_pyodbc_sql_connection_str	Process Mining のデータ ウェアハウス SQL Server への SQLAlchemy PYODBC 形式の SQL 接続文字列。dbname のプレースホルダーは sqlServer:1433/DB_NAME_PLACEHOLDER です。
warehouse.master_sql_connection_str	インストーラーが sql.create_db: true の設定を使用してデータベースを作成する場合は、Process Mining のデータ ウェアハウス SQL Server に対して .NET 形式のマスター SQL 接続文字列を指定する必要があります。接続文字列内のデータベースは、master に設定する必要があります。

注意:

Microsoft SQL Server を設定する際は、Airflow データベースと専用の Process Mining データベースがインストールされている SQL Server マシンのタイムゾーンが UTC に設定されていることを確認してください。

重要: テンプレート PYODBC 接続文字列 sql_connection_string_template_sqlalchemy_pyodbc の名前と、独自のデータベースを利用するときに使用される PYODBC 接続文字列 sqlalchemy_pyodbc_sql_connection_str の名前は異なることに注意してください。また、テンプレート SQL sql_connection_string_template と、独自のデータベースを利用するときに使用される sql_connection_str でも、接続文字列名が異なります。

重要:

独自のデータベースを利用し、input.json ファイルの processmining セクションの接続文字列 sql_connection_str と sqlalchemy_pyodbc_sql_connection_str を使用してそのデータベースを設定した場合、テンプレート接続文字列 sql_connection_string_template と sql_connection_string_template_sqlalchemy_pyodbc は指定しても無視されます。

重要:

以下のデータベースには既定のサーバー ポート 1433 を使用する必要があります。

• warehouse.sql_connection_str
• warehouse.sqlalchemy_pyodbc_sql_connection_str
• warehouse.master_sql_connection_str

非標準の SQL Server ポートはサポートされていません。

Automation Suite ロボット固有の構成

Automation Suite ロボットは、パッケージのキャッシュを使用してプロセスの実行を最適化し、実行速度を向上できます。NuGet パッケージは、インターネット/ネットワークからダウンロードするのではなく、ファイルシステムから取得します。そのためには 10 GiB 以上の領域が追加で必要で、その領域を専用ノードのホスト マシンのファイルシステム上のフォルダーに割り当てる必要があります。

パッケージのキャッシュを有効化するには、input.json の以下のパラメーターを更新する必要があります。

パラメーター	既定値	説明
packagecaching	true	true に設定すると、ロボットはローカル キャッシュを使用してパッケージを解決します。
packagecachefolder	/uipath_asrobots_package_cache	パッケージが保存されているサーバーレス エージェント ノード上のディスクの場所です。

AI Center 固有の構成

AI Center が正常に機能するには、input.json ファイルで aicenter.external_object_storage.port パラメーターと aicenter.external_object_storage.fqdn パラメーターを設定する必要があります。

手記：ファイルの external_object_storage セクションを構成した場合でも、input.json ファイルの aicenter セクションでパラメーターを構成する必要があります。

次のサンプルは、有効な input.jsonを示しています AI Center の構成

"aicenter": {
  "external_object_storage" {
    "port": 443,
    "fqdn": "s3.us-west-2.amazonaws.com"
  }
},
"external_object_storage": {
  "enabled": true,
  "create_bucket": false,
  "storage_type": "s3", 
  "region": "us-west-2", 
  "use_instance_profile": true
}
...