Plantilla de Apache Kafka a la planilla de Kafka

La plantilla de Apache Kafka a Apache Kafka crea una canalización de transmisión que transmite datos como bytes desde una fuente de Apache Kafka y, luego, escribe los bytes en un receptor de Apache Kafka.

Requisitos de la canalización

  • El tema de origen de Apache Kafka debe existir.
  • Los servidores del agente de origen y receptor de Apache Kafka deben estar en ejecución y se debe poder acceder a ellos desde las máquinas de trabajador de Dataflow.
  • Si usas Google Cloud Managed Service para Apache Kafka como fuente o receptor, el tema debe existir antes de iniciar la plantilla.

Formato del mensaje de Kafka

Los mensajes fuente de Apache Kafka se leen como bytes, y los bytes se escriben en el receptor de Apache Kafka.

Autenticación

La plantilla de Apache Kafka a Apache Kafka admite la autenticación SASL/PLAIN y TLS para los agentes de Kafka.

Parámetros de la plantilla

Parámetros obligatorios

  • readBootstrapServerAndTopic: Servidor de arranque y tema de Kafka desde los que se lee la entrada. Por ejemplo, localhost:9092;topic1,topic2
  • kafkaReadAuthenticationMode: Es el modo de autenticación que se usará con el clúster de Kafka. Usa KafkaAuthenticationMethod.NONE para la no autenticación, KafkaAuthenticationMethod.SASL_PLAIN para nombre de usuario y contraseña de SASL/PLAIN, KafkaAuthenticationMethod.SASL_SCRAM_512 para autenticación SASL_SCRAM_512 y KafkaAuthenticationMethod.TLS para autenticación basada en certificados. KafkaAuthenticationMethod.APPLICATION_DEFAULT_CREDENTIALS solo se debe usar para el clúster de Google Cloud Apache Kafka para BigQuery, ya que permite la autenticación con credenciales predeterminadas de la aplicación.
  • writeBootstrapServerAndTopic: Tema de Kafka en el que se escribirá el resultado.
  • kafkaWriteAuthenticationMethod: Es el modo de autenticación que se usará con el clúster de Kafka. Usa NONE para la no autenticación, SASL_PLAIN para nombre de usuario y contraseña de SASL/PLAIN, SASL_SCRAM_512 para la autenticación basada en SASL_SCRAM_512 y TLS para la autenticación basada en certificados. El valor predeterminado es APPLICATION_DEFAULT_CREDENTIALS.

