Suporte ao Spring Cloud Azure Kafka

O suporte do Spring Cloud Azure Kafka ajuda os aplicativos Spring a autenticar e se conectar a Hubs de Eventos do Azure usando credenciais OAuth ou cadeias de conexão. Este artigo descreve os tipos de autenticação, opções de configuração, dependências e cenários de uso com suporte.

Versão do Kafka com suporte

A versão atual do starter é compatível com o Apache Kafka Clients 2.0.0 e usa Java 8 ou versões superiores.

Tipos de autenticação com suporte

O starter oferece suporte aos seguintes tipos de autenticação:

• Autenticação por string de conexão simples
  • Autenticação de cadeia de conexão direta
  • Autenticação de cadeia de conexão baseada em ARM
• Autenticação de credencial OAuth
  • Autenticação de identidade gerenciada
  • Autenticação de nome de usuário/senha
  • Autenticação de service principal
  • autenticação DefaultAzureCredential

Como funciona

Autenticação de credencial OAuth

Esta seção descreve o fluxo de trabalho geral da autenticação OAuth do Spring Cloud Azure.

O Spring Cloud Azure primeiro cria um dos seguintes tipos de credenciais, dependendo da configuração de autenticação do aplicativo:

• ClientSecretCredential
• ClientCertificateCredential
• UsernamePasswordCredential
• ManagedIdentityCredential

Se o aplicativo não usar um desses tipos de credenciais, ele usará a cadeia de credenciais por meio de DefaultAzureTokenCredential para obter credenciais das propriedades do aplicativo, de variáveis de ambiente, de identidade gerenciada ou de IDEs. Para obter informações detalhadas, consulte Autenticação do Spring Cloud Azure.

Autenticação por string de conexão simples

Para o modo de autenticação de cadeia de conexão, você pode usar a autenticação de cadeia de conexão diretamente ou usar o Azure Resource Manager para recuperar a cadeia de conexão. Para obter mais informações sobre o uso, consulte a seção Uso básico para autenticação de cadeia de conexão.

Configuração

Propriedades configuráveis ao usar o suporte do Kafka com a autenticação OAuth

O Spring Cloud Azure para Kafka dá suporte aos dois níveis de opções de configuração a seguir:

1. Propriedades do Kafka para Hubs de Eventos no Spring Cloud Azure.
2. As opções de configuração de autenticação global de credential e profile com prefixos de spring.cloud.azure.
3. Configurações de nível específicas do Kafka. As configurações de nível do Kafka também estão disponíveis para os binders do Spring Boot e do Spring Cloud Stream para os escopos common, consumer, producer ou admin, que têm prefixos diferentes.

As propriedades globais são expostas por meio de com.azure.spring.cloud.autoconfigure.context.AzureGlobalProperties. As propriedades específicas do Kafka são expostas por org.springframework.boot.autoconfigure.kafka.KafkaProperties (Spring Boot) e org.springframework.cloud.stream.binder.kafka.properties.KafkaBinderConfigurationProperties (binder do Spring Cloud Stream).

A lista a seguir mostra todas as opções de configuração com suporte.

• Propriedades Kafka do Spring Cloud Azure para Hubs de Eventos.

  • Propriedade: spring.cloud.azure.eventhubs.kafka.enabled
  • Descrição: se deve habilitar a conexão sem credenciais com o Hubs de Eventos do Azure para Kafka; o valor padrão é true.

• As opções de configuração de autenticação global do Spring Cloud Azure

  • Prefixo: spring.cloud.azure
  • Opções com suporte: spring.cloud.azure.credential.*, spring.cloud.azure.profile.*

  Para obter a lista completa de opções de configuração global, consulte Propriedades de configuração global.

• Configuração comum do Kafka do Spring Boot

  • Prefixo: spring.kafka.properties.azure
  • Exemplo: spring.kafka.properties.azure.credential.*

• Opções de configuração do consumidor do Spring Kafka

  • Prefixo: spring.kafka.consumer.properties.azure
  • Exemplo: spring.kafka.consumer.properties.azure.credential.*

• Opções de configuração do produtor do Spring Kafka

  • Prefixo: spring.kafka.producer.properties.azure
  • Exemplo: spring.kafka.producer.properties.azure.credential.*

• Opções de configuração de administrador do Spring Kafka

  • Prefixo: spring.kafka.admin.properties.azure
  • Exemplo: spring.kafka.admin.properties.azure.credential.*

• Configuração comum do Spring Cloud Stream Kafka Binder

  • Prefixo: spring.cloud.stream.kafka.binder.configuration.azure
  • Exemplo: spring.cloud.stream.kafka.binder.configuration.azure.credential.*

• Configuração do consumidor do Spring Cloud Stream Kafka Binder

  • Prefixo: spring.cloud.stream.kafka.binder.consumer-properties.azure
  • Exemplo: spring.cloud.stream.kafka.binder.consumer-properties.azure.credential.*

• Configuração do produtor do Spring Cloud Stream Kafka Binder

  • Prefixo: spring.cloud.stream.kafka.binder.producer-properties.azure
  • Exemplo: spring.cloud.stream.kafka.binder.producer-properties.azure.credential.*

• Configuração de administrador do Spring Cloud Stream Kafka Binder

  • Prefixo: não há suporte; use a configuração comum ou de administração do Spring Boot para Kafka.

A tabela a seguir mostra as opções de configuração comuns do Kafka do Spring Boot:

Propriedades configuráveis ao usar o suporte do Kafka com autenticação de cadeia de conexão simples

A tabela a seguir mostra as opções de configuração comuns dos Hubs de Eventos do Spring Boot para Kafka:

Configuração de dependência

Adicione a dependência a seguir ao seu projeto. Essa dependência inclui automaticamente a dependência spring-boot-starter no seu projeto.

