構築・運用: WebOTX Application Server Manual

WebOTX Manual V10.2 (第4版)

目次を表示

4. その他機能

本章では、WebOTX にて提供している運用ツール及びサポートツールについて設定方法、使用方法を解説します。

4.1. マイクロサービスビルドツール

マイクロサービスビルドツールは、コマンドオプションで指定されたマイクロサービスプロファイルを展開し、ユーザアプリケーション、ユーザライブラリ、任意設定ファイル、起動スクリプト、Dockerファイルの配置、設定ファイル（config.properties）によるDomain.xmlの更新を行い、マイクロサービスパッケージとしてアーカイブファイル（*.zip）を出力するツールです。
マイクロサービスビルドツールは、Windows環境においてWebOTX Developer V10.2をインストールすることで、<WebOTXインストールディレクトリ>\Developer\ms-build-tool にインストールされます。（以降、マイクロサービスビルドツールのインストールディレクトリを ${TOOL_DIR} と記述します。）
Linux環境においてもコマンドで使用することが可能ですが、 ${TOOL_DIR} 配下をアーカイブし、Linux環境にファイル転送して、展開する必要がります。詳細は、[Linux環境へのインストール方法]を確認してください。

4.1.1. 使用方法

Windowsの場合

${TOOL_DIR}\bin>ms-build-tool.bat --app-server-name MicroServiceProfile --app-file application(*.war) [--lib-file LibraryFile] [--config-file configProperties] [--option-file optionFile] [--bootstrap-file scriptFile] [--docker-setting DockerSettingFile] [--output-file outputFile] [--echo [ true｜false ]] [--version] [--help [オプション名|all]] [--clean]

Linuxの場合

${TOOL_DIR}/bin>./ms-build-tool.sh --app-server-name MicroServiceProfile --app-file application(*.war) [--lib-file LibraryFile] [--config-file configProperties] [--option-file optionFile] [--bootstrap-file scriptFile] [--docker-setting DockerSettingFile] [--output-file outputFile] [--echo [ true｜false ]] [--version] [--help [オプション名|all]] [--clean]