Parámetros opcionales

  • enableCommitOffsets: Confirma los desplazamientos de los mensajes procesados en Kafka. Si se habilita, esto minimizará las brechas o el procesamiento duplicado de los mensajes cuando se reinicie la canalización. Requiere especificar el ID del grupo de consumidores. La configuración predeterminada es "false".
  • consumerGroupId: Es el identificador único del grupo de consumidores al que pertenece esta canalización. Obligatorio si la confirmación de desplazamientos a Kafka está habilitada. La configuración predeterminada es vacía.
  • kafkaReadOffset: Es el punto de partida para leer mensajes cuando no existen compensaciones confirmadas. El primero comienza desde el principio y el más reciente desde el mensaje más reciente. La configuración predeterminada es: la más reciente.
  • kafkaReadUsernameSecretId: Es el ID del secreto de Google Cloud Secret Manager que contiene el nombre de usuario de Kafka que se usará con la autenticación SASL_PLAIN. Por ejemplo, projects/<PROJECT_ID>/secrets/<SECRET_ID>/versions/<SECRET_VERSION>. La configuración predeterminada es vacía.
  • kafkaReadPasswordSecretId: Es el ID del secreto de Google Cloud Secret Manager que contiene la contraseña de Kafka que se usará con la autenticación SASL_PLAIN. Por ejemplo, projects/<PROJECT_ID>/secrets/<SECRET_ID>/versions/<SECRET_VERSION>. La configuración predeterminada es vacía.
  • kafkaReadKeystoreLocation: Es la ruta de acceso de Google Cloud Storage al archivo Java KeyStore (JKS) que contiene el certificado TLS y la clave privada que se usarán para la autenticación con el clúster de Kafka. Por ejemplo, gs://your-bucket/keystore.jks
  • kafkaReadTruststoreLocation: Es la ruta de acceso de Google Cloud Storage al archivo Java TrustStore (JKS) que contiene los certificados de confianza que se usarán para verificar la identidad del agente de Kafka.
  • kafkaReadTruststorePasswordSecretId: Es el ID del secreto de Google Cloud Secret Manager que contiene la contraseña que se usará para acceder al archivo Java TrustStore (JKS) para la autenticación TLS de Kafka. Por ejemplo, projects/<PROJECT_ID>/secrets/<SECRET_ID>/versions/<SECRET_VERSION>.
  • kafkaReadKeystorePasswordSecretId: Es el ID del secreto de Google Cloud Secret Manager que contiene la contraseña que se usará para acceder al archivo Java KeyStore (JKS) para la autenticación TLS de Kafka. Por ejemplo, projects/<PROJECT_ID>/secrets/<SECRET_ID>/versions/<SECRET_VERSION>
  • kafkaReadKeyPasswordSecretId: Es el ID del secreto de Google Cloud Secret Manager que contiene la contraseña que se usará para acceder a la clave privada dentro del archivo Java KeyStore (JKS) para la autenticación TLS de Kafka. Por ejemplo, projects/<PROJECT_ID>/secrets/<SECRET_ID>/versions/<SECRET_VERSION>
  • kafkaReadSaslScramUsernameSecretId: Es el ID del secreto de Google Cloud Secret Manager que contiene el nombre de usuario de Kafka que se usará con la autenticación SASL_SCRAM. Por ejemplo, projects/<PROJECT_ID>/secrets/<SECRET_ID>/versions/<SECRET_VERSION>.
  • kafkaReadSaslScramPasswordSecretId: Es el ID del secreto de Google Cloud Secret Manager que contiene la contraseña de Kafka que se usará con la autenticación SASL_SCRAM. Por ejemplo, projects/<PROJECT_ID>/secrets/<SECRET_ID>/versions/<SECRET_VERSION>.
  • kafkaReadSaslScramTruststoreLocation: Es la ruta de acceso de Google Cloud Storage al archivo Java TrustStore (JKS) que contiene los certificados de confianza que se usarán para verificar la identidad del agente de Kafka.
  • kafkaReadSaslScramTruststorePasswordSecretId: Es el ID del secreto de Google Cloud Secret Manager que contiene la contraseña que se usará para acceder al archivo Java TrustStore (JKS) para la autenticación SASL_SCRAM de Kafka. Por ejemplo, projects/<PROJECT_ID>/secrets/<SECRET_ID>/versions/<SECRET_VERSION>.
  • kafkaWriteUsernameSecretId: Es el ID del secreto de Google Cloud Secret Manager que contiene el nombre de usuario de Kafka para la autenticación SASL_PLAIN con el clúster de Kafka de destino. Por ejemplo, projects/<PROJECT_ID>/secrets/<SECRET_ID>/versions/<SECRET_VERSION> La configuración predeterminada es vacía.
  • kafkaWritePasswordSecretId: Es el ID del secreto de Google Cloud Secret Manager que contiene la contraseña de Kafka que se usará para la autenticación SASL_PLAIN con el clúster de Kafka de destino. Por ejemplo, projects/<PROJECT_ID>/secrets/<SECRET_ID>/versions/<SECRET_VERSION> La configuración predeterminada es vacía.
  • kafkaWriteKeystoreLocation: Es la ruta de acceso de Google Cloud Storage al archivo Java KeyStore (JKS) que contiene el certificado TLS y la clave privada para la autenticación con el clúster de Kafka de destino. Por ejemplo, gs://<BUCKET>/<KEYSTORE>.jks
  • kafkaWriteTruststoreLocation: Es la ruta de acceso de Google Cloud Storage al archivo Java TrustStore (JKS) que contiene los certificados de confianza que se usarán para verificar la identidad del agente de Kafka de destino.
  • kafkaWriteTruststorePasswordSecretId: Es el ID del secreto de Google Cloud Secret Manager que contiene la contraseña que se usará para acceder al archivo Java TrustStore (JKS) para la autenticación TLS con el clúster de Kafka de destino. Por ejemplo, projects/<PROJECT_ID>/secrets/<SECRET_ID>/versions/<SECRET_VERSION>
  • kafkaWriteKeystorePasswordSecretId: Es el ID del secreto de Google Cloud Secret Manager que contiene la contraseña para acceder al archivo Java KeyStore (JKS) que se usará para la autenticación TLS con el clúster de Kafka de destino. Por ejemplo, projects/<PROJECT_ID>/secrets/<SECRET_ID>/versions/<SECRET_VERSION>
  • kafkaWriteKeyPasswordSecretId: Es el ID del secreto de Google Cloud Secret Manager que contiene la contraseña que se usará para acceder a la clave privada dentro del archivo Java KeyStore (JKS) para la autenticación TLS con el clúster de Kafka de destino. Por ejemplo, projects/<PROJECT_ID>/secrets/<SECRET_ID>/versions/<SECRET_VERSION>

Ejecuta la plantilla

Console

  1. Ve a la página Crear un trabajo a partir de una plantilla de Dataflow.
  2. Ir a Crear un trabajo a partir de una plantilla
  3. En el campo Nombre del trabajo, ingresa un nombre de trabajo único.
  4. Opcional: Para Extremo regional, selecciona un valor del menú desplegable. La región predeterminada es us-central1.

    Para obtener una lista de regiones en las que puedes ejecutar un trabajo de Dataflow, consulta Ubicaciones de Dataflow.

  5. En el menú desplegable Plantilla de Dataflow, selecciona the Kafka to Cloud Storage template.
  6. En los campos de parámetros proporcionados, ingresa los valores de tus parámetros.
  7. Opcional: Para cambiar del procesamiento “exactamente una vez” al modo de transmisión al menos una vez, selecciona Al menos una vez.
  8. Haz clic en Ejecutar trabajo.

