Red Hat JBoss Web Server Operator

手順

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

   以下に例を示します。

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

   Copy to Clipboard Toggle word wrap

   前の例では、出現する <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

   Copy to Clipboard Toggle word wrap

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

   以下に例を示します。

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

   Copy to Clipboard Toggle word wrap

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

手順

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

2. Web サーバーアプリケーションのカスタムリソースファイルを作成するには、次の手順を実行します。

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

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

      apiVersion: web.servers.org/v1alpha1
      kind: WebServer
      metadata:
          name: <image name>
      spec:
          # Add fields here
          applicationName: <application name>
          replicas: 2
      webImage:
         applicationImage: <URL of the image>

      Copy to Clipboard Toggle word wrap

      以下に例を示します。

      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

      Copy to Clipboard Toggle word wrap

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

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

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

      $ oc apply -f webservers_cr.yaml

      Copy to Clipboard Toggle word wrap

      上記のコマンドは、Web アプリケーションがデプロイされたことを確認するメッセージを表示します。

      以下に例を示します。

      webserver/example-image-webserver created

      Copy to Clipboard Toggle word wrap

      上記のコマンドを実行すると、Operator はルートも自動的に作成します。

4. Operator が自動的に作成したルートを確認します。

   $ oc get routes

   Copy to Clipboard Toggle word wrap

5. オプション: ステップ 3 で作成した webserver を削除します。

   $ oc delete webserver example-image-webserver

   Copy to Clipboard Toggle word wrap
   注記

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

   oc delete -f webservers_cr.yaml

手順

1. エンコードされたシークレット文字列を作成します。

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

   2. secret.txt ファイルに、シークレット文字列をプレインテキストで入力します。

      以下に例を示します。

      qwerty

      Copy to Clipboard Toggle word wrap

   3. 文字列をエンコードするには、次のコマンドを入力します。

      base64 secret.txt

      Copy to Clipboard Toggle word wrap

      上記のコマンドは、エンコードされた文字列を表示します。

      以下に例を示します。

      cXdlcnR5Cg==

      Copy to Clipboard Toggle word wrap

2. Secret という種類のオブジェクトを定義する secret.yaml ファイルを作成します。

   以下に例を示します。

   kind: Secret
   apiVersion: v1
   metadata:
     name: jws-secret
   data:
     WebHookSecretKey: cXdlcnR5Cg==

   Copy to Clipboard Toggle word wrap

   上記の例では、jws-secret がシークレットの名前、cXdlcnR5Cg== がエンコードされたシークレット文字列です。

3. シークレットを作成するには、次のコマンドを入力します。

   oc create -f secret.yaml

   Copy to Clipboard Toggle word wrap

   上記のコマンドは、シークレットが作成されたことを確認するメッセージを表示します。

   以下に例を示します。

   secret/jws-secret created

   Copy to Clipboard Toggle word wrap

検証

1. Webhook の URL を取得します。

   oc describe BuildConfig | grep webhooks

   Copy to Clipboard Toggle word wrap

   上記のコマンドは、次の形式で Webhook URL を生成します。

   https://<host>:<port>/apis/build.openshift.io/v1/namespaces/<namespace>/buildconfigs/<name>/webhooks/<secret>/generic

   Copy to Clipboard Toggle word wrap

2. たとえば payload.json という名前で、最小限の JSON ファイルを作成します。

   {}

   Copy to Clipboard Toggle word wrap

