JBoss EAP XP 2.0.0 での Eclipse MicroProfile の使用

手順

1. JBoss EAP 7.3.4 GA パッチを JBoss EAP サーバーに適用していない場合は、JBoss EAP XP マネージャー 2.0.0 patch-apply コマンドを使用して JBoss EAP 7.3.4 GA パッチを適用します。

   $ java -jar jboss-eap-xp-manager.jar patch-apply --jboss-home=/PATH/TO/EAP --patch=/PATH/TO/PATCH/jboss-eap-7.3.4-patch.zip

   patch-apply コマンドは、patch apply 管理 CLI コマンドに似ています。patch apply 管理 CLI コマンドを使用して、パッチを適用することもできます。

2. 以下のコマンドを使用して EAP XP 2.0 パッチストリームを管理するために、JBoss EAP XP マネージャー 2.0.0 を設定します。

   $ java -jar jboss-eap-xp-manager.jar setup --jboss-home=/PATH/TO/EAP

   注記

   JBoss EAP XP 2.0.0 パッチを同時に適用することができます。--xp-patch 引数を使用して JBoss EAP XP 2.0.0 パッチへのパスを含めます。

   例:

   $ java -jar jboss-eap-xp-manager.jar setup --jboss-home=/PATH/TO/EAP --xp-patch /PATH/TO/PATCH/jboss-eap-xp-2.0.0-patch.zip

   これで、サーバーが JBoss EAP XP 2.0 パッチストリームを管理できるようになりました。

3. 任意設定: setup コマンドで --xp-patch 引数を使用しない場合は、JBoss EAP XP マネージャー 2.0.0 patch-apply コマンドを使用して JBoss EAP XP 2.0.0 パッチを適用します。

   $ java -jar jboss-eap-xp-manager.jar patch-apply --jboss-home=/PATH/TO/EAP --patch=/PATH/TO/PATCH/jboss-eap-xp-2.0.0-patch.zip

手順

1. サーバーが正しいパッチにあり、JBoss EAP XP 1.0.x がインストールされていることを確認します。

   $ java -jar jboss-eap-xp-manager.jar status --jboss-home=__<path_to_eap>__
   ...
   You are currently on JBoss EAP XP 1.
   You are using an old version of JBoss EAP XP. The current version is 2, please upgrade.
   Enabled patch streams and their cumulative patch ids:
   - Patch stream: 'JBoss EAP'; Cumulative patch id: 'jboss-eap-7.3.4'
   - Patch stream: 'jboss-eap-xp-1.0'; Cumulative patch id: 'jboss-eap-xp-1.0.0.CP'
   Available commands in this state are: [remove, upgrade]

   この出力は、サーバーが JBoss EAP XP 2.0.0 にアップグレードする準備ができていることを示しています。

   他の出力が表示される場合は、トラブルシューティングの推奨事項を参照してください。

2. upgrade コマンドを使用して JBoss EAP XP 1.0.x を 2.0.0 にアップグレードし、JBoss EAP XP 2.0.0 パッチを適用します。

   $ java -jar jboss-eap-xp-manager.jar upgrade --jboss-home=__<path_to_eap>__ --xp-patch=__<path_to_patch>__/jboss-eap-xp-2.0.0-patch.zip

3. yes を入力して、サポートポリシープロンプトを受け入れます。

   サーバーは JBoss EAP XP 2.0.0 パッチストリームを管理する準備ができており、JBoss EAP XP 2.0.0 パッチで更新されます。

手順

1. oc login コマンドを使用して、OpenShift インスタンスにログインします。

2. OpenShift で新しいプロジェクトを作成します。

   プロジェクトでは、1 つのユーザーグループが他のグループとは別にコンテンツを整理および管理することができます。以下のコマンドを使用すると OpenShift でプロジェクトを作成できます。

   $ oc new-project PROJECT_NAME

   たとえば、以下のコマンドを使用して、microprofile-config クイックスタートで eap-demo という名前の新規プロジェクトを作成します。

   $ oc new-project eap-demo

手順

1. Red Hat カスタマーポータルの手順にしたがって、レジストリーサービスアカウント管理アプリケーション を使用して認証トークンを作成します。

2. トークンの OpenShift シークレットが含まれる YAML ファイルをダウンロードします。

   YAML ファイルは、トークンの Token Information ページの OpenShift Secret タブからダウンロードできます。

3. ダウンロードした YAML ファイルを使用して、OpenShift プロジェクトの認証トークンシークレットを作成します。

   oc create -f 1234567_myserviceaccount-secret.yaml

4. 以下のコマンドを使用して、OpenShift プロジェクトのシークレットを設定します。シークレット名は前のステップで作成したシークレットの名前に置き換えてください。

   oc secrets link default 1234567-myserviceaccount-pull-secret --for=pull
   oc secrets link builder 1234567-myserviceaccount-pull-secret --for=pull

   関連情報

   • Red Hat コンテナーレジストリーへの認証の設定
   • レジストリーサービスアカウント管理アプリケーション
   • 安全なレジストリーにアクセスの設定

手順

1. 以下のコマンドをいずれか 1 つ使用して、JBoss EAP XP の OpenShift イメージの最新 JDK 8 および JDK 11 イメージストリームとテンプレートを OpenShift プロジェクトの名前空間にインポートします。

   1. JDK 8 イメージストリームのインポート:

      oc replace --force -f https://raw.githubusercontent.com/jboss-container-images/jboss-eap-openshift-templates/eap-xp2/jboss-eap-xp2-openjdk8-openshift.json

      このコマンドは以下のイメージストリームおよびテンプレートをインポートします。

      • JDK 8 ビルダーイメージストリーム: jboss-eap-xp2-openjdk8-openshift
      • JDK 8 ランタイムイメージストリーム: jboss-eap-xp2-openjdk8-runtime-openshift

   2. JDK 11 イメージストリームのインポート:

      oc replace --force -f https://raw.githubusercontent.com/jboss-container-images/jboss-eap-openshift-templates/eap-xp2/jboss-eap-xp2-openjdk11-openshift.json

      このコマンドは以下のイメージストリームおよびテンプレートをインポートします。

      • JDK 11 ビルダーイメージストリーム: jboss-eap-xp2-openjdk11-openshift
      • JDK 11 ランタイムイメージストリーム: jboss-eap-xp2-openjdk11-runtime-openshift

   3. JDK 8 および JDK 11 テンプレートをインポートします。

      for resource in \
      eap-xp2-basic-s2i.json \
      eap-xp2-third-party-db-s2i.json
      do
      oc replace --force -f https://raw.githubusercontent.com/jboss-container-images/jboss-eap-openshift-templates/eap-xp2/templates/${resource}
      done

   注記

   上記のコマンドを使用してインポートされた JBoss EAP XP イメージストリームおよびテンプレートは、OpenShift プロジェクト内のみで利用できます。

2. 一般的な openshift namespace にアクセスできる管理者権限を持っている場合、すべてのプロジェクトがイメージストリームおよびテンプレートにアクセスできるようにするには、コマンドの oc replace 行に -n openshift を追加します。以下に例を示します。

   ...
   oc replace -n openshift --force -f \
   ...

