WebOTX Manual V10.4 (第4版) 目次を表示

---

15. マイクロサービスプロファイルを使用したWebOTX Uber JARの作成

15.1. 概要

15.1.1. WebOTX Uber JAR生成ツール

15.1.1.1. 前提条件

15.1.1.2. 機能概要

WebOTX Uber JARの作成

• WebOTXマイクロサービスランタイムのダウンロード
• ユーザアプリケーションの配置
• ユーザアプリケーションが実行時に依存するライブラリのダウンロード
• アプリケーションの実行に必要なファイルの配置・編集
• WebOTX Uber JARの作成

マイクロサービスパッケージの作成

• Dockerfileの編集
• WebOTX Uber JARの配置
• その他コンテナイメージ作成に必要なファイルの配置

15.1.1.3. 作成手順

• WebOTX Developer を利用して新規に作成
• Mavenコマンドを利用して新規に作成

15.2. WebOTX Developerを利用して新規に作成

15.2.1. Maven実行環境の準備

15.2.1.1. m2eのインストール

15.2.1.2. m2eプラグインの設定

• Installation home
  項目にインストール済みのMavenのフォルダパスを入力します。
  
• Installation name
  項目に任意のランタイム識別名を入力し終了をクリックします。
  

15.2.1.3. JRE設定の確認

15.2.2. Mavenプロジェクトの作成

15.2.2.1. 新規作成ウィザードの実行

15.2.2.2. WebOTXマイクロサービスMavenアーキタイプの選択

15.2.2.3. MavenプロジェクトのMaven GAVの設定

15.2.3. アプリケーションの作成

15.2.4. pom.xmlの編集

15.2.5. ビルド実行

15.2.5.1. 実行結果の確認

15.2.5.2. 出力ファイルの確認

• WebOTX Uber JAR
  [package-uberjarゴールの設定 > outputDirectory]で指定したディレクトリに出力します。
  出力先を指定しなければ、targetフォルダ直下に出力されます。
  
• マイクロサービスパッケージ
  [package-dockerゴールの設定 > outputDirectory]で指定したディレクトリに出力します。
  出力先を指定しなければ、target\webotx-ms-packageフォルダに出力されます。
  

15.2.6. Uber JARの実行確認

15.2.6.1. javaコマンドで実行

> java -jar <WebOTX Uber JARファイル名>.jar --basedir <展開先ディレクトリ>

>mkdir d:\work
>java -jar SampleAP-0.0.1-SNAPSHOT-micro.jar --basedir d:\work
展開先ディレクトリ d:\work

>java -jar SampleAP-0.0.1-SNAPSHOT-micro.jar
展開先ディレクトリ D:\Users\user\AppData\Local\Temp\webotx-micro-9654027332002318037

15.2.6.2. WebOTX Developerで実行

• 名前
  外部ツール構成の名前を設定します。 任意の名前を設定します。
  
• ロケーション
  JAVAコマンドの実行パスを設定します。
• 作業ディレクトリー
  プロジェクトフォルダを指定します。 ${workspace_loc:/＜プロジェクト名＞}
  
• 引数
  -jarオプションでWebOTX Uber JARファイルを設定します。
  -jar target\＜WebOTX Uber JARのjarファイル名＞ --basedir ＜展開先ディレクトリ＞
  

• その他
  MS932 を設定します。
  MS932以外の場合、コンソールに出力するWebOTXのログの日本語が正しく表示できません。

>java -jar SampleAP-0.0.1-SNAPSHOT-micro.jar
java.lang.IllegalArgumentException: アプリケーションは既に起動しています [PID: 7016 ]
    at com.nec.webotx.micro.boot.loader.Launcher.checkMultipleStartup(Launcher.java:604)
    at com.nec.webotx.micro.boot.loader.Launcher.launch(Launcher.java:90)
    at com.nec.webotx.micro.boot.WebOTXMicroLauncher.main(WebOTXMicroLauncher.java:36)
    at com.nec.webotx.micro.WebOTXMicro.main(WebOTXMicro.java:23)

>jps
10984 Jps
11304 org.eclipse.equinox.launcher_1.5.400.v20190515-0925.jar
5272 SampleAP-0.0.1-SNAPSHOT-micro.jar

>taskkill /F /PID 5272
成功: PID 5272 のプロセスは強制終了されました。

15.2.6.3. WebOTX Uber JARのサンプルアプリケーションの接続確認

  情報: Version 10.40.00.00 (build 20210402) ready in 29,839 (ms)

15.2.7. Uber JARのデバッグ

15.2.7.1. WebOTX Uber JARのデバッグを有効にする

• javaコマンドでdebugオプションを指定した実行例：
  

  java -Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=4004 -jar SampleAP-0.0.1-SNAPSHOT-micro.jar --basedir .

