資格情報を更新する

ガイドライン

異なる Automation Suite コンポーネントの資格情報を更新するには、次の手順に従います。

1. input.json ファイルを生成します。
2. 各コンポーネントのセクション (SQL、Redis、ObjectStore) の説明に従って、指定したコンポーネントの新しい資格情報を input.json に指定します。
3. 各コンポーネントのセクション (SQL、Redis、ObjectStore) の説明に従って、uipathctl CLI を実行します。

input.json ファイルを生成する

次のように、最新の input.json ファイルを生成します。

• A: 次のコマンドを実行して input.json ファイルの最新バージョンを取得します。

  uipathctl manifest get-revision

• B: 次のコマンドを実行して過去の input.json ファイルすべての一覧を表示し、選択するファイルを決定します。

  uipathctl manifest list-revisions

SQL 接続文字列を更新する

Automation Suite 製品が SQL データベースへの接続に使用する接続文字列を更新する状況として、次のような複数のシナリオがあります。

• セキュリティとコンプライアンスのために、データベースへの接続に使用するパスワードを定期的にローテーションする場合。
• SQL Server の FQDN を変更する場合。
• メンテナンスのためにデータベースを別の SQL Server に移行する場合。
• 1 つ以上の接続属性 (MultiSubnetFailover など) を追加、変更、削除する場合。
• 基本認証から Kerberos と Active Directory を使用する統合認証に切り替える場合。
  重要:

  Automation Suite の製品は、SQL データベースの接続文字列を更新する際に、テーブルやスキーマを作成しません。新しい接続文字列が、現在使用しているものと同じデータベースを参照していることを確認してください。

  更新プロセス中のダウンタイムを回避するために、更新プロセスの時点で現在の接続文字列が有効であることを確認してください。更新後に、古い接続文字列を取り消すことができます。

インストール済み製品の接続文字列を更新する

Automation Suite のインストール済み製品の接続文字列を更新するには、任意のサーバー ノードに接続し、次の操作を実行します。

1. input.json ファイルを生成します。
2. インストール済みの製品の新しい接続文字列を input.json 内で指定します。
3. uipathctl を実行します。

インストール済み製品の新しい接続文字列を指定する

Automation Suite で実行される製品の接続文字列を指定する方法は 2 つあります。

• A: Automation Suite で実行されるすべての製品に共通する接続文字列テンプレートを指定します。この方法では、すべての製品に既定のデータベース名が使用されます。

• B: 各製品に固有の接続文字列を指定します。

重要:

.NET、JDBC、または ODBC のパスワードは、必ず次のようにエスケープしてください。

• .NET の場合: パスワードの先頭と末尾に ' を追加し、他のすべての ' を 2 個に増やします。

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

TrustServerCertificate=False を設定した場合、SQL Server 用に追加の CA 証明書を指定する必要が生じることがあります。SQL Server の証明書が自己署名証明書の場合、または社内 CA によって署名された証明書の場合はこれが必須になります。詳しくは、「CA 証明書を更新する」をご覧ください。

A: すべての製品に共通の接続文字列を指定する

Automation Suite で実行されるすべての製品は、共通のテンプレートの接続文字列を参照します。この方法を選択するユース ケースの 1 つとして、すべての製品のパスワードを一度に変更する場合があります。この場合、パスワードはすべての製品で同じになります。

このシナリオでは、すべての製品のデータベース名が、Automation Suite で必要とされる既定の名前である必要があります。設定したデータベース名が Automation Suite の要件を満たさない場合は、次の手順に従います。

ヒント: SQL データベース内のデータベースとその既定の名前のリストを確認します。

次の表は、製品サービスで使用できるテンプレート形式を示しています。

