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:

• Criar um componente Config Server para Spring Java
• Vincular o Config Server for Spring ao seu aplicativo de contêiner
• Observe os valores de configuração antes e depois de conectar o servidor de configuração ao seu aplicativo
• Criptografar e descriptografar valores de configuração com uma chave simétrica

Importante

Este tutorial usa serviços que podem afetar sua fatura do Azure. Se você decidir acompanhar o passo a passo, certifique-se de excluir os recursos apresentados neste artigo para evitar cobranças inesperadas.

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:

Item	Explicação
Scope	O Config Server for Spring é executado no mesmo ambiente que o aplicativo de contêiner conectado.
Dimensionamento	Para manter uma única fonte de verdade, o Config Server for Spring não é dimensionado. As propriedades minReplicas de dimensionamento e maxReplicas estão ambas definidas como 1.
Recursos	A alocação de recursos de contêiner para o Config Server for Spring é fixa, o número de núcleos de CPU é 0,5 e o tamanho da memória é 1Gi.
Preços	O faturamento do Config Server for Spring se enquadra nos preços baseados no consumo. Os recursos consumidos pelos componentes Java gerenciados são cobrados pelas taxas ativas/ociosas. Você pode excluir componentes que não estão mais em uso para interromper a cobrança.
Vinculação	O aplicativo de contêiner se conecta a um Config Server for Spring por meio de uma ligação. A associação injeta configurações em variáveis de ambiente do aplicativo de contêiner. Depois que uma associação é estabelecida, o aplicativo contêiner pode ler valores de configuração de variáveis de ambiente.

Configurar

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

CLI do Azure

Execute os comandos a seguir para criar seu grupo de recursos e o ambiente de Aplicativos de Contêiner.

1. Crie variáveis para dar suporte à configuração do aplicativo. Esses valores são fornecidos para você para os fins desta lição.

   export LOCATION=eastus
   export RESOURCE_GROUP=my-services-resource-group
   export ENVIRONMENT=my-environment
   export JAVA_COMPONENT_NAME=configserver
   export APP_NAME=my-config-client
   export IMAGE="mcr.microsoft.com/javacomponents/samples/sample-service-config-client:latest"
   export URI="https://github.com/Azure-Samples/azure-spring-cloud-config-java-aca.git"
   

   Variável	Description
   LOCATION	O local da região do Azure onde você cria seu aplicativo de contêiner e o componente Java.
   ENVIRONMENT	O nome do ambiente dos Aplicativos de Contêiner do Azure para seu aplicativo de demonstração.
   RESOURCE_GROUP	O nome do grupo de recursos do Azure para seu aplicativo de demonstração.
   JAVA_COMPONENT_NAME	O nome do componente Java criado para seu aplicativo de contêiner. Nesse caso, você cria um componente Config Server para Spring Java.
   IMAGE	A imagem de contêiner usada em seu aplicativo de contêiner.
   URI	Você pode substituir o URI pela URL do repositório Git, se for privado, adicione as configurações de autenticação relacionadas, como spring.cloud.config.server.git.username e spring.cloud.config.server.git.password.

2. Entre no Azure com a CLI do Azure.

   az login
   

3. Crie um grupo de recursos.

   az group create --name $RESOURCE_GROUP --location $LOCATION
   

4. Crie seu ambiente de aplicativos de contêiner.

   az containerapp env create \
       --name $ENVIRONMENT \
       --resource-group $RESOURCE_GROUP \
       --location $LOCATION
   

Portal do Azure

Use as etapas a seguir para criar cada um dos recursos necessários para criar um aplicativo de contêiner.

1. Procure Aplicativos de Contêiner no portal do Azure e selecione Criar.

2. Insira os seguintes valores na guia Noções básicas .

   Property	valor
   Subscrição	Selecione a subscrição do Azure.
   Grupo de recursos	Selecione Criar novo link para criar um novo grupo de recursos chamado my-resource-group.
   Nome do aplicativo de contêiner	Digite my-config-client.
   Origem da implantação	Selecione Imagem de contêiner.
   Região	Selecione a região mais próxima de si.
   Ambiente de aplicativos de contêiner	Selecione o link Criar novo para criar um novo ambiente.

3. Na janela do ambiente Create Container Apps, insira os seguintes valores.

   Property	valor
   Nome do ambiente	Insira o meu ambiente.
   Redundância de zona	selecione Desativado.

   Selecione Criar e, em seguida, selecione a guia Contêiner .

