通知を受け取る

UiPath Automation Suite

UiPath Automation Suite ガイド

手順 3: デプロイ後の手順

このページでは、デプロイの完了後に実行する必要のある手順について説明します。

📘

注:

Azure Bastion を使用する場合、\ を使用して複数行に分割されているコマンドをコピーして貼り付けようとすると、期待どおりに動作しない可能性があることに注意してください。改行が正しく解釈されるようにするには、コンソールのクリップボード ウィジェットを使用します。

インストールを検証する


Automation Suite が正常にインストールされたかどうかを確認するには、flags コンテナー内のストレージ アカウントに移動する必要があります。installResult というコンテナー内の自動生成ファイルの内容が successful である場合、インストールは完了しています。インストールに失敗した場合は、failed という内容になります。

 

証明書を更新する


🚧

重要

インストール プロセスによって、ユーザーに代わって自己署名証明書が生成されます。ただし、Azure のデプロイ テンプレートには、自動生成された自己署名証明書を使用する代わりに、CA によって発行されたサーバー証明書をインストール時に指定するオプションもあります。

自己署名証明書は 90 日で有効期限が切れるので、インストールが完了したら速やかに、信頼された CA によって署名された証明書に置き換える必要があります。証明書を更新しないと、90 日後にインストールが停止します。

手順については、「証明書を管理する」をご覧ください。

 

フラグとログを検索する

Automation Suite のインストール プロセスやその他の操作に関する詳細情報が必要な場合はまずは、クラスターのデプロイおよびメンテナンス時にさまざまなフラグやログを保存するために使用されるストレージ アカウントを確認することをお勧めします。

ストレージ アカウントを見つけるには、次の手順に従います。

  1. デプロイが実行されたリソース グループに移動します。
  2. リソースの種類「Storage Account」でフィルター処理します。
  3. st で名前が終わるストレージ アカウントを検索します。たとえば、次のとおりです。
14731473
  1. ストレージ アカウントを選択し、[Containers] をクリックします。オプションは、 [flags][logs]です。
14951495

flags コンテナー

フラグ コンテナーには、管理または単純にさまざまな操作のステータスを報告するために必要な必要ないろいろなフラグまたはファイルを格納します。新しいクラスターでは、 flags コンテナーの内容は通常次の例のように表示されます。

14021402

フラグ コンテナー内のファイルは、クラスター上の Automation Suite のインストール プロセスや、インスタンスの更新などの特定のクラスター操作などのさまざまな操作を管理するために使用されます。たとえば、次のとおりです。

  • uipath-server-000000.success は、クラスターの特定のノードでのインフラストラクチャのインストールが正常に完了しことを示します。
  • installResult は、インストール全体が成功すると success を読み取ります。

logs コンテナー

通常、操作の実行時には、logs コンテナー内にログ ファイルが生成されます。新規クラスター上では、ログ コンテナーの内容は、通常、次の例のように表示されます。

14801480

logs コンテナー内のすべてのファイルは、インストール プロセスの特定の手順のログを表します。たとえば、次のとおりです。

  • infra-uipath-server-000000.log は、インフラストラクチャのインストール ログを保存します。
  • fabric.log は、ファブリックのインストールに関するログを保存します。
  • services.log は、アプリケーションとサービスのインストールに関するログが保存されます。

 

デプロイの出力にアクセスする


インストールが完了したら、[出力] タブのデプロイの出力にアクセスする必要があります。
そのためには、自身のリソース グループに移動し、[Deployments] → [mainTemplate] (または [Microsoft.Template-DateTime] など) → [出力] に移動します。

18441844 15011501 24992499

 

デプロイの出力


OutputDescription
DocumentationA link to the documentation.
URLThe Load Balancer URL. Can be used for direct access.

If custom domains were enabled this is the domain that you would use for the CNAME binding.
KeyVaultURLThe Azure Portal URL for the Key Vault created by the deployment. It contains all the secrets (credentials) used in the deployment.
ArgoCDURLThe URL for accessing ArgoCD. This is available within the VNet. External access to this URL must be set up as described in: Step 4: Configuring the DNS.
ArgoCDPasswordThe password used to log in to the ArgoCD portal.
HostAdminUsername and HostAdminPasswordThe credentials used for Host Administration.
ClusterAdministrationURLThe URL for the Cluster Administration portal.

デプロイで使用されるすべての資格情報は、デプロイ時にプロビジョニングされた Key Vault 内にシークレットとして保存されます。シークレットにアクセスするには、リソース グループ内のリソースをフィルター処理し、Vault を検索して、[シークレット] をクリックします。

