Tutorial: Conectar-se a um servidor de configuração gerenciado para o Spring em aplicativos de contêiner do Azure

O Config Server for Spring fornece um local centralizado para disponibilizar dados de configuração para vários aplicativos. Neste artigo, você aprenderá a conectar um aplicativo hospedado em Aplicativos de Contêiner do Azure a uma instância do Java Config Server for Spring.

O componente Config Server for Spring Java usa um repositório GitHub como fonte para definições de configuração. Os valores de configuração são disponibilizados para seu aplicativo de contêiner por meio de uma associação entre o componente e seu aplicativo de contêiner. À medida que os valores mudam no servidor de configuração, eles fluem automaticamente para seu aplicativo, tudo sem exigir que você recompile ou reimplante seu aplicativo.

Neste tutorial, irá aprender a:

Pré-requisitos

• Uma conta do Azure com uma subscrição ativa. Se ainda não tiver um, pode criar um gratuitamente.
• CLI do Azure.

Considerações

Ao executar no Config Server for Spring em Aplicativos de Contêiner do Azure, esteja ciente dos seguintes detalhes:

Configurar

Antes de começar a trabalhar com o Config Server for Spring, primeiro você precisa criar os recursos necessários.

Esse ambiente é usado para hospedar o componente java do Config Server for Spring e seu aplicativo de contêiner.

Criar o componente Config Server for Spring Java

Agora que você tem um ambiente de aplicativos de contêiner, você pode criar seu aplicativo de contêiner e vinculá-lo a um componente java do Config Server for Spring. Quando você vincula seu aplicativo de contêiner, os valores de configuração são sincronizados automaticamente do componente Config Server para seu aplicativo.

Vincular seu aplicativo de contêiner ao componente Config Server for Spring Java

Depois que o aplicativo contêiner e o componente Config Server são vinculados, as alterações de configuração são sincronizadas automaticamente com o aplicativo contêiner.

Quando você visita o URL do aplicativo novamente, o valor de connectTimeout é agora 10000. Esse valor vem do repositório Git definido na $URI variável originalmente definida como a origem do componente de configuração. Especificamente, esse valor é extraído da connectionTimeout propriedade no arquivo application.yml do repo.

A solicitação bind injeta a definição de configuração no aplicativo como variáveis de ambiente. Esses valores agora estão disponíveis para o código do aplicativo para usar ao buscar definições de configuração do servidor de configuração.

Nesse caso, as seguintes variáveis de ambiente estão disponíveis para o aplicativo:

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 você quiser personalizar o seu próprio SPRING_CONFIG_IMPORT, você pode se referir à variável SPRING_CLOUD_CONFIG_COMPONENT_URI de ambiente - por exemplo, você pode substituir por argumentos de linha de comando, como Java -Dspring.config.import=optional:configserver:${SPRING_CLOUD_CONFIG_COMPONENT_URI}?fail-fast=true.

Você também pode remover uma associação do seu aplicativo.

(Opcional) Desvincule seu aplicativo de contêiner do componente Config Server for Spring Java

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

Quando você visita o URL do aplicativo novamente, o valor de connectTimeout volta para 0.

Clean up resources (Limpar recursos)

Os recursos criados neste tutorial têm um efeito na sua fatura do Azure. Se você não vai usar esses serviços a longo prazo, execute o seguinte comando para remover tudo o que foi criado neste tutorial.

az group delete --resource-group $RESOURCE_GROUP

Opções de configuração

O az containerapp update comando usa o --configuration parâmetro para controlar como o Config Server for Spring é configurado. Você pode usar vários parâmetros ao mesmo tempo, desde que estejam separados por um espaço. Para obter mais informações, consulte Spring Cloud Config Server.

A tabela a seguir descreve os diferentes valores de configuração de back-end do Git disponíveis:

A lista a seguir descreve configurações comuns:

• Configurações relacionadas ao registro:

  • logging.level.*
  • logging.group.*
  • Quaisquer outras configurações sob o logging.* namespace devem ser proibidas - por exemplo, escrever arquivos de log usando logging.file deve ser proibido.

• spring.cloud.config.server.overrides

  • Mapa extra para uma fonte de propriedade a ser enviado a todos os clientes incondicionalmente.