3. イメージストリームとテンプレートを別のプロジェクトにインポートする必要がある場合には、コマンドラインの oc replace に -n PROJECT_NAME を追加します。以下に例を示します。

   ...
   oc replace -n PROJECT_NAME --force -f
   ...

   cluster-samples-operator を使用する場合は、クラスターサンプルオペレーターの設定についての OpenShift ドキュメントを参照してください。クラスターサンプルオペレーターの詳細は、https://docs.openshift.com/container-platform/latest/openshift_images/configuring-samples-operator.html を参照してください。

手順

1. JBoss EAP XP イメージと Java アプリケーションのソースコードを使用して、新しい OpenShift アプリケーションを作成します。S2I ビルド用に提供される JBoss EAP XP テンプレートの 1 つを使用します。

   $ oc new-app --template=eap-xp2-basic-s2i \ 1
    -p EAP_IMAGE_NAME=jboss-eap-xp2-openjdk8-openshift:latest \
    -p EAP_RUNTIME_IMAGE_NAME=jboss-eap-xp2-openjdk8-runtime-openshift:latest \
    -p IMAGE_STREAM_NAMESPACE=eap-demo \ 2
    -p SOURCE_REPOSITORY_URL=https://github.com/jboss-developer/jboss-eap-quickstarts \ 3
    -p SOURCE_REPOSITORY_REF=xp-2.0.x \ 4
    -p CONTEXT_DIR=microprofile-config 5

   1

   使用するテンプレート。アプリケーションイメージは latest でタグ付けされます。

   2

   最新のイメージとテンプレートは、プロジェクトの namespace にインポートされたため、イメージストリームが見つかる場所の namespace を指定する必要があります。通常はプロジェクトの名前になります。

   3

   アプリケーションのソースコードが含まれるリポジトリーの URL。

   4

   ソースコードに使用する Git リポジトリー参照。Git ブランチやタグ参照にすることができます。

   5

   ビルドするソースリポジトリー内のディレクトリー。

   別の例として、JDK 11 ランタイムイメージを使用して microprofile-config クイックスタートをデプロイするには、以下のコマンドを入力します。このコマンドは、GitHub の microprofile-config ソースコードとともに アプリケーションのデプロイメントに向けた OpenShift の準備 セクションで作成した、eap-demo プロジェクトで eap-xp2-basic-s2i テンプレートを使用します。

   $ oc new-app --template=eap-xp2-basic-s2i \ 1
    -p EAP_IMAGE_NAME=jboss-eap-xp2-openjdk11-openshift:latest \
    -p EAP_RUNTIME_IMAGE_NAME=jboss-eap-xp2-openjdk11-runtime-openshift:latest \
    -p IMAGE_STREAM_NAMESPACE=eap-demo \ 2
    -p SOURCE_REPOSITORY_URL=https://github.com/jboss-developer/jboss-eap-quickstarts \ 3
    -p SOURCE_REPOSITORY_REF=xp-2.0.x \ 4
    -p CONTEXT_DIR=microprofile-config 5

   1

   使用するテンプレート。アプリケーションイメージは latest でタグ付けされます。

   2

   最新のイメージとテンプレートは、プロジェクトの名前空間にインポートされたため、イメージストリームが見つかる場所の namespace を指定する必要があります。通常はプロジェクトの名前になります。

   3

   アプリケーションのソースコードが含まれるリポジトリーの URL。

   4

   ソースコードに使用する Git リポジトリー参照。Git ブランチやタグ参照にすることができます。

   5

   ビルドするソースリポジトリー内のディレクトリー。

   注記

   テンプレートは、多くのテンプレートパラメーターにデフォルト値を指定でき、一部またはすべてのデフォルトをオーバーライドする必要がある場合があります。パラメーターのリストやデフォルト値などのテンプレートの情報を表示するには、コマンド oc describe template TEMPLATE_NAME を使用します。

   新しい OpenShift アプリケーションを作成するときに、環境変数を設定 することもあります。

2. ビルド設定の名前を取得します。

   $ oc get bc -o name

3. 取得したビルド設定の名前を使用し、Maven のビルドの進捗を表示します。

   $ oc logs -f buildconfig/${APPLICATION_NAME}-build-artifacts
   
   …
   Push successful
   $ oc logs -f buildconfig/${APPLICATION_NAME}
   …
   Push successful

   たとえば、microprofile-config の場合、以下のコマンドは Maven ビルドの進捗状況を表示します。

   $ oc logs -f buildconfig/eap-xp2-basic-app-build-artifacts
   
   …
   Push successful
   $ oc logs -f buildconfig/eap-xp2-basic-app
   …
   Push successful

   関連情報

   • JBoss EAP XP の最新の OpenShift イメージストリームおよびテンプレートのインポート
   • アプリケーションのデプロイメントに向けた OpenShift の準備

手順

1. 以下のコマンドを使用してアプリケーションのサービス名を取得します。

   $ oc get service

2. オプション: メインサービスをルートとして公開し、OpenShift 外部からアプリケーションにアクセスできるようにします。たとえば、microprofile-config クイックスタートでは、以下のコマンドを使用して必要なサービスとポートを公開します。

   注記

   テンプレートを使用してアプリケーションを作成した場合は、ルートがすでに存在することがあります。存在する場合は次のステップに進みます。

   $ oc expose service/eap-xp2-basic-app --port=8080

3. ルートの URL を取得します。

   $ oc get route

4. この URL を使用して web ブラウザーでアプリケーションにアクセスします。URL は前のコマンド出力にある HOST/PORT フィールドの値になります。

   注記

   JBoss EAP XP 2.0.0 GA ディストリビューションでは、Micprofile Config クイックスタートはアプリケーションのルートコンテキストに対して HTTPS GET リクエストに応答しません。今回の機能拡張は、{JBossXPShortName101} GA ディストリビューションでのみ利用可能です。

   たとえば、Micprofile Config アプリケーションと対話するには、ブラウザーの URL は http://HOST_PORT_Value/config/value になります。

   アプリケーションが JBoss EAP ルートコンテキストを使用しない場合、アプリケーションのコンテキストを URL に追加します。たとえば、microprofile-config クイックスタートの URL は http://HOST_PORT_VALUE/microprofile-config/ のようになります。

5. 任意で、以下のコマンドを実行してアプリケーションインスタンスをスケールアップすることもができます。このコマンドにより、レプリカ数が 3 に増えます。

   $ oc scale deploymentconfig DEPLOYMENTCONFIG_NAME --replicas=3

   たとえば、microprofile-config クイックスタートでは、以下のコマンドを使用してアプリケーションをスケールアップします。

   $ oc scale deploymentconfig/eap-xp2-basic-app --replicas=3

手順

1. New Server ダイアログボックスで新しいサーバーを設定します。

   1. Select server type リストで Red Hat JBoss Enterprise Application Platform 7.3 を選択します。
   2. Server's host name フィールドに localhost を入力します。
   3. Server name フィールドに JBoss EAP 7.3 XP を入力します。
   4. 次へ をクリックします。

2. 新しいサーバーの設定

   1. Home directory フィールドに、デフォルト設定を使用しない場合は、新しいディレクトリーを指定します (例: home/myname/dev/microprofile/runtimes/jboss-eap-7.3)。
   2. Ezecution Environment が JavaSE-1.8 に設定されていることを確認します。
   3. 任意: Server base directory と Configuration file フィールドの値を変更します。
   4. Finish をクリックします。

手順

1. Quickstart Parent Artifact から pom.xml ファイルをインポートします。

