JBoss EAP for OpenShift Container Platform のスタートガイド

1. カスタムレイヤーは、少なくともベースレイヤーに依存します。カスタムレイヤーに必要な機能を提供するベースレイヤーを選択します。

2. Maven プロジェクト内で、src/main/resources ディレクトリーにレイヤーコンテンツを作成します。

   たとえば、PostgreSQL および PostgreSQL データソースのサポートをプロビジョニングするレイヤーを作成するには、src/main/resources ディレクトリーに layers/standalone サブディレクトリーを作成します。standalone サブディレクトリーには以下の内容が含まれます。

   • postgresql-driver

     このディレクトリーには、以下の内容が含まれる layer-spec.xml ファイルが含まれます。

     <?xml version="1.0" ?>
     <layer-spec xmlns="urn:jboss:galleon:layer-spec:1.0" name="postgresql-driver">
         <feature spec="subsystem.datasources">
             <feature spec="subsystem.datasources.jdbc-driver">
                 <param name="driver-name" value="postgresql"/>
                 <param name="jdbc-driver" value="postgresql"/>
                 <param name="driver-xa-datasource-class-name" value="org.postgresql.xa.PGXADataSource"/>
                 <param name="driver-module-name" value="org.postgresql.jdbc"/>
             </feature>
         </feature>
         <packages>
             <package name="org.postgresql.jdbc"/>
         </packages>
     </layer-spec>

   • postgresql-datasource

     このディレクトリーには、以下の内容が含まれる layer-spec.xml ファイルが含まれます。

     <?xml version="1.0" ?>
     <layer-spec xmlns="urn:jboss:galleon:layer-spec:1.0" name="postgresql-datasource">
         <dependencies>
             <layer name="postgresql-driver"/>
         </dependencies>
         <feature spec="subsystem.datasources.data-source">
             <param name="use-ccm" value="true"/>
             <param name="data-source" value="PostgreSQLDS"/>
             <param name="enabled" value="true"/>
             <param name="use-java-context" value="true"/>
             <param name="jndi-name" value="java:jboss/datasources/${env.POSTGRESQL_DATASOURCE,env.OPENSHIFT_POSTGRESQL_DATASOURCE:PostgreSQLDS}"/>
             <param name="connection-url" value="jdbc:postgresql://${env.POSTGRESQL_SERVICE_HOST,\
     env.OPENSHIFT_POSTGRESQL_DB_HOST}:${env.POSTGRESQL_SERVICE_PORT,\
     env.OPENSHIFT_POSTGRESQL_DB_PORT}/${env.POSTGRESQL_DATABASE, env.OPENSHIFT_POSTGRESQL_DB_NAME}"/>
             <param name="driver-name" value="postgresql"/>
             <param name="user-name" value="${env.POSTGRESQL_USER, env.OPENSHIFT_POSTGRESQL_DB_USERNAME}"/>
             <param name="password" value="${env.POSTGRESQL_PASSWORD, env.OPENSHIFT_POSTGRESQL_DB_PASSWORD}"/>
             <param name="check-valid-connection-sql" value="SELECT 1"/>
             <param name="background-validation" value="true"/>
             <param name="background-validation-millis" value="60000"/>
             <param name="flush-strategy" value="IdleConnections"/>
             <param name="statistics-enabled" value="${wildfly.datasources.statistics-enabled:${wildfly.statistics-enabled:false}}" />
         </feature>

3. カスタム機能パックの構築に使用される pom.xml ファイルでは、JBoss EAP の依存関係を参照してください。

   <dependency>
       <groupId>org.jboss.eap</groupId>
       <artifactId>wildfly-ee-galleon-pack</artifactId>1
       <version>7.3.0.GA-redhat-00004</version>
       <type>zip</type>
   </dependency>

   1

   JBoss EAP 拡張パック (JBoss EAP XP) を使用する場合は、この要素の値を wildfly-galleon-pack にする必要があります。

   これらの依存関係は、Red Hat Maven リポジトリー https://maven.repository.redhat.com/ga/ から入手できます。

4. Galleon Maven プラグインの build-user-feature-pack ゴールを使用してカスタムレイヤーを構築します。

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

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

   $ oc new-project eap-tx-demo

3. 基盤の Pod の実行に使用される default サービスアカウントに view ロールを追加します。これにより、サービスアカウントが eap-tx-demo namespace のすべてのリソースを確認できるようになります。 これは、クラスターの管理に必要です。

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

