Configurar um Spring Cloud Config Server gerenciado no Azure Spring Apps

Nota

Azure Spring Apps é o novo nome para o serviço Azure Spring Cloud. Embora o serviço tenha um novo nome, você verá o nome antigo em alguns lugares por um tempo enquanto trabalhamos para atualizar ativos, como capturas de tela, vídeos e diagramas.

Este artigo aplica-se a: ✔️ Java ✔️ C#

Este artigo aplica-se a: ✔️ Consumo padrão e dedicado (Pré-visualização) ✔️ Básico/Standard ❌ Enterprise

Este artigo mostra como configurar um Spring Cloud Config Server gerenciado no serviço Azure Spring Apps.

O Spring Cloud Config Server fornece suporte ao servidor e ao cliente para uma configuração externalizada em um sistema distribuído. A instância do Config Server fornece um local central para gerenciar propriedades externas para aplicativos em todos os ambientes. Para obter mais informações, consulte a documentação do Spring Cloud Config.

Nota

Para usar o config server no plano de consumo padrão e dedicado, você deve habilitá-lo primeiro. Para obter mais informações, consulte Habilitar e desabilitar o Spring Cloud Config Server no Azure Spring Apps.

Pré-requisitos

Restrição

Há algumas restrições quando você usa o Config Server com um back-end Git. As propriedades a seguir são injetadas automaticamente em seu ambiente de aplicativo para acessar o Config Server e o Service Discovery. Se você também configurar essas propriedades a partir de seus arquivos do Config Server, poderá enfrentar conflitos e comportamento inesperado.

eureka.client.service-url.defaultZone
eureka.client.tls.keystore
eureka.instance.preferIpAddress
eureka.instance.instance-id
server.port
spring.cloud.config.tls.keystore
spring.config.import
spring.application.name
spring.jmx.enabled
management.endpoints.jmx.exposure.include

Atenção

Não coloque essas propriedades em seus arquivos de aplicativo do Config Server.

Crie seus arquivos do Config Server

O Azure Spring Apps dá suporte ao Azure DevOps Server, GitHub, GitLab e Bitbucket para armazenar seus arquivos do Config Server. Quando o repositório estiver pronto, você poderá criar os arquivos de configuração e armazená-los lá.

Algumas propriedades configuráveis estão disponíveis apenas para determinados tipos. As seções a seguir descrevem as propriedades de cada tipo de repositório.

Nota

O Config Server usa master (no Git) como o rótulo padrão se você não especificar um. No entanto, o GitHub alterou recentemente a ramificação padrão de master para main. Para evitar falhas no Azure Spring Apps Config Server, preste atenção ao rótulo padrão ao configurar o Config Server com o GitHub, especialmente para repositórios recém-criados.

Repositório público

Quando você usa um repositório público, suas propriedades configuráveis são mais limitadas do que com um repositório privado.

A tabela a seguir lista as propriedades configuráveis que você pode usar para configurar um repositório Git público.

Nota

O uso de um hífen (-) para separar palavras é a única convenção de nomenclatura atualmente suportada. Por exemplo, você pode usar default-label, mas não defaultLabel.

Property Obrigatório Funcionalidade
uri Sim O URI do repositório Git usado como back-end do Config Server. Deve começar com http://, , https://git@, ou ssh://.
default-label Não O rótulo padrão do repositório Git. Deve ser o nome da filial, o nome da marca ou o ID de confirmação do repositório.
search-paths Não Uma matriz de cadeias de caracteres que são usadas para pesquisar subdiretórios do repositório Git.

Repositório privado com autenticação SSH

A tabela a seguir lista as propriedades configuráveis que você pode usar para configurar um repositório Git privado com SSH.

Nota

O uso de um hífen (-) para separar palavras é a única convenção de nomenclatura atualmente suportada. Por exemplo, você pode usar default-label, mas não defaultLabel.

