Connettersi a un server di configurazione gestito per Spring in App contenitore di Azure

Config Server per Spring fornisce una posizione centralizzata per rendere i dati di configurazione disponibili per più applicazioni. Questo articolo illustra come connettere un'app ospitata in App contenitore di Azure a un server di configurazione Java per Spring.

Il componente Config Server for Spring Java usa un repository GitHub come origine per le impostazioni di configurazione. I valori di configurazione vengono resi disponibili per l'app contenitore tramite un'associazione tra il componente e l'app contenitore. Man mano che i valori cambiano nel server di configurazione, passano automaticamente all'applicazione, senza dover ricompilare o ridistribuire l'applicazione.

In questa esercitazione, tu apprendi come:

Prerequisiti

• Un account Azure con una sottoscrizione attiva. Se non ne hai già uno, puoi crearne uno gratuitamente.
• interfaccia della riga di comando di Azure.

Considerazioni

Quando si utilizza Config Server per Spring all'interno di App contenitore di Azure, si raccomanda di considerare i seguenti dettagli:

Configurazione

Prima di iniziare a lavorare con Config Server per Spring, occorre innanzitutto creare le risorse necessarie.

Questo ambiente viene usato per ospitare sia il componente Config Server per Spring java che l'app contenitore.

Creare il componente Config Server per Spring Java

Ora che si dispone di un ambiente App contenitore, è possibile creare l'app contenitore e associarla a un componente Config Server per Spring java. Quando si associa l'app contenitore, i valori di configurazione vengono sincronizzati automaticamente dal componente del server di configurazione all'applicazione.

Associare l'applicazione container al componente Config Server per Spring Java

Dopo aver associato l'app contenitore e il componente Config Server, le modifiche alla configurazione vengono sincronizzate automaticamente con l'app contenitore.

Quando si visita nuovamente l'URL dell'app, il valore di connectTimeout è ora 10000. Questo valore proviene dal repository Git impostato nella $URI variabile originariamente impostata come origine del componente di configurazione. In particolare, questo valore viene estratto dalla proprietà connectionTimeout nel file application.yml del repository.

La richiesta di associazione inserisce l'impostazione di configurazione nell'applicazione come variabili di ambiente. Questi valori sono ora disponibili per il codice dell'applicazione da usare per il recupero delle impostazioni di configurazione dal server di configurazione.

In questo caso, le variabili di ambiente seguenti sono disponibili per l'applicazione:

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

Se si desidera personalizzare il proprio SPRING_CONFIG_IMPORT, è possibile fare riferimento alla variabile di ambiente SPRING_CLOUD_CONFIG_COMPONENT_URI, ad esempio, è possibile eseguire l'override da argomenti della riga di comando, ad esempio Java -Dspring.config.import=optional:configserver:${SPRING_CLOUD_CONFIG_COMPONENT_URI}?fail-fast=true.

È anche possibile rimuovere un'associazione dall'applicazione.

(Facoltativo) Annullare l'associazione dell'applicazione contenitore dal componente Config Server per Spring Java

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

Quando si visita nuovamente l'URL dell'app, il valore di connectTimeout cambia in 0.

Pulire le risorse

Le risorse create in questa esercitazione hanno effetto sulla fattura di Azure. Se non si intende usare questi servizi a lungo termine, eseguire il comando seguente per rimuovere tutti gli elementi creati in questa esercitazione.

az group delete --resource-group $RESOURCE_GROUP

Opzioni di configurazione

Il az containerapp update comando usa il --configuration parametro per controllare la configurazione del server di configurazione per Spring. È possibile usare più parametri contemporaneamente, purché siano separati da uno spazio. Per altre informazioni, vedere Spring Cloud Config Server.

La tabella seguente descrive i diversi valori di configurazione back-end Git disponibili:

L'elenco seguente descrive le configurazioni comuni:

• Registrazione delle configurazioni correlate:

  • logging.level.*
  • logging.group.*
  • Tutte le altre configurazioni nello logging.* spazio dei nomi devono essere vietate, ad esempio la scrittura di file di log tramite logging.file deve essere vietata.

• spring.cloud.config.server.overrides

  • Mappa aggiuntiva per una sorgente di proprietà da inviare a tutti i client senza condizioni.