4. 自動化トランザクションリカバリーが機能するには、JBoss EAP アプリケーションは ReadWriteMany 永続ボリューム を使用する必要があります。

   ${APPLICATION_NAME}-eap-claim 永続ボリュームクレーム のデータを保持するため eap73-tx-recovery-s2i アプリケーションテンプレートによって想定される永続ボリュームのプロビジョニングを行います。

   この例は、以下の定義で NFS メソッドを使用してプロビジョニングされる永続ボリュームオブジェクトを使用します。

   $ cat txpv.yaml
   apiVersion: v1
   kind: PersistentVolume
   metadata:
     name: txpv
   spec:
     capacity:
       storage: 1Gi
     accessModes:
       - ReadWriteMany
     persistentVolumeReclaimPolicy: Retain
     nfs:
       path: /mnt/mountpoint
       server: 192.168.100.175

5. 上記の定義の path および server フィールドを環境に合わせて更新し、以下のコマンドを使用して永続ボリュームのプロビジョニングを行います。

   $ oc create -f txpv.yaml
   persistentvolume "txpv" created

   $ oc get pv
   NAME      CAPACITY   ACCESSMODES   RECLAIMPOLICY   STATUS      CLAIM     STORAGECLASS   REASON    AGE
   txpv      1Gi        RWX           Retain         Available                                      26s

   重要

   NFS メソッドを使用して eap73-tx-recovery-s2i アプリケーションテンプレートの永続ボリュームオブジェクトのプロビジョニングを行う場合、適切なパーミッションがある状態でマウントポイントをエクスポートするようにしてください。マウントポイントのエクスポート元となるホストで以下を実行します。

   # chmod -R 777 /mnt/mountpoint

   # cat /etc/exports
   /mnt/mountpoint *(rw,sync,anonuid=185,anongid=185)

   # exportfs -va
   exporting *:/mnt/mountpoint

   # setsebool -P virt_use_nfs 1

   上記の /mnt/mountpoint パスは、環境に合わせて変更してください。

1. eap73-tx-recovery-s2i アプリケーションテンプレートを使用して、jta-crash-rec-eap7 クイックスタートをデプロイします。以下を指定します。

   例: eap73-tx-recovery-s2i アプリケーションテンプレート (JDK 8)

   $ oc new-app --template=eap73-tx-recovery-s2i \
   --name=eap-app

   例: eap73-openjdk11-tx-recovery-s2i アプリケーションテンプレート (JDK 11)

   $ oc new-app --template=eap73-openjdk11-tx-recovery-s2i \
   --name=eap-app

2. ビルドが完了するまで待ちます。oc logs -f bc/eap-app コマンドを使用すると、ビルドの状態を確認できます。

3. JAVA_OPTS_APPEND および JBOSS_MODULES_SYSTEM_PKGS_APPEND 環境変数の定義で eap-app デプロイメント設定を編集します。

   $ oc get dc
   NAME                REVISION   DESIRED   CURRENT   TRIGGERED BY
   eap-app             1          1         1         config,image(eap-app:latest)
   eap-app-amq         1          1         1     config,image(amq-broker-72-openshift:1.1)
   eap-app-migration   1          1         1         config,image(eap-app:latest)

   $ oc set env dc/eap-app \
   -e JBOSS_MODULES_SYSTEM_PKGS_APPEND="org.jboss.byteman" \
   -e JAVA_OPTS_APPEND="-javaagent:/tmp/src/extensions/byteman/byteman.jar=script:/tmp/src/src/main/scripts/xa.btm"
   deploymentconfig "eap-app" updated

   この設定は、以下のように XA トランザクションの処理を変更するよう、Byteman のトレースおよび監視ツールに通知します。

   • 最初のトランザクションは成功するように常に許可されます。
   • XA トラザクションが 2 つ目のトランザクションのフェーズ 2 を実行するとき、特定の Pod の JVM プロセスが停止されます。

1. 現在の namespace で実行中の Pod をリストします。

   $ oc get pods | grep Running
   NAME                        READY     STATUS      RESTARTS   AGE
   eap-app-2-r00gm             1/1       Running     0          1m
   eap-app-amq-1-mws7x         1/1       Running     0          2m
   eap-app-migration-1-lvfdt   1/1       Running     0          2m

