通知を受け取る

UiPath Automation Suite

UiPath Automation Suite ガイド

自動: オフライン アップグレード

このページでは、自動化された方法でオフライン環境で Automation Suite をアップグレードする方法について説明します。

Ansible を使用すると、複数の操作をクラスター内の 1 つのマシンで実行することで、Automation Suite クラスター全体のアップグレードを自動化できます。

次の図では、Server 1 ノード (または Ansible ホスト ノード) が Ansible を使用して Automation Suite クラスター全体のアップグレードをオーケストレーションしています。

1076

 

準備


🚧

重要

アップグレードの前に、uipathctl.sh スクリプトを使用する環境が準備されていることを確認してください。詳細については、「uipathctl.sh を使用する」をご覧ください。


すべてのノードの /opt/UiPathAutomationSuite フォルダーに 10 GiB の空き領域があることを確認します。十分な領域がない場合は、このフォルダーの容量を増やすか、以前のインストーラー ファイル (cluster_config.json を除く) をすべて削除できます。以前のインストーラーは、いつでも再度ダウンロードできます。
利用可能な領域を確認するには、コマンド df -h /opt/UiPathAutomationSuite を実行します。

アップグレードの準備をするには、次の手順に従います。

  1. SSH を介して Ansible のホスト ノードとして以前に識別したサーバー ノードにログインします。Ansible のホスト ノードとして /uipath で UiPath バンドルの追加ディスクが接続されたプライマリ サーバー ノードを選択していることを確認します。

  2. ルート ユーザーになります。

sudo su -
  1. /opt/UiPathAutomationSuite ディレクトリの下にインストール フォルダーを作成します。
# Please replace {version} with installer version
mkdir -p /opt/UiPathAutomationSuite/{version}/installer
  1. sf-installer.zip をダウンロードし、それを /opt/UiPathAutomationSuite/{version}/installer にコピーします。ダウンロードの手順については、「sf-installer.zip」をご覧ください。
cp /path/to/sf-installer.zip /opt/UiPathAutomationSuite/{version}/installer
  1. sf-installer.zip を解凍します。
cd /opt/UiPathAutomationSuite/{version}/installer
unzip sf-installer.zip -d .
  1. sf-infra.tar.gz をダウンロードし、それを /uipath/{version} にコピーします。ダウンロードの手順については、「 sf-infra.tar.gz」をご覧ください。
cp /path/to/sf-infra.tar.gz /uipath/{version}
  1. sf.tar.gz をダウンロードし、それを /uipath/{version} にコピーします。ダウンロードの手順については、「 sf.tar.gz」をご覧ください。
cp /path/to/sf.tar.gz /uipath/{version}
  1. インストーラーに必要な権限を付与します。
chmod 755 -R /opt/UiPathAutomationSuite/{version}/installer
  1. Ansible ホスト ノードで最新の cluster_config.json ファイルを生成します。

📘

注:

cluster_config.json のパラメーターを設定する方法の詳細については、「高度なインストール」をご覧ください。

  • 古い cluster_config.json がある場合は、クラスターから構成ファイルを生成します。
cd /opt/UiPathAutomationSuite/{version}/installer

./configureUiPathAS.sh config get -i /path/to/old/cluster_config.json -o ./cluster_config.json
  • 古い cluster_config.json ファイルがない場合は、既定値の上書きを生成します。これは、以前のバージョンのインストール時に生成済みである可能性があります。
cd /opt/UiPathAutomationSuite/{version}/installer

./configureUiPathAS.sh config get -o ./cluster_config.json
  • Automation Suite を以前のバージョンからアップグレードし、続いて Process Mining を有効化する場合は、sql_connection_string_template_sqlalchemy_pyodbc を更新する必要があります。以下に例を示します。
"sql_connection_string_template_sqlalchemy_pyodbc": "mssql+pyodbc://testadmin@sfmfup20211043125452-8926d153-sql.database.windows.net:sgTQrg%40R%40dvoYddYBoKn045ncoC9WhWU@sfmfup20211043125452-8926d153-sql.database.windows.net:1433/DB_NAME_PLACEHOLDER?driver=ODBC+Driver+17+for+SQL+Server"

