前回は、既存のJakarta EEアプリケーションをコンテナ化する方法を紹介しました。既存のJakarta EE アプリケーション(WAR)を JBoss EAP でコンテナ化 - 赤帽エンジニアブログ

今回は昔から運用されている Servlet/JSP で動作する Java EE アプリケーションをコンテナ化してOpenShiftへデプロイする方法を紹介します。

必要な作業は以下の4つです。

Jakarta EE に対応（今回は説明を省きます）
Mavenの導入
Git対応
Helmの作成

Jakarta EEに対応

アプリケーションを Java EE から Jakarta EE に移行します。 JBoss EAP 8.0 は Jakarta EE 10 に対応しており、Java EE には対応していないためです。本記事は、この移行が目的ではないため省略します。この移行を支援するツールとして、Migration Toolkit があります。 Migration Toolkit は Red Hat が提供しているツールです。

Maven の導入

次に、アプリケーションのビルドのため Maven を導入します。多くのアプリケーションはすでに導入しているでしょう。しかしながら、一部のアプリケーションは Ant や独自の方法でビルドしているかもしれません。今回は、最低限必要な Maven の設定を記載しています。これから Maven を使う場合は、これをベースに依存関係を追加してください。すでにMavenを使っている場合は、この設定を既存の設定に追加してください。

今回は、 Servlet/JSP を実行可能な、できるだけコンパクトな JBoss EAP をデプロイします。 JBoss EAP はアプリケーションが必要とする機能だけをもつコンパクトな JBoss EAP を作成できます。この仕組みを Galleon と言います。 Galleon は各機能を Layer として定義しています。 Servlet/JSP を実行できる Layer は web-server です。 Layer は今回使用しているweb-serverのほかにも、ejbやjaxrsなどさまざまあります。

他にどのような Layer があるのかは以下に記載されています。

第8章 JBoss EAP for OpenShift の機能のトリム | Red Hat Product Documentation

また、Galleon 自体に興味のある方はこちらをごらん下さい。

Galleon Provisioning Guide

今回使用する pom.xml は以下のとおりです。

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>org.example</groupId>
    <artifactId>jee-traditional</artifactId>
    <packaging>war</packaging>
    <version>1.0-SNAPSHOT</version>

    <profiles>
        <profile>
            <id>openshift</id>
        </profile>
        <profile>
            <id>develop</id>
            <activation>
                <activeByDefault>true</activeByDefault>
            </activation>
        </profile>
    </profiles>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.jboss.bom</groupId>
                <artifactId>jboss-eap-ee</artifactId>
                <version>8.0.0.GA-redhat-00009</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
    <pluginRepositories>
        <pluginRepository>
            <id>jboss</id>
            <url>https://maven.repository.redhat.com/ga/</url>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </pluginRepository>
    </pluginRepositories>
    <repositories>
        <repository>
            <id>jboss</id>
            <url>https://maven.repository.redhat.com/ga/</url>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </repository>
    </repositories>

    <build>
        <finalName>ROOT.war</finalName>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-war-plugin</artifactId>
                <version>3.4.0</version>
            </plugin>
            <plugin>
                <groupId>org.jboss.eap.plugins</groupId>
                <artifactId>eap-maven-plugin</artifactId>
                <version>1.0.0.Final-redhat-00014</version>
                <configuration>
                    <channels>
                        <channel>
                            <manifest>
                                <groupId>org.jboss.eap.channels</groupId>
                                <artifactId>eap-8.0</artifactId>
                            </manifest>
                        </channel>
                    </channels>
                    <feature-packs>
                        <feature-pack>
                            <location>org.jboss.eap:wildfly-ee-galleon-pack</location>
                        </feature-pack>
                        <feature-pack>
                            <location>org.jboss.eap.cloud:eap-cloud-galleon-pack</location>
                        </feature-pack>
                    </feature-packs>
                    <layers>
                        <layer>web-server</layer>
                    </layers>
                    <runtime-name>ROOT.war</runtime-name>
                </configuration>
                <executions>
                    <execution>
                        <goals>
                            <goal>package</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

Git 対応

アプリケーションは Git リポジトリで管理します。 OpenShift は後に指定する Git リポジトリからアプリケーションのソースコードを取得して、ビルドします。 Git リポジトリは OpenShift からアクセスできればどこでも大丈夫です。今回は、GitHub 上のリポジトリを用います。

github.com

Helm 対応

最後に、Helmチャートを使用してアプリケーションを含んだ JBoss EAP を作成します。 Helm は、CLI の helm コマンドを使うか、OpenShift のコンソール上で使用します。

OpenShiftのコンソールはこの図の 作成 から進み、HelmチャートはJBoss EAP 8を選択してください。

今回は、CLI ツールを用います。各OSが提供しているパッケージマネージャでhelmをインストールしましょう。

まずはHelmリリースの定義をYAMLで作成します。このYAMLはhelm.yamlとします。ファイルの中身は以下のようにします。 build.uri には先ほどの Git の URL を指定します。

build:
  uri: https://github.com/chiroito/jee-traditional.git
deploy:
  replicas: 1

あとは、helmコマンドでOpenShiftにインストールするだけです。今回はmyappという名前でインストールします。 oc projectコマンドで自分の望んでいるプロジェクトに移動してから、実行しましょう。

> oc project home
> helm install myapp -f helm.yaml jboss-eap/eap8

ここまでで全て完了しました。

OpenShift で確認

アプリケーションが OpenShift にデプロイされたかを確認します。

開発者向けの表示のBuildsをクリックします。 Buildsに my-app-build-artifacts というBuildConfigsができているはずです。 最終実行のステータスが Completeになっていればビルドは成功です。 Runningはまだビルドしています。

他のステータスになったら、実行を確認しましょう。 最終実行のカラムにあるmyapp-build-artifacts-1をクリックします。ログのタブをクリックするとログが出力されます。出力されたログから失敗した原因を確認しましょう。

ビルドが成功したら、アプリケーションがデプロイされています。左側のメニューのトポロジー をクリックします。ここにmyappというアイコンができているはずです。これをクリックすると、右側に詳細が表示されます。その詳細で、青色の丸の中に1 Podと表示されていればアプリケーションが起動しています。 0 Podの場合はアプリケーションの起動がまだ終わっていないか、起動に失敗しています。青丸の上のリソースタブを開き、Podsのログを表示して、失敗の原因を確認しましょう。