Suporte do Spring Cloud Azure Kafka

O suporte Spring Cloud Azure Kafka ajuda aplicações Spring a autenticar e ligar-se aos Hubs de Eventos do Azure usando credenciais OAuth ou strings de ligação. Este artigo descreve os tipos de autenticação suportados, opções de configuração, dependências e cenários de utilização.

Versão Kafka suportada

A versão atual do starter é compatível com os Apache Kafka Clients 2.0.0 e utiliza Java 8 ou superior.

Tipos de autenticação suportados

O starter suporta os seguintes tipos de autenticação:

• Autenticação de cadeia de conexão simples
  • Autenticação direta por cadeia de ligação
  • Autenticação de cadeia de conexão baseada em ARM
• Autenticação de credenciais OAuth
  • Autenticação de identidade gerenciada
  • Autenticação de nome de utilizador/palavra-passe
  • Autenticação do principal de serviço
  • DefaultAzureCredential autenticação

Como funciona

Autenticação de credenciais OAuth

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

O Spring Cloud Azure constrói primeiro um dos seguintes tipos de credenciais, dependendo da configuração de autenticação da aplicação:

• ClientSecretCredential
• ClientCertificateCredential
• UsernamePasswordCredential
• ManagedIdentityCredential

Se a aplicação não usar um destes tipos de credenciais, a aplicação utiliza a cadeia DefaultAzureTokenCredential de credenciais para obter credenciais das propriedades da aplicação, variáveis de ambiente, identidade gerida ou IDEs. Para obter informações detalhadas, consulte Spring Cloud Azure authentication.

Autenticação de cadeia 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 Gerenciador de Recursos do Azure 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 a Kafka com autenticação OAuth

O Spring Cloud Azure para Kafka suporta os seguintes dois níveis de opções de configuração:

1. Propriedades Kafka do Spring Cloud Azure para Hubs de Eventos.
2. As opções globais de configuração de autenticação de credential e profile com os prefixos de spring.cloud.azure.
3. Configurações de nível específicas de Kafka. As configurações ao nível do Kafka também estão disponíveis para os associadores 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 via com.azure.spring.cloud.autoconfigure.context.AzureGlobalProperties. As propriedades específicas do Kafka são expostas via org.springframework.boot.autoconfigure.kafka.KafkaProperties (Spring Boot) e org.springframework.cloud.stream.binder.kafka.properties.KafkaBinderConfigurationProperties (Spring Cloud Stream binder).

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

• 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 aos 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 suportadas: 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 Spring Boot Kafka

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

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

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

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

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

• Opções de configuração do 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 de 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 administrativa do Spring Cloud Stream Kafka Binder

  • Prefixo: não é suportado; utilize a configuração comum ou de administração do Spring Boot Kafka.

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

Propriedades configuráveis ao usar o suporte a 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 seguinte dependência ao seu projeto. Esta 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>

Utilização básica

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

Usar autenticação OAuth

Quando usa a autenticação OAuth que o Spring Cloud Azure fornece para o Kafka, pode configurar credenciais específicas usando as configurações anteriores. Em alternativa, pode optar por não configurar quaisquer credenciais. Neste caso, o Spring Cloud Azure carrega as credenciais a partir do ambiente. Esta secção descreve como carregar credenciais a partir do ambiente CLI do Azure ou do ambiente de alojamento Azure Spring Apps.

A secção seguinte descreve cenários que utilizam diferentes bibliotecas do ecossistema Spring com autenticação OAuth.

Suporte à aplicação Spring Kafka

Esta secção descreve o cenário de utilização de uma aplicação Spring Boot que utiliza Spring Kafka ou a biblioteca Spring Integration Kafka.

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 autenticação OAuth, especifique o endpoint dos Event Hubs, como mostrado no seguinte exemplo:

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

Suporte ao aplicativo Spring Cloud Stream binder Kafka

Esta secção descreve o cenário de utilização para aplicações Spring Boot que utilizam a biblioteca Kafka do binder 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 autenticação OAuth, especifique o endpoint dos Event Hubs, como mostrado no seguinte exemplo:

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

Usar identidade gerenciada para autenticação OAuth

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

2. Configure as seguintes propriedades no arquivo application.yml:

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

   Importante

   Se estiveres a usar identidade gerida atribuída pelo utilizador, adiciona também a propriedade spring.cloud.azure.credential.client-id com o ID de cliente de identidade gerida atribuida pelo utilizador.

Amostras

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

Usar autenticação por cadeia de ligação

Você pode usar a autenticação de cadeia de conexão diretamente ou usar o Gerenciador de Recursos do Azure para recuperar a cadeia de conexão.

Configuração de dependência

Adicione as seguintes dependências se 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 quiser recuperar a cadeia de ligação usando o Azure Resource Manager, adicione a seguinte dependência:

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

Configuração

Utilizar diretamente a cadeia de ligação dos Hubs de Eventos

A forma mais simples de se ligar aos Hubs de Eventos para Kafka é através da cadeia de ligação. Basta adicionar a seguinte propriedade.

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

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

Se não quiser configurar a cadeia de conexão em seu aplicativo, você pode 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 Visual Studio Code ou Intellij IDEA. Como alternativa, você pode usar a Identidade Gerenciada se seu aplicativo for implantado na Nuvem do Azure. Basta garantir que o principal tem permissão suficiente para ler os metadados dos recursos.

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

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

Amostras

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