2. 新しい XA トラザクションを発行します。

   1. ブラウザーを開き、http://eap-app-eap-tx-demo.openshift.example.com/jboss-jta-crash-rec にアクセスして、アプリケーションを起動します。
   2. Mercedes を Key フィールド、Benz を Value フィールドに入力します。Submit ボタンをクリックします。
   3. しばらく待ち、Refresh Table リンクをクリックします。

   4. Mercedes エントリーが含まれるテーブル行がどのように updated via JMS. で更新されるか注意してください。まだ更新されない場合は、Refresh Table リンクを数回クリックしてください。この代わりに、eap-app-2-r00gm Pod のログを調べ、トランザクションが適切に処理されたことを確認することもできます。

      $ oc logs eap-app-2-r00gm | grep 'updated'
      INFO  [org.jboss.as.quickstarts.xa.DbUpdaterMDB] (Thread-0 (ActiveMQ-client-global-threads-1566836606)) JTA Crash Record Quickstart: key value pair updated via JMS.

3. ブラウザーを使用し、http://eap-app-eap-tx-demo.openshift.example.com/jboss-jta-crash-rec で 2 つ目の XA トラザクションを発行します。

   1. Land を Key フィールドに、Rover を Value フィールドに入力します。Submit ボタンをクリックします。
   2. しばらく待ち、Refresh Table リンクをクリックします。
   3. Land Rover エントリーが updated via …​ 接尾辞なしでどのように追加されたかに注目してください。

4. クラスターをスケールダウンします。

   $ oc scale --replicas=0 dc/eap-app
   deploymentconfig "eap-app" scaled

   1. eap-app-2-r00gm Pod の終了がどのようにスケジュールされたかを確認します。

      $ oc get pods
      NAME                        READY     STATUS        RESTARTS   AGE
      eap-app-1-build             0/1       Completed     0          4m
      eap-app-2-r00gm             1/1       Terminating   0          2m
      eap-app-amq-1-mws7x         1/1       Running       0          3m
      eap-app-migration-1-lvfdt   1/1       Running       0          3m

5. マイグレーション Pod のログを確認し、トランザクションリカバリーがどのように実行されるかを確認します。リカバリーの終了まで待機します。

   $ oc logs -f eap-app-migration-1-lvfdt
   Finished Migration Check cycle, pausing for 30 seconds before resuming
   ...
   Finished, recovery terminated successfully
   Migration terminated with status 0 (T)
   Releasing lock: (/opt/eap/standalone/partitioned_data/split-1)
   Finished Migration Check cycle, pausing for 30 seconds before resuming
   ...

6. クラスターを元にスケールアップします。

   $ oc scale --replicas=1 dc/eap-app
   deploymentconfig "eap-app" scaled

7. ブラウザーを使用して再度 http://eap-app-eap-tx-demo.openshift.example.com/jboss-jta-crash-rec にアクセスします。

8. テーブルに両方のトランザクションのエントリーが含まれることに注意してください。以下の出力と似たものになります。

   表7.1 例: データベーステーブルの内容

   データベーステーブルの内容
   Key	Value
   Mercedes	Benz updated via JMS.
   Land	Rover updated via JMS.

   上記のテーブルの内容は、2 つ目の XA トラザクションが終了する前にクラスターがスケールダウンしたものの、マイグレーション Pod がトランザクションリカバリーを実行し、トランザクションが正常に完了したことを示しています。

手順

1. EAP イメージを OpenShift にインポートします。詳細は、JBoss EAP XP の最新の OpenShift イメージストリームおよびテンプレートのインポート を参照してください。
2. アプリケーションイメージストリームの変更についての更新を受信し、新規ビルドをトリガーするようにイメージストリームを設定します。詳細は、イメージストリームタグの定期的なインポートの設定 を参照してください。

3. EAP S2I イメージを使用してアプリケーションイメージをビルドするための eap-s2i-build テンプレートを作成します。

   $ oc replace --force -f https://raw.githubusercontent.com/jboss-container-images/jboss-eap-openshift-templates/master/eap-s2i-build.yaml

   この eap-s2i-build テンプレートは 2 つのビルド設定と、中間ビルドアーティファクトと最終的なアプリケーションイメージに対応する 2 つのイメージストリームを作成します。

