第9章 Spring Boot と Kubernetes の統合

手順

1. 以下の Maven 依存関係を Spring Boot Maven プロジェクトの pom.xml ファイルに追加して、Kubernetes インテグレーションを有効にします。

   <project ...>
     ...
     <dependencies>
       ...
       <dependency>
         <groupId>io.fabric8</groupId>
         <artifactId>spring-cloud-kubernetes-core</artifactId>
       </dependency>
       ...
     </dependencies>
     ...
   </project>

2. インテグレーションを完了するには以下を行います。

   • アノテーションを Java ソースコードに追加します。
   • Kubernetes ConfigMap オブジェクトを作成します。
   • アプリケーションが ConfigMap オブジェクトを読み取りできるようにするため、OpenShift サービスアカウントのパーミッションを編集します。

手順

1. 新しいシェルプロンプトを開き、以下の Maven コマンドを入力して簡単な Camel Spring Boot プロジェクトを作成します。

   mvn org.apache.maven.plugins:maven-archetype-plugin:2.4:generate \
     -DarchetypeCatalog=https://maven.repository.redhat.com/ga/io/fabric8/archetypes/archetypes-catalog/2.2.0.fuse-740017-redhat-00003/archetypes-catalog-2.2.0.fuse-740017-redhat-00003-archetype-catalog.xml \
     -DarchetypeGroupId=org.jboss.fuse.fis.archetypes \
     -DarchetypeArtifactId=spring-boot-camel-config-archetype \
     -DarchetypeVersion=2.2.0.fuse-740017-redhat-00003

   archetype プラグインは対話モードに切り替わり、残りのフィールドを追加するよう要求します。

   Define value for property 'groupId': : org.example.fis
   Define value for property 'artifactId': : fuse74-configmap
   Define value for property 'version':  1.0-SNAPSHOT: :
   Define value for property 'package':  org.example.fis: :
   [INFO] Using property: spring-boot-version = 1.5.17.RELEASE
   Confirm properties configuration:
   groupId: org.example.fis
   artifactId: fuse74-configmap
   version: 1.0-SNAPSHOT
   package: org.example.fis
   spring-boot-version: 1.5.17.RELEASE
    Y: :

   プロンプトが表示されたら、groupId の値には org.example.fis、artifactId の値には fuse74-configmap を入力します。残りのフィールドにはデフォルト値を使用します。

2. OpenShift にログインし、アプリケーションをデプロイする OpenShift プロジェクトに切り替えます。たとえば、developer ユーザーとしてログインし、test プロジェクトにデプロイする場合は、以下のコマンドを入力します。

   oc login -u developer -p developer
   oc project test

3. コマンドラインで、新しい fuse74-configmap プロジェクトのディレクトリーに移動し、このアプリケーションの Secret オブジェクトを作成します。

   oc create -f sample-secret.yml

   注記

   アプリケーションをデプロイする 前 に Secret オブジェクトを作成する必要があります。そうでないと、Secret が利用できるようになるまでデプロイされたコンテナーが待機状態になります。続けて Secret を作成すると、コンテナーは待機状態ではなくなります。Secret オブジェクトの設定方法に関する詳細は「Secret の設定」を参照してください。

4. クイックスタートアプリケーションをビルドおよびデプロイします。fuse74-configmap プロジェクトのトップレベルで以下を入力します。

   mvn fabric8:deploy -Popenshift

5. 次のようにアプリケーションログを確認します。

   1. ブラウザーで OpenShift コンソールを開き、該当するプロジェクト namespace を選択します (例: test)。
   2. fuse74-configmap サービスの円形 Pod アイコンの中心をクリックします。
   3. Pods ビューで Name Pod をクリックし、実行中の Pod の詳細を表示します (1 つの Pod のみが実行中である場合は直接詳細ページが表示されます)。
   4. Logs タグをクリックしてアプリケーションログを表示し、下方向にスクロールして Camel アプリケーションによって生成されたログメッセージを見つけます。

