Red Hat JBoss Web Server for OpenShift

手順

1. Red Hat カスタマーポータルの手順にしたがって、レジストリーサービスアカウントを使用して認証トークンを作成します。
2. トークンの Token Information ページで、OpenShift Secret タブをクリックし、トークンの OpenShift シークレットを含む YAML ファイルをダウンロードします。

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

   注記

   前の例で、1234567-myserviceaccount を前の手順で作成したシークレットの名前に置き換えます。

手順

1. カスタマーポータルの認証情報を使用して、Red Hat Container Registry にログインします。詳細は、Red Hat コンテナーレジストリーの認証 を参照してください。

2. 使用している JDK バージョンに応じて、次のいずれかの手順を実行します。

   • OpenJDK 8 を使用している場合は、次のコマンドを入力します。

     for resource in \
     jws56-openjdk8-tomcat9-ubi8-basic-s2i.json \
     jws56-openjdk8-tomcat9-ubi8-https-s2i.json \
     jws56-openjdk8-tomcat9-ubi8-image-stream.json
     do
     oc replace -n openshift --force -f \
     https://raw.githubusercontent.com/jboss-container-images/jboss-webserver-5-openshift-image/jws56el8-v5.6.0/templates/${resource}
     done

     上記のコマンドは、UBI8 JDK 8 イメージストリーム、jboss-webserver56-openjdk8-tomcat9-openshift-ubi8、およびコマンドで指定されたすべてのテンプレートをインポートします。

   • OpenJDK 11 を使用している場合は、次のコマンドを入力します。

     for resource in \
     jws56-openjdk11-tomcat9-ubi8-basic-s2i.json \
     jws56-openjdk11-tomcat9-ubi8-https-s2i.json \
     jws56-openjdk11-tomcat9-ubi8-image-stream.json
     do
     oc replace -n openshift --force -f \
     https://raw.githubusercontent.com/jboss-container-images/jboss-webserver-5-openshift-image/jws56el8-v5.6.0/templates/${resource}
     done

     上記のコマンドは、UBI8 JDK 11 イメージストリーム、jboss-webserver56-openjdk11-tomcat9-openshift-ubi8、およびコマンドで指定されたすべてのテンプレートをインポートします。

手順

1. ローカルファイルシステムで、バイナリービルド用のソースディレクトリーと deployments サブディレクトリーを作成します。

   たとえば、tomcat-websocket-chat アプリケーション用に /ocp ソースディレクトリーと /deployments サブディレクトリーを作成するには、次のコマンドを入力します。

   $ cd openshift-quickstarts/tomcat-websocket-chat/
   $ mkdir -p ocp/deployments

   注記

   ソースディレクトリーには、Maven バイナリーに含まれていないアプリケーションで必要なコンテンツを含めることができます。詳細は、OpenShift S2I プロセスの JWS を参照してください。

2. .war、.ear、または .jar バイナリーファイルを deployments サブディレクトリーにコピーします。

   たとえば、サンプル tomcat-websocket-chat アプリケーションの .war ファイルをコピーするには、次のコマンドを入力します。

   $ cp target/websocket-chat.war ocp/deployments/

   注記

   上記の例では、target/websocket-chat.war が、コピーするバイナリーファイルへのパスです。

   ソースディレクトリーの deployments サブディレクトリーにあるアプリケーションアーカイブは、OpenShift 上にビルドされているイメージの $JWS_HOME/tomcat/webapps/ ディレクトリーにコピーされます。アプリケーションを正常にデプロイできるようにするには、Web アプリケーションデータを含むディレクトリー階層が正しく構造化されていることを確認する必要があります。詳細は、OpenShift S2I プロセスの JWS を参照してください。

3. OpenShift インスタンスにログインします。

   $ oc login <url>

4. 必要に応じて新規プロジェクトを作成します。

   以下に例を示します。

   $ oc new-project jws-bin-demo

   注記

   前の例では、jws-bin-demo が作成するプロジェクトの名前です。