コマンド引数	説明
--app-server-name	インストーラ、あるいは任意のリポジトリからダウンロードしたマイクロサービスプロファイルを指定します。ファイルの指定は、絶対パスまたは、相対パスで指定します。相対パスで指定する場合は、${TOOL_DIR}/app-server をカレントとする相対パスで指定します。このオプションは、必須です。
--app-file	コンパイルしてパッケージングしたアプリケーションファイル(*.war)を指定します。ファイルの指定は、絶対パスまたは、相対パスで指定します。相対パスで指定する場合は、コマンドの実行ディレクトリをカレントとする相対パスで指定します。このオプションは、必須です。
--lib-file	アプリケーションファイル(.war)が使用するライブラリファイル(.jar)を指定します。ファイルの指定は、絶対パスまたは、相対パスで指定します。相対パスで指定する場合は、コマンドの実行ディレクトリをカレントとする相対パスで指定します。 Windows環境でライブラリファイルを複数指定する場合は、";"（セミコロン）で区切って指定します。Linux環境の場合は、":"（コロン）で区切って指定します。このオプションは、省略可能です。
--config-file	マイクロサービスの domain.xml の設定変更を行うコンフィグプロパティファイル（config.properties）を指定します。ファイルの指定は、絶対パスまたは、相対パスで指定します。相対パスで指定する場合は、コマンドの実行ディレクトリをカレントとする相対パスで指定します。このオプションは、省略可能です。オプションを省略した場合は、${TOOL_DIR}/config/default-config.properties を使用して、domain.xmlの設定を行います。コンフィグプロパティファイル（config.properties）の設定内容については、[設定値の変更]を確認してください。
--option-file	マイクロサービス向け任意設定ファイルを指定します。ファイルの指定は、絶対パスまたは、相対パスで指定します。相対パスで指定する場合は、コマンドの実行ディレクトリをカレントとする相対パスで指定します。 Windows環境で任意設定ファイルを複数指定する場合は、";"（セミコロン）で区切って指定します。Linux環境の場合は、":"（コロン）で区切って指定します。このオプションは、省略可能です。
--bootstrap-file	起動スクリプト(ドメインの起動+プロセス監視)を指定します。ファイルの指定は、絶対パスまたは、相対パスで指定します。相対パスで指定する場合は、コマンドの実行ディレクトリをカレントとする相対パスで指定します。このオプションは、省略可能です。オプションを省略した場合は、${TOOL_DIR}/config/default-run.sh.templateを使用します。
--docker-setting	Dockerファイルを指定します。ファイルの指定は、絶対パスまたは、相対パスで指定します。相対パスで指定する場合は、コマンドの実行ディレクトリをカレントとする相対パスで指定します。このオプションは、省略可能です。オプションを省略した場合は、${TOOL_DIR}/config/default-run.sh.templateを使用します。
--output-file	マイクロサービスパッケージの出力ファイルを指定します。ファイルの指定は、絶対パスまたは、相対パスで指定します。相対パスで指定する場合は、コマンドの実行ディレクトリをカレントとする相対パスで指定します。このオプションは、省略可能です。オプションを省略した場合は、既定ファイル名my-ms-webotx-as.zipで、カレントディレクトリに出力します。
--echo	コマンドエコーの表示（true）、非表示（false）を指定します。このオプションは、省略可能です。オプションを省略した場合は、表示（true）を使用します。
--version	マイクロサービスビルドツールのバージョンを表示します。このオプションは、他のオプションと併用できません。
--help	マイクロサービスビルドツールのヘルプを表示します。 allまたは、オプション名を省略した場合は、usageとしてコマンドの書式を一覧を表示します。オプション名を指定した場合は、指定したオプション名の書式および説明を表示します。
--clean	マイクロサービスプロファイル（*.zip）の展開ディレクトリを削除してファイルの展開を行います。展開ディレクトリは、--app-server-nameのコマンドオプションで指定されたファイルと同じディレクトリに作成します。コマンドオプションを指定しない場合は、前回マイクロサービスプロファイルを展開した各ファイルを使用して、今回指定したファイルの配置および、更新を行います。前回と今回で配置するファイルが異なった場合、前回配置したファイルは削除されません。ファイル名が同一であれば、ファイルを上書きして配置します。

4.1.1.1. 使用例

マイクロサービスプロファイル（${TOOL_DIR}/app-server/webotx-as-microprofile-1.2.zip）、アプリケーションファイル（${TOOL_DIR}/tmp/example.war）、ライブラリファイル（${TOOL_DIR}/tmp/example.jar）を使用して、マイクロサービスパッケージファイル（（${TOOL_DIR}/tmp/my-ms-package.zip）を作成する場合のコマンド例です。

Windowsの場合

${TOOL_DIR}> .\bin\ms-build-tool.bat --app-server-name webotx-as-microprofile-1.2.zip --app-file .\tmp\example.war --lib-file .\tmp\example.jar --output-file .\tmp\my-ms-package.zip

Unixの場合

${TOOL_DIR}> ./bin/ms-build-tool.sh --app-server-name webotx-as-microprofile-1.2.zip --app-file ./tmp/example.war --lib-file ./tmp/example.jar --output-file ./tmp/my-ms-package.zip

4.1.2. Linux環境へのインストール方法

Windows環境にインストールされているWebOTX Developer V10.2に同梱されているマイクロサービスビルドツールをLinux環境へインストールする方法を説明します。
マイクロサービスビルドツールがインストールされているディレクトリ（<WebOTXインストールディレクトリ>\Developer\ms-build-tool）を ${TOOL_DIR} として、以降記述します。

${TOOL_DIR} のフォルダをzip形式でアーカイブします。
アーカイブしたファイルをファイル転送ツールやコマンドを使用して、対象となるLinux環境の任意のフォルダに転送します。
Linux環境のコンソールを起動します。
ファイル転送を行った任意のフォルダにCDコマンドで移動します。
unzipコマンドで転送したアーカイブファイルを解凍します。
CDコマンドで<任意フォルダ>/ms-build-tool/bin に移動します。
ms-build-tool.shにchmodコマンドで実行権限を付与します。