Liferay DXPインスタンスのアップグレード

Liferay は 3 か月ごとに、セキュリティとバグの修正、および機能強化を含む Liferay DXP の新しい四半期リリース バージョンをリリースします。 新しい Liferay DXP バージョンにアップグレードするには、DXP データベースをアップグレードする必要があります。

次の手順を確認して、データベースのアップグレードを実行します。

1. 前提条件をインストールする
2. バックアップをダウンロード
3. データを抽出してインポートする
4. データのアップグレードを実行する
5. ドキュメントライブラリとデータベースを圧縮する
6. ドキュメントライブラリとデータベースをアップロードする
7. バックアップを復元する

前提条件をインストールする

アップグレード手順を開始する前に、次の前提条件を満たしてください。

• Liferay CloudデータベースがPostgreSQLを使用している場合は、ローカルで利用可能なPostgreSQL 16インストール。
• Liferay Cloud データベースが MySQL を使用している場合は、ローカルで利用可能な MySQL インストール。
• アップグレード先の DXP のバージョン用の Liferay DXP バンドル をダウンロードしました。 このバンドルを選択した場所に抽出します。

バックアップをダウンロード

次の手順を実行して、現在 prd 環境で実行されているDXPインスタンスのバックアップ（データベースとデータボリュームの両方で設定される）をダウンロードします。

1. クラウド コンソールにログインします。

2. 本番環境に移動し、メニューから［ バックアップ ］を選択します。

   

3. リストされているバックアップの1つを選択し、［アクション］メニューから［ダウンロード］を選択します。 データボリュームとデータベースのzipファイルをダウンロードします。

   

データの抽出とインポート

次のステップは、ダウンロードしたアーカイブからデータを抽出し、アップグレードに必要な場所にデータを移動することです。

データ量を抽出する

バックアップからデータボリュームを抽出するには、次の手順を実行します：

1. ダウンロードしたデータボリュームの .tgz アーカイブ (名前は backup-lfr-[PROJECT_NAME]-prd-[BACKUP_ID].tgz) を、先ほど抽出した Liferay バンドルの LIFERAY_HOME/data フォルダに移動します。

2. 以下のコマンドを実行して、アーカイブを抽出します：

   tar -xvzf ARCHIVE_NAME.tgz
   

データベースの抽出とインポート

ダウンロードしたデータベース アーカイブ (名前は backup-db-[PROJECT_NAME]-prd-[BACKUP_ID].tgz) の場所でコマンド ラインを開き、次の手順を実行してインポートします。

1. データベースアーカイブを抽出します：

   tar -xvzf ARCHIVE_NAME.tgz
   

2. ローカル システム上のデータベース クライアントを使用して、インポートされたデータ用のデータベースを作成します。

   PostgreSQLの場合:

   psql -U postgres -c "CREATE DATABASE lportal OWNER postgres encoding UTF8 locale='en_US.UTF-8' template=template0"
   

   MySQLの場合 (データベース名として拡張子なしの .sql ダンプの名前を使用):

   mysql -u root -p
   

   プロンプトが表示されたらパスワードを入力します。

   create database DATABASE_NAME default character set utf8mb4 collate utf8mb4_unicode_ci;
   

3. 抽出された .sql ダンプからデータベースをインポートします：

   PostgreSQLの場合 (ダンプファイルの名前を置き換えます):

   psql -U postgres lportal -v ON_ERROR_STOP=1 < DATABASE_NAME.sql
   

   MySQLの場合:

   use DATABASE_NAME;
   

   source DATABASE_NAME.sql;
   

   exit
   

データベースとドキュメントライブラリが配置され、データのアップグレードを実行する準備が整いました。

データアップグレードの実行

DXPバンドルは、データのアップグレードに使用されるアップグレードツールを提供します。 このツールは、バンドルに含まれるスクリプト db_upgrade_client.shを通じて呼び出されます。

LIFERAY_HOME/tools/portal-tools-db-upgrade-client フォルダ内でコマンドラインを開きます。 次に、以下のコマンドを実行します：

db_upgrade_client.sh -j "-Dfile.encoding=UTF-8 -Duser.timezone=GMT -Xmx2048m" -l "output.log"

アップグレードツールは、データのアップグレードを開始する前に、インストールに関する情報を要求します。 Tomcat とともに Liferay バンドルをダウンロードした場合、いくつかのディレクトリがデフォルト値として自動的に検出されます。 プロンプトが表示されたら、Liferay Cloud 環境に適切なデータベースを選択してください。

以下は、この情報を入力するアップグレードツールとの相互作用の例です：

Please enter your application server (tomcat):
tomcat