2. 使用しているクイックスタートで環境変数が必要な場合は、環境変数を設定します。

   サーバーの 概要 ダイアログボックスで、起動設定に環境変数を定義します。

   たとえば、microprofile-opentracing クイックスタートでは以下の環境変数を使用します。

   • JAEGER_REPORTER_LOG_spans を true に設定
   • JAEGER_SAMPLER_PARAM を 1 に設定
   • JAEGER_SAMPLER_TYPE を const に設定

手順

1. アプリケーションの実行に必要な機能を提供する、サポートされる JBoss EAP Galleon レイヤーを特定します。

2. Maven プロジェクトの pom.xml ファイルの <plugin> 要素で JBoss EAP feature-pack の場所を参照します。以下の例のように、最新バージョンの Maven プラグインと org.jboss.eap:wildfly-galleon-pack Galleon 機能パックの最新バージョンを指定する必要があります。以下の例は、jaxrs-server ベースレイヤーおよび jpa-distribute レイヤーを含む単一の feature-pack も含まれています。jaxrs-server ベースレイヤーは、サーバーの追加サポートを提供します。

   <plugins>
         <plugin>
               <groupId>org.wildfly.plugins</groupId>
                <artifactId>wildfly-jar-maven-plugin</artifactId>
                <version>${bootable.jar.maven.plugin.version}</version>
               <configuration>
                    <feature-pack-location>org.jboss.eap:wildfly-galleon-pack:${jboss.xp.galleon.feature.pack.version}</feature-pack-location>
                    <layers>
                        <layer>jaxrs-server</layer>
                        <layer>jpa-distributed</layer>
                    </layers>
                    <excluded-layers>
                        <layer>jpa</layer>
                    </excluded-layers>
                    ...
   </plugins>

   この例では、プロジェクトからの jpa レイヤーの除外も示しています。

   注記

   jpa-distributed レイヤーをプロジェクトに含める場合は、jaxrs-server レイヤーから jpa レイヤーを除外する必要があります。jpa レイヤーはローカルの infinispan hibernate キャッシュを設定し、jpa-distributed レイヤーはリモート infinispan hibernate キャッシュを設定します。

手順

1. 以下の内容を pom.xml ファイルの <build> 要素に追加します。最新バージョンの Maven プラグインと、org.jboss.eap:wildfly-galleon-pack Galleon 機能パックの最新バージョンを指定する必要があります。以下に例を示します。

   <plugins>
       <plugin>
           <groupId>org.wildfly.plugins</groupId>
           <artifactId>wildfly-jar-maven-plugin</artifactId>
           <version>${bootable.jar.maven.plugin.version}</version>
           <configuration>
                <feature-pack-location>org.jboss.eap:wildfly-galleon-pack:${jboss.xp.galleon.feature.pack.version}</feature-pack-location>
               <layers>
                   <layer>jaxrs-server</layer>
                   <layer>microprofile-platform</layer>
               </layers>
            </configuration>
           <executions>
               <execution>
                   <goals>
                       <goal>package</goal>
                   </goals>
               </execution>
           </executions>
       </plugin>
   </plugins>

   注記

   pom.xml ファイルで Galleon レイヤーを指定しない場合、起動可能な JAR サーバーには standalone-microprofile.xml 設定と同じ設定が含まれます。

2. アプリケーションを起動可能な JAR としてパッケージ化します。

   $ mvn package

3. アプリケーションを起動します。

   $ NAME="foo" java -jar target/microprofile-config-bootable.jar

   注記

   この例では、環境変数に NAME を使用しますが、デフォルト値の jim を使用することができます。

   注記

   サポートされる起動可能な JAR 引数の一覧を表示するには、--help を java -jar target/microprofile-config-bootable.jar コマンドの最後に追加します。

4. Web ブラウザーで以下の URL を指定して Eclipse MicroProfile Config アプリケーションにアクセスします。

   http://localhost:8080/config/json

5. 検証: ターミナルで以下のコマンドを実行し、アプリケーションが適切に動作します。

   curl http://localhost:8080/config/json

   以下が想定される出力です。

   {"result":"Hello foo"}

手順

1. 起動可能な hollow JAR をビルドするには、プロジェクトの pom.xml ファイルで <hollow-jar> プラグイン設定要素を true に設定する必要があります。以下に例を示します。

1. 起動可能な hollow JAR をビルドします。

   $ mvn clean package

2. 起動可能な hollow JAR を実行します。

   $ java -jar target/microprofile-config-bootable.jar --deployment=target/microprofile-config.war

   重要

   サーバーにデプロイする WAR ファイルへのパスを指定するには、以下の引数を使用します。<PATH_NAME> は、デプロイメントへのパスになります。

   --deployment=<PATH_NAME>

3. アプリケーションにアクセスします。

   $ curl http://localhost:8080/microprofile-config/config/json

   注記

   root ディレクトリーに Web アプリケーションを登録するには、アプリケーションに ROOT.war という名前を付けます。

手順

1. 以下の内容を pom.xml ファイルの <build> 要素に追加します。最新バージョンの Maven プラグインと、org.jboss.eap:wildfly-galleon-pack Galleon 機能パックの最新バージョンを指定する必要があります。以下に例を示します。

   <plugins>
       <plugin>
           <groupId>org.wildfly.plugins</groupId>
           <artifactId>wildfly-jar-maven-plugin</artifactId>
           <version>${bootable.jar.maven.plugin.version}</version>
           <configuration>
               <feature-pack-location>org.jboss.eap:wildfly-galleon-pack:${jboss.xp.galleon.feature.pack.version}</feature-pack-location>
               <layers>
                   <layer>jaxrs-server</layer>
                   <layer>microprofile-platform</layer>
               </layers>
               <cloud/>
               </configuration>
               <executions>
                   <execution>
                       <goals>
                           <goal>package</goal>
                       </goals>
                   </execution>
               </executions>
       </plugin>
   </plugins>

   注記

   <cloud/> 要素をプラグイン設定の <configuration> 要素に含める必要があります。そのため、JBoss EAP Maven JAR プラグインは OpenShift プラットフォームを選択できます。

2. アプリケーションをパッケージ化します。

   $ mvn package

3. oc login コマンドを使用して、OpenShift インスタンスにログインします。

4. OpenShift で新しいプロジェクトを作成します。以下に例を示します。

   $ oc new-project bootable-jar-project

5. 以下の oc コマンドを入力してアプリケーションイメージを作成します。

   $ mkdir target/openshift && cp target/microprofile-config-bootable.jar target/openshift  1
   
   $ oc import-image ubi8/openjdk-11 --from=registry.redhat.io/ubi8/openjdk-11 --confirm 2
   
   $ oc new-build --strategy source --binary --image-stream openjdk-11 --name microprofile-config-app 3
   
   $ oc start-build microprofile-config-app --from-dir target/openshift 4

   1

   ターゲットディレクトリーに openshift サブディレクトリーを作成します。パッケージ化されたアプリケーションが、作成されたサブディレクトリーにコピーされます。

   2

   最新の OpenJDK 11 イメージストリームタグおよびイメージ情報を OpenShift プロジェクトにインポートします。

   3

   microprofile-config-app ディレクトリーおよび OpenJDK 11 イメージストリームに基づいてビルド設定を作成します。

   4

   target/openshift サブディレクトリーをバイナリー入力として使用し、アプリケーションをビルドします。

   注記

   OpenShift は CLI スクリプトコマンドのセットを起動可能な JAR 設定ファイルに適用し、クラウド環境に合わせて調整します。このスクリプトにアクセスするには、Maven プロジェクト /target directory の bootable-jar-build-artifacts/generated-cli-script.txt ファイルを開きます。

