Compatibilidad con Azure Kafka de Spring Cloud

La compatibilidad con Spring Cloud Azure Kafka ayuda a las aplicaciones de Spring a autenticarse y conectarse a Azure Event Hubs mediante credenciales de OAuth o cadenas de conexión. En este artículo se describen los tipos de autenticación, las opciones de configuración, las dependencias y los escenarios de uso admitidos.

Versión de Kafka compatible

La versión actual del inicio es compatible con Apache Kafka Clients 2.0.0 y usa Java 8 o posterior.

Tipos de autenticación admitidos

El iniciador admite los siguientes tipos de autenticación:

• Autenticación de cadena de conexión sin formato
  • Autenticación de cadena de conexión directa
  • Autenticación de cadena de conexión basada en ARM
• Autenticación de credenciales de OAuth
  • Autenticación de identidad administrada
  • Autenticación de nombre de usuario y contraseña
  • Autenticación de entidad de servicio
  • autenticación de DefaultAzureCredential

Cómo funciona

Autenticación de credenciales de OAuth

En esta sección se describe el flujo de trabajo general de la autenticación OAuth de Azure de Spring Cloud.

Spring Cloud Azure primero compila uno de los siguientes tipos de credenciales, en función de la configuración de autenticación de la aplicación:

• ClientSecretCredential
• ClientCertificateCredential
• UsernamePasswordCredential
• ManagedIdentityCredential

Si la aplicación no usa uno de estos tipos de credenciales, la aplicación usa la cadena DefaultAzureTokenCredential de credenciales para obtener las credenciales de las propiedades de la aplicación, variables de entorno, identidad administrada o IDE. Para obtener información detallada, consulte autenticación de Azure de Spring Cloud.

Autenticación de cadena de conexión sin formato

Para el modo de autenticación de cadena de conexión, puede usar la autenticación de cadena de conexión directamente o usar Azure Resource Manager para recuperar la cadena de conexión. Para obtener más información sobre el uso, consulte la sección Uso básico de para la autenticación de cadenas de conexión.

Configuración

Propiedades configurables al usar la compatibilidad de Kafka con la autenticación de OAuth

Spring Cloud Azure para Kafka admite los dos niveles siguientes de opciones de configuración:

1. Propiedades de Spring Cloud Azure para Event Hubs Kafka.
2. Las opciones de configuración de autenticación global de credential y profile con prefijos de spring.cloud.azure.
3. Configuraciones de nivel específicas de Kafka. Las configuraciones de nivel de Kafka también están disponibles para los enlazadores Spring Boot y Spring Cloud Stream para common, consumer, producero ámbitos de admin, que tienen prefijos diferentes.

Las propiedades globales se exponen a través de com.azure.spring.cloud.autoconfigure.context.AzureGlobalProperties. Las propiedades específicas de Kafka se exponen a través de org.springframework.boot.autoconfigure.kafka.KafkaProperties (Spring Boot) y org.springframework.cloud.stream.binder.kafka.properties.KafkaBinderConfigurationProperties (enlazador de Spring Cloud Stream).

En la lista siguiente se muestran todas las opciones de configuración admitidas.

• Propiedades de Spring Cloud Azure para Event Hubs Kafka.

  • Propiedad: spring.cloud.azure.eventhubs.kafka.enabled
  • Descripción: si se va a habilitar la conexión gratuita de credenciales a Azure Event Hubs para Kafka, el valor predeterminado es true.

• Las opciones de configuración de autenticación global de Azure de Spring Cloud

  • Prefijo: spring.cloud.azure
  • Opciones admitidas: spring.cloud.azure.credential.*, spring.cloud.azure.profile.*

  Para obtener la lista completa de opciones de configuración global, consulte Propiedades de configuración global.

• Configuración común de Kafka de Spring Boot

  • Prefijo: spring.kafka.properties.azure
  • Ejemplo: spring.kafka.properties.azure.credential.*

• Opciones de configuración de consumidor de Spring Kafka

  • Prefijo: spring.kafka.consumer.properties.azure
  • Ejemplo: spring.kafka.consumer.properties.azure.credential.*

• Opciones de configuración del productor de Spring Kafka

  • Prefijo: spring.kafka.producer.properties.azure
  • Ejemplo: spring.kafka.producer.properties.azure.credential.*

• Opciones de configuración de administrador de Spring Kafka

  • Prefijo: spring.kafka.admin.properties.azure
  • Ejemplo: spring.kafka.admin.properties.azure.credential.*

• Configuración común de Spring Cloud Stream Kafka Binder

  • Prefijo: spring.cloud.stream.kafka.binder.configuration.azure
  • Ejemplo: spring.cloud.stream.kafka.binder.configuration.azure.credential.*