パラメーター	説明	製品
sql_connection_string_template	カタログ名を DB_NAME_PLACEHOLDER に設定した ADO.NET の完全な接続文字列。インストーラーは、このプレースホルダーを、インストールするスイートのサービスの既定データベース名に置き換えます。	Platform、Orchestrator、Automation Suite ロボット、Test Manager、Automation Hub、Automation Ops、Insights、Task Mining、Data Service、Process Mining
sql_connection_string_template_jdbc	データベース名を DB_NAME_PLACEHOLDER に設定した JDBC の完全な接続文字列。インストーラーは、このプレースホルダーを、インストールするスイートのサービスの既定データベース名に置き換えます。	AI Center
sql_connection_string_template_odbc	データベース名を DB_NAME_PLACEHOLDER に設定した ODBC の完全な接続文字列。インストーラーは、このプレースホルダーを、インストールするスイートのサービスの既定データベース名に置き換えます。	Document Understanding、Apps
sql_connection_string_template_sqlalchemy_pyodbc	データベース名を DB_NAME_PLACEHOLDER に設定した SQLAlchemy PYODBC の完全な接続文字列。インストーラーは、このプレースホルダーを、インストールするスイートのサービスの既定データベース名に置き換えます。 例： "sql_connection_string_template_sqlalchemy_pyodbc": "mssql+pyodbc://testadmin%40sfdev4515230-sql.database.windows.net:07%3Cl%5Bxj-%3D~[e-mail]:1433/DB_NAME_PLACEHOLDER?driver=ODBC+Driver+17+for+SQL+Server"	Process Mining

sql_connection_string_template の例

Server=tcp:sfdev1804627-c83f074b-sql.database.windows.net:1433;Initial Catalog=DB_NAME_PLACEHOLDER;Persist Security Info=False;User Id=testadmin;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;"

sql_connection_string_template_sqlalchemy_pyodbc の例

"mssql+pyodbc://testadmin%40sfdev4515230-sql.database.windows.net:07%3Cl%5Bxj-%3D~[e-mail]:1433/DB_NAME_PLACEHOLDER?driver=ODBC+Driver+17+for+SQL+Server"

注: input.json を、更新する新しい接続文字列テンプレートで更新します。

B: 各製品に固有の接続文字列を指定する

プラットフォーム

Platform サービスは、組織とテナントの管理、ライセンス管理、ユーザー管理などの管理機能を提供します。Platform サービスは既定で有効化されており、削除することはできません。既定のデータベース名は AutomationSuite_Platform です。

Platform サービスの接続文字列を指定するには、次のセクションを input.json ファイルに追加するか、更新します。

"platform": {
  "sql_connection_str": "***" // dotnet connection string 
}

Orchestrator

Orchestrator の既定のデータベース名は AutomationSuite_Orchestrator です。

Orchestrator サービスの接続文字列を指定するには、次のセクションを input.json ファイルに追加するか、更新します。

"orchestrator": {
  "sql_connection_str": "***" // dotnet connection string
}

Automation Suite ロボット

Automation Suite ロボットと Orchestrator は、既定では同じデータベースを共有します。データベース名は AutomationSuite_Orchestrator です。

Automation Suite ロボットの接続文字列を指定するには、次のセクションを input.json ファイルに追加するか、更新します。

"asrobots": {
  "sql_connection_str": "***" // dotnet connection string
}

Automation Hub

Automation Hub の既定のデータベース名は AutomationSuite_Automation_Hub です。

Automation Suite サービスの接続文字列を指定するには、次のセクションを input.json ファイルに追加するか、更新します。

"automation_hub": {
  "sql_connection_str": "***" // dotnet connection string
}

Automation Ops

Automation Ops の既定のデータベース名は AutomationSuite_Platform です。

Automation Ops サービスの接続文字列を指定するには、次のセクションを input.json ファイルに追加するか、更新します。

"automation_ops": {
  "sql_connection_str": "***" // dotnet connection string
}

AI Center

AI Center の既定のデータベース名は AutomationSuite_AICenter です。

AI Center サービスの接続文字列を指定するには、次のセクションを input.json ファイルに追加するか、更新します。

"aicenter": {
  "sql_connection_str": "***" // jdbc connection string
}

Apps (アプリ)

Apps の既定のデータベース名は AutomationSuite_Apps です。

Apps サービスの接続文字列を指定するには、次のセクションを input.json ファイルに追加するか、更新します。

"apps": {
  "sql_connection_str": "***" // odbc connection string
}

Data Service

Data Service の既定のデータベース名は AutomationSuite_DataService です。

Data Service サービスの接続文字列を指定するには、次のセクションを input.json ファイルに追加するか、更新します。

"dataservice": {
  "sql_connection_str": "***" // dotnet connection string
}