<dependency>
    <groupId>com.azure.spring</groupId>
    <artifactId>spring-cloud-azure-starter</artifactId>
</dependency>

Uso básico

As seções a seguir mostram os cenários clássicos de uso do aplicativo Spring Boot.

Usar a autenticação OAuth

Ao usar a autenticação OAuth que o Spring Cloud Azure fornece para o Kafka, você pode configurar credenciais específicas usando as configurações anteriores. Como alternativa, você pode optar por não configurar nenhuma credencial. Nesse caso, o Spring Cloud Azure carrega as credenciais do ambiente. Esta seção descreve como carregar credenciais do ambiente de CLI do Azure ou do ambiente de hospedagem Aplicativos Spring do Azure.

A seção a seguir descreve cenários que usam diferentes bibliotecas de ecossistema do Spring com autenticação OAuth.

Suporte ao aplicativo Spring Kafka

Esta seção descreve o cenário de uso de um aplicativo Spring Boot que usa o Spring Kafka ou a biblioteca Kafka do Spring Integration.

Configuração de dependência

<dependency>
    <groupId>com.azure.spring</groupId>
    <artifactId>spring-cloud-azure-starter</artifactId>
</dependency>
<!-- Using Spring Kafka library only-->
<dependency>
    <groupId>org.springframework.kafka</groupId>
    <artifactId>spring-kafka</artifactId>
    <version>{version}</version><!--Need to be set, for example:2.8.6-->
</dependency>
<!-- Using Spring Integration library only -->
<dependency>
    <groupId>org.springframework.integration</groupId>
    <artifactId>spring-integration-kafka</artifactId>
    <version>{version}</version><!--Need to be set, for example:5.5.12-->
</dependency>

Atualização de configuração

Para usar a autenticação OAuth, especifique o ponto de extremidade dos Hubs de Eventos, conforme mostrado no exemplo a seguir:

spring.kafka.bootstrap-servers=<NAMESPACENAME>.servicebus.windows.net:9093

Suporte à aplicação do binder Kafka do Spring Cloud Stream

Esta seção descreve o cenário de uso de aplicativos Spring Boot que usam a biblioteca binder Kafka do Spring Cloud Stream.

Configuração de dependência

<dependency>
    <groupId>com.azure.spring</groupId>
    <artifactId>spring-cloud-azure-starter</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-stream-kafka</artifactId>
    <version>{version}</version><!--Need to be set, for example:3.2.3-->
</dependency>

Configuração

Para usar a autenticação OAuth, especifique o ponto de extremidade dos Hubs de Eventos, conforme mostrado no exemplo a seguir:

spring.cloud.stream.kafka.binder.brokers=<NAMESPACENAME>.servicebus.windows.net:9093

Usar a identidade gerenciada para autenticação OAuth

1. Para usar a identidade gerenciada, habilite a identidade gerenciada para seu serviço e atribua as funções Hubs de Eventos do Azure Data Sender e Hubs de Eventos do Azure Data Receiver. Para obter mais informações, consulte Atribuir funções do Azure para direitos de acesso.

2. Configure as seguintes propriedades em seu arquivo de application.yml:

   spring:
     cloud:
       azure:
         credential:
           managed-identity-enabled: true
   

   Importante

   Se você estiver usando a identidade gerenciada atribuída pelo usuário, adicione também a propriedade spring.cloud.azure.credential.client-id com a ID do cliente de identidade gerenciada atribuída pelo usuário.

Amostras

Consulte o azure-spring-boot-samples repositório no GitHub.

Usar autenticação de cadeia de conexão

Você pode usar a autenticação de cadeia de conexão diretamente ou usar o Azure Resource Manager para recuperar a cadeia de conexão.

Configuração de dependência

Adicione as dependências a seguir se você quiser migrar seu aplicativo Apache Kafka para usar os Hubs de Eventos do Azure para Kafka.

<dependency>
    <groupId>com.azure.spring</groupId>
    <artifactId>spring-cloud-azure-starter</artifactId>
</dependency>

Se você quiser recuperar o cadeia de conexão usando Azure Resource Manager, adicione a seguinte dependência:

<dependency>
    <groupId>com.azure.spring</groupId>
    <artifactId>spring-cloud-azure-resourcemanager</artifactId>
</dependency>

Configuração

Usar diretamente a cadeia de conexão dos Hubs de Eventos

A maneira mais simples de se conectar aos Hubs de Eventos para Kafka é usar a string de conexão. Basta adicionar a propriedade a seguir.

spring.cloud.azure.eventhubs.connection-string=${AZURE_EVENTHUBS_CONNECTION_STRING}

Usar o Azure Resource Manager para recuperar a cadeia de conexão

Se você não quiser configurar a cadeia de conexão em seu aplicativo, poderá usar o Azure Resource Manager para recuperar a cadeia de conexão. Para autenticar com o Azure Resource Manager, você também pode usar credenciais armazenadas na CLI do Azure ou em outra ferramenta de desenvolvimento local, como o Visual Studio Code ou o Intellij IDEA. Como alternativa, você pode usar a Identidade Gerenciada se o aplicativo for implantado no Azure Cloud. Basta garantir que a entidade tenha permissões suficientes para ler metadados do recurso.

Para usar o Azure Resource Manager para recuperar a cadeia de conexão, basta adicionar a propriedade a seguir.

spring:
  cloud:
    azure:
      profile:
        subscription-id: ${AZURE_SUBSCRIPTION_ID}
      eventhubs:
        namespace: ${AZURE_EVENTHUBS_NAMESPACE}
        resource:
          resource-group: ${AZURE_EVENTHUBS_RESOURCE_GROUP}

Amostras

Consulte o azure-spring-boot-samples repositório no GitHub.