5. アプリケーションに使用する OpenShift イメージストリームの JWS を特定します。

   $ oc get is -n openshift | grep ^jboss-webserver | cut -f1 -d ' '

   上記のコマンドは、次のタイプの出力を生成します。

   jboss-webserver56-openjdk8-tomcat9-openshift-ubi8

   注記

   -n openshift オプションは、使用するプロジェクトを指定します。oc get is -n openshift コマンドは、openshift プロジェクトからイメージストリームリソースを取得します。

6. 新しいビルド設定を作成し、イメージストリームとアプリケーション名を指定していることを確認します。

   たとえば、サンプル tomcat-websocket-chat アプリケーションの新しいビルド設定を作成するには、次のようにします。

   $ oc new-build --binary=true \
    --image-stream=jboss-webserver56-openjdk8-tomcat9-openshift-ubi8:latest\*
    --name=jws-wsch-app

   注記

   上記の例では、jws-wsch-app が JWS for OpenShift アプリケーションの名前です。

   上記のコマンドは、次のタイプの出力を生成します。

   --> Found image 8c3b85b (4 weeks old) in image stream "openshift/jboss-webserver56-tomcat9-openshift" under tag "latest" for "jboss-webserver56"
   
       JBoss Web Server 5.6
       --------------------
       Platform for building and running web applications on JBoss Web Server 5.6 - Tomcat v9
   
       Tags: builder, java, tomcat9
   
       * A source build using binary input will be created
         * The resulting image will be pushed to image stream "jws-wsch-app:latest"
         * A binary build was created, use 'start-build --from-dir' to trigger a new build
   
   --> Creating resources with label build=jws-wsch-app ...
       imagestream "jws-wsch-app" created
       buildconfig "jws-wsch-app" created
   --> Success

7. バイナリービルドを開始します。

   以下に例を示します。

   $ oc start-build jws-wsch-app --from-dir=./ocp --follow

   注記

   上記の例では、jws-wsch-app は JWS for OpenShift アプリケーションの名前であり、ocp はソースディレクトリーの名前です。

   上記のコマンドは、OpenShift イメージビルドのバイナリー入力用に作成したソースディレクトリーを使用するよう OpenShift に指示します。

   上記のコマンドは、次のタイプの出力を生成します。

   Uploading directory "ocp" as binary input for the build ...
   build "jws-wsch-app-1" started
   Receiving source from STDIN as archive ...
   
   Copying all deployments war artifacts from /home/jboss/source/deployments directory into `/opt/jws-5.6/tomcat/webapps` for later deployment...
   '/home/jboss/source/deployments/websocket-chat.war' -> '/opt/jws-5.6/tomcat/webapps/websocket-chat.war'
   
   Pushing image 172.30.202.111:5000/jws-bin-demo/jws-wsch-app:latest ...
   Pushed 0/7 layers, 7% complete
   Pushed 1/7 layers, 14% complete
   Pushed 2/7 layers, 29% complete
   Pushed 3/7 layers, 49% complete
   Pushed 4/7 layers, 62% complete
   Pushed 5/7 layers, 92% complete
   Pushed 6/7 layers, 100% complete
   Pushed 7/7 layers, 100% complete
   Push successful