📘

注:

[シークレット] タブに「The operation “List” is not enabled in the key vault’s access policy」という警告が表示された場合は、次の手順を実行します。

  1. [アクセス ポリシー] → [アクセス ポリシーの追加] → [テンプレートからの構成] → [シークレットの管理] → [プリンシパルの選択] に移動します。
  2. ユーザーを選択し、[保存]をクリックします。
  3. [シークレット] に戻ります。警告が消え、シークレットが表示されるはずです。
18431843

 

クラスターの仮想マシンにアクセスする


仮想マシンは、プライベート VNet 内でプロビジョニングされます。次の手順に従って、Azure Bastion を介して仮想マシンにアクセスできます。

  1. Automation Suite をデプロイしたリソース グループに移動します。

  2. エージェント、GPU エージェント、およびサーバー仮想マシンはスケール セット内にあるため、目的のインスタンスを含むスケール セットに移動する必要があります。

21572157
  1. [設定] タブの [インスタンス] セクションに移動します。
25122512
  1. 接続する仮想マシンの名前をクリックします。
21762176
  1. [接続] ボタンをクリックし、ドロップダウン メニューから [Bastion] を選択します。
25282528
  1. デプロイ時に入力した資格情報 (資格情報 Key Vaultの [シークレット] にある [管理者のユーザー名] および [管理者のパスワード] パラメーター) を入力し、[接続] をクリックします。
15881588

 

DNS の要件


As mentioned in Step 1: Preparing your Azure Deployment, the Automation Suite Azure deployment creates a Load Balancer with a public IP and a DNS label associated. This DNS label is Microsoft-owned.

デプロイでは、さらに、クラスター VNet 内でプライベート DNS ゾーンがプロビジョニングされ、インストールおよび構成プロセスで使用されるいくつかのレコードも追加されます。

外部マシンから接続する場合、プライベート DNS ゾーンを使用してさまざまなサービスの DNS を解決することはできないため、これらのレコードを自身のホスト ファイルに追加する必要があります。
See Step 4: Configuring the DNS for more details.

これで、クラスター上で実行されるさまざまなサービスに接続できるようになります。

 

Accessing the Cluster Administration portal


The Cluster Administration portal is a centralized location where you can find all the resources required to complete an Automation Suite installation and perform common post-installation operations. For details, see Getting started with the Cluster Administration portal.

To access the Cluster Administration portal, take the following step:

  1. URL: https://${CONFIG_CLUSTER_FQDN}/uipath-management に移動します。

📘

You do not need any credentials to access the Cluster Administration portal.

 

Automation Suite の一般インターフェイスにアクセスする


一般的な用途での Automation Suite ユーザー インターフェイスは、組織の管理者とユーザーの両方に対するポータルとして機能します。これは、誰もがすべての Automation Suite 領域 (管理ページ、プラットフォーム レベルのページ、サービス固有ページ、およびユーザー固有ページ) にアクセスできる、組織レベルの共通リソースです。

See Interface tour for more details.

Automation Suite にアクセスするには、次の手順に従います。

  1. URL: https://${Loadbalancer_dns} (<loadbalancer_dns> は、ロード バランサーの DNS ラベルであり、出力の下にあります) に移動します。

  2. 既定の組織に切り替えます。

  3. ユーザー名は orgadmin です。

  4. [Key Vault] から [シークレット][ホスト管理者のパスワード] に進み、パスワードを取得します。

 

ホストの管理にアクセスする


システム管理者は、ホスト ポータルで Automation Suite インスタンスを構成します。このポータルから構成した設定は、組織全体に継承され、一部は組織レベルで上書きできます。

See Managing system administrators for more on host administrators.
See Interface tour for more on the host portal.

ホスト管理にアクセスするには、次の手順に従います。

  1. URL: https://${Loadbalancer_dns} (<loadbalancer_dns> は、ロード バランサーの DNS ラベルであり、[出力] の下にあります) に移動します。

  2. Host 組織に切り替えます。

  3. 以前に [UiPath 管理者のユーザー名] パラメーターの値として指定したユーザー名を入力します。

  4. 以前に [UiPath 管理者のパスワード] パラメーターの値として指定したパスワードを入力します。[Key Vault] から [シークレット][ホスト管理者のパスワード] に進み、パスワードを取得します。

 

ArgoCD にアクセスする