6. 検証:

   利用可能な OpenShift Pod の一覧を表示し、以下のコマンドを実行して Pod のビルドステータスを確認します。

   $ oc get pods

   ビルドされたアプリケーションイメージを確認します。

   $ oc get is microprofile-config-app

   出力には、名前、イメージリポジトリー、タグなどのビルドされたアプリケーションイメージの詳細が表示されます。この手順の例では、イメージストリーム名とタグの出力には microprofile-config-app:latest が表示されます。

7. アプリケーションをデプロイします。

   重要

   起動可能な JAR にシステムプロパティーを指定するには、JAVA_OPTS_APPEND 環境変数を使用する必要があります。以下の例は、JAVA_OPTS_APPEND 環境変数の使用方法を示しています。

   oc new-app <_IMAGESTREAM_> -e JAVA_OPTS_APPEND="-Xlog:gc*:file=/tmp/gc.log:time -Dwildfly.statistics-enabled=true"

   $ oc new-app microprofile-config-app
   
   $ oc expose svc/microprofile-config-app

   重要

   起動可能な JAR にシステムプロパティーを指定するには、JAVA_OPTS_APPEND 環境変数を使用する必要があります。以下の例は、JAVA_OPTS_APPEND 環境変数の使用方法を示しています。

   $ oc new-app <_IMAGESTREAM_> -e JAVA_OPTS_APPEND="-Xlog:gc*:file=/tmp/gc.log:time -Dwildfly.statistics-enabled=true"

   新しいアプリケーションが作成され、起動します。アプリケーション設定は新しいサービスとして公開されます。

8. 検証: ターミナルで以下のコマンドを実行し、アプリケーションが適切に動作するかどうかをテストします。

   $ curl http://$(oc get route microprofile-config-app --template='{{ .spec.host }}')/config/json

   想定される出力:

   {"result":"Hello jim"}

手順

1. プロジェクトのルートディレクトリーに scripts という名前のディレクトリーを作成します。以下に例を示します。

   $ mkdir scripts

2. cli.properties ファイルを作成し、そのファイルを /scripts ディレクトリーに保存します。このファイルに config.path および config.ordinal システムプロパティーを定義します。以下に例を示します。

   config.path=/etc/config
   config.ordinal=200

3. mp-config.cli などの CLI スクリプトを作成し、これを /scripts ディレクトリーなどの起動可能な JAR のアクセス可能なディレクトリーに保存します。以下の例は、mp-config.cli スクリプトの内容を示しています。

   # config map
   
   /subsystem=microprofile-config-smallrye/config-source=os-map:add(dir={path=${config.path}}, ordinal=${config.ordinal})

   mp-config.cli CLI スクリプトは、新しい ConfigSource を作成し、Pipelineal および path の値をプロパティーファイルから取得します。

4. スクリプトを /scripts ディレクトリーに保存します。このディレクトリーは、プロジェクトのルートディレクトリーにあります。

5. 既存のプラグイン <configuration> 要素に以下の設定抽出を追加します。

   <cli-sessions>
       <cli-session>
           <properties-file>
               scripts/cli.properties
           </properties-file>
           <script-files>
               <script>scripts/mp-config.cli</script>
           </script-files>
       </cli-session>
   </cli-sessions>

6. アプリケーションをパッケージ化します。

   $ mvn package

7. oc login コマンドを使用して、OpenShift インスタンスにログインします。

8. オプション: target/openshift サブディレクトリーを作成していない場合は、以下のコマンドを実行してサブディレクトリーを作成する必要があります。

   $ mkdir target/openshift

9. パッケージ化したアプリケーションを、作成したサブディレクトリーにコピーします。

   $ cp target/microprofile-config-bootable.jar target/openshift

10. target/openshift サブディレクトリーをバイナリー入力として使用し、アプリケーションをビルドします。

    $ oc start-build microprofile-config-app --from-dir target/openshift

    注記

    OpenShift は CLI スクリプトコマンドのセットを起動可能な JAR 設定ファイルに適用し、クラウド環境に合わせて調整します。このスクリプトにアクセスするには、Maven プロジェクト /target directory の bootable-jar-build-artifacts/generated-cli-script.txt ファイルを開きます。

11. ConfigMap を作成します。以下に例を示します。

    $ oc create configmap microprofile-config-map --from-literal=name="Name comes from Openshift ConfigMap"

12. dc を使用して、ConfigMap をアプリケーションにマウントします。以下に例を示します。

    $ oc set volume deployments/microprofile-config-app --add --name=config-volume \
    --mount-path=/etc/config \
    --type=configmap \
    --configmap-name=microprofile-config-map

    oc set volume コマンドを実行すると、アプリケーションは新しい設定で再デプロイされます。

13. 出力をテストします。

    $ curl http://$(oc get route microprofile-config-app --template='{{ .spec.host }}')/config/json

    以下が想定される出力です。

    {"result":"Hello Name comes from Openshift ConfigMap"}

手順

1. Maven プロジェクトを設定します。

   $ mvn archetype:generate \
   -DgroupId=GROUP_ID \
   -DartifactId=ARTIFACT_ID \
   -DarchetypeGroupId=org.apache.maven.archetypes \
   -DarchetypeArtifactId=maven-archetype-webapp \
   -DinteractiveMode=false

   GROUP_ID はプロジェクトの groupId で、ARTIFACT_ID はプロジェクトの artifactId です。

2. pom.xml ファイルで、リモートリポジトリーから JBoss EAP BOM ファイルを取得するように Maven を設定します。

   <repositories>
       <repository>
           <id>jboss</id>
           <url>https://maven.repository.redhat.com/ga</url>
           <snapshots>
               <enabled>false</enabled>
           </snapshots>
       </repository>
   </repositories>
   <pluginRepositories>
     <pluginRepository>
         <id>jboss</id>
           <url>https://maven.repository.redhat.com/ga</url>
           <snapshots>
               <enabled>false</enabled>
           </snapshots>
     </pluginRepository>
   </pluginRepositories>

3. jboss-eap-jakartaee8 BOM の Jakarta EE アーティファクトのバージョンを自動的に管理するように Maven を設定するには、プロジェクトの pom.xml ファイルの <dependencyManagement> セクションに BOM を追加します。以下に例を示します。

   <dependencyManagement>
     <dependencies>
       <dependency>
           <groupId>org.jboss.bom</groupId>
           <artifactId>jboss-eap-jakartaee8</artifactId>
           <version>7.3.4.GA</version>
           <type>pom</type>
           <scope>import</scope>
       </dependency>
     </dependencies>
   </dependencyManagement>

4. 以下の例のように、BOM によって管理されるサーブレット API アーティファクトをプロジェクトの pom.xml ファイルの <dependency> セクションに追加します。

   <dependency>
       <groupId>org.jboss.spec.javax.servlet</groupId>
       <artifactId>jboss-servlet-api_4.0_spec</artifactId>
       <scope>provided</scope>
   </dependency>

手順