6. src/main/resources/application.properties で設定されるデフォルトの受信者リストは、生成されたメッセージを 2 つのダミーエンドポイントである direct:async-queue および direct:file に送信します。これにより、以下のようなメッセージがアプリケーションログに書き込まれます。

   5:44:57.376 [Camel (camel) thread #0 - timer://order] INFO  generate-order-route - Generating message message-44, sending to the recipient list
   15:44:57.378 [Camel (camel) thread #0 - timer://order] INFO  target-route-queue - ----> message-44 pushed to an async queue (simulation)
   15:44:57.379 [Camel (camel) thread #0 - timer://order] INFO  target-route-queue - ----> Using username 'myuser' for the async queue
   15:44:57.380 [Camel (camel) thread #0 - timer://order] INFO  target-route--file - ----> message-44 written to a file

7. ConfigMap オブジェクトを使用して fuse74-configmap アプリケーションの設定を更新する前に、OpenShift ApiServer からデータを確認するパーミッションを fuse74-configmap アプリケーションに付与する必要があります。以下のコマンドを入力し、fuse74-configmap アプリケーションのサービスアカウントに view パーミッションを付与します。

   oc policy add-role-to-user view system:serviceaccount:test:qs-camel-config

   注記

   構文 system:serviceaccount:PROJECT_NAME:SERVICE_ACCOUNT_NAME を使用してサービスアカウントが指定されます。fis-config デプロイメント記述子は、SERVICE_ACCOUNT_NAME を qs-camel-config に定義します。

8. ライブリロード機能の動作を確認するには、以下のように ConfigMap オブジェクトを作成します。

   oc create -f sample-configmap.yml

   新しい ConfigMap は、実行中のアプリケーションにある Camel ルートの受信者リストをオーバーライドし、生成されたメッセージを 3 つ のダミーエンドポイントである direct:async-queue、direct:file、および direct:mail に送信するよう設定します。ConfigMap オブジェクトの詳細は、「ConfigMap の設定」を参照してください。これにより、以下のようなメッセージがアプリケーションログに書き込まれます。

   16:25:24.121 [Camel (camel) thread #0 - timer://order] INFO  generate-order-route - Generating message message-9, sending to the recipient list
   16:25:24.124 [Camel (camel) thread #0 - timer://order] INFO  target-route-queue - ----> message-9 pushed to an async queue (simulation)
   16:25:24.125 [Camel (camel) thread #0 - timer://order] INFO  target-route-queue - ----> Using username 'myuser' for the async queue
   16:25:24.125 [Camel (camel) thread #0 - timer://order] INFO  target-route--file - ----> message-9 written to a file (simulation)
   16:25:24.126 [Camel (camel) thread #0 - timer://order] INFO  target-route--mail - ----> message-9 sent via mail

1. サンプル Secret オブジェクトの作成
2. Secret のボリュームマウントの設定
3. Secret プロパティーを読み取るため spring-cloud-kubernetes を設定

手順

1. Spring Boot アプリケーションで 外部化設定 メカニズムを使用し、ConfigMap プロパティーソースへアクセスします。たとえば、Java Bean に @Configuration アノテーションを付けると、ConfigMap による Bean のプロパティー値のインジェクションが可能になります。
2. プロジェクトの bootstrap.properties ファイル (または bootstrap.yaml ファイル) で、spring.application.name プロパティーが ConfigMap の名前と一致するよう設定します。

3. アプリケーションに関連するサービスアカウントの view パーミッションを有効にします (デフォルトでは、default というサービスアカウントになります)。たとえば、view パーミッションを default サービスアカウントに追加するには、以下を実行します。

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

手順

1. クイックスタートの src/main/resources ディレクトリーに移動し、bootstrap.yml ファイルを開きます。
2. 設定プロパティー spring.cloud.kubernetes.reload.enabled=true を変更します。

手順

1. リロード機能がデフォルト設定 (refresh モード) で有効になっていることを仮定します。ConfigMap の変更時に以下の Beanが更新されます。

   @Configuration
   @ConfigurationProperties(prefix = "bean")
   public class MyConfig {
   
       private String message = "a message that can be changed live";
   
       // getter and setters
   
   }

2. 変更の詳細を確認するには、以下のようにメッセージを定期的に出力する別の Bean を作成します。

   @Component
   public class MyBean {
   
       @Autowired
       private MyConfig config;
   
       @Scheduled(fixedDelay = 5000)
       public void hello() {
           System.out.println("The message is: " + config.getMessage());
       }
   }

3. 以下のように ConfigMap を使用すると、アプリケーションによって出力されるメッセージを変更できます。

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: reload-example
   data:
     application.properties: |-
       bean.message=Hello World!

   Pod に関連する ConfigMap の bean.message という名前のプロパティーに変更を加えると、プログラムの出力に反映されます。