15.2.7.2. WebOTX Developerでリモートデバッグ

• 名前
  デバッグ構成の任意の名前を設定します。
  
• プロジェクト
  デバッグ対象のプロジェクトを選択します。
  プロジェクト・エクスプローラで選択しているプロジェクトがデフォルトで設定されています。
• ホスト
  WebOTX Uber JARの実行マシンのアドレスを設定します。
  
• ポート
  WebOTX Uber JARの実行時に指定したデバッグポートを設定します。
  
• リモートVMの終了を許可
  このオプションを有効にすると、Developerでデバッグ終了時にWebOTX Uber JARの実行も終了します。 終了させない場合は有効にしないでください。デフォルトは無効になっています。
  

• その他
  MS932 を設定します。
  MS932以外の場合、コンソールに出力するWebOTXのログの日本語が正しく表示できません。

15.3. Mavenコマンドを利用して新規に作成

15.3.1. Mavenプロジェクトの作成

> mvn archetype:generate -DarchetypeGroupId=com.nec.webotx -DarchetypeArtifactId=ms-uberjar-archetype -DarchetypeVersion=10.4 -DgroupId=com.sample -DartifactId=sample-app -Dversion=1.0-SNAPSHOT

15.3.2. アプリケーションの作成

15.3.3. pom.xmlの編集

15.3.4. ビルド実行

> mvn package

> mvn com.nec.webotx:ms-uberjar-maven-plugin:10.4:package-uberjar

> mvn com.nec.webotx:ms-uberjar-maven-plugin:10.4:package-docker

15.3.4.1. 実行結果の確認

15.3.4.2. 出力ファイルの確認

• WebOTX Uber JAR
  [package-uberjarゴールの設定 > outputDirectory]で指定したディレクトリに出力します。
  出力先を指定しなければ、targetフォルダ直下に出力されます。
  
• マイクロサービスパッケージ
  [package-dockerゴールの設定 > outputDirectory]で指定したディレクトリに出力します。
  出力先を指定しなければ、target\webotx-ms-packageフォルダに出力されます。
  

15.3.5. Uber JARの実行確認

> java -jar <WebOTX Uber JARファイル名>.jar --basedir <展開先ディレクトリ>

  情報: Version 10.40.00.00 (build 20210402) ready in 29,839 (ms)

15.4. コンテナイメージの作成

コンテナエンジンに Docker を使用する場合のコンテナイメージの作成ついて説明します。 コンテナエンジンに Podman を使用する場合は、docker コマンドを podman コマンドに読み替えてください。 詳細については、使用するコンテナエンジン、コンテナオーケストレーションツールのドキュメントを参照してください。

15.4.1. コンテナイメージの作成

コンテナイメージの作成は次のとおりの手順で行います。

1. マイクロサービスパッケージ(webotx-ms-package)をファイル転送ツールやコマンドを使用して、対象となるLinux環境の任意のフォルダに転送します。
2. ホストOSにログイン名 root でログインします。

   $ login: root

3. ファイル転送を行った任意のフォルダにCDコマンドで移動します。

   # cd <任意のフォルダ>/webotx-ms-package

4. Dockerのコンテナイメージを作成します。以下のコマンドを実行します。
   イメージ名を指定する場合はDockerの規約に従ってください。 必要であればbuildコマンドの--build-argオプションでhttp_proxy、https_proxy、no_proxyにコンテナイメージ生成時に使用するプロキシサーバの情報を指定してください。

   # docker build -t <イメージ名> .

5. コンテナイメージが生成されていることを確認します。 以下のコマンドを実行します。
   

   # docker images
   REPOSITORY TAG IMAGE ID CREATED
   <イメージ名> <タグ> ************ ** **** ago
   registry.access.redhat.com/rhel latest ************ ** **** ago

   (*) *** 部分の表記は環境によって異なります。
   
   生成時に指定した名前のイメージが表示されれば、生成完了です。

15.4.2. 動作確認

動作確認は次のとおりの手順で行います。

1. ホストOSにログイン名 root でログインします。

   $ login: root

2. コンテナを起動します。コンテナの環境変数OTX_LICENSEで製品の「ライセンスキー」を指定します。 また、コンテナ起動時にホスト8080番ポートへの通信をコンテナ8080番ポート(既定値)へ転送します。 以下のコマンドを実行します。

   # docker run -it -d -e OTX_LICENSE=<ライセンスキー> -p 8080:8080 <イメージ名>

   Caution
   指定する「ライセンスキー」は事前に購入していただく必要があります。

   Caution
   「8080番ポート」はホスト上で使用していないポート番号を指定してください。
   ポート番号が競合していないことを確認するには、以下のコマンドで確認できます。

   # ss -ant | grep 8080

   Memo
   デバッグを有効にする場合はJAVA_TOOL_OPTIONS にデバッグオプションを設定します。
   また、サービス用のポート番号に加えて、デバッグ用のポート番号もコンテナ外に公開してください。
   指定例は、以下のとおりです。

   # docker run -it -p 18080:8080 -p 14004:4004 -e JAVA_TOOL_OPTIONS="-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=4004"  <イメージ名>