• spring.cloud.config.override-none

  • Você pode alterar a prioridade de todas as substituições no cliente para ser mais parecida com valores padrão, permitindo que os aplicativos forneçam seus próprios valores em variáveis de ambiente ou propriedades do sistema, definindo o spring.cloud.config.override-none=true sinalizador - o padrão é false - no repositório remoto.

• spring.cloud.config.allow-override

  • Se você habilitar o bootstrap config first, poderá permitir que os aplicativos cliente substituam a configuração do servidor de configuração colocando duas propriedades dentro da configuração de aplicativos provenientes do servidor de configuração.

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

  • Você pode configurar o Indicador de integridade para verificar mais aplicativos, juntamente com perfis personalizados e rótulos personalizados.

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

  • Você pode definir spring.cloud.config.server.accept-empty como para false que o servidor retorne um status HTTP 404 se o aplicativo não for encontrado. Por padrão, esse sinalizador é definido como true.

• Encriptação e desencriptação (simétrica):

  • encrypt.key
    • Conveniente quando você usa uma chave simétrica porque é um único valor de propriedade para configurar.
  • spring.cloud.config.server.encrypt.enabled
    • Defina esta propriedade como false para desativar a desencriptação do lado do servidor.

Atualizar

Os serviços que consomem propriedades precisam saber sobre uma mudança antes que ela aconteça. O método de notificação padrão para o Config Server for Spring envolve acionar manualmente o evento de atualização, como uma atualização por chamada https://<YOUR_CONFIG_CLIENT_HOST_NAME>/actuator/refresh, que pode não ser viável se houver muitas instâncias de aplicativo.

Em vez disso, você pode atualizar automaticamente os valores do Config Server permitindo que o cliente de configuração pesquise alterações com base em uma atualização interna. Use as seguintes etapas para atualizar automaticamente os valores do Config Server:

1. Registre uma tarefa agendada para atualizar o contexto em um determinado intervalo, conforme mostrado no exemplo a seguir:

   @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. Habilite autorefresh e defina o intervalo de atualização apropriado no arquivo application.yml . No exemplo a seguir, o cliente sonda uma alteração de configuração a cada 60 segundos, que é o valor mínimo que você pode definir para um intervalo de atualização.

   Por padrão, autorefresh é definido como false e refresh-interval é definido como 60 segundos.

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

3. Adicione @RefreshScope o seu código. No exemplo a seguir, a variável connectTimeout é atualizada automaticamente a cada 60 segundos:

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

Encriptação e desencriptação com uma chave simétrica

Desencriptação do lado do servidor

Por padrão, a criptografia do lado do servidor está habilitada. Use os seguintes passos para ativar a desencriptação na sua aplicação:

1. Adicione a propriedade criptografada em seu arquivo .properties no repositório Git.

   O seu ficheiro deve assemelhar-se ao seguinte exemplo:

   message={cipher}f43e3df3862ab196a4b367624a7d9b581e1c543610da353fbdd2477d60fb282f
   

2. Atualize o componente Config Server for Spring Java para usar o repositório Git que tem a propriedade criptografada e defina a chave de criptografia.

   Antes de executar o comando a seguir, substitua os espaços reservados cercados por <> seus valores.

   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
   

Desencriptação do lado do cliente

Pode usar a desencriptação de propriedades do lado do cliente seguindo os passos:

1. Adicione a propriedade criptografada em seu arquivo .properties no repositório Git.

2. Atualize o componente Config Server for Spring Java para usar o repositório Git que tem a propriedade criptografada e desative a descriptografia do lado do servidor.

   Antes de executar o comando a seguir, substitua os espaços reservados cercados por <> seus valores.

   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. No seu aplicativo cliente, adicione a chave ENCRYPT_KEY=randomKey de desencriptação como uma variável de ambiente.

   Como alternativa, se você incluir spring-cloud-starter-bootstrap no classpath, ou definir spring.cloud.bootstrap.enabled=true como uma propriedade do sistema, defina encrypt.key em bootstrap.properties.

   Antes de executar o comando a seguir, substitua os espaços reservados cercados por <> seus valores.

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

   encrypt:
     key: somerandomkey