4. 最終的なアプリケーションイメージのリソースを作成するために、パラメーターとともに eap-s2i-build テンプレートを処理します。以下の例は、アプリケーションイメージ my-app を作成します。

   $ oc process eap-s2i-build \
     -p APPLICATION_IMAGE=my-app \ 1
     \
     -p EAP_IMAGE=jboss-eap-xp1-openjdk11-openshift:1.0 \ 2
     -p EAP_RUNTIME_IMAGE=jboss-eap-xp1-openjdk11-runtime-openshift:1.0 \ 3
     -p EAP_IMAGESTREAM_NAMESPACE=$(oc project -q) \ 4
     \
     -p SOURCE_REPOSITORY_URL=https://github.com/jboss-developer/jboss-eap-quickstarts.git \ 5
     -p SOURCE_REPOSITORY_REF=xp-1.0.x \ 6
     -p CONTEXT_DIR=microprofile-config | oc create -f - 7

   1

   アプリケーションイメージストリームの名前。アプリケーションイメージは latest でタグ付けされます。

   2

   EAP ビルダーイメージのイメージストリームタグ。

   3

   EAP ランタイムイメージのイメージストリームタグ。

   4

   Red Hat ミドルウェアイメージのイメージストリームがインストールされている名前空間。省略されている場合、openshift 名前空間が使用されます。これは、openshift 以外の名前空間にイメージストリームをインストールしている場合にのみ変更します。

   5

   アプリケーションの Git ソース URL。

   6

   Git ブランチ/タグリファンレンス

   7

   ビルドするアプリケーションが含まれる Git リポジトリー内のパス。

5. EAP オペレーターを使用して、デプロイメント用にアプリケーションイメージを準備します。

   1. WildFlyServer リソースを設定します。

      $ cat > my-app.yaml<<EOF
      
      apiVersion: wildfly.org/v1alpha1
      kind: WildFlyServer
      metadata:
        name: my-app
      spec:
       applicationImage: 'my-app:latest'
       replicas: 1
      EOF

   2. 設定を適用し、EAP オペレーターがこのアプリケーションイメージを参照する新しい WildFlyServer リソースを作成できるようにします。

      $ oc apply -f my-app.yaml

   3. 以下のコマンドを使用して、WildFlyServer リソースを表示します。

      $ oc get wfly my-app

      関連情報

      • アプリケーションイメージストリームのインポートに関する詳細は、JBoss EAP XP の最新の OpenShift イメージストリームおよびテンプレートのインポート を参照してください。
      • イメージストリームの定期的なインポートについての詳細は、イメージストリームタグの定期的なインポートの設定 を参照してください。

手順

1. Web ブラウザーを開き、OperatorHub にログインします。
2. Java アプリケーションに使用する Project または名前空間を選択します。
3. Installed Operator に移動し、JBoss EAP オペレーターを選択します。
4. Overview タブで、Create Instance リンクをクリックします。

5. アプリケーションイメージの詳細を指定します。

   アプリケーションイメージは、Java アプリケーションが含まれる Docker イメージを指定します。applicationImage フィールドがイメージストリームタグに対応している場合は、イメージへの変更により、アプリケーションの自動アップグレードがトリガーされます。

   JBoss EAP for OpenShift アプリケーションイメージの以下のリファレンスのいずれかを以下のような例で指定できます。

   • イメージの名前: mycomp/myapp
   • タグ: mycomp/myapp:1.0
   • A digest: mycomp/myapp:@sha256:0af38bc38be93116b6a1d86a9c78bd14cd527121970899d719baf78e5dc7bfd2
   • イメージストリームタグ: my-app:latest
   • イメージハッシュ: quay.io/bootable-jar/myapp@sha256:47c06c96e80d0defb777686cdb468c636d9b3b7081a35b784330a050a403e15b

6. アプリケーションのサイズを指定します。例を以下に示します。

   spec:
     replicas:2

   • オプション: アプリケーションのパッケージ化に起動可能な JAR を使用している場合は、以下の例のように表示されます。

     spec:
       bootableJar: true