8. イメージに基づいて新しい OpenShift アプリケーションを作成します。

   以下に例を示します。

   $ oc new-app jws-wsch-app

   注記

   上記の例では、jws-wsch-app が JWS for OpenShift アプリケーションの名前です。

   上記のコマンドは、次のタイプの出力を生成します。

   --> Found image e5f3a6b (About a minute old) in image stream "jws-bin-demo/jws-wsch-app" under tag "latest" for "jws-wsch-app"
   
       JBoss Web Server 5.6
       --------------------
       Platform for building and running web applications on JBoss Web Server 5.6 - Tomcat v9
   
       Tags: builder, java, tomcat9
   
       * This image will be deployed in deployment config "jws-wsch-app"
       * Ports 8080/tcp, 8443/tcp, 8778/tcp will be load balanced by service "jws-wsch-app"
         * Other containers can access this service through the hostname "jws-wsch-app"
   
   --> Creating resources ...
       deploymentconfig "jws-wsch-app" created
       service "jws-wsch-app" created
   --> Success
       Application is not exposed. You can expose services to the outside world by executing one or more of the commands below:
        'oc expose svc/jws-wsch-app'
       Run 'oc status' to view your app.

9. サービスを公開して、アプリケーションがユーザーにアクセスできるようにします。

   たとえば、サンプル jws-wsch-app アプリケーションにアクセスできるようにするには、次の手順を実行します。

   1. 公開するサービスの名前を確認します。

      $ oc get svc -o name

      上記のコマンドは、次のタイプの出力を生成します。

      service/jws-wsch-app

   2. サービスを公開するには、以下を実行します。

      $ oc expose svc/jws-wsch-app

      上記のコマンドは、次のタイプの出力を生成します。

      route "jws-wsch-app" exposed

10. 公開されたルートのアドレスを取得します。

    oc get routes --no-headers -o custom-columns='host:spec.host' jws-wsch-app

11. Web ブラウザーを開き、URL を入力してアプリケーションにアクセスします。

    たとえば、サンプル jws-wsch-app アプリケーションにアクセスするには、次の URL を入力します。

    \http://<address_of_exposed_route>/websocket-chat

    注記

    前の例で、<address_of_exposed_route> をデプロイメントに適した値に置き換えます。

手順

1. OpenShift インスタンスにログインします。

   $ oc login <url>

2. 必要に応じて新規プロジェクトを作成します。

   $ oc new-project <project-name>

   注記

   前の例で、<project-name> を作成するプロジェクトの名前に置き換えます。

3. アプリケーションに使用する OpenShift イメージストリームの JWS を特定します。

   $ oc get is -n openshift | grep ^jboss-webserver | cut -f1 -d ' '

   上記のコマンドは、次のタイプの出力を生成します。

   jboss-webserver56-openjdk8-tomcat9-openshift-ubi8

   注記

   -n openshift オプションは、使用するプロジェクトを指定します。oc get is -n openshift コマンドは、openshift プロジェクトからイメージストリームリソースを取得します。

4. Red Hat JBoss Web Server for OpenShift イメージを使用して、ソースコードから新しい OpenShift アプリケーションを作成します。

   $ oc new-app \
    _<source_code_location>_\
    --image-stream=jboss-webserver56-openjdk8-tomcat9-openshift-ubi8\
    --name=_<openshift_application_name>_

   以下に例を示します。

   $ oc new-app \
    \https://github.com/jboss-openshift/openshift-quickstarts.git#main \
    --image-stream=jboss-webserver56-openjdk8-tomcat9-openshift-ubi8\
    --context-dir='tomcat-websocket-chat' \
    --name=jws-wsch-app

   上記のコマンドは、ソースコードをイメージに追加し、ソースコードをコンパイルします。上記のコマンドは、ビルド設定とサービスも作成します。

5. アプリケーションを公開するには、次の手順を実行します。

   1. 公開するサービスの名前を確認するには:

      $ oc get svc -o name

      上記のコマンドは、次のタイプの出力を生成します。

      service/<openshift_application_name>

   2. サービスを公開するには、以下を実行します。

      $ oc expose svc/<openshift_application_name>

      上記のコマンドは、次のタイプの出力を生成します。

      route "<openshift_application_name>" exposed

6. 公開されたルートのアドレスを取得するには、以下を実行します。

   oc get routes --no-headers -o custom-columns='host:spec.host' <openshift_application_name>

