アップグレードツールは、コアおよびインストールされているモジュールをアップグレードするに当たって、最も簡単な方法を提供します。ファイルまたはツールのコマンドラインインターフェイスから、アップグレードを設定できます。アップグレードツールを使用すると、コアとすべてのモジュールをまとめて、または個別にアップグレードできます。
Liferay DXP 7.1バンドルにはアップグレードツールが含まれています。手動でLiferay DXP 7.1をインストールした場合は、アップグレードツールを個別にダウンロードできます。
-
Liferay DXP 7.1： Liferay DXP 7.1ダウンロードページに移動し、*[管理ツール]を選択して、[ダウンロード]*をクリックします。
-
Liferay Portal CE 7.1：ダウンロードページに行き、Liferay Portalツール7.1用のダウンロードを選択します。
アップグレードツールを実行する前に、ツールの使用方法、およびコアアップグレードとコア以外のモジュールアップグレードの設定方法を確認してください。
まず最初に、ツールの使用方法を説明します。
アップグレードツールの使用法
db_upgrade.shスクリプト（Windows上ではdb_upgrade.bat）がアップグレードツールを起動します。これは、[Liferay Home]/tools/portal-tools-db-upgrade-clientフォルダ内にあります。
このコマンドは、アップグレードツールの使用法を表示します。
db_upgrade.sh --help
コアのみをアップグレードするには、com.liferay.portal.upgrade.internal.configuration.ReleaseManagerConfiguration.configというファイルと下記の内容と合わせて、[Liferay Home]/osgi/configsフォルダに追加します 。
autoUpgrade="false"
この設定は自動的なモジュールアップグレードを防ぎますが、コアアップグレードを終えた後にアップグレードツールがアップグレード中のモジュールのためにGogoシェルを開いてしまう原因になります。
ツールのデフォルトのJavaパラメータは、次のとおりです。
-Dfile.encoding=UTF8 -Duser.country=US -Duser.language=en -Duser.timezone=GMT -Xmx2048m
この-jオプションを使用すると、JVMパラメータを上書きできます。たとえば、これらのオプションはJVMメモリを10GBに設定します。このメモリ量は、このプロセスタイプで最初に設定する量として適しています。
db_upgrade.sh -j "-Dfile.encoding=UTF8 -Duser.country=US -Duser.language=en -Duser.timezone=GMT -Xmx10240m"
この-lオプションを使用すると、ツールのログファイル名を指定できます。
db_upgrade.sh -l "output.log"
アップグレードツールのコマンドラインオプションは次のとおりです。
–helpまたは**-h**：ツールのヘルプメッセージを表示します。
–jvm-optsまたは**-j** +[arg]：アップグレードプロセスのJVMオプションを設定します。
–log-fileまたは**-l** + [arg]：ツールのログファイル名を指定します。デフォルトの名前はupgrade.logです。
–shellまたは**-s**：アップグレードプロセスが完了したら、自動的にGogoシェルに接続します。
アップグレードを開始する前に、コア以外のモジュールのアップグレードを実行する方法を決定しておいてください。
コア以外のモジュールアップグレードの設定
アップグレードツールを設定することで、インストールされているすべてのモジュールを自動的にアップグレードしたり、手動でモジュールのアップグレードを実行するために（コアアップグレードの完了後に）Gogoシェルを開くようにしたりできます。
アップグレードツールのautoUpgradeプロパティがtrue（デフォルト設定）に設定されている場合は、インストールされているすべてのモジュールのアップグレードプロセスも実行されます。
com.liferay.portal.upgrade.internal.configuration.ReleaseManagerConfiguration.configというファイルにautoUpgrade="false"を設定して、そのファイルを[Liferay Home]/osgi/configsフォルダにコピーすると、コアのアップグレード後にアップグレードツールによってGogoシェルが開きます。Gogoシェルでは、モジュールのアップグレードを管理できます。
コア以外のモジュールをアップグレードする方法は以上です。次に、コアアップグレードの設定オプションについて説明します。
コアアップグレードの設定
コアアップグレードでは設定が必要です。実行時にコマンドラインインターフェースを介して設定したり、[Liferay Home]/tools/portal-tools-db-upgrade-client/にある以下のファイルで事前に設定することができます。
app-server.properties：サーバーの場所とライブラリを指定します。portal-upgrade-database.properties：データベース接続を設定します。portal-upgrade-ext.properties：アップグレードに必要な残りのポータルプロパティを設定します。現在使用しているポータルプロパティ（データベースのプロパティを除く）をこのファイルにコピーすることをお勧めします。現在のプロパティをコピーする前に、Liferay DXP 7.1のポータルプロパティを更新したことを確認してください 。
次に、各ファイルのプロパティについて説明します。
app-server.propertiesの設定
以下の情報を指定して、Liferay DXP 7.1がインストールされているアプリケーションサーバーを設定します。
dir： アプリケーションサーバーディレクトリの絶対パスです。（必須）
extra.lib.dirs： クラスパスに追加するバイナリまたはリソースを含む、追加ディレクトリのカンマ区切りのリストです。すべての絶対パス、またはすべてのdirの相対パスを使用してください。（必須）
global.lib.dir： アプリケーションサーバーのグローバルライブラリディレクトリです。絶対パスまたはdirの相対パスを使用してください。（必須）
portal.dir： ご利用のアプリサーバにインストールされているポータルのディレクトリです。絶対パスまたはdirの相対パスを使用してください。（必須）
**server.detector.server.id：**サポートされているアプリケーションサーバーのIDです。 （必須）以下がIDです。
jbossjonasresintomcatweblogicwebspherewildfly
相対パスはUnixスタイルのフォーマットを使用しなければなりません。たとえば、次のプロパティはWindows用で、相対パスを使用しています。
dir=D:\
extra.lib.dirs=Liferay/liferay-portal-master/tomcat-9.0.10/bin
global.lib.dir=Liferay/liferay-portal-master/tomcat-9.0.10/lib
portal.dir=Liferay/liferay-portal-master/tomcat-9.0.10/webapps/ROOT
server.detector.server.id=tomcat
たとえば、これらのプロパティはUnix用であり、すべての絶対パスを使用しています。
dir=/
extra.lib.dirs=/home/user/liferay/liferay-portal-master/tomcat-9.0.10/bin
global.lib.dir=/home/user/liferay/liferay-portal-master/tomcat-9.0.10/lib
portal.dir=/home/user/liferay/liferay-portal-master/tomcat-9.0.10/webapps/ROOT
server.detector.server.id=tomcat
portal-upgrade-database.propertiesの設定
アップグレードするデータベースを設定するために、以下の情報を指定します。
これらのプロパティ は、portal-ext.propertiesファイルで使用するJDBCポータルのプロパティと完全に対応しています。
jdbc.default.driverClassName （必須）
jdbc.default.url （必須）
jdbc.default.username （必須）
jdbc.default.password （必須）
portal-upgrade-ext.propertiesの設定
アップグレードそのものを設定するには、以下の情報を指定します。
liferay.home：Liferayのホームフォルダ（必須）
**hibernate.jdbc.batch_size：**パフォーマンスを向上させるために使用されるJDBCバッチサイズです。デフォルトでは、250に設定されています。（オプション）
アップグレードの設定例
下記はアップグレードツールのコマンドラインインターフェイスとの対話の例です。
Please enter your application server (tomcat):
tomcat
Please enter your application server directory (../../tomcat-8.0.32):
Please enter your extra library directories (../../tomcat-8.0.32/bin):
Please enter your global library directory (../../tomcat-8.0.32/lib):
Please enter your portal directory (../../tomcat-8.0.32/webapps/ROOT):
[ db2 mariadb mysql oracle postgresql sqlserver sybase ]
Please enter your database (mysql):
mariadb
Please enter your database host (localhost):
(etc.)
コマンドラインインタフェースは、入力に基づいて設定ファイルを作成します。 ただし、すべてを事前に設定したい場合は、この情報を設定ファイルに入れておくことをお勧めします。
以下は、カスタマイズして[Liferay Home]/tools/portal-tools-db-upgrade-client/にコピーできるアップグレード設定ファイルの例です。
-
app-server.properties:dir=../../tomcat-8.0.32 global.lib.dir=/lib portal.dir=/webapps/ROOT server.detector.server.id=tomcat extra.lib.dirs=/bin -
portal-upgrade-database.properties:jdbc.default.url=jdbc:mysql://lportal62?characterEncoding=UTF-8&dontTrackOpenResources=true&holdResultsOpenOverStatementClose=true&useFastDateParsing=false&useUnicode=true jdbc.default.driverClassName=com.mysql.jdbc.Driver jdbc.default.username=root jdbc.default.password= -
portal-upgrade-ext.properties:liferay.home=/home/user/servers/liferay7 module.framework.base.dir=/home/user/servers/liferay7/osgi
次に、コアアップグレードを開始する手順について説明します。
コアアップグレードの実行と管理
アップグレードツールの使用法の説明に従って、アップグレードツールを起動します 。 コアアップグレードのステージは次のとおりです。
-
アップグレードパッチレベルを表示する
-
コアアップグレードプロセスを実行する
-
コアベリファイアを実行する
アップグレードツールのログファイル（デフォルトのファイルはupgrade.log）でアップグレードを監視します 。コアアップグレードプロセスが失敗した場合は、失敗を分析して解決します。Liferay DXP 7.1（またはそれ以降）のコアアップグレード手順が失敗した場合は、アップグレードツールを実行すると、その手順から再開されます。
コア以外のモジュールをアップグレードするようにアップグレードツールを設定した場合 、ツールはGogoシェルを開き、該当するモジュールのアップグレードを開始します。Gogoシェルを使用すると、モジュールのアップグレード、モジュールのアップグレードステータスの確認、アップグレードの確認、およびモジュールのアップグレードの再開を行うことができます。次は、Gogoシェルコマンドを使用して、Liferay DXPアップグレードを完了する方法について説明します。