3. 以下のコマンドを実行して、コンテナが起動していることを確認します。

   # docker ps
   CONTAINER ID IMAGE COMMAND CREATED
   537d3c548628 <イメージ名> "java -jar ・・・" 2 minutes ago
   

4. サンプルアプリを利用して、コンテナで動作しているWebOTX Uber JARへ接続確認します。Webブラウザを起動し、次のURLを入力してください。
   http://[ホストOSのIPアドレス]:8080/{artifactId}-{version}/parameter/query?param=ok
   Webブラウザ上に「ok」の表示が確認できれば、正常に動作しています。

15.5. pom.xmlの設定

15.5.1. configurationタグ記述箇所

15.5.1.1. プラグイン単位

<plugin>
    <groupId>com.nec.webotx</groupId>
    <artifactId>ms-uberjar-maven-plugin</artifactId>
    <version>10.4</version>
    <executions>
        <execution>
            <goals>
                <goal>package-uberjar</goal>
                <goal>package-docker</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
    ※ここに設定を記述します。
    </configuration>
</plugin>

15.5.1.2. ゴール単位

<plugin>
    <groupId>com.nec.webotx</groupId>
    <artifactId>ms-uberjar-maven-plugin</artifactId>
    <version>10.4</version>
    <executions>
        <execution>
            <goals>
                <goal>package-uberjar</goal>
            </goals>
            <configuration>
            ※ここに設定を記述します。
            </configuration>
        </execution>
        <execution>
            <goals>
                <goal>package-docker</goal>
            </goals>
            <configuration>
            ※ここに設定を記述します。
            </configuration>
        </execution>
    </executions>
</plugin>

15.5.2. 設定一覧

• package-uberjarゴール
• package-dockerゴール

15.5.2.1. package-uberjarゴールの設定

• webotxUberJar
• userApPath
• dependJars
• jdbcDriverPath
• jdbcDriverGAV
• jdkVersion
• configPropertiesPath
• preStartCmdsConfPath
• postStartCmdsConfPath
• postDeployCmdsConfPath
• keystoreJksPath
• cacertsJksPath
• policyConfPath
• deployFiles
• uberjarName
• outputDirectory

webotxUberJar

<webotxUberJar>
    <artifactItem>
        <groupId>com.nec.webotx</groupId>
        <artifactId>webotx-micro</artifactId>
        <version>10.41</version>
    </artifactItem>
</webotxUberJar>

userApPath

<userApPath>C:\xxx\yyy\zzz\app.war</userApPath>

dependJars

<dependJars>
    <artifactItem>
        <groupId>xxx.xxx.xxx</groupId>
        <artifactId>lib1</artifactId>
        <version>1.0.0</version>
    </artifactItem>
    <artifactItem>
        <groupId>yyy.yyy.yyy</groupId>
        <artifactId>lib2</artifactId>
        <version>2.0.0</version>
    </artifactItem>
</dependJars>

jdbcDriverPath

<jdbcDriverPath>
    <path>
        C:\xxx\yyy\zzz\jdbc-driver.jar
    </path>
</jdbcDriverPath>

jdbcDriverGAV

<jdbcDriverGAV>
    <artifactItem>
        <groupId>xxx.xxx.xxx</groupId>
        <artifactId>yyy</artifactId>
        <version>1.0</version>
    </artifactItem>
</jdbcDriverGAV>

jdkVersion

<jdkVersion>11</jdkVersion>

configPropertiesPath

<configPropertiesPath>C:\xxx\yyy\zzz\config.properties</configPropertiesPath>

preStartCmdsConfPath

<preStartCmdsConfPath>C:\xxx\yyy\zzz\pre-start-commands.conf</preStartCmdsConfPath>

postStartCmdsConfPath

<postStartCmdsConfPath>C:\xxx\yyy\zzz\post-start-commands.conf</postStartCmdsConfPath>

postDeployCmdsConfPath

<postDeployCmdsConfPath>C:\xxx\yyy\zzz\post-deploy-commands.conf</postDeployCmdsConfPath>

keystoreJksPath

<keystoreJksPath>C:\xxx\yyy\zzz\keystore.jks</keystoreJksPath>

cacertsJksPath

<cacertsJksPath>C:\xxx\yyy\zzz\cacerts.jks</cacertsJksPath>