See also Manual: Advanced installation experience.

 

実行


🚧

重要

アップグレード中またはアップグレード後にエラーや問題が発生した場合、以前にバックアップを構成していれば、以前のバージョンにロールバックできます。
手順については、「エラー時のロールバック」をご覧ください。

 

ハイドレートする docker-registry

必要なダウンタイムを最小限に抑えるには、次の手順を実行して、アップグレード前に docker-registry を新しいバージョンの製品のコンテナー イメージでハイドレートします。

  1. docker-registry をハイドレートするには、最初のサーバー ノードで次のコマンドを実行します。
cd /opt/UiPathAutomationSuite/{version}/installer

./configureUiPathAS.sh registry upload --offline-bundle /uipath/{version}/sf.tar.gz --offline-tmp-folder /uipath/tmp

 

バックアップを構成する

バックアップを構成するには、次の手順に従います。

  1. クラスターのバックアップが有効化されていることを確認します。現在のデプロイで使用したバージョンと同じバージョンのインストーラーを使用してバックアップを作成する必要があります。手順については、Automation Suite のアップグレード元のバージョンに対応するバックアップと復元のドキュメントをご覧ください。たとえば、v2021.10 の Automation Suite からアップグレードする場合はv2021.10 のガイドに記載されている手順を実行します。

  2. SSH を介して Ansible のホスト ノードとして以前に識別したサーバー ノードにログインします。

  3. 必要なすべてのボリュームがクラスターにバックアップされていることを確認します。

/path/to/old-installer/configureUiPathAS.sh verify-volumes-backup

📘

注:

バックアップには時間がかかることがあるため、その場合は 15 分から 20 分ほど待ってから再度ボリュームのバックアップを確認してください。

バックアップが作成されたら、続いて次の手順を実行します。

 

クラスターをメンテナンス モードにする

クラスターをメンテナンス モードにすると、イングレス コントローラーとすべての UiPath サービスがシャットダウンし、Automation Suite クラスターへのすべての受信トラフィックがブロックされます。

🚧

重要

この操作によりダウンタイムが発生し、ビジネス オートメーションはアップグレード プロセス全体で中断されます。

  1. クラスターをメンテナンス モードにするには、以下を実行します。
cd /opt/UiPathAutomationSuite/{version}/installer
./configureUiPathAS.sh enable-maintenance-mode
  1. クラスターがメンテナンス モードであることを確認するには、以下を実行します。
./configureUiPathAS.sh is-maintenance-enabled

🚧

重要

メンテナンス モードを有効化した後に、SQL Server のバックアップを作成し、トランザクションがこれ以上 SQL データベースに記録されないようにします。

 

クラスターをアップグレードする

Automation Suite クラスターをアップグレードするには、次の手順に従います。

  1. SSH を介して Ansible ホスト ノードに接続し、ルート ユーザーになります。

  2. すべてのノードでアップグレード手順を実行するには、基本パラメーターを使用して次のコマンドを実行します。より細かい制御が必要な場合は、「パラメーター」セクションをご覧ください。

📘

注:

準備手順の説明に従って生成した cluster_config.json を更新したことを確認してください。

# Please replace {version} with installer version, in all the below commands
cd /opt/UiPathAutomationSuite/{version}/installer

./uipathctl.sh upgrade --cluster-config ./cluster_config.json --install-type offline --steps all --offline-infra-bundle /uipath/{version}/sf-infra.tar.gz --accept-license-agreement

🚧

重要

アップグレード プロセスでは、Canal CNI から Cilium CNI に移行する必要があります。自動アップグレードによってこの手順が自動的に実行された後、クラスター内のすべてのノードが再起動されて移行が完了します。
ノードが再起動したら、数分待ってから、すべてのサービスが再びオンラインになっていることを確認します。ArgoCD にログインして、すべてのアプリケーションのステータスを監視できます。