Please enter your application server directory (../../tomcat-9.0.17):

Please enter your extra library directories (../../tomcat-9.0.17/bin):

Please enter your global library directory (../../tomcat-9.0.17/lib):

Please enter your portal directory (../../tomcat-9.0.17/webapps/ROOT):

[ db2 mariadb mysql oracle postgresql sqlserver ]
Please enter your database (mysql):
postgresql

Please enter your database host (localhost):

(etc.)

必要な情報を入力すると、アップグレードツールによってデータのアップグレードが実行されます。 次のメッセージがコンソールに表示されたら、アップグレードは完了です：

Completed Liferay core upgrade and verify processes in 64 seconds
Checking to see if all upgrades have completed... done.

バンドルをローカルでテストして、アップグレードがスムーズに完了したことを確認します。 LIFERAY_HOME/tomcat-9.xx/bin/から次のコマンドを実行して、インスタンスをローカルでテストできます。

./catalina.sh run

アップグレードが完了して検証されると、データベースとデータ ボリュームを Liferay Cloud にアップロードする準備が整います。

ドキュメントライブラリを圧縮する

Liferayのインストールがアップグレードされたので、以下の手順に従って、 バックアップ サービスにアップロードする準備をします。

ドキュメントライブラリの圧縮

1. LIFERAY_HOME/data フォルダ内でコマンドラインを開きます。

2. 次のコマンドを使用して、このファイルを .tgz アーカイブに圧縮します：

   tar -czvf volume.tgz document_library
   

   重要

   ダウンロードしたデータ ボリュームにさらにフォルダー ( license/ フォルダーなど) が含まれている場合は、これらを document_libraryの後に追加の引数として追加します。

データベースアップグレードツールの使用

次に、データベースの種類に応じて、次の手順に従って データベース ダンプを作成します。

これらの手順により、データベースがダンプされ、結果として得られる database.gz ファイルに圧縮されます。

ドキュメントライブラリとデータベースをアップロードする

コンソール経由でドキュメント ライブラリとデータベース アーカイブを バックアップ サービスにアップロードします。

1. まだログインしていない場合は、 Liferay Cloud コンソールにログインします。

2. 適切な環境の バックアップ ページに移動します。

3. 画面上部の「 バックアップのアップロード… 」をクリックします。

   

4. [バックアップのアップロード] ページで適切な環境を展開し、データベースとドキュメント ライブラリの両方の + アイコンをクリックしてアップロードします。

   

5. データベース・ダンプとドキュメント・ライブラリの両方がアップロードされたら、 ［アップロードの開始］ をクリックします。

アップロードが完了すると、「バックアップ」ページのリストの一番上に新しいバックアップが表示されます。

プロジェクトのLiferayイメージバージョンを更新する

アップグレードされたデータベースが正しく機能するように、環境で使用している Liferay イメージのバージョンを更新する必要があります。

Liferay DXP の新しいバージョンを反映するために、必要に応じてこれらの場所を更新します。

• liferay/LCP.jsonの image プロパティ。 更新されたイメージの サービス変更ログ を確認し、アップグレードされた DXP バージョンがイメージ内のバージョンと一致していることを確認します (たとえば、 liferaycloud/liferay-dxp:7.2-4.0.7の 7.2 )。

• liferay/gradle.properties内の liferay.workspace.docker.image.liferay プロパティ。 アップグレードしたDXPバージョンに一致するイメージについては、 Liferay DXP Docker Hubページ を確認してください。

これらのイメージ バージョンの両方が更新されたら、 変更を 選択した環境にデプロイします。 これにより、アップロードしたバックアップを復元するための Liferay サービスが準備されます。

バックアップを復元する

次の手順に従って、選択した環境にバックアップを復元します：

1. まだログインしていない場合は、Liferay Cloud コンソールにログインします。

2. バックアップをアップロードした環境 に移動し、サイド メニューから バックアップ をクリックします。

3. リストからバックアップを選択し、そのバックアップのアクションメニューから ［復元］をクリックします。

   

4. ドロップダウンリストから復元先の環境の1つを選択します（たとえば、 dev 環境）。

   

5. 環境に復元をクリックします。

   注

   バックアップの展開中は、選択した環境は使用できません。

　 これでDXPデータベースを新しいバージョンにアップグレードし、選択した環境にデプロイできました。 必要に応じて、同じバックアップを他の環境に再度 復元 することもできます。

関連トピック

DXPアップグレードの詳細：

• Liferay DXP アップグレードの基本
• DXPインスタンスを新しいマイナーバージョンにアップデートする
• データベースアップグレードツールの使用