7. env spec を使用してアプリケーション環境を設定します。環境変数は、POSTGRESQL_SERVICE_HOST などの値や POSTGRESQL_USER などの Secret オブジェクトから直接取得できます。例を以下に示します。

   spec:
     env:
     - name: POSTGRESQL_SERVICE_HOST
       value: postgresql
     - name: POSTGRESQL_SERVICE_PORT
       value: '5432'
     - name: POSTGRESQL_DATABASE
       valueFrom:
         secretKeyRef:
           key: database-name
           name: postgresql
     - name: POSTGRESQL_USER
       valueFrom:
         secretKeyRef:
           key: database-user
           name: postgresql
     - name: POSTGRESQL_PASSWORD
       valueFrom:
         secretKeyRef:
           key: database-password
           name: postgresql

   その他のリソース

   • Java アプリケーションの OpenShift へのデプロイ時に任意の設定を完了する方法は、EAP オペレーターを使用した Java アプリケーションの展開: オプションの設定 を参照してください。
   • eap-s2i-build テンプレートでアプリケーションイメージを構築する方法は、eap-s2i-build テンプレートを使用したアプリケーションイメージのビルド を参照してください。
   • アプリケーションイメージを起動可能な JAR としてパッケージ化する方法は、JBoss EAP OpenShift プラットフォームでの起動可能な JAR の使用 を参照してください。
   • 環境変数の一覧は、環境変数 を参照してください。

手順

1. volumeClaimTemplate を指定し、リソース要件を設定して、JBoss EAP スタンドアロンデータディレクトリーを保存します。テンプレートの名前は JBoss EAP の名前から派生します。対応するボリュームは ReadWriteOnce アクセスモードでマウントされます。

   spec:
     storage:
       volumeClaimTemplate:
         spec:
           resources:
             requests:
               storage: 3Gi

   このストレージ要件を満たす永続ボリュームは、/eap/standalone/data ディレクトリーにマウントされます。

手順

1. CLI を使用して JBoss EAP インスタンスにアクセスします。
2. トランザクションオブジェクトストアのすべてのヒューリスティックトランザクションレコードを解決します。詳細は、JBoss EAP でのトランザクション の ヒューリスティックな結果のリカバリー を参照してください。

3. EJB クライアントリカバリーフォルダーからすべてのレコードを削除します。

   1. すべてのファイルを Pod EJB クライアントリカバリーディレクトリーから削除します。

      $JBOSS_HOME/standalone/data/ejb-xa-recovery
      oc exec <podname> rm -rf $JBOSS_HOME/standalone/data/ejb-xa-recovery

4. Pod のステータスが SCALING_DOWN_CLEAN に変わり、Pod が終了します。

手順

1. EJB リモート呼び出しを受信するパーミッションを持つターゲットサーバーにユーザーを作成します。

   $JBOSS_HOME/bin/add-user.sh

2. 呼び出し元の JBoss EAP アプリケーションサーバーを設定します。

   1. カスタム設定機能を使用して、$JBOSS_HOME/standalone/configuration に eap-config.xml ファイルを作成します。詳細は、カスタム設定 を参照してください。

   2. wildfly.config.url プロパティーで呼び出し元 JBoss EAP アプリケーションサーバーを設定します。

      JAVA_OPTS_APPEND="-Dwildfly.config.url=$JBOSS_HOME/standalone/configuration/eap-config.xml"

      注記

      設定に以下の例を使用する場合は、>>PASTE_…​_HERE<< を、設定したユーザーとパスワードで置き換えます。

      設定例

      <configuration>
        <authentication-client xmlns="urn:elytron:1.0">
        <authentication-rules>
                <rule use-configuration="jta">
                    <match-abstract-type name="jta" authority="jboss"/>
            </rule>
            </authentication-rules>
            <authentication-configurations>
             <configuration name="jta">
                     <sasl-mechanism-selector selector="DIGEST-MD5"/>
                     <providers>
                         <use-service-loader />
                 </providers>
             <set-user-name name=">>PASTE_USER_NAME_HERE<<"/>
                 <credentials>
                          <clear-password password=">>PASTE_PASSWORD_HERE<<"/>
                 </credentials>
                     <set-mechanism-realm name="ApplicationRealm" />
                 </configuration>
            </authentication-configurations>
        </authentication-client>
      </configuration>

1. MAVEN_MIRROR_URL 変数を適用するビルド設定の名前を特定します。

   oc get bc -o name
   buildconfig/eap

2. eap のビルド設定を MAVEN_MIRROR_URL 環境変数で更新します。

   oc env bc/eap MAVEN_MIRROR_URL="https://10.0.0.1:8443/repository/internal/"
   buildconfig "eap" updated

3. 設定を確認します。

   oc env bc/eap --list
   # buildconfigs eap
   MAVEN_MIRROR_URL=https://10.0.0.1:8443/repository/internal/

4. アプリケーションの新しいビルドをスケジュールします。