1. BOM によって管理される JBoss Logging および JAX-RS 依存関係を、プロジェクトの pom.xml ファイルの <dependencies> セクションに追加します。例を以下に示します。

   <dependencies>
       <dependency>
           <groupId>org.jboss.logging</groupId>
           <artifactId>jboss-logging</artifactId>
           <scope>provided</scope>
       </dependency>
       <dependency>
           <groupId>org.jboss.spec.javax.ws.rs</groupId>
           <artifactId>jboss-jaxrs-api_2.1_spec</artifactId>
           <scope>provided</scope>
       </dependency>
   </dependencies>

2. 以下の内容を pom.xml ファイルの <build> 要素に追加します。最新バージョンの Maven プラグインと、org.jboss.eap:wildfly-galleon-pack Galleon 機能パックの最新バージョンを指定する必要があります。以下に例を示します。

   <plugins>
       <plugin>
           <groupId>org.wildfly.plugins</groupId>
           <artifactId>wildfly-jar-maven-plugin</artifactId>
           <version>${bootable.jar.maven.plugin.version}</version>
           <configuration>
               <feature-packs>
                   <feature-pack>
                       <location>org.jboss.eap:wildfly-galleon-pack:${jboss.xp.galleon.feature.pack.version}</location>
                   </feature-pack>
               </feature-packs>
               <layers>
                   <layer>jaxrs-server</layer>
                </layers>
           </configuration>
           <executions>
               <execution>
                   <goals>
                       <goal>package</goal>
                   </goals>
               </execution>
           </executions>
       </plugin>
   </plugins>

3. java ファイルを保存するディレクトリーを作成します。

   $ mkdir -p APPLICATION_ROOT/src/main/java/com/example/logging/

   APPLICATION_ROOT は、アプリケーションの pom.xml 設定ファイルが含まれるディレクトリーです。

4. 以下の内容で Java ファイル RestApplication.java を作成し、ファイルを APPLICATION_ROOT/src/main/java/com/example/logging/ ディレクトリーに保存します。

   package com.example.logging;
   import javax.ws.rs.ApplicationPath;
   import javax.ws.rs.core.Application;
   
   @ApplicationPath("/")
   public class RestApplication extends Application {
   }

5. 以下の内容で Java ファイル HelloWorldEndpoint.java を作成し、ファイルを APPLICATION_ROOT/src/main/java/com/example/logging/ ディレクトリーに保存します。

   package com.example.logging;
   
   import javax.ws.rs.Path;
   import javax.ws.rs.core.Response;
   import javax.ws.rs.GET;
   import javax.ws.rs.Produces;
   
   import org.jboss.logging.Logger;
   @Path("/hello")
   public class HelloWorldEndpoint {
   
       private static Logger log = Logger.getLogger(HelloWorldEndpoint.class.getName());
       @GET
       @Produces("text/plain")
       public Response doGet() {
           log.debug("HelloWorldEndpoint.doGet called");
           return Response.ok("Hello from XP bootable jar!").build();
       }
   }

6. configure-oidc.cli などの CLI スクリプトを作成し、APPLICATION_ROOT/scripts ディレクトリーなどの起動可能な JAR のアクセス可能なディレクトリーに保存します。APPLICATION_ROOT は Maven プロジェクトのルートディレクトリーです。スクリプトには以下のコマンドが含まれている必要があります。

   /subsystem=logging/logger=com.example.logging:add(level=ALL)
   /subsystem=logging/json-formatter=json-formatter:add(exception-output-type=formatted, pretty-print=false, meta-data={version="1"}, key-overrides={timestamp="@timestamp"})
   /subsystem=logging/console-handler=CONSOLE:write-attribute(name=level,value=ALL)
   /subsystem=logging/console-handler=CONSOLE:write-attribute(name=named-formatter, value=json-formatter)

7. プラグイン <configuration> 要素に以下の設定抽出を追加します。

   <cli-sessions>
           <cli-session>
           <script-files>
               <script>scripts/logging.cli</script>
           </script-files>
       </cli-session>
   </cli-sessions>

   この例は、アプリケーションの JSON ロギングを有効にするためにサーバーロギング設定ファイルを変更する logging.cli CLI スクリプトを示しています。

8. アプリケーションを起動可能な JAR としてパッケージ化します。

   $ mvn package

9. オプション: JBoss EAP ベアメタルプラットフォームでアプリケーションを実行するには、JBoss EAP ベアメタルプラットフォームでの起動可能な JAR の使用 にある手順に従いますが、以下の違いがあります。

   1. アプリケーションを起動します。

      mvn wildfly-jar:run

   2. 検証: ブラウザーで http://127.0.0.1:8080/hello に URL を指定すると、アプリケーションにアクセスできます。

      予期される出力: アプリケーションコンソールで com.example.logging.HelloWorldEndpoint デバッグトレースを含む JSON 形式のログを表示できます。

10. オプション: JBoss EAP OpenShift プラットフォームでアプリケーションを実行するには、以下の手順を実行します。

    1. <cloud/> 要素をプラグイン設定に追加します。以下に例を示します。

       <plugins>
          <plugin>
              ... <!-- You must evolve the existing configuration with the <cloud/> element  -->
              <configuration >
                  ...
                  <cloud/>
               </configuration>
           </plugin>
       </plugins>

    2. アプリケーションをリビルドします。

       $ mvn clean package

    3. oc login コマンドを使用して、OpenShift インスタンスにログインします。

    4. OpenShift で新しいプロジェクトを作成します。以下に例を示します。

       $ oc new-project bootable-jar-project

    5. 以下の oc コマンドを入力してアプリケーションイメージを作成します。

       $ mkdir target/openshift && cp target/logging-bootable.jar target/openshift 1
       
       $ oc import-image ubi8/openjdk-11 --from=registry.redhat.io/ubi8/openjdk-11 --confirm
        2
       
       $ oc new-build --strategy source --binary --image-stream openjdk-11 --name logging 3
       
       $ oc start-build logging --from-dir target/openshift 4

       1

       target/openshift サブディレクトリーを作成します。パッケージ化されたアプリケーションは openshift サブディレクトリーにコピーされます。

       2

       最新の OpenJDK 11 イメージストリームタグおよびイメージ情報を OpenShift プロジェクトにインポートします。

       3

       ロギングディレクトリーおよび OpenJDK 11 イメージストリームに基づいてビルド設定を作成します。

       4

       target/openshift サブディレクトリーをバイナリー入力として使用し、アプリケーションをビルドします。

    6. アプリケーションのデプロイ:

       $ oc new-app logging
       
       $ oc expose svc/logging

    7. ルートの URL を取得します。

       $ oc get route logging --template='{{ .spec.host }}'

    8. 直前のコマンドから返された URL を使用して、Web ブラウザーでアプリケーションにアクセスします。以下に例を示します。

       http://ROUTE_NAME/hello

    9. Verfication: 以下のコマンドを実行して、利用可能な OpenShift Pod の一覧を表示し、Pod のビルドステータスを確認します。

       $ oc get pods

       アプリケーションの実行中の Pod ログにアクセスします。APP_POD_NAME は、実行中の Pod ロギングアプリケーションの名前です。

       $ oc logs APP_POD_NAME

       想定される結果: Pod ログは JSON 形式であり、com.example.logging.HelloWorldEndpoint デバッグトレースが含まれます。

手順