3. Webhook にリクエストを送信するには、次の curl コマンドを入力します。

   curl -H "X-GitHub-Event: push" -H "Content-Type: application/json" -k -X POST --data-binary @payload.json https://<host>:<port>/apis/build.openshift.io/v1/namespaces/<namespace>/buildconfigs/<name>/webhooks/<secret>/generic

   Copy to Clipboard Toggle word wrap

   上記の例で、payload.json は作成した最小限の JSON ファイルの名前です。

   URL 文字列の <host>、<port>、<namespace>、<name> を、お使いの環境に適した値に置き換えます。<secret> を、Webhook 用に作成したシークレットの名前に置き換えます。

   上記のコマンドは、次のタイプの Webhook レスポンスを JSON 形式で生成します。

   {"kind":"Build","apiVersion":"build.openshift.io/v1","metadata":{"name":"test-2","namespace":"jfc","selfLink":"/apis/build.openshift.io/v1/namespaces/jfc/buildconfigs/test-2/instantiate","uid":"a72dd529-edc6-4e1c-898e-7c0dbbea176e","resourceVersion":"846159","creationTimestamp":"2020-10-30T12:29:30Z","labels":{"application":"test","buildconfig":"test","openshift.io/build-config.name":"test","openshift.io/build.start-policy":"Serial"},"annotations":{"openshift.io/build-config.name":"test","openshift.io/build.number":"2"},"ownerReferences":[{"apiVersion":"build.openshift.io/v1","kind":"BuildConfig","name":"test","uid":"1f78fa3f-2f3b-421b-9f49-192184cc2280","controller":true}],"managedFields":[{"manager":"openshift-apiserver","operation":"Update","apiVersion":"build.openshift.io/v1","time":"2020-10-30T12:29:30Z","fieldsType":"FieldsV1","fieldsV1":{"f:metadata":{"f:annotations":{".":{},"f:openshift.io/build-config.name":{},"f:openshift.io/build.number":{}},"f:labels":{".":{},"f:application":{},"f:buildconfig":{},"f:openshift.io/build-config.name":{},"f:openshift.io/build.start-policy":{}},"f:ownerReferences":{".":{},"k:{\"uid\":\"1f78fa3f-2f3b-421b-9f49-192184cc2280\"}":{".":{},"f:apiVersion":{},"f:controller":{},"f:kind":{},"f:name":{},"f:uid":{}}}},"f:spec":{"f:output":{"f:to":{".":{},"f:kind":{},"f:name":{}}},"f:serviceAccount":{},"f:source":{"f:contextDir":{},"f:git":{".":{},"f:ref":{},"f:uri":{}},"f:type":{}},"f:strategy":{"f:sourceStrategy":{".":{},"f:env":{},"f:forcePull":{},"f:from":{".":{},"f:kind":{},"f:name":{}},"f:pullSecret":{".":{},"f:name":{}}},"f:type":{}},"f:triggeredBy":{}},"f:status":{"f:conditions":{".":{},"k:{\"type\":\"New\"}":{".":{},"f:lastTransitionTime":{},"f:lastUpdateTime":{},"f:status":{},"f:type":{}}},"f:config":{".":{},"f:kind":{},"f:name":{},"f:namespace":{}},"f:phase":{}}}}]},"spec":{"serviceAccount":"builder","source":{"type":"Git","git":{"uri":"https://github.com/jfclere/demo-webapp.git","ref":"master"},"contextDir":"/"},"strategy":{"type":"Source","sourceStrategy":{"from":{"kind":"DockerImage","name":"image-registry.openshift-image-registry.svc:5000/jfc/jboss-webserver54-tomcat9-openshift@sha256:75dcdf81011e113b8c8d0a40af32dc705851243baa13b68352706154174319e7"},"pullSecret":{"name":"builder-dockercfg-rvbh8"},"env":[{"name":"MAVEN_MIRROR_URL"},{"name":"ARTIFACT_DIR"}],"forcePull":true}},"output":{"to":{"kind":"ImageStreamTag","name":"test:latest"}},"resources":{},"postCommit":{},"nodeSelector":null,"triggeredBy":[{"message":"Generic WebHook","genericWebHook":{"secret":"\u003csecret\u003e"}}]},"status":{"phase":"New","config":{"kind":"BuildConfig","namespace":"jfc","name":"test"},"output":{},"conditions":[{"type":"New","status":"True","lastUpdateTime":"2020-10-30T12:29:30Z","lastTransitionTime":"2020-10-30T12:29:30Z"}]}}
   {
     "kind": "Status",
     "apiVersion": "v1",
     "metadata": {
   
     },
     "status": "Success",
     "message": "no git information found in payload, ignoring and continuing with build",
     "code": 200
   }

   Copy to Clipboard Toggle word wrap