通知を受け取る

UiPath Automation Suite

UiPath Automation Suite ガイド

uipathctl.sh を使用する

このページでは、uipathctl.sh スクリプトの使用方法について説明します。

★削除★ uipathctl.sh script provides an automated way to upgrade a cluster to a newer version, configure a backup, restore a cluster, and more, by running it on one node. The automation of these tasks is done via the IT automation tool Ansible.

要件


Ansible は、SSH メカニズムを使用して任意のホスト ノードまたはマシンにログインし、タスクを実行します。
Before running the uipathctl.sh script, you must take the following steps:

  1. Ansible ホスト ノードを識別します。
  2. ノードの SSH 署名を既知のホストに追加します。
  3. SSH 認証方法を設定します。
  4. Ansible およびその他の前提条件ツールをインストールします。

手順については、以下のセクションをご覧ください。

 

Ansible ホスト ノードを識別する


Ansible ホスト ノードは、Ansible をインストールするマシンです。クラスター内ですべてのオートメーションを実行するために必要な権限が付与されるように、このマシンはサーバー ノードである必要があります。

オンライン インストールの場合、Ansible ホスト ノードは任意のサーバー ノードにすることができます。

In offline installations, the Ansible host node must be the primary server node on which you mounted the UiPath bundle disk in the /uipath location. If there is no server node with the UiPath bundle disk attached, you can simply mount an additional disk to any of the existing server nodes and consider it to be the Ansible host node.

 

ノードの SSH 署名を既知のホストに追加する


To add the SSH signature of your node to the known hosts, add the private IP address of each node in the cluster to the known_hosts file in the Ansible host node.

Run the following command on the Ansible host node by replacing <node-private-ip> with the private IP address of each node in the cluster, one at a time.

ssh-keyscan -H <node-private-ip> >> ~/.ssh/known_hosts

 

SSH 認証方法を設定する


Ansible は、次の 2 つの SSH メカニズムをサポートしています。

 

オプション 1: キーベースの SSH 認証 (推奨)

手順 1: SSH キーを設定する

SSH キー認証メカニズムでは、秘密キーと公開キーの組み合わせを使用します。
公開キーをコピーすることにより、他のすべてのノードで Ansible ホスト ノードの公開キーへのアクセス権を付与してください。

If you do not have an SSH key, you can generate one by running the ssh-keygen command.

SSH キーを生成する

You can generate a new SSH key using the ssh-keygen command. To generate the new SSH key, just run ssh-keygen command and follow the instructions.

新しい SSH キーを生成するには、次の手順を実行します。

  1. Generate a new SSH key using the ssh-keygen command.
  2. キーの場所を書き留めておきます。既定値は次のとおりです。
    • Public Key: ~/.ssh/id_rsa.pub
    • Private Key: ~/.ssh/id_rsa
  3. 公開キーをコピーすることにより、他のすべてのノードで Ansible ホスト ノードの公開キーへのアクセス権を付与します。

各ノードの公開キーへのアクセス権を付与する

To grant access to the public key, copy it to all nodes in the cluster (including current node) using the ssh-copy-id command. If the path of the SSH public key is not ~/.ssh/id_rsa.pub, make sure to replace it accordingly.

ssh-copy-id -i ~/.ssh/id_rsa.pub [email protected]

手順 2: Ansible に SSH キー アクセスを提供する

Ansible は、SSH のメカニズムを使用してホスト マシンにログインし、必要なインストールを実行します。このため、Ansible に SSH キー アクセスを提供する必要があります。

次のいずれかの方法から選択します。

Option 1: Using ssh-agent (recommended)

By default, Ansible uses ssh-agent to obtain access to nodes. For more information about ssh-agent, see ssh-agent manual.

To add a new key to ssh-agent, run the following command:

eval "$(ssh-agent -s)"
ssh-add ~/.ssh/id_rsa

オプション 2: 保護されていない秘密キーを使用する

📘

注:

このオプションは、秘密キーがパスフレーズで保護されていない場合にのみサポートされます。

This method entails using the private key interactively, by adding the --ansible-private-key parameter to your the uipathctl.sh script. The parameter takes the absolute path of private key and uses it for authentication.

 

オプション 2: パスワードベースの SSH 認証

If you opt for password-based SSH authentication, you must provide the --ansible-ask-password parameter to uipathctl.sh script. This parameter will prompt you to provide the password for authentication.

 

Ansible およびその他の前提条件ツールをインストールする


Ansible およびその他の前提条件ツールがインストールされているかどうかを確認する

前に選択した Ansible ホスト ノードに、Ansible と以下のその他のサポート ツールがインストールされていることを確認する必要があります。

  • ansible (v2.8 以上)
    To check if ansible was installed, run:
ansible --version &>/dev/null || echo "Error: Ansible is not installed"
  • ansible-playbook
    To check if ansible-playbook was installed, run:
ansible-playbook --version &>/dev/null || echo "Error: Ansible Playbook is not installed"
  • sshpass – Required only when using password for authentication along with the --ansible-ask-password パラメーターに関係なく更新されます。
    To check if sshpass was installed, run:
sshpass -V &>/dev/null || echo "Error: sshpass is not installed"
  • zip
    To check if zip was installed, run:
zip --version &>/dev/null || echo "Error: zip is not installed"

🚧

重要

前のコマンドのいずれかでエラーが発生する場合、対象のパッケージがマシンにインストールされていません。必要なツールをすべてインストールするには、次のセクションの手順を実行します。すべてのツールが既にインストールされている場合、以下の手順は省略できます。

Ansible およびその他の前提条件ツールをインストールする

