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

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

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

準備

重要:

Before upgrading, make sure you have prepared your environment for using the uipathctl.sh script. For details, see Using uipathctl.sh.

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

利用可能な領域を確認するには、コマンド df -h /opt/UiPathAutomationSuite を実行します。

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

1. Log into the server node that you previously identified as the Ansible host node via SSH. Make sure you have selected the primary server node with the UiPath bundle additional disk attached at /uipath as your Ansible host node.

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

   sudo su -
   

3. /opt/UiPathAutomationSuite ディレクトリの下にインストール フォルダーを作成します。

   # Please replace {version} with installer version
   mkdir -p /opt/UiPathAutomationSuite/{version}/installer
   

4. Download sf-installer.zip and copy it to /opt/UiPathAutomationSuite/{version}/installer. For download instructions, see sf-installer.zip.

   cp /path/to/sf-installer.zip /opt/UiPathAutomationSuite/{version}/installer
   

5. sf-installer.zip を解凍します。

   cd /opt/UiPathAutomationSuite/{version}/installer
   unzip sf-installer.zip -d .
   

6. Download sf-infra.tar.gz and copy it to /uipath/{version}. For download instructions, see sf-infra.tar.gz.

   cp /path/to/sf-infra.tar.gz /uipath/{version}
   

7. Download sf.tar.gz and copy it to /uipath/{version}. For download instructions, see sf.tar.gz.

   cp /path/to/sf.tar.gz /uipath/{version}
   

8. インストーラーに必要な権限を付与します。

   chmod 755 -R /opt/UiPathAutomationSuite/{version}/installer
   

9. Ansible ホスト ノードで最新の cluster_config.json ファイルを生成します。

   注:

   For details on how to configure the cluster_config.json parameters, see Advanced installation experience.

   • 古い 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://[e-mail]:[e-mail]:1433/DB_NAME_PLACEHOLDER?driver=ODBC+Driver+17+for+SQL+Server"
     

   See also Manual: Advanced installation experience.

実行

重要:

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

For instructions, see Rollback on error.

Docker レジストリをハイドレートする

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

重要:

• アップグレードの 10 時間以上前に、コンテナー内および/またはその他のインフラ イメージをハイドレートしないでください。
• If you upgrade Document Understanding and Computer Vision, you must download the base images that match your upgraded Automation Suite version (use the base image that corresponds with your ML Package version) and hydrate them to your docker registry prior to upgrade to avoid disruption to your running DU skills. To download the Document Understanding and Computer Vision installation packages, see Downloading the installation packages.

docker-registry をハイドレートするには、最初のサーバー ノードで次のコマンドを実行します。

cd /opt/UiPathAutomationSuite/{version}/installer

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

バックアップを構成する

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

1. Make sure you have enabled the backup on the cluster. You must create the backup using the same version of the installer as the one you used for the current deployment. For instructions, see the backup and restore documentation corresponding to the Automation Suite version from which you plan to upgrade. For instance, if you plan to upgrade from Automation Suite 2021.10, follow the instructions in the 2021.10 guide.

2. Log into the server node that you previously identified as the Ansible host node via SSH.

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
   

2. クラスターがメンテナンス モードであることを確認するには、以下を実行します。

   ./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 にログインして、すべてのアプリケーションのステータスを監視できます。

   重要:

   If you get the following error, follow the instructions in Downgrading Ceph from 16.2.6 to 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

基本パラメーター

パラメーター	値 (Value)
--install-type	設定可能な値: online および offline。 このページではオフライン環境での手順について説明しているので、 offline 値を選択します。
--steps	設定可能な値は、all、infra、fabric、services です。 インストールおよびアップグレード プロセスの各段階を示します。 all – Recommended: A superset of all the other steps, which upgrades the entire Automation Suite. infra – すべてのノードの Automation Suite 上の Kubernetes とその他のインフラストラクチャ コンポーネントをアップグレードします。 bundles – Automation Suite クラスター内でホストされている Docker レジストリを、ファブリックおよびサービスのコンテナー イメージとともにアップロードしてハイドレートします。 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 – Automation Suite のすべてのファブリック コンポーネントと共有コンポーネントをアップグレードします。 services – Automation Suite にインストールされているすべての UiPath 製品サービスをアップグレードします。 アップグレード中にエラーが発生した場合は、これらのチェックポイントを使用すると、アップグレード操作を最初からリトライするのではなく、再開できます。
--offline-bundle	ファブリックとサービスのコンテナー イメージを含む sf.tar.gz オフライン バンドルのパスです。/uipath/{version}/sf.tar.gz に保存することをお勧めします。
--offline-infra-bundle	Kubernetes とインフラストラクチャのバンドルを含む、 sf-infra.tar.gz オフライン バンドルのパスです。
--cluster-config	cluster_config.json ファイル。Automation Suite を介してデプロイされる UiPath サービスに適用されるパラメーターや設定を定義します。

詳細パラメーター

パラメーター	値 (Value)
--ansible-username	すべてのノードへの SSH 接続に使用するユーザー名を指定します。既定では、現在のユーザーが設定されます。すべてのノードで異なるユーザー名を使用する場合は、このパラメーターを使用するのではなく、inventory.ini ですべてのノードのユーザー名を設定して、スクリプトに渡します。 例： スクリプトの実行中は、ユーザー名 myadminuser でログインします。一方で、SSH を介して接続するときにユーザー名 testadmin を使用する場合は、このパラメーターを設定するときに testadmin を使用する必要があります。
--inventory	既存の Ansible のインベントリ ファイルを指定します。指定しない場合は、既存のクラスターから基本の構成を持って自動的に生成されます。 より細かく制御したい特定のシナリオでは、独自のインベントリ ファイルを指定できます。たとえば、クラスター内のすべてのノードに対して異なる SSH ユーザー名や SSH キーを使用する場合が考えられます。 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
  

• If you experience issues with image vulnerabilities or storage consumption after performing an upgrade, delete the images from the old installer. For details, see the Troubleshooting section.

• After upgrading to Automation Suite 2022.10.13 or newer, you can clean up the previous version images after the upgrade from the in-cluster Docker registry. For instructions, see How to delete images from the old installer after upgrade.

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

注:

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

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

To enable the backup, follow the instructions in described in the Backing up and restoring the cluster documentation.