Conectar-se a um servidor de configuração gerenciado para o Spring no 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 um servidor de configuração Java para a instância do Spring.

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

Neste tutorial, você aprenderá a:

Pré-requisitos

• Uma conta Azure com uma assinatura ativa. Caso ainda não tenha uma, você pode criar uma gratuitamente.
• CLI do Azure.

Considerações

Ao executar no Servidor de Configuração para o Spring no Aplicativos de Contêiner do Azure, lembre-se dos seguintes detalhes:

Instalação

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

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

Criar o servidor de configuração para o componente Spring Java

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

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

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

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

A solicitação de associação injeta a configuração no aplicativo em forma de variáveis de ambiente. Esses valores agora estão disponíveis para o código da aplicação usar ao obter as configurações 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 seu próprio SPRING_CONFIG_IMPORT, você pode consultar a variável de ambiente SPRING_CLOUD_CONFIG_COMPONENT_URI - 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 de seu aplicativo.

(Opcional) Desassociar 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ê acessar a URL do aplicativo novamente, o valor de connectTimeout será alterado para 0.

Limpar os recursos

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

az group delete --resource-group $RESOURCE_GROUP

Opções de configuração

O comando az containerapp update usa o parâmetro --configuration para controlar como o Config Server for Spring está configurado. Você pode usar vários parâmetros ao mesmo tempo, desde que estejam separados por um espaço. Para obter mais informações, confira 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 em log:

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

• spring.cloud.config.server.overrides

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

• spring.cloud.config.override-none

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

• spring.cloud.config.allow-override

  • Se você habilitar o primeiro bootstrap de configuração, poderá permitir que os aplicativos cliente substituam a configuração do servidor de configuração. A substituição é feita colocando duas propriedades dentro da configuração dos aplicativos vindas do servidor de configuração.

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

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

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

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

• Criptografia e descriptografia (simétrica):

  • encrypt.key
    • Conveniente quando você usa uma chave simétrica porque é um único valor de propriedade a ser configurado.
  • spring.cloud.config.server.encrypt.enabled
    • Defina essa propriedade para false para desabilitar a descriptografia no lado do servidor.

Atualizar

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

Como alternativa, você pode atualizar automaticamente os valores do Config Server, permitindo que o cliente de configuração sonde se há alterações com base em uma atualização interna. Use as etapas a seguir para atualizar automaticamente os valores do Servidor de Configuração:

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 pesquisa 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 no 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;
   }
   

Criptografia e descriptografia com uma chave simétrica

Descriptografia do lado do servidor

Por padrão, a criptografia do lado do servidor está habilitada. Use as etapas a seguir para habilitar a descriptografia no seu aplicativo:

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

   O arquivo deverá ser parecido com o 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 espaços reservados cercados por <> pelos 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
   

Descriptografia do lado do cliente

Você pode usar a descriptografia de propriedades do lado do cliente seguindo as etapas:

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

2. Atualize o componente Config Server do Spring Java para usar o repositório Git que contém a propriedade criptografada e desativar a descriptografia no lado do servidor.

   Antes de executar o comando a seguir, substitua espaços reservados cercados por <> pelos 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 aplicativo cliente, adicione a chave de descriptografia ENCRYPT_KEY=randomKey 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 espaços reservados cercados por <> pelos seus valores.

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

   encrypt:
     key: somerandomkey