Ansible とその他の関連パッケージをインストールするには、次の手順を実行します。

  1. Navigate to the installer folder on the Ansible host node. The installer is usually located in the /opt/UiPathAutomationSuite/{version} folder.

  2. 次のコマンドを実行します:

  • オンラインの場合:
./uipathctl.sh install-prerequisites --install-type online --accept-license-agreement
  • オフラインの場合:

You need an additional Ansible tarball, which contains Ansible and other dependent packages. Download ansible.tar.gz and store it anywhere outside the installer folder. For download instructions, see ansible.tar.gz.
条件分岐 (if) ansible.tar.gz is located in some different location, update the absolute location for the --offline-prerequisites-bundle パラメーターに関係なく更新されます。

./uipathctl.sh install-prerequisites --install-type offline --offline-prerequisites-bundle ../ansible.tar.gz --accept-license-agreement

 

Ansible の高度な構成


Generating the Ansible inventory.ini file

In some scenarios, such as when configuring the backup or upgrading, Automation Suite automatically generates the inventory.ini file for Ansible. However, there are few situations where you must build and provide the inventory.ini file to Ansible. For example:

  • While restoring the cluster from the backup data. This is because at the time of restore there is no healthy cluster to derive inventory.ini です。
  • ユーザー名や SSH キーなど、ノードごとの固有性が非常に高い高度な構成を提供する場合。

For more details, see How to build your own inventory.

The following code block displays the inventory template that the uipathctl.sh script understands.

[FIRST_SERVER]
'10.0.1.1'

[SECONDARY_SERVERS]
'10.0.1.2'
'10.0.1.3'

[AGENTS]
'10.0.1.4'
'10.0.1.5'

[TASKMINING]
'10.0.1.6'

[GPU]
'10.0.1.7'

[all:vars]
ansible_connection=ssh
ansible_timeout=10
ansible_user=admin

Group

Value

[FIRST_SERVER]

The starting point where you run the uipathctl.sh script. This is also called the Ansible host node.
You must provide the Private IP address for this node.

[SECONDARY_SERVER]

The group of other server nodes in the cluster.
You must provide the Private IP address of all the other server nodes.

[AGENTS]

The group of agent nodes in the cluster.
You must provide the Private IP address of all agent nodes.

[TASKMINING]

The group of Task Mining nodes in the cluster.
You must provide the Private IP address of all the Task Mining nodes.

[GPU]

The group of GPU nodes in the cluster.
You must provide the Private IP address of all the GPU nodes.

[all:vars]

The group of variables applied to all the previously defined host groups.
You can provide the variables per group or per host node. For details, see Assigning a variable to many machines: group variables.

 

Ansible 変数ファイルを生成する

For Ansible orchestration on other nodes, you must define some parameters that Ansible uses to determine the location of the installer and corresponding files on other nodes. These parameters are define in the Yaml file and provided to Ansible.

If you want to modify the default configuration, create a file in following format and provide it to uipathctl.sh using --ansible-variables-file です。

#Path where installer zip is available. By default, uipathctl.sh takes the current folder and compress it to zip before copying it to other nodes.
installer_path: /path/to/installer.zip
# Path where installer will be copied on nodes
target_installer_base_path: /opt/UiPathAutomationSuite/<version>/installer
# Install type - online or offline
install_type: online
# Path on nodes where offline bundles will be copied
target_bundle_base_path: /opt/UiPathAutomationSuite/{version}
# Path on nodes where offline bundles will be extracted
target_tmp_path: /opt/UiPathAutomationSuite/tmp
# Basepath and filname for the various config files and bundles on the local machine
cluster_config_filename: cluster_config.json
cluster_config_basepath: /var/tmp/uipathctl_{version}
backup_config_filename: backup_config.json
backup_config_basepath: /var/tmp/uipathctl_{version}
restore_config_filename: restore.json
restore_config_basepath: /var/tmp/uipathctl_{version}
infra_bundle_filename: sf-infra.tar.gz
infra_bundle_basepath: /var/tmp/uipath_upgrade_<version>

Variable

Value

installer_path

The path of sf-installer.zip. If you do not provide this value, uipathctl.sh will zip the current directory and copy it to other nodes, as an installer zip.

target_installer_base_path

The path where the installer will be copied on the nodes. The default value is /opt/UiPathAutomationSuite/{version}/installer.

install_type

The installation method. Possible values are: online and offline.

target_bundle_base_path

The path on the nodes where the offline bundles will be copied. The default location is /opt/UiPathAutomationSuite/{version}.

target_tmp_path

The path on the nodes where the bundle is extracted. The default location is /opt/UiPathAutomationSuite/tmp.

cluster_config_filename

The name of the cluster configuration file. The default value is cluster_config.json.

cluster_config_basepath

The location where cluster_config.json will be stored temporarily on the nodes during orchestration. The default value is /var/tmp/uipathctl_{version}.

backup_config_filename

The name of the backup configuration file. The default value is backup.json.

backup_config_basepath

The location where backup.json will be stored temporarily on the nodes during orchestration. The default value is /var/tmp/uipathctl_{version}.

restore_config_filename

The name of the restore configuration file. The default value is restore.json.

restore_config_basepath

The location where restore.json will be stored temporarily on the nodes during orchestration. The default value is /var/tmp/uipathctl_{version}.

infra_bundle_filename

The name of the bundle containing the infrastructure layers. This is the same as the one you provided to the uipathctl.sh script.

infra_bundle_basepath

The location where sf-infra.tar.gz will be stored temporarily on the nodes during orchestration. This is the same as the one you provided to the uipathctl.sh script.

4 か月前に更新


uipathctl.sh を使用する


このページでは、uipathctl.sh スクリプトの使用方法について説明します。

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

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