• Configuración del consumidor de Kafka Binder de Spring Cloud Stream

  • Prefijo: spring.cloud.stream.kafka.binder.consumer-properties.azure
  • Ejemplo: spring.cloud.stream.kafka.binder.consumer-properties.azure.credential.*

• Configuración del productor de Kafka Binder de Spring Cloud Stream

  • Prefijo: spring.cloud.stream.kafka.binder.producer-properties.azure
  • Ejemplo: spring.cloud.stream.kafka.binder.producer-properties.azure.credential.*

• Configuración del administrador de Spring Cloud Stream Kafka Binder

  • Prefijo: no compatible, use la configuración común o de administrador de Spring Boot Kafka.

En la tabla siguiente se muestran las opciones de configuración comunes de Spring Boot Kafka:

Propiedades configurables al usar la compatibilidad de Kafka con autenticación de cadena de conexión sin formato

En la tabla siguiente se muestran las opciones de configuración comunes de Spring Boot Event Hubs para Kafka:

Configuración de dependencias

Agregue la siguiente dependencia al proyecto. Esta dependencia incluye automáticamente la dependencia en el spring-boot-starter proyecto.

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

Uso básico

En las secciones siguientes se muestran los escenarios clásicos de uso de aplicaciones de Spring Boot.

Uso de la autenticación de OAuth

Cuando se usa la autenticación de OAuth que proporciona Spring Cloud Azure para Kafka, puede configurar credenciales específicas mediante las configuraciones anteriores. Como alternativa, puede optar por no configurar ninguna credencial. En este caso, Spring Cloud Azure carga las credenciales desde el entorno. En esta sección se describe cómo cargar credenciales desde el entorno de CLI de Azure o el entorno de hospedaje de Azure Spring Apps.

En la sección siguiente se describen los escenarios que usan diferentes bibliotecas del ecosistema de Spring con la autenticación de OAuth.

Compatibilidad con aplicaciones de Spring Kafka

En esta sección se describe el escenario de uso de una aplicación de Spring Boot que usa Spring Kafka o la biblioteca de Spring Integration Kafka.

Configuración de dependencias

<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>

Actualización de configuración

Para usar la autenticación de OAuth, especifique el punto de conexión de Event Hubs, como se muestra en el ejemplo siguiente:

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

Compatibilidad con aplicaciones kafka del enlazador de Spring Cloud Stream

En esta sección se describe el escenario de uso de las aplicaciones de Spring Boot que usan la biblioteca kafka del enlazador de Spring Cloud Stream.

Configuración de dependencias

<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>

Configuración

Para usar la autenticación de OAuth, especifique el punto de conexión de Event Hubs, como se muestra en el ejemplo siguiente:

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

Uso de la identidad administrada para la autenticación de OAuth

1. Para usar la identidad administrada, habilite la identidad administrada para el servicio y asigne los Azure Event Hubs Data Receiver roles y Azure Event Hubs Data Sender . Para más información, consulte Asignación de roles de Azure para derechos de acceso.

2. Configure las siguientes propiedades en el archivo application.yml:

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

   Importante

   Si usa la identidad administrada asignada por el usuario, agregue también la propiedad spring.cloud.azure.credential.client-id con el identificador de cliente de identidad administrada asignada por el usuario.

Muestras

Consulte el azure-spring-boot-samples repositorio en GitHub.

Uso de la autenticación de cadena de conexión

Puede usar la autenticación de cadena de conexión directamente o usar Azure Resource Manager para recuperar la cadena de conexión.

Configuración de dependencias

Agregue las siguientes dependencias si desea migrar la aplicación apache Kafka para usar Azure Event Hubs para Kafka.

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

Si desea recuperar el cadena de conexión mediante Azure Resource Manager, agregue la dependencia siguiente:

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

Configuración

Uso de la cadena de conexión de Event Hubs directamente

La manera más sencilla de conectarse a Event Hubs para Kafka es con la cadena de conexión. Solo tiene que agregar la siguiente propiedad.

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

Uso de Azure Resource Manager para recuperar la cadena de conexión

Si no desea configurar la cadena de conexión en la aplicación, puede usar Azure Resource Manager para recuperar la cadena de conexión. Para autenticarse con Azure Resource Manager, también puede usar credenciales almacenadas en la CLI de Azure u otra herramienta de desarrollo local, como Visual Studio Code o Intellij IDEA. Como alternativa, puede usar la identidad administrada si la aplicación se implementa en la nube de Azure. Asegúrese de que la entidad de seguridad tiene permiso suficiente para leer los metadatos de recursos.

Para usar Azure Resource Manager para recuperar la cadena de conexión, basta con agregar la siguiente propiedad.

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

Muestras

Consulte el azure-spring-boot-samples repositorio en GitHub.