Using the Liferay DXP Service
ご覧のページは、お客様の利便性のために一部機械翻訳されています。また、ドキュメントは頻繁に更新が加えられており、翻訳は未完成の部分が含まれることをご了承ください。最新情報は都度公開されておりますため、必ず英語版をご参照ください。翻訳に問題がある場合は、 こちら までご連絡ください。

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

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

本番環境で大規模なデータセットを使用する場合、スムーズなアップグレードを行うためには、さらにいくつかの考慮事項があります。 例えば、カスタムコードやマーケットプレイスアプリは、正常に動作し続けるために追加のアップデートが必要になる場合があります。 Liferay DXPのアップグレードに関するガイドを参照して、コアアップグレードの全体像をご確認ください。

新しいマイナーバージョンまたはサービスパックに更新するには、代わりに Liferay DXP の新しいバージョンへの更新 を参照してください。

重要

Liferay PaaS環境でのアップグレードには、アップグレードされたデータベースの復元が必要となるため、Liferayサービスの再起動に時間がかかり、サービスが停止します。 本番環境におけるこのダウンタイムに備えて、事前に計画を立ててください。

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

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

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

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

重要

古いものを再利用するのではなく、アップグレード用の新しいバンドルをダウンロードしてください。 過去の使用データがデータ更新に支障をきたす可能性があります。

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

次の手順を実行して、現在 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
    

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

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

重要

Liferay 7.4 U82/GA82 より前は、 db_upgrade_client.sh ファイルは db_upgrade.sh という名前でした。

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"

アップグレードツールは、データのアップグレードを開始する前に、インストールに関する情報を要求します。 LiferayとTomcatが同梱されたバンドルをダウンロードした場合、一部のディレクトリはデフォルト値として自動的に検出されます。 プロンプトが表示されたら、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. バックアップのアップロードページで、該当する環境を展開し、データベースとドキュメントライブラリの両方の + アイコンをクリックしてアップロードします。

    アイコンをクリックすると、データベースとドキュメントライブラリの両方が.gz形式のアーカイブとしてアップロードされます。

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

アップロードAPIを使用して、データベースダンプとドキュメントライブラリをアップロードすることもできます。 詳細については、 バックアップ サービス API を参照してください。

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

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

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

Liferay DXPの新バージョンを反映させるため、必要に応じて以下の箇所を更新してください。

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

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

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

ヒント

CDN キャッシュの古いコンテンツに関連するバグを回避するには、 ネットワークCDNに移動し、 CDN キャッシュをクリア をクリックします。

バックアップを復元する

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

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

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

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

    アップロードしたバックアップの[アクション]メニューから[復元先...]を選択します。

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

    バックアップをデプロイする環境を選択してください。

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

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

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

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