1. 以下の内容を pom.xml ファイルの <build> 要素に追加します。最新バージョンの Maven プラグインと、org.jboss.eap:wildfly-galleon-pack Galleon 機能パックの最新バージョンを指定する必要があります。以下に例を示します。

   <plugins>
       <plugin>
           <groupId>org.wildfly.plugins</groupId>
           <artifactId>wildfly-jar-maven-plugin</artifactId>
           <version>${bootable.jar.maven.plugin.version}</version>
           <configuration>
               <feature-pack-location>org.jboss.eap:wildfly-galleon-pack:${jboss.xp.galleon.feature.pack.version}</feature-pack-location>
               <layers>
                   <layer>datasources-web-server</layer>
                   <layer>web-clustering</layer>
               </layers>
           </configuration>
           <executions>
               <execution>
                   <goals>
                       <goal>package</goal>
                   </goals>
               </execution>
           </executions>
       </plugin>
   </plugins>

   注記

   この例では、web-clustering Galleon レイヤーを使用して Web セッション共有を有効にします。

2. 以下の設定を含む src/main/webapp/WEB-INF ディレクトリーに web.xml ファイルを作成します。

   <?xml version="1.0" encoding="UTF-8"?>
   
   <web-app version="4.0"
            xmlns="http://xmlns.jcp.org/xml/ns/javaee"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee  http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd">
       <distributable/>
   </web-app>

   <distributable/> タグは、このサーブレットを複数のサーバーに分散できることを示します。

3. java ファイルを保存するディレクトリーを作成します。

   $ mkdir -p APPLICATION_ROOT
   /src/main/java/com/example/webclustering/

   APPLICATION_ROOT は、アプリケーションの pom.xml 設定ファイルが含まれるディレクトリーです。

4. 以下の内容で Java ファイル MyServlet.java を作成し、ファイルを APPLICATION_ROOT/src/main/java/com/example/webclustering/ ディレクトリーに保存します。

   package com.example.webclustering;
   
   import java.io.IOException;
   import java.io.PrintWriter;
   import javax.servlet.ServletException;
   import javax.servlet.annotation.WebServlet;
   import javax.servlet.http.HttpServlet;
   import javax.servlet.http.HttpServletRequest;
   import javax.servlet.http.HttpServletResponse;
   
   @WebServlet(urlPatterns = {"/clustering"})
   public class MyServlet extends HttpServlet {
       @Override
       protected void doGet(HttpServletRequest request, HttpServletResponse response)
               throws IOException {
           response.setContentType("text/html;charset=UTF-8");
           long t;
           User user = (User) request.getSession().getAttribute("user");
           if (user == null) {
               t = System.currentTimeMillis();
               user = new User(t);
               request.getSession().setAttribute("user", user);
           }
           try (PrintWriter out = response.getWriter()) {
               out.println("<!DOCTYPE html>");
               out.println("<html>");
               out.println("<head>");
               out.println("<title>Web clustering demo</title>");
               out.println("</head>");
               out.println("<body>");
               out.println("<h1>Session id " + request.getSession().getId() + "</h1>");
               out.println("<h1>User Created " + user.getCreated() + "</h1>");
               out.println("<h1>Host Name " + System.getenv("HOSTNAME") + "</h1>");
               out.println("</body>");
               out.println("</html>");
           }
       }
   }

   MyServlet.java の内容は、クライアントが HTTP リクエストを送信するエンドポイントを定義します。

5. 以下の内容で Java ファイル User.java を作成し、ファイルを APPLICATION_ROOT/src/main/java/com/example/webclustering/ ディレクトリーに保存します。

   package com.example.webclustering;
   
   import java.io.Serializable;
   
   public class User implements Serializable {
       private final long created;
   
       User(long created) {
           this.created = created;
       }
       public long getCreated() {
           return created;
       }
   }

6. アプリケーションをパッケージ化します。

   $ mvn package