gcloud

En tu shell o terminal, ejecuta la plantilla:

gcloud dataflow flex-template run JOB_NAME \
    --project=PROJECT_ID \
    --region=REGION_NAME \
    --template-file-gcs-location=gs://dataflow-templates-REGION_NAME/VERSION/flex/Kafka_to_Kafka \
    --parameters \
readBootstrapServerAndTopic=READ_BOOTSTRAP_SERVER_AND_TOPIC,\
kafkaReadAuthenticationMode=APPLICATION_DEFAULT_CREDENTIALS,\
writeBootstrapServerAndTopic=WRITE_BOOTSTRAP_SERVER_AND_TOPIC,\
kafkaWriteAuthenticationMethod=APPLICATION_DEFAULT_CREDENTIALS
  

Reemplaza lo siguiente:

  • PROJECT_ID: El ID del proyecto Google Cloud en el que deseas ejecutar el trabajo de Dataflow
  • JOB_NAME: Es el nombre del trabajo que elijas
  • REGION_NAME: La región en la que deseas implementar tu trabajo de Dataflow, por ejemplo, us-central1
  • VERSION: Es la versión de la plantilla que deseas usar.

    Puedes usar los siguientes valores:

    • latest para usar la última versión de la plantilla, que está disponible en la carpeta superior non-dated en el bucket gs://dataflow-templates-REGION_NAME/latest/
    • el nombre de la versión, como 2023-09-12-00_RC00, para usar una versión específica de la plantilla, que se puede encontrar anidada en la carpeta superior con fecha correspondiente en el bucket gs://dataflow-templates-REGION_NAME/
  • READ_BOOTSTRAP_SERVER_AND_TOPIC: La dirección del servidor de arranque de Apache Kafka y el tema desde el que se leerá
  • WRITE_BOOTSTRAP_SERVER_AND_TOPIC: La dirección del servidor de arranque de Apache Kafka y el tema en el que se escribirá

    El formato de la dirección y el tema del servidor de arranque depende del tipo de clúster:

    • Clúster de Managed Service for Apache Kafka: projects/PROJECT_ID/locations/REGION_NAME/clusters/CLUSTER_NAME/topics/TOPIC_NAME
    • Clúster de Kafka externo: BOOTSTRAP_SERVER_ADDRESS;TOPIC_NAME

API

Para ejecutar la plantilla con la API de REST, envía una solicitud POST HTTP. Para obtener más información de la API y sus permisos de autorización, consulta projects.templates.launch.

POST https://dataflow.googleapis.com/v1b3/projects/PROJECT_ID/locations/LOCATION/flexTemplates:launch
{
   "launch_parameter": {
      "jobName": "JOB_NAME",
      "parameters": {
          "readBootstrapServerAndTopic": "READ_BOOTSTRAP_SERVER_AND_TOPIC",
          "kafkaReadAuthenticationMode": "APPLICATION_DEFAULT_CREDENTIALS",
          "writeBootstrapServerAndTopic": "WRITE_BOOTSTRAP_SERVER_AND_TOPIC",
          "kafkaWriteAuthenticationMethod": "APPLICATION_DEFAULT_CREDENTIALS
      },
      "containerSpecGcsPath": "gs://dataflow-templates-LOCATION/VERSION/flex/Kafka_to_Kafka",
   }
}
  

Reemplaza lo siguiente:

  • PROJECT_ID: El ID del proyecto Google Cloud en el que deseas ejecutar el trabajo de Dataflow
  • JOB_NAME: Es el nombre del trabajo que elijas
  • LOCATION: La región en la que deseas implementar tu trabajo de Dataflow, por ejemplo, us-central1
  • VERSION: Es la versión de la plantilla que deseas usar.

    Puedes usar los siguientes valores:

    • latest para usar la última versión de la plantilla, que está disponible en la carpeta superior non-dated en el bucket gs://dataflow-templates-REGION_NAME/latest/
    • el nombre de la versión, como 2023-09-12-00_RC00, para usar una versión específica de la plantilla, que se puede encontrar anidada en la carpeta superior con fecha correspondiente en el bucket gs://dataflow-templates-REGION_NAME/
  • READ_BOOTSTRAP_SERVER_AND_TOPIC: La dirección del servidor de arranque de Apache Kafka y el tema desde el que se leerá
  • WRITE_BOOTSTRAP_SERVER_AND_TOPIC: La dirección del servidor de arranque de Apache Kafka y el tema en el que se escribirá

    El formato de la dirección y el tema del servidor de arranque depende del tipo de clúster:

    • Clúster de Managed Service for Apache Kafka: projects/PROJECT_ID/locations/LOCATION/clusters/CLUSTER_NAME/topics/TOPIC_NAME
    • Clúster de Kafka externo: BOOTSTRAP_SERVER_ADDRESS;TOPIC_NAME

¿Qué sigue?