policyConfPath

// Grant everyone the following permission:
grant {
    permission java.io.FilePermission "/tmp/*", "read,write";
};

<policyConfPath>C:\xxx\yyy\zzz\policy.conf</policyConfPath>

deployFiles

<deployFiles>
    <deployInfo>
        <src>C:\xxx\yyy\zzz\foo.jar</src>
        <dst>WebOTX\domains\domain1\lib\foo.jar</dst>
    </deployInfo>
</deployFiles>

uberjarName

<uberjarName>micro-uber</uberjarName>

outputDirectory

<outputDirectory>C:\xxx\yyy\zzz</outputDirectory>

15.5.2.2. package-dockerゴールの設定

• dockerfilePath
• baseImage
• jdk
• uberjarPath
• uberjarName
• outputDirectory

dockerfilePath

<dockerfilePath>${project.basedir}/webotx-config/default-Dockerfile-root</dockerfilePath>

baseImage

<baseImage>registry.access.redhat.com/ubi7/ubi-minimal</baseImage>

jdk

<jdk>C:\xxx\yyy\zzz\jdk-11.0.10_linux-x64_bin.tar.gz</jdk>

uberjarPath

<uberjarPath>C:\xxx\yyy\zzz</uberjarPath>

uberjarName

<uberjarName>micro-uber</uberjarName>

outputDirectory

<outputDirectory>C:\xxx\yyy\zzz</outputDirectory>

15.6. 既存アプリケーションの移行

15.6.1. JAVAプロジェクトで作成したアプリケーション

1. コンテナ向けプリケーション検証を行います。
   Memo
   Uber JAR向けにJavaアプリケーションを作成する場合、コンパイルエラー等の問題を解決後に「コンテナ向けアプリケーション検証機能」を使用してUber JARで動作可能か否かの確認を行ってください。変更が必要な場合は対処を行ってください。
   
2. WebOTX Developerにて、既存プロジェクトをMavenプロジェクトに変換します。
   既存プロジェクトの右クリックメニュー[構成] > [Convert to Maven Project]を実行してください。
3. プロジェクトディレクトリ直下に作成されるpom.xmlを編集します。
   
   • 次の記述を行い、WebOTXマイクロサービスMavenプラグインを使用する為の定義を行います。
     

     <plugins>
         <plugin>
             <groupId>com.nec.webotx</groupId>
             <artifactId>ms-uberjar-maven-plugin</artifactId>
             <version>10.4</version>
             <executions>
                 <execution>
                     <goals>
                         <goal>package-uberjar</goal>
                         <goal>package-docker</goal>
                     </goals>
                 </execution>
             </executions>
         </plugin>
     </plugins>
     

   • [pom.xmlの設定]を参照し、<plugin>タグ内に必要な定義を行います。
   • 次の記述を行い、依存ライブラリの定義を行います。
     

     <dependencies>
         <dependency>
             <groupId>依存ライブラリのgroupId</groupId>
             <artifactId>依存ライブラリのartifactId</artifactId>
             <version>依存ライブラリのversion</version>
             <scope>provided</scope>
         </dependency>
         ※上記<dependency>を１セットとして必要分を定義します。
     </dependencies>
     

4. 前項で[pom.xmlの設定]を参照して設定した内容に従い、必要なファイルを配置します。
   

mvn install:install-file -Dfile=<配置するライブラリファイルパス> -DgroupId=<groupId> -DartifactId=<artifactId> -Dversion=<version> -Dpackaging=jar

15.6.2. Mavenプロジェクトで作成したアプリケーション

1. コンテナ向けプリケーション検証を行います。
   Memo
   Uber JAR向けにJavaアプリケーションを作成する場合、コンパイルエラー等の問題を解決後に「コンテナ向けアプリケーション検証機能」を使用してUber JARで動作可能か否かの確認を行ってください。変更が必要な場合は対処を行ってください。
   
2. プロジェクトディレクトリ直下のpom.xmlを編集します。
   
   • 次の記述を行い、WebOTXマイクロサービスMavenプラグインを使用する為の定義を行います。
     

     <plugins>
         <plugin>
             <groupId>com.nec.webotx</groupId>
             <artifactId>ms-uberjar-maven-plugin</artifactId>
             <version>10.4</version>
             <executions>
                 <execution>
                     <goals>
                         <goal>package-uberjar</goal>
                         <goal>package-docker</goal>
                     </goals>
                 </execution>
             </executions>
         </plugin>
     </plugins>
     

   • [pom.xmlの設定]を参照し、<plugin>タグ内に必要な定義を行います。
3. 前項で[pom.xmlの設定]を参照して設定した内容に従い、必要なファイルを配置します。
   

15.7. ライセンスについて