ArgoCD コンソールを使用して、インストールした製品を管理できます。

ArgoCD にアクセスするには、次の手順に従います。

  1. URL: https://alm.${Loadbalancer_dns} (<loadbalancer_dns> は、ロード バランサーの DNS ラベルであり、[出力] の下にあります) に移動します。この URL への外部アクセスは、「手順 4: DNS を構成する」に示すように設定する必要があることに注意してください。

  2. ユーザー名は admin です。

  3. パスワードにアクセスするには、[出力] タブ、または資格情報 Key Vault に移動します。

 

Rancher にアクセスする


Automation Suite では、Rancher を使用してすぐに使えるクラスター管理ツールを提供します。これにより、クラスターを管理し、監視やトラブルシューティングにアクセスすることができます。

See Rancher documentation for more details.
See Using the monitoring stack for more on how to use Rancher monitoring in Automation Suite.

Rancher コンソールにアクセスするには、次の手順に従います。

  1. URL: https://monitoring.${Loadbalancer_dns} (<loadbalancerdns> は、ロード バランサーの DNS ラベルであり、デプロイの [出力] 内にあります) に移動します。

  2. ユーザー名は admin です。

  3. パスワードにアクセスするには、以下を実行します。

kubectl get secrets/rancher-admin-password -n cattle-system \
-o "jsonpath={.data['password']}" | echo $(base64 -d)

 

クラスターをスケーリングする


デプロイからプロビジョニングされた計算リソースは、スケーリングを容易にする Azure スケール セットで構成されます。

サーバー ノード、エージェント ノード、特殊なエージェント ノード (GPU ノードなど) の追加など、特定のスケール セットに手動でリソースを追加することができます。

特定のスケール セットを指定することにより手動でスケーリングを実行し、直接リソースを追加できます。

そのためには、以下の手順に従ってください。

  1. Azure Portal に移動し、特定のスケール セットに対してフィルター処理します。
18381838
  1. 適切なスケール セットを選択し、[スケーリング] をクリックします。
15811581
  1. 横にあるスライダーまたは入力フィールドを使用して [インスタンス数] フィールドを変更し、[保存] をクリックします。

📘

注:

サーバーのスケール セットの場合、インスタンス数は奇数である必要があります。

  1. スケーリング処理はバックグラウンドで開始され、完了すると新しいリソースが使用可能となります。

 

Azure VM のライフサイクル操作


👍

Azure では、シャットダウンの準備をするために最大で 15 分の時間枠が許可されていますが、Automation Suite ノードの正常終了にかかる時間は、20 分 (エージェント ノードおよび GPU エージェント ノードの場合) から数時間 (サーバー ノードの場合) まで幅があります。


データ損失を避けるために、サーバーの VMSS アップグレード ポリシーを手動に設定し、サーバー仮想マシンでスケール セット アクションからの保護を有効化します。そのため、提供されている Runbook を使用してサーバーのライフサイクルを管理することをお勧めします。


The InstanceRefresh, RemoveNodes, RemoveServers, and CheckServerZoneResilience runbooks are supported only for multi-node HA-ready production deployments.


Runbook の実行後のサーバーの数は、奇数かつ 3 より大きくする必要があります (たとえば、サーバーが 4 つの場合はインスタンスの更新を実行できません。合計で 5 つの場合はサーバーを削除できません)。


VMSS 内のすべての仮想マシンのステートは、Running である必要があります。


一度に実行する Runbook は 1 つだけにする必要があります。

🚧

The InstanceRefresh, RemoveNodes, and RemoveServers runbooks are affected by an issue causing node removal operations to fail if Process Mining (AirFlow) and/or Automation Suite Robots service pods are scheduled on the node.

 

InstanceRefresh

説明

The InstanceRefresh runbook has the following use cases:

  • サーバー、エージェント、GPU スケール セット上で VMSS OS SKU を更新します。
  • 1 つ以上の VMSS に対してノード ローテーション操作を実行します。
  • あらかじめ VMSS に適用されていたその他の VMSS 構成変更。

