Azure Container Appsで Spring 用のマネージド構成サーバーに接続する

Config Server for Spring は、構成データを複数のアプリケーションで使用できるようにするための一元的な場所を提供します。 この記事では、Azure Container Apps でホストされているアプリを、Java Config Server for Spring インスタンスに接続する方法について説明します。

Spring Java コンポーネントの Config Server は、構成設定のソースとしてGitHub リポジトリを使用します。 構成値は、コンポーネントとコンテナー アプリの間のバインドを介して、コンテナー アプリで利用できるようになります。 構成サーバーで値を変更すると、その値は自動的にアプリケーションに反映され、アプリケーションを再コンパイルしたり再デプロイしたりする必要はありません。

このチュートリアルで学習する内容は次のとおりです。

前提条件

• アクティブなサブスクリプションを持つAzure アカウント。 まだお持ちでない場合は、無料で作成できます。
• Azure CLI。

考慮事項

Azure Container Appsの Config Server for Spring で実行する場合は、次の詳細に注意してください。

セットアップ

Config Server for Spring の操作を開始する前に、まず、必要なリソースを作成する必要があります。

この環境は、Config Server for Spring Java コンポーネントとコンテナー アプリの両方をホストするために使用されます。

Spring Java コンポーネントの構成サーバーを作成する

Container Apps 環境が準備できたので、コンテナー アプリを作成し、Config Server for Spring Java コンポーネントにバインドできます。 コンテナー アプリをバインドすると、構成値は自動的に Config Server コンポーネントからアプリケーションに同期されます。

Spring Java コンポーネントの Config Server にコンテナー アプリをバインドする

コンテナー アプリと Config Server コンポーネントがバインドされると、構成の変更が自動的にコンテナー アプリに同期されます。

アプリの URL にもう一度アクセスすると、connectTimeout の値が 10000 になります。 この値は、元々構成コンポーネントのソースとして設定されていた $URI 変数に設定されている Git リポジトリから取得します。 具体的には、この値はリポジトリの connectionTimeout ファイルの プロパティから取得されます。

バインド要求は、構成の設定を環境変数としてアプリケーションに注入します。 これらの値は、構成サーバーから構成の設定をフェッチする場合に、アプリケーション コードに使用できるようになりました。

この場合、アプリケーションでは次の環境変数を使用できます。

SPRING_CLOUD_CONFIG_URI=http://[JAVA_COMPONENT_INTERNAL_FQDN]:80
SPRING_CLOUD_CONFIG_COMPONENT_URI=http://[JAVA_COMPONENT_INTERNAL_FQDN]:80
SPRING_CONFIG_IMPORT=optional:configserver:$SPRING_CLOUD_CONFIG_URI

独自の SPRING_CONFIG_IMPORT をカスタマイズする場合は、環境変数 SPRING_CLOUD_CONFIG_COMPONENT_URI を参照できます。たとえば、Java -Dspring.config.import=optional:configserver:${SPRING_CLOUD_CONFIG_COMPONENT_URI}?fail-fast=true などのコマンド ライン引数でオーバーライドできます。

バインディングは、アプリケーションから削除することもできます。

(省略可能)Spring Java コンポーネントの Config Server からコンテナー アプリのバインドを解除する

az containerapp update \
    --name $APP_NAME \
    --unbind $JAVA_COMPONENT_NAME \
    --resource-group $RESOURCE_GROUP

アプリの URL にもう一度アクセスすると、connectTimeout の値が 0 に戻ります。

リソースをクリーンアップする

このチュートリアルで作成したリソースは、Azureの請求書に影響します。 これらのサービスを長期間使用しない場合は、次のコマンドを実行して、このチュートリアルで作成したすべてのものを削除してください。

az group delete --resource-group $RESOURCE_GROUP

構成オプション

az containerapp update コマンドでは、--configuration パラメーターを使用して、Spring 用 Config Server の構成方法をコントロールします。 スペースで区切ることで、一度に複数のパラメーターを使用することが可能です。 詳細については、「Spring Cloud Config Server」を参照してください。

次の表に、使用できるさまざまな Git バックエンドの構成値が載っています。

次のリストは、一般的な構成を示しています。

• ログ関連の構成:

  • logging.level.*
  • logging.group.*
  • logging.* 名前空間の下位にあるその他の構成は、禁止されます。たとえば、logging.file を使用したログ ファイルの書き込みなどは禁止です。

• spring.cloud.config.server.overrides

  • すべてのクライアントに無条件で送信される、プロパティ ソースに関連する追加のマップ。

• spring.cloud.config.override-none

  • リモート リポジトリで spring.cloud.config.override-none=true フラグを設定することで (既定値は false)、クライアント内のすべてのオーバーライドの優先順位を、より既定値に近くなるよう変更し、アプリケーションが環境変数またはシステム プロパティに独自の値を指定できるようにします。

• spring.cloud.config.allow-override

  • 構成の最初のブートストラップを有効にした場合、クライアント アプリケーションが構成サーバーからの構成をオーバーライドすることを許可できます。 オーバーライドは、構成サーバーから取得されるアプリケーション構成内に 2 つのプロパティを配置することによって行われます。

• spring.cloud.config.server.health.*

  • 正常性インジケーターを構成すると、カスタム プロファイルとカスタム ラベルも含め、より多くのアプリケーションを確認できます。