Property Obrigatório Funcionalidade
uri Sim O URI do repositório Git usado como back-end do Config Server. Deve começar com http://, , https://git@, ou ssh://.
default-label Não O rótulo padrão do repositório Git. Deve ser o nome da filial, o nome da marca ou o ID de confirmação do repositório.
search-paths Não Uma matriz de cadeias de caracteres usadas para pesquisar subdiretórios do repositório Git.
private-key Não A chave privada SSH para acessar o repositório Git. Necessário quando o URI começa com git@ ou ssh://.
host-key Não A chave de host do servidor de repositório Git. Não deve incluir o prefixo do algoritmo como coberto pelo host-key-algorithm.
host-key-algorithm Não O algoritmo de chave do host. Deve ser ssh-dss, ssh-rsa, ecdsa-sha2-nistp256, ecdsa-sha2-nistp384 ou ecdsa-sha2-nistp521. Necessário apenas se host-key existir.
strict-host-key-checking Não Indica se a instância do Config Server falha ao iniciar ao usar o private host-key. Deve ser true (valor padrão) ou false.

Repositório privado com autenticação básica

A tabela a seguir lista as propriedades configuráveis que você pode usar para configurar um repositório Git privado com autenticação básica.

Nota

O uso de um hífen (-) para separar palavras é a única convenção de nomenclatura atualmente suportada. Por exemplo, use default-label, não defaultLabel.

Property Obrigatório Funcionalidade
uri Sim O URI do repositório Git usado como back-end do Config Server. Deve começar com http://, , https://git@, ou ssh://.
default-label Não O rótulo padrão do repositório Git. Deve ser o nome da ramificação, nome da tag ou commit-id do repositório.
search-paths Não Uma matriz de cadeias de caracteres usadas para pesquisar subdiretórios do repositório Git.
username Não O nome de usuário usado para acessar o servidor de repositório Git. Necessário quando o servidor de repositório Git suporta autenticação básica HTTP.
password Não A senha ou token de acesso pessoal usado para acessar o servidor do repositório Git. Necessário quando o servidor de repositório Git suporta autenticação básica HTTP.

Nota

Muitos servidores de repositório Git suportam o uso de tokens em vez de senhas para autenticação básica HTTP. Alguns repositórios permitem que os tokens persistam indefinidamente. No entanto, alguns servidores de repositório Git, incluindo o Azure DevOps Server, forçam os tokens a expirar em algumas horas. Os repositórios que fazem com que os tokens expirem não devem usar a autenticação baseada em tokens com o Azure Spring Apps. Se você usar esse token, lembre-se de atualizá-lo antes que ele expire.

O GitHub removeu o suporte para autenticação de senha, então você precisa usar um token de acesso pessoal em vez de autenticação de senha para o GitHub. Para obter mais informações, consulte Requisitos de autenticação de token para operações Git.

Outros repositórios Git

A tabela a seguir lista as propriedades configuráveis que você pode usar para configurar repositórios Git com um padrão.

Nota

O uso de um hífen (-) para separar palavras é a única convenção de nomenclatura atualmente suportada. Por exemplo, use default-label, não defaultLabel.

Property Obrigatório Funcionalidade
repos Não Um mapa que consiste nas configurações de um repositório Git com um nome próprio.
repos."uri" Sim em repos O URI do repositório Git usado como back-end do Config Server. Deve começar com http://, , https://git@, ou ssh://.
repos."name" Sim em repos Um nome para identificar o repositório; por exemplo, equipa-A ou equipa-B. Necessário apenas se repos existir.
repos."pattern" Não Uma matriz de cadeias de caracteres usadas para corresponder a um nome de aplicativo. Para cada padrão, use o formato {application}/{profile} com curingas.
repos."default-label" Não O rótulo padrão do repositório Git. Deve ser o nome da filial, nome da tag ou IOD de confirmação do repositório.
repos."search-paths" Não Uma matriz de cadeias de caracteres usadas para pesquisar subdiretórios do repositório Git.
repos."username" Não O nome de usuário usado para acessar o servidor de repositório Git. Necessário quando o servidor de repositório Git suporta autenticação básica HTTP.
repos."password" Não A senha ou token de acesso pessoal usado para acessar o servidor do repositório Git. Necessário quando o servidor de repositório Git suporta autenticação básica HTTP.
repos."private-key" Não A chave privada SSH para acessar o repositório Git. Necessário quando o URI começa com git@ ou ssh://.
repos."host-key" Não A chave de host do servidor de repositório Git. Não deve incluir o prefixo do algoritmo como coberto pelo host-key-algorithm.
repos."host-key-algorithm" Não O algoritmo de chave do host. Deve ser ssh-dss, ssh-rsa, ecdsa-sha2-nistp256, ecdsa-sha2-nistp384 ou ecdsa-sha2-nistp521. Necessário apenas se host-key existir.
repos."strict-host-key-checking" Não Indica se a instância do Config Server falha ao iniciar ao usar o private host-key. Deve ser true (valor padrão) ou false.