7. オプション: JBoss EAP ベアメタルプラットフォームでアプリケーションを実行するには、JBoss EAP ベアメタルプラットフォームでの起動可能な JAR の使用 にある手順に従いますが、以下の違いがあります。

   1. JBoss EAP ベアメタルプラットフォームでは、以下の例のように、java -jar コマンドを使用して複数の起動可能な JAR インスタンスを実行できます。

      $ java -jar target/web-clustering-bootable.jar -Djboss.node.name=node1
      
      $ java -jar target/web-clustering-bootable.jar -Djboss.node.name=node2 -Djboss.socket.binding.port-offset=10

   2. 検証: ノード 1 インスタンス (http://127.0.0.1:8080/clustering) でアプリケーションにアクセスできます。ユーザーセッション ID とユーザー相関時間を書き留めます。

      このインスタンスを強制終了した後に、ノード 2 インスタンス (http://127.0.0.1:8090/clustering) にアクセスできます。ユーザーは、セッション ID とノード 1 インスタンスのユーザー作成時間と一致する必要があります。

8. オプション: JBoss EAP OpenShift プラットフォームでアプリケーションを実行するには、JBoss EAP OpenShift プラットフォームでの起動可能な JAR の使用 にある手順に従いますが、以下の手順を完了させてください。

   1. <cloud/> 要素をプラグイン設定に追加します。以下に例を示します。

      <plugins>
         <plugin>
             ... <!-- You must evolve the existing configuration with the <cloud/> element  -->
             <configuration >
                 ...
                 <cloud/>
              </configuration>
          </plugin>
      </plugins>

   2. アプリケーションをリビルドします。

      $ mvn clean package

   3. oc login コマンドを使用して、OpenShift インスタンスにログインします。

   4. OpenShift で新しいプロジェクトを作成します。以下に例を示します。

      $ oc new-project bootable-jar-project

   5. JBoss EAP OpenShift プラットフォームで web-clustering アプリケーションを実行するには、Pod が実行されているサービスアカウントに承認アクセスが付与される必要があります。サービスアカウントは Kubernetes REST API にアクセスできます。以下の例は、サービスアカウントに付与されている認可アクセスを示しています。

      $ oc policy add-role-to-user view system:serviceaccount:$(oc project -q):default

   6. 以下の oc コマンドを入力してアプリケーションイメージを作成します。

      $ mkdir target/openshift && cp target/web-clustering-bootable.jar target/openshift 1
      
      $ oc import-image ubi8/openjdk-11 --from=registry.redhat.io/ubi8/openjdk-11 --confirm 2
      
      $ oc new-build --strategy source --binary --image-stream openjdk-11 --name web-clustering 3
      
      $ oc start-build web-clustering --from-dir target/openshift 4

      1

      target/openshift サブディレクトリーを作成します。パッケージ化されたアプリケーションは openshift サブディレクトリーにコピーされます。

      2

      最新の OpenJDK 11 イメージストリームタグおよびイメージ情報を OpenShift プロジェクトにインポートします。

      3

      web-clustering ディレクトリーおよび OpenJDK 11 イメージストリームに基づいてビルド設定を作成します。

      4

      target/openshift サブディレクトリーをバイナリー入力として使用し、アプリケーションをビルドします。

   7. アプリケーションのデプロイ:

      $ oc new-app web-clustering -e KUBERNETES_NAMESPACE=$(oc project -q)
      
      $ oc expose svc/web-clustering

      重要

      現在の OpenShift namespace の他の Pod を表示するには KUBERNETES_NAMESPACE 環境変数を使用する必要があります。使用しない場合、サーバーは default 名前空間から Pod の取得を試行します。

   8. ルートの URL を取得します。

      $ oc get route web-clustering --template='{{ .spec.host }}'

   9. 直前のコマンドから返された URL を使用して、Web ブラウザーでアプリケーションにアクセスします。以下に例を示します。

      http://ROUTE_NAME/clustering

      ユーザーセッション ID およびユーザー作成時間を書き留めます。

   10. アプリケーションを 2 つの Pod にスケーリングします。

       $ oc scale --replicas=2 deployments web-clustering

   11. 以下のコマンドを実行して、利用可能な OpenShift Pod の一覧を表示し、Pod のビルドステータスを確認します。

       $ oc get pods

   12. oc delete pod web-clustering-POD_NAME コマンドを使用して最も古い Pod を強制終了します。POD_NAME は最も古い Pod の名前です。

   13. アプリケーションを再度アクセスします。

       http://ROUTE_NAME/clustering

       想定される結果: 新規 Pod で生成されるセッション ID および作成時間は、終了した Pod のものに一致します。これは、Web セッションデータストレージが有効になっていることを示します。

手順

1. 以下の内容を pom.xml ファイルの <build> 要素に追加します。最新バージョンの Maven プラグインと、org.jboss.eap:wildfly-galleon-pack Galleon 機能パックの最新バージョンを指定する必要があります。以下に例を示します。

   <plugins>
       <plugin>
            <groupId>org.wildfly.plugins</groupId>
            <artifactId>wildfly-jar-maven-plugin</artifactId>
            <version>${bootable.jar.maven.plugin.version}</version>
            <configuration>
                <feature-pack-location>org.jboss.eap:wildfly-galleon-pack:${jboss.xp.galleon.feature.pack.version}</feature-pack-location>
                <layers>
                      <layer>datasources-web-server</layer>
                </layers>
           </configuration>
           <executions>
               <execution>
                   <goals>
                       <goal>package</goal>
                    </goals>
               </execution>
           </executions>
       </plugin>
   </plugins>

   この例には、elytron サブシステムが含まれる datasources-web-server Galleon レイヤーが含まれていました。

2. src/main/webapp/WEB-INF ディレクトリーの web.xml ファイルを更新します。以下に例を示します。

   <?xml version="1.0" encoding="UTF-8"?>
   
   <web-app version="4.0"
            xmlns="http://xmlns.jcp.org/xml/ns/javaee"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee  http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd">
   
       <login-config>
           <auth-method>BASIC</auth-method>
           <realm-name>Example Realm</realm-name>
       </login-config>
   
   </web-app>

3. java ファイルを保存するディレクトリーを作成します。

   $ mkdir -p APPLICATION_ROOT/src/main/java/com/example/authentication/

   APPLICATION_ROOT は Maven プロジェクトのルートディレクトリーです。

4. 以下の内容で Java ファイル TestServlet.java を作成し、ファイルを APPLICATION_ROOT/src/main/java/com/example/authentication/ ディレクトリーに保存します。

   package com.example.authentication;
   
   import javax.servlet.annotation.HttpMethodConstraint;
   import javax.servlet.annotation.ServletSecurity;
   import javax.servlet.annotation.WebServlet;
   import javax.servlet.http.HttpServlet;
   import javax.servlet.http.HttpServletRequest;
   import javax.servlet.http.HttpServletResponse;
   
   import java.io.IOException;
   import java.io.PrintWriter;
   
   @WebServlet(urlPatterns = "/hello")
   @ServletSecurity(httpMethodConstraints = { @HttpMethodConstraint(value = "GET", rolesAllowed = { "Users" }) })
   public class TestServlet extends HttpServlet {
   
       @Override
       protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
           PrintWriter writer = resp.getWriter();
           writer.println("Hello " + req.getUserPrincipal().getName());
           writer.close();
       }
   
   }

5. authentication.cli などの CLI スクリプトを作成し、これを APPLICATION_ROOT/scripts ディレクトリーなどの起動可能な JAR のアクセス可能なディレクトリーに保存します。スクリプトには以下のコマンドが含まれている必要があります。

   /subsystem=elytron/properties-realm=bootable-realm:add(users-properties={relative-to=jboss.server.config.dir, path=bootable-users.properties, plain-text=true}, groups-properties={relative-to=jboss.server.config.dir, path=bootable-groups.properties})
   /subsystem=elytron/security-domain=BootableDomain:add(default-realm=bootable-realm, permission-mapper=default-permission-mapper, realms=[{realm=bootable-realm, role-decoder=groups-to-roles}])
   
   /subsystem=undertow/application-security-domain=other:write-attribute(name=security-domain, value=BootableDomain)

6. プラグイン <configuration> 要素に以下の設定抽出を追加します。

   <cli-sessions>
       <cli-session>
           <script-files>
               <script>scripts/authentication.cli</script>
           </script-files>
       </cli-session>
   </cli-sessions>

   この例は、サーバーに定義されたセキュリティードメインにデフォルトの undertow セキュリティードメインを設定する authentication.cli CLI スクリプトを示しています。

7. Maven プロジェクトのルートディレクトリーで、JBoss EAP JAR Maven プラグインが起動可能な JAR に追加するプロパティーファイルを保存するディレクトリーを作成します。

   $ mkdir -p APPLICATION_ROOT/extra-content/standalone/configuration/

   APPLICATION_ROOT は、アプリケーションの pom.xml 設定ファイルが含まれるディレクトリーです。

   このディレクトリーには、bootable-users.properties および bootable-groups.properties などのファイルを保存します。

   bootable-users.properties ファイルには以下の内容が含まれます。

   testuser=bootable_password

   bootable-groups.properties ファイルには以下の内容が含まれます。

   testuser=Users

8. 以下の extra-content-content-dirs 要素を既存の <configuration> 要素に追加します。

   <extra-server-content-dirs>
               <extra-content>extra-content</extra-content>
   </extra-server-content-dirs>

   extra-content ディレクトリーには、プロパティーファイルが含まれます。

9. アプリケーションを起動可能な JAR としてパッケージ化します。

   $ mvn package

10. アプリケーションを起動します。

    mvn wildfly-jar:run

11. サーブレットを呼び出しますが、認証情報は指定しないでください。

    curl -v http://localhost:8080/hello

    想定される出力:

    HTTP/1.1 401 Unauthorized
    ...
    WWW-Authenticate: Basic realm="Example Realm"

12. サーバーを呼び出して認証情報を指定します。以下に例を示します。

    $ curl -v -u testuser:bootable_password http://localhost:8080/hello

    起動可能な JAR に対して HTTP 認証が有効になっていることを示す HTTP 200 ステータスが返されます。以下に例を示します。

    HTTP/1.1 200 OK
    ....
    Hello testuser

手順

1. 以下の内容を pom.xml ファイルの <build> 要素に追加します。最新バージョンの Maven プラグインと、org.jboss.eap:wildfly-galleon-pack Galleon 機能パックの最新バージョンを指定する必要があります。以下に例を示します。

   <plugins>
       <plugin>
           <groupId>org.wildfly.plugins</groupId>
           <artifactId>wildfly-jar-maven-plugin</artifactId>
           <version>${bootable.jar.maven.plugin.version}</version>
           <configuration>
               <feature-packs>
                   <feature-pack>
                       <location>org.jboss.eap:wildfly-galleon-pack:${jboss.xp.galleon.feature.pack.version}</location>
                   </feature-pack>
                   <feature-pack>
                       <location>org.jboss.sso:keycloak-adapter-galleon-pack:${keycloak.feature.pack.version}</location>
                   </feature-pack>
               </feature-packs>
               <layers>
                   <layer>datasources-web-server</layer>
                   <layer>keycloak-client-oidc</layer>
               </layers>
           </configuration>
           <executions>
               <execution>
                   <goals>
                       <goal>package</goal>
                   </goals>
               </execution>
           </executions>
       </plugin>
   </plugins>

   Maven プラグインは、Web アプリケーションのデプロイに必要なサブシステムとモジュールをプロビジョニングします。

   keycloak-client-oidc レイヤーは、keycloak サブシステムとその依存関係を使用して Red Hat Single Sign-On 認証のサポートをアクティベートすることで、Red Hat Single Sign-On の OpenID Connect クライアントアダプターをプロジェクトに提供します。Red Hat Single Sign-On クライアントアダプターは、Red Hat Single Sign-On でアプリケーションとサービスのセキュリティーを保護するライブラリーです。

2. pom.xml ファイルでは、プラグイン設定で <context-root> を false に設定します。これにより、simple-webapp リソースパスにアプリケーションが登録されます。デフォルトでは、WAR ファイルは root-context パスで登録されます。

   <configuration>
       ...
        <context-root>false</context-root>
        ...
   </configuration>

3. configure-oidc.cli などの CLI スクリプトを作成し、APPLICATION_ROOT/scripts ディレクトリーなどの起動可能な JAR のアクセス可能なディレクトリーに保存します。APPLICATION_ROOT は Maven プロジェクトのルートディレクトリーです。スクリプトには、以下の例のようなコマンドを含める必要があります。

   /subsystem=keycloak/secure-deployment=simple-webapp.war:add( \
       realm=demo, \
       resource=simple-webapp, \
       public-client=true, \
       auth-server-url=http://localhost:8090/auth/, \
       ssl-required=EXTERNAL)

   このスクリプトの例では、keycloak サブシステムで secure-deployment=simple-webapp.war リソースを定義します。simple-webapp.war リソースは、起動可能な JAR にデプロイされる WAR ファイルの名前です。

4. プロジェクトの pom.xml ファイルで、以下の設定抽出を既存のプラグイン <configuration> 要素に追加します。

   <cli-sessions>
       <cli-session>
           <script-files>
               <script>scripts/configure-oidc.cli</script>
           </script-files>
       </cli-session>
   </cli-sessions>

5. src/main/webapp/WEB-INF ディレクトリーの web.xml ファイルを更新します。以下に例を示します。

   <?xml version="1.0" encoding="UTF-8"?>
   
   <web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
      metadata-complete="false">
   
       <login-config>
           <auth-method>BASIC</auth-method>
           <realm-name>Simple Realm</realm-name>
       </login-config>
   
   </web-app>

6. オプション: ステップ 7 から 9 の代わりに、keycloak.json 記述子を web アプリケーションの WEB-INF ディレクトリーに追加して、Web アプリケーションにサーバー設定を埋め込むことも可能です。以下に例を示します。

   {
       "realm" : "demo",
       "resource" : "simple-webapp",
       "public-client" : "true",
       "auth-server-url" : "http://localhost:8090/auth/",
       "ssl-required" : "EXTERNAL"
   }

   次に、Web アプリケーションの <auth-method> を KEYCLOAK に設定する必要があります。以下のコード例は、<auth-method> を設定する方法を示しています。

       <login-config>
           <auth-method>KEYCLOAK</auth-method>
           <realm-name>Simple Realm</realm-name>
       </login-config>

7. 以下の内容で SecuredServlet.java という名前の Java ファイルを作成し、ファイルを APPLICATION_ROOT/src/main/java/com/example/securedservlet/ ディレクトリーに保存します。

   package com.example.securedservlet;
   
   import java.io.IOException;
   import java.io.PrintWriter;
   import java.security.Principal;
   
   import javax.servlet.ServletException;
   import javax.servlet.annotation.HttpMethodConstraint;
   import javax.servlet.annotation.ServletSecurity;
   import javax.servlet.annotation.WebServlet;
   import javax.servlet.http.HttpServlet;
   import javax.servlet.http.HttpServletRequest;
   import javax.servlet.http.HttpServletResponse;
   
   @WebServlet("/secured")
   @ServletSecurity(httpMethodConstraints = { @HttpMethodConstraint(value = "GET",
       rolesAllowed = { "Users" }) })
   public class SecuredServlet extends HttpServlet {
   
       @Override
       protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
           try (PrintWriter writer = resp.getWriter()) {
               writer.println("<html>");
               writer.println("<head><title>Secured Servlet</title></head>");
               writer.println("<body>");
               writer.println("<h1>Secured Servlet</h1>");
               writer.println("<p>");
               writer.print(" Current Principal '");
               Principal user = req.getUserPrincipal();
               writer.print(user != null ? user.getName() : "NO AUTHENTICATED USER");
               writer.print("'");
               writer.println("    </p>");
               writer.println("  </body>");
               writer.println("</html>");
           }
       }
   }