4. Na guia Contêiner, insira os seguintes valores.

   Property	valor
   Nome	Digite my-config-client.
   Fonte da imagem	Selecione Docker Hub ou outros registros.
   Tipo de imagem	Selecione Público.
   Servidor de login do Registro	Digite mcr.microsoft.com.
   Imagem e tag	Insira javacomponents/samples/sample-service-config-client:latest.

   Selecione a guia Ingresso .

5. Na guia Ingresso , insira o seguinte e deixe o restante do formulário com seus valores padrão.

   Property	valor
   Entrada	Selecione Ativado.
   Tráfego de entrada	Selecione Aceitar tráfego de qualquer lugar.
   Tipo de ingresso	Selecione HTTP.
   Porta de destino	Digite 8080.

   Selecione Rever + criar.

6. Depois que as verificações de validação forem aprovadas, selecione Criar para criar seu aplicativo de contêiner.

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.

CLI do Azure

1. Crie o componente Config Server for Spring Java.

   az containerapp env java-component config-server-for-spring create \
       --environment $ENVIRONMENT \
       --resource-group $RESOURCE_GROUP \
       --name $JAVA_COMPONENT_NAME \
       --min-replicas 1 \
       --max-replicas 1 \
       --configuration spring.cloud.config.server.git.uri=$URI
   

2. Atualize o componente Config Server for Spring Java.

   az containerapp env java-component config-server-for-spring update \
       --environment $ENVIRONMENT \
       --resource-group $RESOURCE_GROUP \
       --name $JAVA_COMPONENT_NAME \
       --min-replicas 2 \
       --max-replicas 2 \
       --configuration spring.cloud.config.server.git.uri=$URI spring.cloud.config.server.git.refresh-rate=60
   

   Aqui, você está dizendo ao componente onde encontrar o repositório que contém suas informações de configuração por meio da uri propriedade. A refresh-rate propriedade informa ao Container Apps com que frequência verificar se há alterações no repositório Git.

Portal do Azure

Agora que você tem um ambiente existente e um aplicativo de contêiner de cliente do servidor de configuração, você pode criar uma instância de componente Java do Config Server for Spring.

1. Vá para o ambiente do seu aplicativo de contêiner no portal.

2. No menu de navegação, em Categoria Serviços , selecione Serviços.

3. Selecione a lista suspensa Configurar e selecione Componente Java.

4. No painel Configurar componente Java, insira os seguintes valores.

   Property	valor
   Tipo de componente Java	Selecione Config Server for Spring.
   Nome do componente Java	Digite configserver.

5. Na seção Repositórios Git, selecione Adicionar e insira os seguintes valores:

   Property	valor
   Tipo	Selecione HTTP.
   URI	Introduzir https://github.com/Azure-Samples/azure-spring-cloud-config-java-aca.git.

   Deixe o restante dos campos com os valores padrão e selecione Adicionar.

6. Selecione Seguinte.

7. Na guia Revisão, selecione Configurar.

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

CLI do Azure

1. Crie o aplicativo de contêiner que consome dados de configuração.

   az containerapp create \
       --name $APP_NAME \
       --resource-group $RESOURCE_GROUP \
       --environment $ENVIRONMENT \
       --image $IMAGE \
       --min-replicas 1 \
       --max-replicas 1 \
       --ingress external \
       --target-port 8080 \
       --query properties.configuration.ingress.fqdn
   

   Este comando retorna a URL do seu aplicativo de contêiner que consome dados de configuração. Copie o URL para um editor de texto para que você possa usá-lo em uma próxima etapa.

   Se você visitar seu aplicativo em um navegador, o connectTimeout valor retornado será o valor padrão de 0.

2. Associe-se ao Config Server for Spring.

   Agora que o aplicativo de contêiner e o Config Server foram criados, você os vincula com o update comando ao seu aplicativo de contêiner.

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

   O --bind $JAVA_COMPONENT_NAME parâmetro cria o link entre seu aplicativo de contêiner e o componente de configuração.

Portal do Azure

1. Vá para o ambiente do aplicativo de contêiner no portal.

2. No menu de navegação, na categoria Serviços , selecione Serviços.

3. Na lista, selecione configserver.

4. Em associações, selecione a lista suspensa Nome do aplicativo e selecione my-config-client.

5. Selecione a guia Revisão .

6. Selecione Configurar.

7. Retorne ao seu aplicativo de contêiner no portal e copie a URL do seu aplicativo para um editor de texto para que você possa usá-lo em uma próxima etapa.

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