❗️

警告

次のエラーが発生する場合は、「 Ceph を 16.2.6 から 15.2.9 にダウングレードする」の手順に従ってください。

Ceph cluster is running on version: 16.2.6 with known bug(https://docs.ceph.com/en/quincy/releases/pacific/#v16-2-6-pacific). Please provide temporary backup directory (via environment variable 'TMP_CEPH_BACKUP_PATH') to downgrade ceph

 

基本パラメーター

ParameterValue
--install-typePossible values: online and offline.
Since this page provides instructions for an offline environment, choose the offline value.
--stepsPossible values are: all, infra, fabric, and services.
Denotes each stage of the installation and upgrade process.

allRecommended: A superset of all the other steps, which upgrades the entire Automation Suite.

infra – Upgrades Kubernetes and other infrastructure components on Automation Suite on all the nodes.

bundles – Uploads and hydrates the docker registry hosted within the Automation Suite cluster with the fabric and services container images.

You must upload and hydrate the Docker registry at the same time as upgrading Kubernetes and the infrastructure components. To execute the two steps simultaneously, run --steps bundles infra.
Do not run --steps bundles alone as it will damage the cluster.

fabric – Upgrades all fabric and shared components of Automation Suite.

services – Upgrades all UiPath product services installed on Automation Suite.

If an error occurs during the upgrade, you can use these checkpoints to resume the upgrade operation instead of retrying from start.
--offline-bundlePath to the sf.tar.gz offline bundle, containing the fabric and services container images. It is recommended to store it in /uipath/{version}/sf.tar.gz.
--offline-infra-bundlePath to the sf-infra.tar.gz offline bundle, containing Kubernetes and infrastructure bundles.
--cluster-configcluster_config.json file, which defines the parameters, settings, and preferences applied to the UiPath services deployed via Automation Suite.

詳細パラメーター

ParameterValue
--ansible-usernameSpecify the username to be used for SSH connections to all the nodes. Defaults to the current user. If you use a different username for all the nodes, then instead of using this parameter, set the username for all the nodes in inventory.ini and pass it to the script.

Example:
While running the script, you are logged in as the myadminuser username. However, if you want to use the testadmin username to connect via SSH, you must provide testadmin to this parameter.
--inventorySpecify an existing Ansible inventory file. If not specified, one will be generated automatically from the existing cluster with the basic configuration.

In certain scenarios where you want to have more granular control, you may want to provide your own inventory file. One such example would be if you want to use a different SSH username or SSH key for all the nodes in cluster.

For details, see Generating the Ansible inventory.ini file.

📘

注:

何らかの理由でアップグレードに失敗したものの、Docker レジストリへのアップロードが正常に完了した場合、再アップロードは不要です。ファブリックまたはサービスのインストールを直接実行することでアップグレードを再開できます。./uipathctl.sh upgrade --install-type offline --steps {fabric | services}


アップグレードが完了すると、メンテナンス モードは自動的に無効化されます。

Automation Suite が正常かどうかを確認するには、以下を実行します。

kubectl get applications -n argocd

 

アップグレード後にバックアップを有効化する

📘

注:

次の手順に進む前に、Automation Suite が稼働中でありオートメーションが期待どおり続行されていることを確認します。

クラスターのアップグレードを開始する前に、アップグレード スクリプトによってクラスターのバックアップが自動的に作成され、その後一時的に無効化されます。アップグレードが完了したら、手動でバックアップを有効化できます。

バックアップを有効化するには、任意のサーバー ノードから次のコマンドを実行します。

# replace {version} with the version you are upgrading to
cd /opt/UiPathAutomationSuite/{version}/installer

./configureUiPathAS.sh resume-scheduled-backups

約 1 か月前に更新


自動: オフライン アップグレード


このページでは、自動化された方法でオフライン環境で Automation Suite をアップグレードする方法について説明します。

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

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