8. アプリケーションを起動可能な JAR としてパッケージ化します。

   $ mvn package

9. アプリケーションを起動します。以下の例では、指定された起動可能な JAR パスから simple-webapp Web アプリケーションを起動します。

   $ java -jar target/simple-webapp-bootable.jar

10. Web ブラウザーで以下の URL を指定して、Red Hat Single Sign-On でセキュア化された Web ページにアクセスします。以下の例は、セキュアな simple-webapp Web アプリケーションの URL を示しています。

    http://localhost:8080/simple-webapp/secured

11. Red Hat Single Sign-On レルムからユーザーとしてログインします。

12. 検証: Web ページに以下の出力が表示されることを確認します。

    Current Principal '<principal id>'

手順

1. 開発モードで起動可能な JAR をビルドして起動します。

   $ mvn wildfly-jar:dev

   dev モードでは、サーバーデプロイメントスキャナーは target/deployments ディレクトリーを監視するように設定されています。

2. 以下のコマンドで、アプリケーションを target/deployments ディレクトリーにビルドしてコピーするよう JBoss EAP Maven プラグインに指示します。

   $ mvn package -Ddev

   起動可能な JAR 内にパッケージ化されたサーバーは、target/deployments ディレクトリーに保存されているアプリケーションをデプロイします。

3. アプリケーションコードのコードを変更します。
4. mvn package -Ddev を使用して、JBoss EAP Maven プラグインにアプリケーションを再ビルドして再デプロイするように指示します。

5. サーバーの停止以下に例を示します。

   $ mvn wildfly-jar:shutdown

6. アプリケーションの変更が完了したら、アプリケーションを起動可能な JAR としてパッケージ化します。

   $ mvn package

手順

1. 起動可能な JAR に適用するレガシーパッチを定義する CLI スクリプトを作成します。スクリプトには、1 つまたは複数の patch apply コマンドが含まれている必要があります。Galleon レイヤーでトリミングされたサーバーにパッチを適用する場合には、--override-all コマンドが必要です。以下に例を示します。

   patch apply patch-oneoff1.zip --override-all
   
   patch apply patch-oneoff2.zip --override-all
   
   patch info --json-output

2. pom.xml ファイルの <legacy-patch-cli-script> 要素で CLI スクリプトを参照します。
3. 起動可能な JAR をリビルドします。