A tabela a seguir mostra alguns exemplos de padrões para configurar seu serviço com um repositório extra opcional. Para obter mais informações, consulte a seção Repositórios extras e a seção Correspondência de padrões e vários repositórios da documentação do Spring.

Padrões Description
test-config-server-app-0/* O padrão e o URI do repositório correspondem a um aplicativo de inicialização Spring nomeado test-config-server-app-0 com qualquer perfil.
test-config-server-app-1/dev O padrão e o URI do repositório correspondem a um aplicativo de inicialização Spring nomeado test-config-server-app-1 com um perfil de desenvolvimento.
test-config-server-app-2/prod O padrão e o URI do repositório correspondem a um aplicativo de inicialização do Spring nomeado test-config-server-app-2 com um perfil prod.

Screenshot of Azure portal showing the Config Server page with the Patterns column of the Additional repositories table highlighted.

Anexe seu repositório do Config Server ao Azure Spring Apps

Agora que seus arquivos de configuração estão salvos em um repositório, use as etapas a seguir para conectar o Azure Spring Apps ao repositório.

  1. Inicie sessão no portal do Azure.

  2. Vá para a página Visão geral dos aplicativos do Azure Spring.

  3. Selecione Config Server no painel de navegação esquerdo.

  4. Na seção Repositório padrão, defina URI como https://github.com/Azure-Samples/piggymetrics-config.

  5. Selecione Validar.

    Screenshot of Azure portal showing the Config Server page.

  6. Quando a validação estiver concluída, selecione Aplicar para salvar as alterações.

    Screenshot of Azure portal showing Config Server page with Apply button highlighted.

A atualização da configuração pode levar alguns minutos. Você deve receber uma notificação quando a configuração for concluída.

Insira as informações do repositório diretamente no portal do Azure

Você pode inserir informações do repositório para o repositório padrão e, opcionalmente, para repositórios extras.

Repositório predefinido

Use as etapas nesta seção para inserir informações de repositório para um repositório público ou privado.

  • Repositório público: Na seção Repositório padrão, na caixa Uri , cole o URI do repositório. Insira config para a configuração Label . Verifique se a configuração Autenticação é Pública e selecione Aplicar.

  • Repositório privado: o Azure Spring Apps suporta autenticação básica baseada em senha/token e SSH.

    • Autenticação básica: na seção Repositório padrão, na caixa Uri, cole o URI do repositório e selecione a configuração em Autenticação para abrir o painel Editar autenticação. Na lista suspensa Tipo de autenticação, selecione HTTP Basic e insira seu nome de usuário e senha/token para conceder acesso ao Azure Spring Apps. Selecione OK e, em seguida, selecione Aplicar para concluir a configuração da instância do Config Server.

    Screenshot of the Default repository section showing authentication settings for Basic authentication.

    Nota

    Muitos servidores de repositório Git suportam o uso de tokens em vez de senhas para autenticação básica HTTP. Alguns repositórios permitem que os tokens persistam indefinidamente. No entanto, alguns servidores de repositório Git, incluindo o Azure DevOps Server, forçam os tokens a expirar em algumas horas. Os repositórios que fazem com que os tokens expirem não devem usar a autenticação baseada em tokens com o Azure Spring Apps. Se você usar esse token, lembre-se de atualizá-lo antes que ele expire.

    O GitHub removeu o suporte para autenticação de senha, então você precisa usar um token de acesso pessoal em vez de autenticação de senha para o GitHub. Para obter mais informações, consulte Requisitos de autenticação de token para operações Git.

    • SSH: Na seção Repositório padrão, na caixa Uri, cole o URI do repositório e selecione a configuração em Autenticação para abrir o painel Editar autenticação. No painel Editar Autenticação, na lista suspensa Tipo de autenticação, selecione SSH e insira sua chave privada. Opcionalmente, especifique sua chave de host e algoritmo de chave de host. Inclua sua chave pública no repositório do Config Server. Selecione OK e, em seguida, selecione Aplicar para concluir a configuração da instância do Config Server.

    Screenshot of the Default repository section showing authentication settings for SSH authentication.

Repositórios extras

Se você quiser configurar seu serviço com um repositório extra opcional, especifique as configurações de Uri e Autenticação como fez para o repositório padrão. Certifique-se de incluir uma configuração Name para seu padrão e selecione Aplicar para anexá-lo à sua instância.

Insira as informações do repositório em um arquivo YAML

Se você tiver escrito um arquivo YAML com as configurações do repositório, poderá importá-lo diretamente da sua máquina local para o Azure Spring Apps. O exemplo a seguir mostra um arquivo YAML simples para um repositório privado com autenticação básica.

spring:
  cloud:
    config:
      server:
        git:
          uri: https://github.com/azure-spring-apps-samples-pr/config-server-repository.git
          username: <username>
          password: <password/token>

Selecione o botão Importar configurações e, em seguida, selecione o arquivo YAML no diretório do projeto. Selecione Importar.

Screenshot of the Config Server Import settings pane.

Suas Notificações exibem uma async operação. O Config Server deve relatar o sucesso após 1-2 minutos. As informações do seu arquivo YAML são exibidas no portal do Azure. Selecione Aplicar para concluir a importação.

Usar o Azure Repos para configuração do Azure Spring Apps

Os Azure Spring Apps podem acessar repositórios Git que são públicos, protegidos por SSH ou protegidos usando autenticação básica HTTP. A autenticação básica HTTP é a mais fácil das opções para criar e gerenciar repositórios com o Azure Repos.

Obter URL e credenciais de repositório

Use as etapas a seguir para obter o URL e as credenciais do repositório.

  1. No portal do Azure Repos para seu projeto, selecione o botão Clonar :

  2. Copie o URL do clone da caixa de texto. Esse URL normalmente está no seguinte formato:

    https://<organization name>@dev.azure.com/<organization name>/<project name>/_git/<repository name>
    

    Remova tudo depois https:// e antes dev.azure.com, incluindo o @ símbolo. O URL resultante deve estar no seguinte formato:

    https://dev.azure.com/<organization name>/<project name>/_git/<repository name>
    

    Salve este URL para uso na próxima seção.

  3. Selecione Gerar credenciais do Git para exibir um nome de usuário e senha, que devem ser salvos para uso na seção a seguir.

Configurar o Azure Spring Apps para acessar o repositório Git

  1. Inicie sessão no portal do Azure.

  2. Vá para a página Visão geral dos aplicativos do Azure Spring.

  3. Selecione o serviço a ser configurado.

  4. No painel esquerdo da página de serviço, em Configurações, selecione a guia Servidor de configuração . Configure o repositório que você criou, da seguinte maneira:

    • Adicione o URI do repositório que você salvou na seção anterior.
    • Selecione a configuração em Autenticação para abrir o painel Editar autenticação .
    • Em Tipo de autenticação, selecione HTTP básico.
    • Em Nome de usuário, especifique o nome de usuário que você salvou na seção anterior.
    • Em Senha, especifique a senha salva na seção anterior.
    • Selecione OK e aguarde a conclusão da operação.

    Screenshot of repository configuration settings.

Excluir sua configuração

Selecione Redefinir na guia Config Server para apagar as configurações existentes. Exclua as configurações do servidor de configuração se quiser conectar sua instância do Config Server a outra fonte, como quando estiver mudando do GitHub para o Azure DevOps Server.

Atualização do Config Server

Quando as propriedades são alteradas, os serviços que consomem essas propriedades devem ser notificados antes que as alterações possam ser feitas. A solução padrão para o Spring Cloud Config Server é acionar manualmente o evento de atualização, o que pode não ser viável se houver muitas instâncias de aplicativo. Para obter mais informações, consulte Configuração centralizada

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 etapas a seguir 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.

    @ConditionalOnBean({RefreshEndpoint.class})
    @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 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(), refreshInterval * 1000);
            }
        }
    }
    
  2. Habilite a atualização automática e defina o intervalo de atualização apropriado no arquivo application.yml . No exemplo a seguir, o cliente pesquisa alterações 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, a atualização automática é definida como false e o intervalo de atualização é 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;
    }
    

Para obter mais informações, consulte o exemplo config-client-polling .

Próximos passos

Neste artigo, você aprendeu como habilitar e configurar sua instância do Spring Cloud Config Server. Para saber mais sobre como gerenciar seu aplicativo, consulte Dimensionar um aplicativo no Azure Spring Apps.