使用状況

  1. Go to the Azure Portal and search for the resource called InstanceRefresh.

  2. [開始] ボタンをクリックして、パラメーター リストを開きます。以下の点を考慮してパラメーターを完成させます。
    ノード ローテーション操作が VMSS で実行されるのは、パラメーター REFRESH<node_type>True に設定されている場合だけです。複数の REFRESH<node_type> パラメーターが True に設定されている場合、VMSS ノード ローテーションは、サーバー -> エージェント -> GPU エージェントの順番に実行されます。
    VMSS OS SKU を更新するには、NEWOSVERSION パラメーターを指定する必要があります。Azure Marketplace で利用可能な仮想マシン イメージの SKU は、az vm image list-skus --location <deployment_location> --offer RHEL --publisher RedHat --output table を使用して確認できます。現在の仮想マシンは自動的には最新モデルに更新されません (そのためには、ノード ローテーション操作が必要です)。
    [OK] ボタンをクリックして Runbook を開始します。

25472547

実装の詳細

The InstanceRefresh runbook is a wrapper for the RemoveNodes runbook. As a result, the status is tracked while running RemoveNodes. It updates all the VMSS OS versions (if needed) and extracts, based on the received parameters, the hostname for the node rotation operation and forwards them to the RemoveNodes. If the cluster has exactly three servers, the InstanceRefresh runbook creates three new servers; otherwise, RemoveNodes handles the scale-up to maintain at least one server in each Availability Zone at all times.

 

RemoveNodes

説明