Document Understanding

Document Understanding の既定のデータベース名は AutomationSuite_DU_Datamanager です。

Document Understanding サービスの接続文字列を指定するには、次のセクションを input.json ファイルに追加するか、更新します。

"documentunderstanding": { 
"enabled": true,
"sql_connection_str": "***" // dotnet connection string,
"datamanager": {
 "sql_connection_str": "***" // odbc connection string
 }
}

Insights

Insights の既定のデータベース名は AutomationSuite_Insights です。

Insights サービスの接続文字列を指定するには、次のセクションを input.json ファイルに追加するか、更新します。

"insights": {
  "sql_connection_str": "***" // dotnet connection string
}

Process Mining

Process Mining の既定のデータベース名は AutomationSuite_ProcessMining_Metadata です。

Process Mining サービスの接続文字列を指定するには、次のセクションを input.json ファイルに追加するか、更新します。

"process_mining": {
  "enabled": true,
  "sql_connection_str": "***" // dotnet connection string
  "sqlalchemy_pyodbc_sql_connection_str": "", 
  "warehouse": {
     "sql_connection_str": "",
     "master_sql_connection_str": "",
     "sqlalchemy_pyodbc_sql_connection_str": ""
  }
}

Task Mining

Task Mining の既定のデータベース名は AutomationSuite_Task_Mining です。

Task Mining サービスの接続文字列を指定するには、次のセクションを input.json ファイルに追加するか、更新します。

"task_mining": {
  "sql_connection_str": "***" // dotnet connection string
}

Test Manager

Test Manager の既定のデータベース名は AutomationSuite_Test_Manager です。

Test Manager サービスの接続文字列を指定するには、次のセクションを input.json ファイルに追加するか、更新します。

"test_manager": {
  "sql_connection_str": "***" // dotnet connection string
}

サービス インストーラーを実行する

オンライン

サービス インストーラーをオンライン環境で実行するには、次のコマンドを使用します。

cd /opt/UiPathAutomationSuite/{version}/installer

./install-uipath.sh -i ./cluster_config.json -s -o output.json --accept-license-agreement

オフライン

サービス インストーラーをオフライン環境で実行するには、次のコマンドを使用します。

cd /opt/UiPathAutomationSuite/{version}/installer

./install-uipath.sh -i ./cluster_config.json -s --install-type offline -o output.json --accept-license-agreement

Redis 資格情報を更新する

Redis の新しい資格情報を指定する

input.json ファイルの次のセクションを、新しいパスワードとホスト名で更新します。

"fabric": {
  "redis": {
    "hostname": "new_hostname",
    "password": "new_password",
    "port": 6380,
    "tls": true
  }

uipathctl インストーラーを実行する

Redis の資格情報の更新を完了するには、次のコマンドを使用して uipathctl インストーラーを実行します。

uipathctl manifest apply input.json --only redis --versions versions.json

注:

uipathctl でドライラン フラグを使用すると、コマンドの結果を適用することなく出力できます。

ObjectStore の資格情報を更新する

input.json ファイルの次のセクションを、新しいaccess_key、secret_key、acount_key、account_name で更新します。

"external_object_storage": {
  "enabled": false, // <true/false>
  "create_bucket": true, // <true/false>
  "storage_type": "s3", // <s3,azure,aws>
  "fqdn": "",  // <needed in case of aws non instance profile>
  "port": 443, // <needed in case of aws non instance profile>
  "region": "", 
  "access_key": "", // <needed in case of aws non instance profile>
  "secret_key": "", // <needed in case of aws non instance profile>
  "use_managed_identity": false, // <true/false>
  "bucket_name_prefix": "",
  "bucket_name_suffix": "",
  "account_key": "", // <needed only when using non managed identity>
  "account_name": "",
  "azure_fqdn_suffix": "core.windows.net",
  "client_id": "" // <optional field in case of managed identity>
},

uipathctl インストーラーを実行する

オブジェクト ストアの資格情報の更新を完了するには、次のコマンドを使用して uipathctl インストーラーを実行します。

uipathctl manifest apply input.json --versions versions.json

注:

uipathctl でドライラン フラグを使用すると、コマンドの結果を適用することなく出力できます。