CLI do Azure

Para remover uma associação de um aplicativo contêiner, use a --unbind opção.

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

Portal do Azure

1. Vá para o ambiente do aplicativo de contêiner no portal.

2. No menu de navegação, em Categoria Serviços , selecione Serviços.

3. Na lista, selecione configserver.

4. Em Ligações, localize a linha para my-config-cliente, em seguida, selecione Eliminar.

5. Selecione Seguinte.

6. Selecione a guia Revisão .

7. Selecione Configurar.

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:

Nome	Descrição
spring.cloud.config.server.git.uri spring.cloud.config.server.git.repos.{repoName}.uri	URI do repositório remoto.
spring.cloud.config.server.git.username spring.cloud.config.server.git.repos.{repoName}.username	Nome de usuário para autenticação com repositório remoto.
spring.cloud.config.server.git.password spring.cloud.config.server.git.repos.{repoName}.password	Senha para autenticação com repositório remoto.
spring.cloud.config.server.git.search-paths spring.cloud.config.server.git.repos.{repoName}.search-paths	Caminhos de pesquisa para usar na cópia de trabalho local. Por padrão, pesquisa apenas a raiz.
spring.cloud.config.server.git.force-pull spring.cloud.config.server.git.repos.{repoName}.force-pull	Sinalizador para indicar que o repositório deve forçar pull. Se true, descarte todas as alterações locais e retire do repositório remoto.
spring.cloud.config.server.git.default-label spring.cloud.config.server.git.repos.{repoName}.default-label	O rótulo padrão usado para o Git é principal. Se você não definir spring.cloud.config.server.git.default-label e uma ramificação chamada main não existir, o servidor de configuração por padrão também tentará fazer checkout de uma ramificação chamada master. Se quiser desativar o comportamento de ramificação de fallback, você pode definir spring.cloud.config.server.git.tryMasterBranch como false.
spring.cloud.config.server.git.try-master-branch spring.cloud.config.server.git.repos.{repoName}.try-master-branch	O servidor de configuração por padrão tenta fazer checkout de uma ramificação chamada master.
spring.cloud.config.server.git.skip-ssl-validation spring.cloud.config.server.git.repos.{repoName}.skip-ssl-validation	Você pode desabilitar a validação do certificado TLS/SSL do servidor Git pelo servidor de configuração definindo a git.skipSslValidation propriedade como true.
spring.cloud.config.server.git.clone-on-start spring.cloud.config.server.git.repos.{repoName}.clone-on-start	Sinalizador para indicar que o repositório deve ser clonado na inicialização, não sob demanda. Geralmente leva a uma inicialização mais lenta, mas mais rápida primeira consulta.
spring.cloud.config.server.git.timeout spring.cloud.config.server.git.repos.{repoName}.timeout	Tempo limite em segundos para obter conexão HTTP ou SSH, se aplicável. O valor padrão é 5 segundos.
spring.cloud.config.server.git.refresh-rate spring.cloud.config.server.git.repos.{repoName}.refresh-rate	Com que frequência o servidor de configuração busca dados de configuração atualizados do seu back-end Git.
spring.cloud.config.server.git.private-key spring.cloud.config.server.git.repos.{repoName}.private-key	Chave privada SSH válida. Deve ser definido se ignore-local-ssh-settings é true e o URI do Git está no formato SSH.
spring.cloud.config.server.git.host-key spring.cloud.config.server.git.repos.{repoName}.host-key	Chave de host SSH válida. Deve ser definido se host-key-algorithm também estiver definido.
spring.cloud.config.server.git.host-key-algorithm spring.cloud.config.server.git.repos.{repoName}.host-key-algorithm	Um dos ssh-dss, ssh-rsa, ssh-ed25519, , ecdsa-sha2-nistp384ecdsa-sha2-nistp256, ou ecdsa-sha2-nistp521. Deve ser definido se host-key também estiver definido.
spring.cloud.config.server.git.strict-host-key-checking spring.cloud.config.server.git.repos.{repoName}.strict-host-key-checking	true ou false. Se false, ignore erros com chave de host.
spring.cloud.config.server.git.repos.{repoName}	URI do repositório remoto.
spring.cloud.config.server.git.repos.{repoName}.pattern	O formato padrão é uma lista separada por vírgulas de {application}/{profile} nomes com curingas. Se {application}/{profile} não corresponder a nenhum dos padrões, ele usará o URI padrão definido em.

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