• spring.cloud.config.server.accept-empty

  • アプリケーションが見つからない場合に、サーバーが HTTP 状態の spring.cloud.config.server.accept-empty を返すように、false を 404 に設定できます。 既定では、このフラグは true に設定されます。

• 暗号化と解読 (対称):

  • encrypt.key
    • 対称キーは、単一のプロパティ値を構成すればよいので、便利に使用できます。
  • spring.cloud.config.server.encrypt.enabled
    • このプロパティを false に設定すると、サーバー側の解読を無効にできます。

リフレッシュ

プロパティを使用するサービスでは、変更が発生する前に、それを認識しておく必要があります。 Spring 用 Config Server の既定の通知メソッドには、手動での更新イベントのトリガー (https://<YOUR_CONFIG_CLIENT_HOST_NAME>/actuator/refresh の呼び出しによる更新など) が含まれています。これは、アプリ インスタンスが多数存在する場合には実行が困難となる場合があります。

代わりに、内部の更新に基づいて構成クライアントに変更をポーリングさせることで、Config Server から値を自動的に更新できます。 Config Server から値を自動的に更新するには、次の手順に従います。

1. 次の例に示すように、スケジュールされたタスクを登録して、一定の間隔でコンテキストを更新します。

   @Configuration
   @AutoConfigureAfter({RefreshAutoConfiguration.class, RefreshEndpointAutoConfiguration.class})
   @EnableScheduling
   public class ConfigClientAutoRefreshConfiguration implements SchedulingConfigurer {
       @Value("${spring.cloud.config.refresh-interval:60}")
       private long refreshInterval;
       @Value("${spring.cloud.config.auto-refresh:false}")
       private boolean autoRefresh;
       private final RefreshEndpoint refreshEndpoint;
       public ConfigClientAutoRefreshConfiguration(RefreshEndpoint refreshEndpoint) {
           this.refreshEndpoint = refreshEndpoint;
       }
       @Override
       public void configureTasks(ScheduledTaskRegistrar scheduledTaskRegistrar) {
           if (autoRefresh) {
               // set minimal refresh interval to 5 seconds
               refreshInterval = Math.max(refreshInterval, 5);
               scheduledTaskRegistrar.addFixedRateTask(refreshEndpoint::refresh,  Duration.ofSeconds(refreshInterval));
           }
       }
   }
   

2. autorefresh を有効にし、application.yml ファイルで適切な更新間隔を設定します。 次の例では、クライアントは 60 秒 (更新間隔に設定できる最小値) ごとに構成変更をポーリングします。

   既定では、autorefresh は false に設定され、refresh-interval は 60 秒に設定されます。

   spring:
       cloud:
           config:
           auto-refresh: true
           refresh-interval: 60
   management:
       endpoints:
           web:
           exposure:
               include:
               - refresh
   

3. コードに @RefreshScope を追加します。 次の例では、変数 connectTimeout は 60 秒ごとに自動で更新されます。

   @RestController
   @RefreshScope
   public class HelloController {
       @Value("${timeout:4000}")
       private String connectTimeout;
   }
   

対称キーによる暗号化と暗号解読

サーバー側の暗号解読

既定では、サーバー側の暗号化が有効になっています。 次のステップに沿って、アプリケーションでの解読を有効にします。

1. Git リポジトリの .properties ファイルに、暗号化されたプロパティを追加します。

   ファイルは次の例のようになります。

   message={cipher}f43e3df3862ab196a4b367624a7d9b581e1c543610da353fbdd2477d60fb282f
   

2. Spring Java コンポーネントの Config Server を更新して、暗号化されたプロパティを持つ Git リポジトリを使用し、暗号化キーを設定します。

   次のコマンドを実行する前に、 <> で囲まれたプレースホルダーを実際の値に置き換えます。

   az containerapp env java-component config-server-for-spring update \
       --environment <ENVIRONMENT_NAME> \
       --resource-group <RESOURCE_GROUP> \
       --name <JAVA_COMPONENT_NAME> \
       --configuration spring.cloud.config.server.git.uri=<URI> encrypt.key=randomKey
   

クライアント側の暗号解読

以下の各ステップに従うと、プロパティのクライアント側の暗号解読を使用できます。

1. Git リポジトリの .properties ファイルに、暗号化されたプロパティを追加します。

2. Spring Java コンポーネントの Config Server を更新して、暗号化されたプロパティを持つ Git リポジトリを使用し、サーバー側の復号化を無効にします。

   次のコマンドを実行する前に、 <> で囲まれたプレースホルダーを実際の値に置き換えます。

   az containerapp env java-component config-server-for-spring update \
       --environment <ENVIRONMENT_NAME> \
       --resource-group <RESOURCE_GROUP> \
       --name <JAVA_COMPONENT_NAME> \
       --configuration spring.cloud.config.server.git.uri=<URI> spring.cloud.config.server.encrypt.enabled=false
   

3. クライアント アプリで、環境変数として暗号解読キー ENCRYPT_KEY=randomKey を追加します。

   別の方法として、spring-cloud-starter-bootstrap に classpath を含む場合、またはシステム プロパティとして spring.cloud.bootstrap.enabled=true を設定する場合には、encrypt.key に bootstrap.properties を設定します。

   次のコマンドを実行する前に、 <> で囲まれたプレースホルダーを実際の値に置き換えます。

   az containerapp update \
       --name <APP_NAME> \
       --resource-group <RESOURCE_GROUP> \
       --set-env-vars "ENCRYPT_KEY=randomKey"
   

   encrypt:
     key: somerandomkey