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

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

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

準備

重要:

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

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

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

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

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

   sudo su -

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

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

4. as-installer.zip をダウンロードし、それを /opt/UiPathAutomationSuite/{version}/installer にコピーします。ダウンロードの手順については、「as-installer.zip」をご覧ください。

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

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

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

6. as-infra.tar.gz をダウンロードし、それを /uipath/{version} にコピーします。ダウンロードの手順については、「as-infra.tar.gz」をご覧ください。

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

7. as.tar.gz をダウンロードし、それを /uipath/{version} にコピーします。ダウンロードの手順については、「as.tar.gz」をご覧ください。

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

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

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

9. 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 を v2022.10 から v2023.4 以降にアップグレードする際に、Orchestrator が新旧両方のバージョンで有効化されている場合は、cluster_config.json ファイルの orchestrator.block_classic_executions フラグを true に設定する必要があります。このフラグを使用すると、クラシック フォルダーでのジョブの実行をブロックすることに同意したものとみなされます。フラグを使用しない場合、アップグレードの操作は失敗します。設定例については、Orchestrator 固有の設定に関するページをご覧ください。
   • 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"

   • Automation Suite を v2023.4 より前のバージョンからアップグレードし、Apps が有効化されている場合は、Apps 用の SQL データベースを作成して cluster_config.json ファイルを次の設定で更新する必要があります。

     "apps": {
     "enabled": "true" // This will already be true in existing cluster_config.json if apps is enabled
     "sql_connection_str": "" // Provide ODBC database connection string if apps is enabled
     }

     注:

     アップグレードの以降の手順では、更新後の cluster_config.json ファイルを使用してください。

   「手動: 高度なインストール」もご覧ください。

実行

重要:

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

手順については、「エラー時のロールバック」をご覧ください。

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

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

重要:

• アップグレードの 10 時間以上前に、コンテナー内および/またはその他のインフラ イメージをハイドレートしないでください。
• Document Understanding と Computer Vision をアップグレードする場合は、アップグレード後の Automation Suite のバージョンに対応するベース イメージ (お使いの ML パッケージのバージョンに対応するベース イメージを使用してください) をダウンロードし、実行中の DU スキルの中断を避けるため、アップグレードの前に Docker レジストリにイメージをハイドレートする必要があります。Document Understanding と Computer Vision のインストール パッケージをダウンロードするには、「インストール パッケージをダウンロードする」をご覧ください。

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

cd /opt/UiPathAutomationSuite/{version}/installer

./configureUiPathAS.sh registry upload --offline-bundle /uipath/{version}/as.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

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}/as-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

基本パラメーター

パラメーター	値 (Value)
--install-type	設定可能な値: online および offline。 このページではオフライン環境での手順について説明しているので、 offline 値を選択します。
--steps	設定可能な値は、all、infra、fabric、services です。 インストールおよびアップグレード プロセスの各段階を示します。 all – 推奨: その他すべての手順の上位セットです。Automation Suite 全体をアップグレードします。 infra – すべてのノードの Automation Suite 上の Kubernetes とその他のインフラストラクチャ コンポーネントをアップグレードします。 bundles – Automation Suite クラスター内でホストされている Docker レジストリを、ファブリックおよびサービスのコンテナー イメージとともにアップロードしてハイドレートします。 重要: Kubernetes とインフラストラクチャ コンポーネントをアップグレードするのと同時に、Docker レジストリをアップロードしてハイドレートする必要があります。2 つの手順を同時に実行するには、--steps bundles infra を実行します。 クラスターが破損するため、--steps bundles を単独で実行しないでください。 fabric – Automation Suite のすべてのファブリック コンポーネントと共有コンポーネントをアップグレードします。 services – Automation Suite にインストールされているすべての UiPath 製品サービスをアップグレードします。 アップグレード中にエラーが発生した場合は、これらのチェックポイントを使用すると、アップグレード操作を最初からリトライするのではなく、再開できます。
--offline-bundle	ファブリックとサービスのコンテナー イメージを含む as.tar.gz オフライン バンドルのパスです。/uipath/{version}/as.tar.gz に保存することをお勧めします。
--offline-infra-bundle	Kubernetes とインフラストラクチャのバンドルを含む、 as-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 キーを使用する場合が考えられます。 詳しくは、「Ansible inventory.ini ファイルを生成する」をご覧ください。

注:

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

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

アップグレードの実行後、次の追加手順を実行できます。

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

  kubectl get applications -n argocd

• 2023.4.0 より前のバージョンの Automation Suite からアップグレードする場合は、Apps が実行されているかどうかを確認してから MongoDB を削除します。

  ./configureUiPathAS.sh mongodb uninstall --force

• ./configureUiPathAS.sh mongodb uninstall --force コマンドで MongoDB を削除するとエラーが発生する場合は、次のコマンドを実行してください。

  kubectl patch application "fabric-installer" -n argocd --type=merge -p '{"spec" : {"syncPolicy" : {"automated" : {"selfHeal": false }}}}'
  
  ./configureUiPathAS.sh mongodb uninstall --force
  
  kubectl patch application "fabric-installer" -n argocd --type=merge -p '{"spec" : {"syncPolicy" : {"automated" : {"selfHeal": true }}}}'

• アップグレードの実行後にイメージの脆弱性やストレージの消費に関する問題が発生した場合は、古いインストーラーからイメージを削除します。 詳しくは、「トラブルシューティング」セクションをご覧ください。

• Automation Suite 2023.4.8 以降にアップグレードした後、アップグレード後にクラスター内の Docker レジストリから以前のバージョンのイメージをクリーンアップできます。 手順については、「 アップグレード後に古いインストーラーからイメージを削除する方法」をご覧ください。

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

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

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

バックアップを有効化するには、「クラスターをバックアップおよび復元する」のドキュメントの手順に従ってください。