• spring.cloud.config.override-none

  • È possibile modificare la priorità di tutte le sostituzioni nel client in modo che siano più simili ai valori predefiniti, consentendo alle applicazioni di fornire i propri valori nelle variabili di ambiente o nelle proprietà di sistema, impostando il spring.cloud.config.override-none=true flag , il valore predefinito è false, nel repository remoto.

• spring.cloud.config.allow-override

  • Se si abilita il primo bootstrap di configurazione, è possibile consentire alle applicazioni client di eseguire l'override della configurazione dal server di configurazione. L'operazione di sovrascrittura viene effettuata inserendo due proprietà nella configurazione dell'applicazione fornite dal server di configurazione.

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

  • È possibile configurare l'indicatore di integrità per controllare più applicazioni insieme a profili personalizzati ed etichette personalizzate.

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

  • È possibile impostare spring.cloud.config.server.accept-empty su false in modo che il server restituisca uno stato HTTP 404 se l'applicazione non viene trovata. Per impostazione predefinita, questo flag è impostato su true.

• Crittografia e decrittografia (simmetrica):

  • encrypt.key
    • È utile quando si usa una chiave simmetrica perché si tratta di un singolo valore di proprietà da configurare.
  • spring.cloud.config.server.encrypt.enabled
    • Impostare questa proprietà su false per disabilitare la decrittografia lato server.

Aggiorna

I servizi che utilizzano le proprietà devono conoscere una modifica prima che si verifichi. Il metodo di notifica predefinito per Config Server per Spring prevede l'attivazione manuale dell'evento di aggiornamento, ad esempio un aggiornamento tramite chiamata https://<YOUR_CONFIG_CLIENT_HOST_NAME>/actuator/refresh, che potrebbe non essere fattibile se sono presenti molte istanze dell'app.

È invece possibile aggiornare automaticamente i valori dal server di configurazione consentendo al client di configurazione di eseguire il polling delle modifiche in base a un aggiornamento interno. Seguire questa procedura per aggiornare automaticamente i valori dal server di configurazione:

1. Registrare un'attività pianificata per aggiornare il contesto in un determinato intervallo, come illustrato nell'esempio seguente:

   @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. Abilitare autorefresh e impostare l'intervallo di aggiornamento appropriato nel file application.yml . Nell'esempio seguente il client esegue il polling di una modifica della configurazione ogni 60 secondi, ovvero il valore minimo che è possibile impostare per un intervallo di aggiornamento.

   Per impostazione predefinita, autorefresh è impostato su false e refresh-interval è impostato su 60 secondi.

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

3. Aggiungere @RefreshScope nel codice. Nell'esempio seguente la variabile connectTimeout viene aggiornata automaticamente ogni 60 secondi:

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

Crittografia e decrittografia con una chiave simmetrica

Decrittografia lato server

Per impostazione predefinita, la crittografia lato server è abilitata. Usare la procedura seguente per abilitare la decrittografia nell'applicazione:

1. Aggiungi la proprietà crittografata nel file .properties nel repository Git.

   Il file dovrebbe essere simile all'esempio seguente:

   message={cipher}f43e3df3862ab196a4b367624a7d9b581e1c543610da353fbdd2477d60fb282f
   

2. Aggiornare il componente Config Server per Spring Java per usare il repository Git con la proprietà crittografata e impostare la chiave di crittografia.

   Prima di eseguire il comando seguente, sostituire i segnaposto racchiusi tra <> con i valori personalizzati.

   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
   

Decrittografia lato client

È possibile usare la decrittografia lato client delle proprietà seguendo questi passaggi:

1. Aggiungere la proprietà crittografata nel file .properties nel repository Git.

2. Aggiornare il componente Config Server per Spring Java per usare il repository Git con la proprietà crittografata e disabilitare la decrittografia lato server.

   Prima di eseguire il comando seguente, sostituire i segnaposto racchiusi tra <> con i valori personalizzati.

   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. Nell'app client aggiungere la chiave ENCRYPT_KEY=randomKey di decrittografia come variabile di ambiente.

   In alternativa, se si include spring-cloud-starter-bootstrap su classpath, o se si imposta spring.cloud.bootstrap.enabled=true come proprietà di sistema, si deve impostare encrypt.key in bootstrap.properties.

   Prima di eseguire il comando seguente, sostituire i segnaposto racchiusi tra <> con i valori personalizzati.

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

   encrypt:
     key: somerandomkey