7. Web ブラウザーを開き、次の URL を入力してアプリケーションにアクセスします。

   \http://<address_of_exposed_route>/<java_application_name>

   注記

   前の例で、<address_of_exposed_route> と <java_application_name> をデプロイに適した値に置き換えます。

手順

1. Docker でイメージを開始します。

   docker run --network host -i -t -p 8080:8080 ImageURL

2. CONTAINER ID を検索します。

    docker ps | grep <ImageName>

3. ライブラリーを tomcat/lib/ ディレクトリーにコピーします。

   docker cp <yourLibrary> <CONTAINER ID>:/opt/jws-5.6/tomcat/lib/

4. 新規イメージへの変更のコミット

   docker commit <CONTAINER ID> <NEW IMAGE NAME>

5. 新規イメージタグの作成

   docker tag <NEW IMAGE NAME>:latest <NEW IMAGE REGISTRY URL>:_<TAG>_

6. イメージをレジストリーにプッシュします。

   docker push <NEW IMAGE REGISTRY URL>

手順

1. プロジェクト名前空間で、oc import-image コマンドを使用してイメージストリームを作成し、イメージのタグやその他の情報をインポートします。

   以下に例を示します。

   oc import-image <my-image>-imagestream:latest \
   --from=quay.io/$user/<my-image>:latest \
   --confirm

   前の例では、出現する <my-image> をインポートするイメージの名前に置き換えます。

   上記のコマンドは、quay.io/$user/<my-image> イメージの情報をインポートして <my-image>-imagestream という名前のイメージストリームを作成します。イメージストリームの形式と管理の詳細については、イメージストリームの管理 を参照してください。

2. イメージストリームが更新されるたびに JWS Operator がデプロイする Web アプリケーション用の WebServer 種類のカスタムリソースを作成します。YAML ファイル形式でカスタムリソースを定義できます。

   以下に例を示します。

   apiVersion: web.servers.org/v1alpha1
   kind: WebServer
   metadata:
     name: <my-image>
   spec:
     # Add fields here
     applicationName: my-app
     useSessionClustering: true
     replicas: 2
     webImageStream:
       imageStreamNamespace: <project-name>
       imageStreamName: <my-image>-imagestream

3. oc tag コマンドを使用して、イメージストリームへの更新をトリガーします。

   以下に例を示します。

   oc tag quay.io/$user/<my-image> <my-image>-imagestream:latest --scheduled

   上記のコマンドにより、OpenShift Container Platform は指定されたイメージストリームタグを定期的に更新します。この期間は、デフォルトで 15 分に設定されているクラスター全体の設定です。

手順

1. イメージを準備し、イメージを表示する場所 (例: quay.io/<USERNAME>/tomcat-demo:latest) にプッシュします。

2. Custom Resource Web サーバー用の YAML ファイルを作成するには、次の手順を実行します。

   1. たとえば、webservers_cr.yaml という名前のファイルを作成します。

   2. 詳細を次の形式で入力します。

      apiVersion: web.servers.org/v1alpha1
      kind: WebServer
      metadata:
          name: example-image-webserver
      spec:
          # Add fields here
          applicationName: jws-app
          replicas: 2
      webImage:
         applicationImage: quay.io/<USERNAME>/tomcat-demo:latest

3. Web アプリケーションをデプロイするには、次の手順を実行します。

   1. Web アプリケーションを作成したディレクトリーに移動します。

   2. 以下のコマンドを入力します。

      $ oc apply -f webservers_cr.yaml

      上記のコマンドにより、次の出力が生成されます。

      webserver/example-image-webserver created

      注記

      Operator はルートを自動的に作成します。

4. Operator が作成するルートを確認します。

   $ oc get routes

5. オプション:前の手順で作成した webserver を削除します。

   $ oc delete webserver example-image-webserver

   注記

   または、YAML ファイルを削除して webserver を削除することもできます。以下に例を示します。

   oc delete -f webservers_cr.yaml