The `RemoveNodes runbook has the following use cases:

  • 指定したノードを Automation Suite クラスターから削除します。
  • 1 つまたは 2 つの VM に対してノード ローテーション操作を実行します。

使用状況

  1. 削除するノードのコンピューター名を検索します。そのためには、VMSS に移動し、[Settings] セクションの [Instances] をクリックします。
25082508
  1. Go to the Azure Portal and search for the resource called RemoveNodes.
  2. [開始] ボタンをクリックして、パラメーター リストを開きます。以下の点を考慮して、パラメーターを完成させます。
  • NODESTOBEREMOVEDCOMPUTERNAME は、削除する仮想マシンのコンピューター名のコンマ区切りリストです (例: pxlqw-agent-000009,pxlqw-agent-00000A)。これは唯一の必須パラメーターです。一度に 1 つの VMSS からノードを削除することをお勧めします。
  • ISINSTANCEREFRESH and THREESERVERSSCENARIO are flags populated by the InstanceRefresh wrapper.
    [OK] ボタンをクリックして Runbook を開始します。
25602560

実装の詳細

The RemoveNodes runbook has a recursive approach to overcome the 3-hour fair share timeout. It removes or repaves the first or the first two nodes (the number is chosen in order to fulfill the odd number of servers constraint) from the received list and reruns another instance of the runbook with the remaining list.

ノードに対してノード再舗装操作を実行するには、次の手順を実行する必要があります。

  1. 削除されるノードの数に基づいて、1 つまたは 2 つの仮想マシンを使用して VMSS をスケールアウトします。
  2. 古いインスタンスに対してノードの削除を実行します。

ノードに対してノード削除操作を実行するには、次の手順を実行する必要があります。

  1. インスタンスを遮断およびドレインします。この操作は、エージェントの場合は 20 分後、サーバーの場合は number_of_instances * 60 分後にタイムアウトします。
  2. インスタンスの rke サービスを停止します。この操作は 5 分後にタイムアウトします。
  3. ノードを Automation Suite クラスターから削除し、VM を削除します。この操作は、エージェントの場合は 20 分後、サーバーの場合は number_of_instances * 60 分後にタイムアウトします。

 

RemoveServers

説明

The RemoveServers runbook has the following use case:

  • サーバーを Automation Suite クラスターから削除する。

使用状況

  1. Go to the Azure Portal and search for the resource called RemoveServers.
  2. [開始] ボタンをクリックして、パラメーター リストを開きます。以下の点を考慮して、パラメーターを完成させます。
  • REMOVEDSERVERSCOUNT is the number of servers that will be removed. We recommend removing no more than 2 servers at a time in order not to hit the fair share timeout.
25362536

実装の詳細

The RemoveServers runbook removes the number of servers received as a parameter from the Availability Zones with the most VMs.

 

CheckServerZoneResilience

説明

The CheckServerZoneResilience runbook scales out the server VMSS and uses the RemoveServers runbook to balance the servers across Availability Zones. This is part of the InstanceRefresh flow and should not be run manually.

 

AddGpuNode

説明

In the scenario where the initial deployment was created without a GPU node, we do create the VM Scale Set, but have a different SKU for to prevent zone/SKU availability issues. This runbook changes the SKU to a GPU SKU and adds a node.

🚧

Do not scale the initial GPU VMSS created before running this runbook if the initial deployment was created without GPU nodes.

使用状況

To use this runbook, take the following steps:

  1. Navigate to the resource group where you deployed Automation Suite, then identify and click Automation Account.
  2. Click Runbooks and then the AddGPUNode runbook.
  3. Provide a name for SKU you want to have and click Start.

パラメーター:
skuName – the SKU for the GPU nodes VMSS.

許容値:

  • Standard_NC8as_T4_v3
  • Standard_NC12s_v3
  • Standard_NC24s_v3

RegisterAiCenterExternalOrchestrator

説明

The runbook registers AI Center to the external Orchestrator provided at deployment time.

使用状況

The document exposes a single mandatory parameter, IdentityToken, which is an installation access token generated by the external Identity service. Since the token has a short availability (approximately 1-2 hours), we recommend generating it just before running runbook. For instructions, see Installation key.

BackupCluster

説明

The BackupCluster runbook helps you back up you cluster.

使用状況

  1. Navigate to the resource group where you deployed Automation Suite, then identify and click the Automation Account.
14771477
  1. Click Runbooks and then the BackupCluster runbook.
18341834
  1. Provide a name for the backup you want to create.
18331833
  1. To start a backup operation for the Automation Suite cluster, click the Start button at the top of the page.
18231823
  1. Once the status of the runbook job is Completed, the backup operation is complete. If the status of the runbook job is Failed, you can check the logs in the storage account for more information.
18431843

 

GetAllBackups

説明

The GetAllBackups runbook helps you view a list of all available backups, both scheduled and manual.

12161216

 

RestoreClusterInitialize, RestoreSnapshot

説明

These runbooks help you perform a restore of the cluster.

使用状況

📘

When starting the restore process, we put the cluster in maintenance mode. Once the restore process is successful, we take the cluster out of maintenance mode.

To perform a restore operation, take the following steps:

  1. Identify the restore files you want to use. To do this, navigate to your Automation Suite deployment Automation Account, and run the GetAllBackups runbook.
18421842 18351835
  1. When the runbook job is complete, check the bottom of the Output tab for a list of available backups. Select the one you want to use in the restore operation and copy it.

  2. Navigate back to the Automation Account and run the RestoreClusterInitialize runbook. For the parameter, paste the name of the previously copied backup file. At this point, the restore process is started.

18391839
  1. The RestoreSnapshot job is started automatically. When the job is done, the restore process is complete.

📘

Logs are present in the storage account (ending with st), in the backups container, under the restores/<backup-name>/ folder, where backup-name is the name of the backup used to perform the restore.

  1. After a restore, you should confirm that the cluster is in a good state (see Validating the installation or any ArgoCD troubleshooting link). After this, you have the option to enable the backup on the cluster by running the RestoreClusterFinalize runbook with the same parameter as in the previous step. This enables backups for the cluster.

 

トラブルシューティング

  • 仮想マシンが Automation Suite クラスターに参加できない場合、ロールバックが試行されます。新たに作成された仮想マシンは、通常のノード削除と同じ手順に従います (遮断、ドレイン、rke サービスの停止、クラスターからのノードの削除、仮想マシンの削除)。参加ノードの手順のログは、ストレージ アカウント内の BLOB (infra-<hostname>.log など) 内の [logs] コンテナー内にあります。
  • In case of a failure while deleting nodes, any runbook will stop and display the logs for the step that failed. Fix the issue, complete the process manually or using the RemoveNodes runbook. You can find all the logs in the storage account, inside the logs container, as follows:
    • 遮断およびドレイン – <timestamp>-<runbook_abreviation>-drain_nodes.log
    • rke サービスの停止 – <timestamp>-<runbook_abreviation>-stop_rke.log
    • クラスターからノードを削除する – <timestamp>-<runbook_abreviation>-remove_nodes.log
  • In case of a timeout, you should wait for the step to finish its execution, check the logs, and complete the process manually or using the RemoveNodes runbook. All runbooks use the Azure Run Command feature to execute code in the context of the VMs. One limitation of this method is that it does not return the status of the execution. Therefore, the steps for cordoning, draining, and stopping the rke service run asynchronous, and the status is kept with blobs in the following format: <timestamp>-<runbook_abreviation>-<step_name>.<success/fail>.

15 日前に更新


手順 3: デプロイ後の手順


このページでは、デプロイの完了後に実行する必要のある手順について説明します。

改善の提案は、API リファレンスのページでは制限されています

改善を提案できるのは Markdown の本文コンテンツのみであり、API 仕様に行うことはできません。